Class sap.uxap.AnchorBarModule: sap/uxap/AnchorBar

extends Toolbar

Anchor bar is the navigation bar of an Object page. Its purpose is to provide links to all Sections and Subsections. Takes the form of a Select on phone.


Since: 1.26.
Constructor Summary
new sap.uxap.AnchorBar(sId?, mSettings?)Constructor for a new AnchorBar.
Fields borrowed from class sap.m.Toolbar
applyTagAndContextClassFor, getHTMLTag, isContextSensitive, setHTMLTag
Events borrowed from class sap.m.Toolbar
press
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.AnchorBar.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.uxap.AnchorBar with name sClassName and enriches it with the information contained in oClassInfo.
sap.uxap.AnchorBar.getMetadata()Returns a metadata object for class sap.uxap.AnchorBar.
getScrollDelegate()Returns a sap.ui.core.delegate.ScrollEnablement object used to handle scrolling.
getSelectedButton()ID of the element which is the current target of the association selectedButton, or null.
getShowPopover()Gets current value of property showPopover.
getUpperCase()Gets current value of property upperCase.
scrollToSection(sId, duration)Scroll to a specific Section.
setSelectedButton(oSelectedButton)Sets the associated selectedButton.
setShowPopover(bShowPopover)Sets a new value for property showPopover.
setUpperCase(bUpperCase)Sets a new value for property upperCase.
Methods borrowed from class sap.m.Toolbar
addAriaLabelledBy, addContent, attachPress, destroyContent, detachPress, firePress, getActive, getActiveDesign, getAriaLabelledBy, getContent, getDesign, getEnabled, getHeight, getTitleId, getWidth, indexOfContent, insertContent, removeAllAriaLabelledBy, removeAllContent, removeAriaLabelledBy, removeContent, setActive, setDesign, setEnabled, setHeight, setWidth
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, 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, 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.AnchorBar(sId?, mSettings?)
Constructor for a new AnchorBar.

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.m.Toolbar 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.AnchorBar.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.uxap.AnchorBar with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.Toolbar.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.AnchorBar.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.uxap.AnchorBar.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getScrollDelegate(): object
Returns a sap.ui.core.delegate.ScrollEnablement object used to handle scrolling.
Returns:
{object}
getSelectedButton(): sap.m.Button
ID of the element which is the current target of the association selectedButton, or null.
Returns:
{sap.m.Button}
getShowPopover(): boolean
Gets current value of property showPopover.

Determines whether to show a Popover with Subsection links when clicking on Section links in the Anchor bar.

Default value is true.

Returns:
{boolean} Value of property showPopover
getUpperCase(): boolean
Gets current value of property upperCase.

Determines whether the Anchor bar items are displayed in upper case.

Default value is false.

Returns:
{boolean} Value of property upperCase
scrollToSection(sId, duration)
Scroll to a specific Section.
Parameters:
{string}sId The Section ID to scroll to
{int}duration Scroll duration (in ms). Default value is 0
setSelectedButton(oSelectedButton): sap.uxap.AnchorBar
Sets the associated selectedButton.
Parameters:
{sap.m.Button}oSelectedButton Id of an element which becomes the new target of this selectedButton association; alternatively, an element instance may be given
Returns:
{sap.uxap.AnchorBar} Reference to this in order to allow method chaining
setShowPopover(bShowPopover): sap.uxap.AnchorBar
Sets a new value for property showPopover.

Determines whether to show a Popover with Subsection links when clicking on Section links in the Anchor bar.

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

Default value is true.

Parameters:
{boolean}bShowPopover New value for property showPopover
Returns:
{sap.uxap.AnchorBar} Reference to this in order to allow method chaining
setUpperCase(bUpperCase): sap.uxap.AnchorBar
Sets a new value for property upperCase.

Determines whether the Anchor bar items are displayed in upper case.

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

Default value is false.

Parameters:
{boolean}bUpperCase New value for property upperCase
Returns:
{sap.uxap.AnchorBar} Reference to this in order to allow method chaining