Is the item to be used within the NavigationBar
Deprecated API:Since version 1.38. Instead, use the sap.m.IconTabBar, sap.m.TabContainer or sap.uxap.ObjectPageLayout control.
Method Summary
sap.ui.ux3.NavigationItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.ux3.NavigationItem with name sClassName and enriches it with the information contained in oClassInfo. addSubItem(oSubItem)Adds some subItem to the aggregation subItems. getHref()Gets current value of property href. getVisible()Gets current value of property visible. indexOfSubItem(oSubItem)Checks for the provided sap.ui.ux3.NavigationItem in the aggregation subItems. insertSubItem(oSubItem, iIndex)Inserts a subItem into the aggregation subItems. removeSubItem(vSubItem)Removes a subItem from the aggregation subItems. setHref(sHref)Sets a new value for property href. setVisible(bVisible)Sets a new value for property visible. $,
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 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 Constructor Detail
new sap.ui.ux3.NavigationItem(sId?, mSettings?)
Constructor for a new NavigationItem.
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
- visible : boolean (default: true)
- href : sap.ui.core.URI
- Aggregations
- subItems : sap.ui.ux3.NavigationItem[] (default)
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 |
- Deprecated:
- Since version 1.38. Instead, use the
sap.m.IconTabBar, sap.m.TabContainer or sap.uxap.ObjectPageLayout control.
Method Detail
sap.ui.ux3.NavigationItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.ux3.NavigationItem 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 |
Returns a metadata object for class sap.ui.ux3.NavigationItem.
Returns:
Adds some subItem to the aggregation subItems.
Parameters:
Returns:
Destroys all the subItems in the aggregation subItems.
Returns:
Gets current value of property
href.
Defines the link target URL. This property is optional and should only be set when required! The use of the href property is to not only allow users to navigate in-place by left-clicking NavigationItems, but also to allow right-click and then "open in new tab" or "open in new window". As long as href is not set, an empty window will open and stay blank. But when href is set, the new window/tab will load this URL and it is the application's responsibility to display what the user expects (e.g. the Shell, with the respective NavigationItem being selected).
Returns:
Gets content of aggregation
subItems.
Any NavigationItems on the next hierarchy level connected to this NavigationItem
Returns:
getVisible(): boolean
Gets current value of property
visible.
Whether the NavigationItem is currently visible. When making NavigationItems invisible at runtime it is the application's responsibility to make sure it is not the currently selected one - or to select another one in this case.
Default value is true.
- Since:
- 1.9.0
Returns:
| {boolean} | Value of property visible |
indexOfSubItem(oSubItem): int
Checks for the provided sap.ui.ux3.NavigationItem in the aggregation subItems. and returns its index if found or -1 otherwise.
Parameters:
Returns:
| {int} | The index of the provided control in the aggregation if found, or -1 otherwise |
Inserts a subItem into the aggregation subItems.
Parameters:
| {sap.ui.ux3.NavigationItem} | oSubItem | the subItem to insert; if empty, nothing is inserted |
| {int} | iIndex | the 0-based index the subItem should be inserted at; for a negative value of iIndex, the subItem is inserted at position 0; for a value greater than the current size of the aggregation, the subItem is inserted at the last position |
Returns:
Removes all the controls from the aggregation
subItems.
Additionally, it unregisters them from the hosting UIArea.
Returns:
Removes a subItem from the aggregation subItems.
Parameters:
Returns:
Sets a new value for property
href.
Defines the link target URL. This property is optional and should only be set when required! The use of the href property is to not only allow users to navigate in-place by left-clicking NavigationItems, but also to allow right-click and then "open in new tab" or "open in new window". As long as href is not set, an empty window will open and stay blank. But when href is set, the new window/tab will load this URL and it is the application's responsibility to display what the user expects (e.g. the Shell, with the respective NavigationItem being selected).
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
Returns:
Sets a new value for property
visible.
Whether the NavigationItem is currently visible. When making NavigationItems invisible at runtime it is the application's responsibility to make sure it is not the currently selected one - or to select another one in this case.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is true.
Parameters:
| {boolean} | bVisible | New value for property visible |
- Since:
- 1.9.0
Returns: