Class sap.ui.commons.ToolbarModule: sap/ui/commons/Toolbar

extends Control
implements Toolbar

A horizontal row of items where in many cases the single toolbar items are buttons containing icons. Note that all controls with the sap.ui.commons.ToolbarItem interface can be used as item: Button, ComboBox, TextField.

Deprecated API:Since version 1.38. Instead, use the sap.m.Toolbar control.

Constructor Summary
new sap.ui.commons.Toolbar(sId?, mSettings?)Constructor for a new Toolbar.
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.ui.commons.Toolbar.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.Toolbar with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.commons.Toolbar.getMetadata()Returns a metadata object for class sap.ui.commons.Toolbar.
addItem(oItem)Adds some item to the aggregation items.
addRightItem(oRightItem)Adds some rightItem to the aggregation rightItems.
destroyItems()Destroys all the items in the aggregation items.
destroyRightItems()Destroys all the rightItems in the aggregation rightItems.
getDesign()Gets current value of property design.
getItems()Gets content of aggregation items.
getRightItems()Gets content of aggregation rightItems.
getStandalone()Gets current value of property standalone.
getWidth()Gets current value of property width.
indexOfItem(oItem)Checks for the provided sap.ui.commons.ToolbarItem in the aggregation items.
indexOfRightItem(oRightItem)Checks for the provided sap.ui.commons.ToolbarItem in the aggregation rightItems.
insertItem(oItem, iIndex)Inserts a item into the aggregation items.
insertRightItem(oRightItem, iIndex)Inserts a rightItem into the aggregation rightItems.
removeAllItems()Removes all the controls from the aggregation items.
removeAllRightItems()Removes all the controls from the aggregation rightItems.
removeItem(vItem)Removes a item from the aggregation items.
removeRightItem(vRightItem)Removes a rightItem from the aggregation rightItems.
setDesign(sDesign)Sets a new value for property design.
setStandalone(bStandalone)Sets a new value for property standalone.
setWidth(sWidth)Sets a new value for property width.
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, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, 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.ui.commons.Toolbar(sId?, mSettings?)
Constructor for a new Toolbar.

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:

  • Properties
    • width : sap.ui.core.CSSSize (default: auto)
    • design : sap.ui.commons.ToolbarDesign (default: Flat)
    • standalone : boolean (default: true)
  • Aggregations
    • items : sap.ui.commons.ToolbarItem[] (default)
    • rightItems : sap.ui.commons.ToolbarItem[]

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
Deprecated:
Since version 1.38. Instead, use the sap.m.Toolbar control.
Method Detail
sap.ui.commons.Toolbar.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.commons.Toolbar 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.ui.commons.Toolbar.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.Toolbar.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addItem(oItem): sap.ui.commons.Toolbar
Adds some item to the aggregation items.
Parameters:
{sap.ui.commons.ToolbarItem}oItem the item to add; if empty, nothing is inserted
Returns:
{sap.ui.commons.Toolbar} Reference to this in order to allow method chaining
addRightItem(oRightItem): sap.ui.commons.Toolbar
Adds some rightItem to the aggregation rightItems.
Parameters:
{sap.ui.commons.ToolbarItem}oRightItem the rightItem to add; if empty, nothing is inserted
Returns:
{sap.ui.commons.Toolbar} Reference to this in order to allow method chaining
destroyItems(): sap.ui.commons.Toolbar
Destroys all the items in the aggregation items.
Returns:
{sap.ui.commons.Toolbar} Reference to this in order to allow method chaining
destroyRightItems(): sap.ui.commons.Toolbar
Destroys all the rightItems in the aggregation rightItems.
Returns:
{sap.ui.commons.Toolbar} Reference to this in order to allow method chaining
getDesign(): sap.ui.commons.ToolbarDesign
Gets current value of property design.

Design settings are theme-dependent.

Default value is Flat.

Returns:
{sap.ui.commons.ToolbarDesign} Value of property design
getItems(): sap.ui.commons.ToolbarItem[]
Gets content of aggregation items.

