Class sap.tnt.NavigationListModule: sap/tnt/NavigationList

extends Control

The NavigationList control is an interactive control, which provides a choice of different items, ordered as a list.
Since: 1.34.
Constructor Summary
new sap.tnt.NavigationList(sId?, mSettings?)Constructor for a new NavigationList.
Event Summary
itemSelect(oControlEvent)Fired when an item is selected.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.tnt.NavigationList.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.tnt.NavigationList with name sClassName and enriches it with the information contained in oClassInfo.
sap.tnt.NavigationList.getMetadata()Returns a metadata object for class sap.tnt.NavigationList.
addAriaDescribedBy(vAriaDescribedBy)Adds some ariaDescribedBy into the association ariaDescribedBy.
addAriaLabelledBy(vAriaLabelledBy)Adds some ariaLabelledBy into the association ariaLabelledBy.
addItem(oItem)Adds some item to the aggregation items.
attachItemSelect(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the itemSelect event of this sap.tnt.NavigationList.
destroyItems()Destroys all the items in the aggregation items.
detachItemSelect(fnFunction, oListener)Detaches event handler fnFunction from the itemSelect event of this sap.tnt.NavigationList.
fireItemSelect(mParameters?)Fires event itemSelect to attached listeners.
getAriaDescribedBy()Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy.
getAriaLabelledBy()Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
getExpanded()Gets current value of property expanded.
getItems()Gets content of aggregation items.
getWidth()Gets current value of property width.
indexOfItem(oItem)Checks for the provided sap.tnt.NavigationListItem in the aggregation items.
insertItem(oItem, iIndex)Inserts a item into the aggregation items.
removeAllAriaDescribedBy()Removes all the controls in the association named ariaDescribedBy.
removeAllAriaLabelledBy()Removes all the controls in the association named ariaLabelledBy.
removeAllItems()Removes all the controls from the aggregation items.
removeAriaDescribedBy(vAriaDescribedBy)Removes an ariaDescribedBy from the association named ariaDescribedBy.
removeAriaLabelledBy(vAriaLabelledBy)Removes an ariaLabelledBy from the association named ariaLabelledBy.
removeItem(vItem)Removes a item from the aggregation items.
setExpanded(bExpanded)Sets a new value for property expanded.
setWidth(sWidth)Sets a new value for property width.
Constructor Detail
new sap.tnt.NavigationList(sId?, mSettings?)

Constructor for a new NavigationList.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

  • Properties

  • Aggregations

    • items : sap.tnt.NavigationListItem[] (default)

  • Associations

  • Events

    • itemSelect : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

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

Parameters:
stringsId?ID for the new control, generated automatically if no ID is given
objectmSettings?Initial settings for the new control
Event Detail
itemSelect(oControlEvent)
Fired when an item is selected.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.ui.core.ItemoControlEvent.getParameters.itemThe selected item.
Method Detail
sap.tnt.NavigationList.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.tnt.NavigationList with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

Parameters:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.tnt.NavigationList.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.tnt.NavigationList.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addAriaDescribedBy(vAriaDescribedBy): sap.tnt.NavigationList
Adds some ariaDescribedBy into the association ariaDescribedBy.
Parameters:
sap.ui.core.ID|sap.ui.core.ControlvAriaDescribedBythe ariaDescribedBy to add; if empty, nothing is inserted
Returns:
sap.tnt.NavigationListReference to this in order to allow method chaining
addAriaLabelledBy(vAriaLabelledBy): sap.tnt.NavigationList
Adds some ariaLabelledBy into the association ariaLabelledBy.
Parameters:
sap.ui.core.ID|sap.ui.core.ControlvAriaLabelledBythe ariaLabelledBy to add; if empty, nothing is inserted
Returns:
sap.tnt.NavigationListReference to this in order to allow method chaining
addItem(oItem): sap.tnt.NavigationList
Adds some item to the aggregation items.
Parameters:
sap.tnt.NavigationListItemoItemthe item to add; if empty, nothing is inserted
Returns:
sap.tnt.NavigationListReference to this in order to allow method chaining
attachItemSelect(oData?, fnFunction, oListener?): sap.tnt.NavigationList

Attaches event handler fnFunction to the itemSelect event of this sap.tnt.NavigationList.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.tnt.NavigationList itself.

Fired when an item is selected.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.tnt.NavigationList itself
Returns:
sap.tnt.NavigationListReference to this in order to allow method chaining
destroyItems(): sap.tnt.NavigationList
Destroys all the items in the aggregation items.
Returns:
sap.tnt.NavigationListReference to this in order to allow method chaining
detachItemSelect(fnFunction, oListener): sap.tnt.NavigationList

Detaches event handler fnFunction from the itemSelect event of this sap.tnt.NavigationList.

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.tnt.NavigationListReference to this in order to allow method chaining
fireItemSelect(mParameters?): sap.tnt.NavigationList
Fires event itemSelect to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
sap.ui.core.ItemmParameters.item?The selected item.
Returns:
sap.tnt.NavigationListReference to this in order to allow method chaining
getAriaDescribedBy(): sap.ui.core.ID[]
Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy.
Returns:
sap.ui.core.ID[]
getAriaLabelledBy(): sap.ui.core.ID[]
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
Returns:
sap.ui.core.ID[]
getExpanded(): boolean

Gets current value of property expanded.

Specifies if the control is in expanded or collapsed mode.

Default value is true.

Returns:
booleanValue of property expanded

Gets content of aggregation items.

The items displayed in the list.

Returns:
sap.tnt.NavigationListItem[]
getWidth(): sap.ui.core.CSSSize

Gets current value of property width.

Specifies the width of the control.

Returns:
sap.ui.core.CSSSizeValue of property width
indexOfItem(oItem): int
Checks for the provided sap.tnt.NavigationListItem in the aggregation items. and returns its index if found or -1 otherwise.
Parameters:
sap.tnt.NavigationListItemoItemThe item whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertItem(oItem, iIndex): sap.tnt.NavigationList
Inserts a item into the aggregation items.
Parameters:
sap.tnt.NavigationListItemoItemthe item to insert; if empty, nothing is inserted
intiIndexthe 0-based index the item should be inserted at; for a negative value of iIndex, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
Returns:
sap.tnt.NavigationListReference to this in order to allow method chaining
removeAllAriaDescribedBy(): sap.ui.core.ID[]
Removes all the controls in the association named ariaDescribedBy.
Returns:
sap.ui.core.ID[]An array of the removed elements (might be empty)
removeAllAriaLabelledBy(): sap.ui.core.ID[]
Removes all the controls in the association named ariaLabelledBy.
Returns:
sap.ui.core.ID[]An array of the removed elements (might be empty)
removeAllItems(): sap.tnt.NavigationListItem[]

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.tnt.NavigationListItem[]An array of the removed elements (might be empty)
removeAriaDescribedBy(vAriaDescribedBy): sap.ui.core.ID
Removes an ariaDescribedBy from the association named ariaDescribedBy.
Parameters:
int|sap.ui.core.ID|sap.ui.core.ControlvAriaDescribedByThe ariaDescribedBy to be removed or its index or ID
Returns:
sap.ui.core.IDThe removed ariaDescribedBy or null
removeAriaLabelledBy(vAriaLabelledBy): sap.ui.core.ID
Removes an ariaLabelledBy from the association named ariaLabelledBy.
Parameters:
int|sap.ui.core.ID|sap.ui.core.ControlvAriaLabelledByThe ariaLabelledBy to be removed or its index or ID
Returns:
sap.ui.core.IDThe removed ariaLabelledBy or null
removeItem(vItem): sap.tnt.NavigationListItem
Removes a item from the aggregation items.
Parameters:
int|string|sap.tnt.NavigationListItemvItemThe item to remove or its index or id
Returns:
sap.tnt.NavigationListItemThe removed item or null
setExpanded(bExpanded): sap.tnt.NavigationList

Sets a new value for property expanded.

Specifies if the control is in expanded or collapsed mode.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
booleanbExpandedNew value for property expanded
Returns:
sap.tnt.NavigationListReference to this in order to allow method chaining
setWidth(sWidth): sap.tnt.NavigationList

Sets a new value for property width.

Specifies the width of the control.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
sap.ui.core.CSSSizesWidthNew value for property width
Returns:
sap.tnt.NavigationListReference to this in order to allow method chaining