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
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
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.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, 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, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
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, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
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:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? 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:
{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
sap.uxap.BreadCrumbs.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.uxap.BreadCrumbs.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addLink(oLink): sap.uxap.BreadCrumbs
Adds some link to the aggregation links.
Parameters:
{sap.m.Link}oLink the link to add; if empty, nothing is inserted
Returns:
{sap.uxap.BreadCrumbs} Reference to this in order to allow method chaining
destroyCurrentLocation(): sap.uxap.BreadCrumbs
Destroys the currentLocation in the aggregation currentLocation.
Returns:
{sap.uxap.BreadCrumbs} Reference to this in order to allow method chaining
destroyLinks(): sap.uxap.BreadCrumbs
Destroys all the links in the aggregation links.
Returns:
{sap.uxap.BreadCrumbs} Reference 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}
getLinks(): sap.m.Link[]
Gets content of aggregation links.

A list of all the active link elements in the BreadCrumbs control.

Returns:
{sap.m.Link[]}
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:
{boolean} Value of property showCurrentLocation
indexOfLink(oLink): int
Checks for the provided sap.m.Link in the aggregation links. and returns its index if found or -1 otherwise.
Parameters:
{sap.m.Link}oLink The link whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertLink(oLink, iIndex): sap.uxap.BreadCrumbs
Inserts a link into the aggregation links.
Parameters:
{sap.m.Link}oLink the link to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the link should be inserted at; for a negative value of iIndex, the link is inserted at position 0; for a value greater than the current size of the aggregation, the link is inserted at the last position
Returns:
{sap.uxap.BreadCrumbs} Reference to this in order to allow method chaining
removeAllLinks(): sap.m.Link[]
Removes all the controls from the aggregation links.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.m.Link[]} An array of the removed elements (might be empty)
removeLink(vLink): sap.m.Link
Removes a link from the aggregation links.
Parameters:
{int|string|sap.m.Link}vLink The linkto remove or its index or id
Returns:
{sap.m.Link} The removed link or null
setCurrentLocation(oCurrentLocation): sap.uxap.BreadCrumbs
Sets the aggregated currentLocation.
Parameters:
{sap.m.Text}oCurrentLocation The currentLocation to set
Returns:
{sap.uxap.BreadCrumbs} Reference 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:
{boolean}bShowCurrentLocation New value for property showCurrentLocation
Returns:
{sap.uxap.BreadCrumbs} Reference to this in order to allow method chaining