Aggregating the tool bar items.

Returns:
{sap.ui.commons.ToolbarItem[]}
getRightItems(): sap.ui.commons.ToolbarItem[]
Gets content of aggregation rightItems.

Aggregating the right side tool bar items.

Returns:
{sap.ui.commons.ToolbarItem[]}
getStandalone(): boolean
Gets current value of property standalone.

Per default, tool bars have the stand alone status. Alternatively, they can be nested in other controls and then inherit the design from their parent control.

Default value is true.

Returns:
{boolean} Value of property standalone
getWidth(): sap.ui.core.CSSSize
Gets current value of property width.

When there is not enough space for the toolbar to display all items, the rightmost items are overflowing into a drop-down menu.

Default value is auto.

Returns:
{sap.ui.core.CSSSize} Value of property width
indexOfItem(oItem): int
Checks for the provided sap.ui.commons.ToolbarItem in the aggregation items. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.commons.ToolbarItem}oItem The item whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
indexOfRightItem(oRightItem): int
Checks for the provided sap.ui.commons.ToolbarItem in the aggregation rightItems. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.commons.ToolbarItem}oRightItem The rightItem whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertItem(oItem, iIndex): sap.ui.commons.Toolbar
Inserts a item into the aggregation items.
Parameters:
{sap.ui.commons.ToolbarItem}oItem the item to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the item should be inserted at; for a negative value of iIndex, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
Returns:
{sap.ui.commons.Toolbar} Reference to this in order to allow method chaining
insertRightItem(oRightItem, iIndex): sap.ui.commons.Toolbar
Inserts a rightItem into the aggregation rightItems.
Parameters:
{sap.ui.commons.ToolbarItem}oRightItem the rightItem to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the rightItem should be inserted at; for a negative value of iIndex, the rightItem is inserted at position 0; for a value greater than the current size of the aggregation, the rightItem is inserted at the last position
Returns:
{sap.ui.commons.Toolbar} Reference to this in order to allow method chaining
removeAllItems(): sap.ui.commons.ToolbarItem[]
Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.commons.ToolbarItem[]} An array of the removed elements (might be empty)
removeAllRightItems(): sap.ui.commons.ToolbarItem[]
Removes all the controls from the aggregation rightItems.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.commons.ToolbarItem[]} An array of the removed elements (might be empty)
removeItem(vItem): sap.ui.commons.ToolbarItem
Removes a item from the aggregation items.
Parameters:
{int|string|sap.ui.commons.ToolbarItem}vItem The itemto remove or its index or id
Returns:
{sap.ui.commons.ToolbarItem} The removed item or null
removeRightItem(vRightItem): sap.ui.commons.ToolbarItem
Removes a rightItem from the aggregation rightItems.
Parameters:
{int|string|sap.ui.commons.ToolbarItem}vRightItem The rightItemto remove or its index or id
Returns:
{sap.ui.commons.ToolbarItem} The removed rightItem or null
setDesign(sDesign): sap.ui.commons.Toolbar
Sets a new value for property design.

Design settings are theme-dependent.

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

Default value is Flat.

Parameters:
{sap.ui.commons.ToolbarDesign}sDesign New value for property design
Returns:
{sap.ui.commons.Toolbar} Reference to this in order to allow method chaining
setStandalone(bStandalone): sap.ui.commons.Toolbar
Sets a new value for property standalone.

Per default, tool bars have the stand alone status. Alternatively, they can be nested in other controls and then inherit the design from their parent control.

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

Default value is true.

Parameters:
{boolean}bStandalone New value for property standalone
Returns:
{sap.ui.commons.Toolbar} Reference to this in order to allow method chaining
setWidth(sWidth): sap.ui.commons.Toolbar
Sets a new value for property width.

When there is not enough space for the toolbar to display all items, the rightmost items are overflowing into a drop-down menu.

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

Default value is auto.

Parameters:
{sap.ui.core.CSSSize}sWidth New value for property width
Returns:
{sap.ui.commons.Toolbar} Reference to this in order to allow method chaining