Class sap.uxap.BreadCrumbsModule: sap/uxap/BreadCrumbs

extends Control

The BreadCrumbs control represents the navigation steps up to the current location in the application and allows the user to quickly navigate to a previous location on the path that got him to the current location. It has two main modes of operation. One is a trail of links followed by separators (when there's enough space for the control to fit on one line), and the other is a dropdown list with the links (when the trail of links wouldn't fit on one line).
Since: 1.30.
Constructor Summary
new sap.uxap.BreadCrumbs(sId?, mSettings?)Constructor for a new BreadCrumbs.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.uxap.BreadCrumbs.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.uxap.BreadCrumbs with name sClassName and enriches it with the information contained in oClassInfo.
sap.uxap.BreadCrumbs.getMetadata()Returns a metadata object for class sap.uxap.BreadCrumbs.
addLink(oLink)Adds some link to the aggregation links.
destroyCurrentLocation()Destroys the currentLocation in the aggregation currentLocation.
destroyLinks()Destroys all the links in the aggregation links.
getCurrentLocation()Gets content of aggregation currentLocation.
getLinks()Gets content of aggregation links.
getShowCurrentLocation()Gets current value of property showCurrentLocation.
indexOfLink(oLink)Checks for the provided sap.m.Link in the aggregation links.
insertLink(oLink, iIndex)Inserts a link into the aggregation links.
removeAllLinks()Removes all the controls from the aggregation links.
removeLink(vLink)Removes a link from the aggregation links.
setCurrentLocation(oCurrentLocation)Sets the aggregated currentLocation.
setShowCurrentLocation(bShowCurrentLocation)Sets a new value for property showCurrentLocation.
Constructor Detail
new sap.uxap.BreadCrumbs(sId?, mSettings?)

Constructor for a new BreadCrumbs.

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:

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
Method Detail
sap.uxap.BreadCrumbs.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.uxap.BreadCrumbs 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.uxap.BreadCrumbs.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.uxap.BreadCrumbs.
Returns:
sap.ui.base.MetadataMetadata object describing this class
destroyCurrentLocation(): sap.uxap.BreadCrumbs
Destroys the currentLocation in the aggregation currentLocation.
Returns:
sap.uxap.BreadCrumbsReference to this in order to allow method chaining
getCurrentLocation(): sap.m.Text

Gets content of aggregation currentLocation.

The current/last element in the BreadCrumbs path.

Returns:
sap.m.Text
getShowCurrentLocation(): boolean

Gets current value of property showCurrentLocation.

Sets the visibility of the current/last element in the BreadCrumbs path.

Default value is true.

Returns:
booleanValue of property showCurrentLocation
setCurrentLocation(oCurrentLocation): sap.uxap.BreadCrumbs
Sets the aggregated currentLocation.
Parameters:
sap.m.TextoCurrentLocationThe currentLocation to set
Returns:
sap.uxap.BreadCrumbsReference to this in order to allow method chaining
setShowCurrentLocation(bShowCurrentLocation): sap.uxap.BreadCrumbs

Sets a new value for property showCurrentLocation.

Sets the visibility of the current/last element in the BreadCrumbs path.

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

Default value is true.

Parameters:
booleanbShowCurrentLocationNew value for property showCurrentLocation
Returns:
sap.uxap.BreadCrumbsReference to this in order to allow method chaining