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, while the remaining links prior to them are available in a drop-down menu.
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.m.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 |
Name | Type | Default Value | Description |
---|---|---|---|
currentLocationText | string | Determines the text of current/last element in the Breadcrumbs path. |
|
separatorStyle | sap.m.BreadcrumbsSeparatorStyle | Slash | Determines the visual style of the separator between the |
Default Aggregation: links
Name | Cardinality | Type | Description |
---|---|---|---|
_currentLocation | 0..1 | sap.m.Text |
Private aggregations |
_select | 0..1 | sap.m.Select | |
links (default) | 0..n | sap.m.Link |
A list of all the active link elements in the Breadcrumbs control. Note: Enabling the property |
Name | Cardinality | Type | Description |
---|---|---|---|
ariaLabelledBy | 0..n | sap.ui.core.Control |
Association to controls / IDs which label this control (see WAI-ARIA attribute |
Method | Description |
---|---|
addAriaLabelledBy |
Adds some ariaLabelledBy into the association ariaLabelledBy. |
addLink |
Adds some link to the aggregation links. |
destroyLinks |
Destroys all the links in the aggregation links. |
sap.m.Breadcrumbs.extend |
Creates a new subclass of class sap.m.Breadcrumbs with name
|
getAriaLabelledBy |
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy. |
getCurrentLocationText |
Gets current value of property currentLocationText. Determines the text of 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. Note: Enabling the property |
sap.m.Breadcrumbs.getMetadata |
Returns a metadata object for class sap.m.Breadcrumbs. |
getSeparatorStyle |
Gets current value of property separatorStyle. Determines the visual style of the separator between the Default value is |
indexOfLink |
Checks for the provided |
insertLink |
Inserts a link into the aggregation links. |
removeAllAriaLabelledBy |
Removes all the controls in the association named ariaLabelledBy. |
removeAllLinks |
Removes all the controls from the aggregation links. Additionally, it unregisters them from the hosting UIArea. |
removeAriaLabelledBy |
Removes an ariaLabelledBy from the association named ariaLabelledBy. |
removeLink |
Removes a link from the aggregation links. |
setCurrentLocationText |
Sets a new value for property currentLocationText. Determines the text of current/last element in the Breadcrumbs path. When called with a value of |
setSeparatorStyle |
Custom setter for the |
Adds some ariaLabelledBy into the association ariaLabelledBy.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAriaLabelledBy | sap.ui.core.ID sap.ui.core.Control |
The ariaLabelledBy to add; if empty, nothing is inserted |
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.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.
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 |
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
Gets current value of property currentLocationText.
Determines the text of current/last element in the Breadcrumbs path.
Gets content of aggregation links.
A list of all the active link elements in the Breadcrumbs control. Note: Enabling the property wrapping
of the link will not work since it's incompatible with the concept of the control. The other properties will work, but their effect may be undesirable.
Gets current value of property separatorStyle.
Determines the visual style of the separator between the Breadcrumbs
elements.
Default value is Slash
.
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 an ariaLabelledBy from the association named ariaLabelledBy.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAriaLabelledBy | int sap.ui.core.ID sap.ui.core.Control |
The ariaLabelledBy to be removed or its index or ID |
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 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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sCurrentLocationText | string |
New value for property |
Custom setter for the Breadcrumbs
separator style.
Param | Type | DefaultValue | Description |
---|---|---|---|
sSeparatorStyle | sap.m.BreadcrumbsSeparatorStyle |