Class sap.m.BreadcrumbsModule: sap/m/Breadcrumbs

extends Control

Enables users to navigate between items by providing a list of links to previous steps in the user's navigation path. The last three steps can be accessed as links directly The remaining links prior to them are available in a drop-down menu.
Since: 1.34.
Constructor Summary
new sap.m.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.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.m.Breadcrumbs.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.Breadcrumbs with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.Breadcrumbs.getMetadata()Returns a metadata object for class sap.m.Breadcrumbs.
addLink(oLink)Adds some link to the aggregation links.
destroyLinks()Destroys all the links in the aggregation links.
getCurrentLocationText()Gets current value of property currentLocationText.
getLinks()Gets content of aggregation links.
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.
setCurrentLocationText(sCurrentLocationText)Sets a new value for property currentLocationText.
Constructor Detail
new sap.m.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.m.Breadcrumbs.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.m.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.m.Breadcrumbs.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.Breadcrumbs.
Returns:
sap.ui.base.MetadataMetadata object describing this class
getCurrentLocationText(): string

Gets current value of property currentLocationText.

Determines the text of current/last element in the Breadcrumbs path.

Returns:
stringValue of property currentLocationText
Since:
1.34
setCurrentLocationText(sCurrentLocationText): sap.m.Breadcrumbs

Sets a new value for property currentLocationText.

Determines the text of 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.

Parameters:
stringsCurrentLocationTextNew value for property currentLocationText
Returns:
sap.m.BreadcrumbsReference to this in order to allow method chaining
Since:
1.34