com.sap.ui.commons.client
Class Toolbar

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      com.sap.ui.core.client.Element
          com.sap.ui.core.client.Control
              com.sap.ui.commons.client.Toolbar

public class Toolbar
extends com.sap.ui.core.client.Control

The class Toolbar is the GWT wrapper for the Phoenix control: sap.ui.commons.Toolbar.

A single, horizontal row of immediate, always visible items. In many cases, a toolbar item is a button with an icon. All controls having interface sap.ui.commons.ToolbarItem can be used as item.

• Properties
  • visible : boolean
    Invisible controls are not rendered.
  • width : String
    When there is not enough space for the toolbar to display all items, the rightmost items are overflowing into a drop-down menu.
  • design : com.sap.ui.commons.client.ToolbarDesign
    Design settings are theme-dependent.
  • standalone : boolean
    Alternatively, toolbars can be nested in controls from which they inherit the design.
• Aggregations
  • items : com.sap.ui.commons.client.ToolbarItem
    Aggregating the toolbar items.
• Associations
• Events

Version:

0.18.0-SNAPSHOT

Author:

GENERATOR (JavaScript control: sap.ui.commons.Toolbar)

Constructor Summary

protected

Toolbar() constructs the class Toolbar hidden due to JavaScriptObject restriction

Method Summary

Toolbar	addItem(ToolbarItem item) Appends a item to the aggregation items.
static Toolbar	create() creates a new instance of the class Toolbar
static Toolbar	create(String idOrConfig) creates a new instance of the class Toolbar
static Toolbar	create(String id, String config) creates a new instance of the class Toolbar
Toolbar	destroyItems() Destroys all the items in the Items-aggregation.
ToolbarDesign	getDesign() Getter for property design Design settings are theme-dependent.
com.sap.ui.core.client.js.JsArray<ToolbarItem>	getItems() Getter for aggregation items Aggregating the toolbar items.
String	getWidth() Getter 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.
int	indexOfItem(ToolbarItem item) Checks for the provided com.sap.ui.commons.client.ToolbarItem in the items-aggregation and returns its index if found or -1 otherwise.
Toolbar	insertItem(ToolbarItem item, int index) Inserts some item into the aggregation named items.
boolean	isStandalone() Getter for property standalone Alternatively, toolbars can be nested in controls from which they inherit the design.
boolean	isVisible() Getter for property visible Invisible controls are not rendered.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<ToolbarItem>>	removeAllItems() Removes all the items in the items-aggregation.
com.sap.ui.core.client.js.JsArray<ToolbarItem>	removeItem(int index) Removes a item from the aggregation named items.
Toolbar	setDesign(ToolbarDesign value) Setter for property design Default value is: Flat
Toolbar	setStandalone(boolean value) Setter for property standalone Default value is: true
Toolbar	setVisible(boolean value) Setter for property visible Default value is: true
Toolbar	setWidth(String value) Setter for property width Default value is: auto

Methods inherited from class com.sap.ui.core.client.Control

addStyleClass, hasStyleClass, invalidate, placeAt, placeAt, removeStyleClass, rerender

Methods inherited from class com.sap.ui.core.client.Element

_convertArray, _convertArray, _convertArray, _convertArray, _convertArray, attachBrowserEvent, attachEvent, bindAggregation, bindContext, bindProperty, bindProperty, destroy, detachBrowserEvent, detachEvent, getDomRef, getElementName, getId, getLibraryName, getModel, getParent, getProperty, getTooltip_AsString, getTooltip_Text, getTooltip, isActive, setModel, setProperty, setTooltip, setTooltip, unbindAggregation, unbindContext, unbindProperty

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Toolbar

protected Toolbar()

constructs the class Toolbar
hidden due to JavaScriptObject restriction

Method Detail

create

public static Toolbar create()

creates a new instance of the class Toolbar

create

public static Toolbar create(String idOrConfig)

creates a new instance of the class Toolbar

Parameters:

id - id of the Toolbar or configuration JSON string

create

public static Toolbar create(String id,
                             String config)

creates a new instance of the class Toolbar

Parameters:

id - id of the Toolbar

config - configuration JSON string

isVisible

public final boolean isVisible()

Getter for property visible Invisible controls are not rendered.

Returns:

the value of property visible

setVisible

public final Toolbar setVisible(boolean value)

Setter for property visible
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

getWidth

public final String getWidth()

Getter 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.

Returns:

the value of property width

setWidth

public final Toolbar setWidth(String value)

Setter for property width
Default value is: auto

Parameters:

value - String

Returns:

this to allow method chaining

getDesign

public final ToolbarDesign getDesign()

Getter for property design Design settings are theme-dependent.

Returns:

the value of property design

setDesign

public final Toolbar setDesign(ToolbarDesign value)

Setter for property design
Default value is: Flat

Parameters:

value - com.sap.ui.commons.client.ToolbarDesign

Returns:

this to allow method chaining

isStandalone

public final boolean isStandalone()

Getter for property standalone Alternatively, toolbars can be nested in controls from which they inherit the design.

Returns:

the value of property standalone

setStandalone

public final Toolbar setStandalone(boolean value)

Setter for property standalone
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

getItems

public final com.sap.ui.core.client.js.JsArray<ToolbarItem> getItems()

Getter for aggregation items Aggregating the toolbar items.

Returns:

com.sap.ui.commons.client.ToolbarItem[]

insertItem

public final Toolbar insertItem(ToolbarItem item,
                                int index)

Inserts some item into the aggregation named items.

Parameters:

item - the item to insert

index - int the 0-based index the item should be inserted at.

Returns:

this to allow method chaining

addItem

public final Toolbar addItem(ToolbarItem item)

Appends a item to the aggregation items.

Parameters:

item - com.sap.ui.commons.client.ToolbarItem the item to add

Returns:

this to allow method chaining

removeItem

public final com.sap.ui.core.client.js.JsArray<ToolbarItem> removeItem(int index)

Removes a item from the aggregation named items.

Parameters:

index - int the position of the item to remove.

Returns:

reference to this instance

removeAllItems

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<ToolbarItem>> removeAllItems()

Removes all the items in the items-aggregation.

Returns:

an array of the removed elements (might be empty)

indexOfItem

public final int indexOfItem(ToolbarItem item)

Checks for the provided com.sap.ui.commons.client.ToolbarItem in the items-aggregation and returns its index if found or -1 otherwise.

Parameters:

item - the item whose index is looked for.

Returns:

the index of the provided control in the aggregation.

destroyItems

public final Toolbar destroyItems()

Destroys all the items in the Items-aggregation.

Returns:

this to allow method chaining