Class sap.suite.ui.commons.CountingNavigationItemModule: sap/suite/ui/commons/CountingNavigationItem


This control extends the sap.ui.ux3.NavigationItem control. This control can display the quantity of items on a corresponding content area. It also provides a rich tooltip that can appear and disappear after a certain delay.

Deprecated API:Since version 1.32. Deprecated. Object page should be used instead.

Constructor Summary
new sap.suite.ui.commons.CountingNavigationItem(sId?, mSettings?)Constructor for a new CountingNavigationItem.
Method Summary
sap.suite.ui.commons.CountingNavigationItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.CountingNavigationItem with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.CountingNavigationItem.getMetadata()Returns a metadata object for class sap.suite.ui.commons.CountingNavigationItem.
getQuantity()Getter for property quantity.
setQuantity(sQuantity)Setter for property quantity.
Constructor Detail
new sap.suite.ui.commons.CountingNavigationItem(sId?, mSettings?)
Constructor for a new CountingNavigationItem.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.

If the name of a setting is ambiguous (e.g. a property has the same name as an event), then the framework assumes property, aggregation, association, event in that order. To override this automatic resolution, one of the prefixes "aggregation:", "association:" or "event:" can be added to the name of the setting (such a prefixed name must be enclosed in single or double quotes).

The supported settings are:

  • Properties
  • Aggregations
    • Associations
      • Events

        In addition, all settings applicable to the base type sap.ui.ux3.NavigationItem can be used as well.

        Parameters:
        {string}sId? id for the new control, generated automatically if no id is given
        {object}mSettings? initial settings for the new control
        Deprecated:
        Since version 1.32. Deprecated. Object page should be used instead.
        Method Detail
        sap.suite.ui.commons.CountingNavigationItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function
        Creates a new subclass of class sap.suite.ui.commons.CountingNavigationItem with name sClassName and enriches it with the information contained in oClassInfo.

        oClassInfo might contain the same kind of informations as described in Element.extend.

        Parameters:
        {string}sClassName name of the class to be created
        {object}oClassInfo? object literal with informations about the class
        {function}FNMetaImpl? constructor function for the metadata object. If not given, it defaults to sap.ui.core.ElementMetadata.
        Returns:
        {function} the created class / constructor function
        sap.suite.ui.commons.CountingNavigationItem.getMetadata(): sap.ui.base.Metadata
        Returns a metadata object for class sap.suite.ui.commons.CountingNavigationItem.
        Returns:
        {sap.ui.base.Metadata} Metadata object describing this class
        getQuantity(): string
        Getter for property quantity. Stores the number of content items associated with this navigation item. This number appears in brackets next to the navigation item name. For example, Employes (10000).

        Default value is empty/undefined

        Returns:
        {string} the value of property quantity
        Setter for property quantity.

        Default value is empty/undefined

        Parameters:
        {string}sQuantity new value for property quantity
        Returns:
        {sap.suite.ui.commons.CountingNavigationItem}this to allow method chaining