Represents the navigation steps up to the current location in the app.
The BreadCrumbs
control allows the users to quickly navigate to a previous location on the path that got them to the current location by choosing the displayed navigation steps.
It has two main modes of operation:
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#constructor for a general description of the syntax of the settings object.
new sap.uxap.BreadCrumbs(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | ID for the new control, generated automatically if no ID is given |
|
mSettings? | object | Initial settings for the new control |
Default Aggregation: links
Name | Cardinality | Type | Description |
---|---|---|---|
_overflowSelect | 0..1 | sap.m.Select |
A select control which is used to display the BreadCrumbs content on smaller mobile devices or when there's not enough space for the control to fit on one line. |
_tubeIcon | 0..1 | sap.ui.core.Icon |
An icon that is used as a separator after each link in the standard mode. |
currentLocation | 0..1 | sap.m.Text |
The current/last element in the BreadCrumbs path. |
links (default) | 0..n | sap.m.Link |
A list of all the active link elements in the BreadCrumbs control. |
Method | Description |
---|---|
addLink |
Adds some link to the aggregation links. |
destroyCurrentLocation |
Destroys the currentLocation in the aggregation currentLocation. |
destroyLinks |
Destroys all the links in the aggregation links. |
sap.uxap.BreadCrumbs.extend |
Creates a new subclass of class sap.uxap.BreadCrumbs with name
|
getCurrentLocation |
Gets content of aggregation currentLocation. The current/last element in the BreadCrumbs path. |
getLinks |
Gets content of aggregation links. A list of all the active link elements in the BreadCrumbs control. |
sap.uxap.BreadCrumbs.getMetadata |
Returns a metadata object for class sap.uxap.BreadCrumbs. |
getShowCurrentLocation |
Gets current value of property showCurrentLocation. Sets the visibility of the current/last element in the BreadCrumbs path. Default value is |
indexOfLink |
Checks for the provided |
insertLink |
Inserts a link into the aggregation links. |
removeAllLinks |
Removes all the controls from the aggregation links. Additionally, it unregisters them from the hosting UIArea. |
removeLink |
Removes a link from the aggregation links. |
setCurrentLocation |
Sets the aggregated currentLocation. |
setShowCurrentLocation |
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 Default value is |
Adds some link to the aggregation links.
Param | Type | DefaultValue | Description |
---|---|---|---|
oLink | sap.m.Link |
The link to add; if empty, nothing is inserted |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
Gets content of aggregation currentLocation.
The current/last element in the BreadCrumbs path.
Gets content of aggregation links.
A list of all the active link elements in the BreadCrumbs control.
Gets current value of property showCurrentLocation.
Sets the visibility of the current/last element in the BreadCrumbs path.
Default value is true
.
Checks for the provided sap.m.Link
in the aggregation links. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oLink | sap.m.Link |
The link whose index is looked for |
Inserts a link into the aggregation links.
Param | Type | DefaultValue | Description |
---|---|---|---|
oLink | sap.m.Link |
The link to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation links.
Additionally, it unregisters them from the hosting UIArea.
Removes a link from the aggregation links.
Param | Type | DefaultValue | Description |
---|---|---|---|
vLink | int string sap.m.Link |
The link to remove or its index or id |
Sets the aggregated currentLocation.
Param | Type | DefaultValue | Description |
---|---|---|---|
oCurrentLocation | sap.m.Text |
The currentLocation to set |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bShowCurrentLocation | boolean | true |
New value for property |