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
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
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(mArguments?)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.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
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)
  • 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:
{string}sId? ID for the new control, generated automatically if no ID is given
{object}mSettings? Initial settings for the new control
Event Detail
itemSelect(oControlEvent)
Fired when an item is selected.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.core.Item}oControlEvent.getParameters.item The 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:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.tnt.NavigationList.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.tnt.NavigationList.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addAriaDescribedBy(vAriaDescribedBy): sap.tnt.NavigationList
Adds some ariaDescribedBy into the association ariaDescribedBy.
Parameters:
{string|sap.ui.core.Control}vAriaDescribedBy the ariaDescribedBy to add; if empty, nothing is inserted
Returns:
{sap.tnt.NavigationList} Reference to this in order to allow method chaining
addAriaLabelledBy(vAriaLabelledBy): sap.tnt.NavigationList
Adds some ariaLabelledBy into the association ariaLabelledBy.
Parameters:
{string|sap.ui.core.Control}vAriaLabelledBy the ariaLabelledBy to add; if empty, nothing is inserted
Returns:
{sap.tnt.NavigationList} Reference to this in order to allow method chaining
addItem(oItem): sap.tnt.NavigationList
Adds some item to the aggregation items.
Parameters:
{sap.tnt.NavigationListItem}oItem the item to add; if empty, nothing is inserted
Returns:
{sap.tnt.NavigationList} Reference 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:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.tnt.NavigationList itself
Returns:
{sap.tnt.NavigationList} Reference to this in order to allow method chaining
destroyItems(): sap.tnt.NavigationList
Destroys all the items in the aggregation items.
Returns:
{sap.tnt.NavigationList} Reference 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:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.tnt.NavigationList} Reference to this in order to allow method chaining
fireItemSelect(mArguments?): sap.tnt.NavigationList
Fires event itemSelect to attached listeners.

Expects the following event parameters:

  • item of type sap.ui.core.ItemThe selected item.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.tnt.NavigationList} Reference to this in order to allow method chaining
getAriaDescribedBy(): sap.ui.core.Control[]
Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy.
Returns:
{sap.ui.core.Control[]}
getAriaLabelledBy(): sap.ui.core.Control[]
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
Returns:
{sap.ui.core.Control[]}
getExpanded(): boolean
Gets current value of property expanded.

Specifies if the control is in expanded or collapsed mode.

Default value is true.

Returns:
{boolean} Value of property expanded
getItems(): sap.tnt.NavigationListItem[]
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.CSSSize} Value 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.NavigationListItem}oItem The item whose index is looked for
Returns:
{int} The 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.NavigationListItem}oItem the item to insert; if empty, nothing is inserted
{int}iIndex the 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.NavigationList} Reference to this in order to allow method chaining
removeAllAriaDescribedBy(): sap.ui.core.Control[]
Removes all the controls in the association named ariaDescribedBy.
Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeAllAriaLabelledBy(): sap.ui.core.Control[]
Removes all the controls in the association named ariaLabelledBy.
Returns:
{sap.ui.core.Control[]} 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.Control
Removes an ariaDescribedBy from the association named ariaDescribedBy.
Parameters:
{int|string|sap.ui.core.Control}vAriaDescribedBy The ariaDescribedByto be removed or its index or ID
Returns:
{sap.ui.core.Control} the removed ariaDescribedBy or null
removeAriaLabelledBy(vAriaLabelledBy): sap.ui.core.Control
Removes an ariaLabelledBy from the association named ariaLabelledBy.
Parameters:
{int|string|sap.ui.core.Control}vAriaLabelledBy The ariaLabelledByto be removed or its index or ID
Returns:
{sap.ui.core.Control} the removed ariaLabelledBy or null
removeItem(vItem): sap.tnt.NavigationListItem
Removes a item from the aggregation items.
Parameters:
{int|string|sap.tnt.NavigationListItem}vItem The itemto remove or its index or id
Returns:
{sap.tnt.NavigationListItem} The 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:
{boolean}bExpanded New value for property expanded
Returns:
{sap.tnt.NavigationList} Reference 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.CSSSize}sWidth New value for property width
Returns:
{sap.tnt.NavigationList} Reference to this in order to allow method chaining