Class sap.tnt.NavigationListItemModule: sap/tnt/NavigationListItem

extends Item

The NavigationListItem control represents an action, which can be selected by the user. It can provide sub items.


Since: 1.34.
Constructor Summary
new sap.tnt.NavigationListItem(sId?, mSettings?)Constructor for a new NavigationListItem.
Event Summary
select(oControlEvent)Fired when this item is selected.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.tnt.NavigationListItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.tnt.NavigationListItem with name sClassName and enriches it with the information contained in oClassInfo.
sap.tnt.NavigationListItem.getMetadata()Returns a metadata object for class sap.tnt.NavigationListItem.
addItem(oItem)Adds some item to the aggregation items.
attachSelect(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the select event of this sap.tnt.NavigationListItem.
destroyItems()Destroys all the items in the aggregation items.
detachSelect(fnFunction, oListener)Detaches event handler fnFunction from the select event of this sap.tnt.NavigationListItem.
fireSelect(mArguments?)Fires event select to attached listeners.
getExpanded()Gets current value of property expanded.
getHasExpander()Gets current value of property hasExpander.
getIcon()Gets current value of property icon.
getItems()Gets content of aggregation items.
indexOfItem(oItem)Checks for the provided sap.tnt.NavigationListItem in the aggregation items.
insertItem(oItem, iIndex)Inserts a item into the aggregation items.
removeAllItems()Removes all the controls from the aggregation items.
removeItem(vItem)Removes a item from the aggregation items.
setExpanded(bExpanded)Sets a new value for property expanded.
setHasExpander(bHasExpander)Sets a new value for property hasExpander.
setIcon(sIcon)Sets a new value for property icon.
Methods borrowed from class sap.ui.core.Item
getEnabled, getKey, getText, getTextDirection, setEnabled, setKey, setText, setTextDirection
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, 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, rerender, 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, invalidate, 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.NavigationListItem(sId?, mSettings?)
Constructor for a new NavigationListItem.

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
    • select : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.core.Item 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
select(oControlEvent)
Fired when this 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.NavigationListItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.tnt.NavigationListItem 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.Item.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.NavigationListItem.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.tnt.NavigationListItem.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addItem(oItem): sap.tnt.NavigationListItem
Adds some item to the aggregation items.
Parameters:
{sap.tnt.NavigationListItem}oItem the item to add; if empty, nothing is inserted
Returns:
{sap.tnt.NavigationListItem} Reference to this in order to allow method chaining
attachSelect(oData?, fnFunction, oListener?): sap.tnt.NavigationListItem
Attaches event handler fnFunction to the select event of this sap.tnt.NavigationListItem.

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.NavigationListItem itself.

Fired when this 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.NavigationListItem itself
Returns:
{sap.tnt.NavigationListItem} Reference to this in order to allow method chaining
destroyItems(): sap.tnt.NavigationListItem
Destroys all the items in the aggregation items.
Returns:
{sap.tnt.NavigationListItem} Reference to this in order to allow method chaining
detachSelect(fnFunction, oListener): sap.tnt.NavigationListItem
Detaches event handler fnFunction from the select event of this sap.tnt.NavigationListItem.

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.NavigationListItem} Reference to this in order to allow method chaining
fireSelect(mArguments?): sap.tnt.NavigationListItem
Fires event select 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.NavigationListItem} Reference to this in order to allow method chaining
getExpanded(): boolean
Gets current value of property expanded.

Specifies if the item is expanded.

Default value is true.

Returns:
{boolean} Value of property expanded
getHasExpander(): boolean
Gets current value of property hasExpander.

Specifies if the item has an expander.

Default value is true.

Returns:
{boolean} Value of property hasExpander
getIcon(): sap.ui.core.URI
Gets current value of property icon.

Specifies the icon for the item.

Default value is .

Returns:
{sap.ui.core.URI} Value of property icon
getItems(): sap.tnt.NavigationListItem[]
Gets content of aggregation items.

The sub items.

Returns:
{sap.tnt.NavigationListItem[]}
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.NavigationListItem
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.NavigationListItem} Reference to this in order to allow method chaining
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)
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.NavigationListItem
Sets a new value for property expanded.

Specifies if the item is expanded.

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.NavigationListItem} Reference to this in order to allow method chaining
setHasExpander(bHasExpander): sap.tnt.NavigationListItem
Sets a new value for property hasExpander.

Specifies if the item has an expander.

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

Default value is true.

Parameters:
{boolean}bHasExpander New value for property hasExpander
Returns:
{sap.tnt.NavigationListItem} Reference to this in order to allow method chaining
setIcon(sIcon): sap.tnt.NavigationListItem
Sets a new value for property icon.

Specifies the icon for the item.

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

Default value is .

Parameters:
{sap.ui.core.URI}sIcon New value for property icon
Returns:
{sap.tnt.NavigationListItem} Reference to this in order to allow method chaining