namespace sap.ui.mdc.actiontoolbar

Control sample: sap.ui.mdc.actiontoolbar
Visiblity:
Available since: N/A
Module:
Application Component: CA-UI5-MDC

Nodes Overview

Node Description
sap.ui.mdc.actiontoolbar.ActionToolbarAction

The action for an ActionToolbar) control


Methods Overview

Method Description
onToolbar(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


Properties

Name Type Default Value Description
useAsHeader boolean true

Determines whether the toolbar is used as header (e.g. for a table).

Visibility: public

Aggregations

Default Aggregation: actions

Name Cardinality Type Description
actions (default) 0..n sap.ui.mdc.actiontoolbar.ActionToolbarAction

Further actions in the toolbar.

begin 0..n sap.ui.core.Control

Content shown at the begin of the toolbar (e.g. Title).

between 0..n sap.ui.core.Control

Content shown between the title and actions on the toolbar.

end 0..n sap.ui.core.Control

Content at the end of the toolbar.


Methods Overview

Method Description
addAction

Adds some action to the aggregation actions.

addBegin

Adds some begin to the aggregation begin.

addBetween

Adds some between to the aggregation between.

addEnd

Adds some end to the aggregation end.

destroyActions

Destroys all the actions in the aggregation actions.

destroyBegin

Destroys all the begin in the aggregation begin.

destroyBetween

Destroys all the between in the aggregation between.

destroyEnd

Destroys all the end in the aggregation end.

sap.ui.mdc.ActionToolbar.extend

Creates a new subclass of class sap.ui.mdc.ActionToolbar 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.OverflowToolbar.extend.

getActions

Gets content of aggregation actions.

Further actions in the toolbar.

getBegin

Gets content of aggregation begin.

Content shown at the begin of the toolbar (e.g. Title).

getBetween

Gets content of aggregation between.

Content shown between the title and actions on the toolbar.

getEnd

Gets content of aggregation end.

Content at the end of the toolbar.

sap.ui.mdc.ActionToolbar.getMetadata

Returns a metadata object for class sap.ui.mdc.ActionToolbar.

getUseAsHeader

Gets current value of property useAsHeader.

Determines whether the toolbar is used as header (e.g. for a table).

Default value is true.

indexOfAction

Checks for the provided sap.ui.mdc.actiontoolbar.ActionToolbarAction in the aggregation actions. and returns its index if found or -1 otherwise.

indexOfBegin

Checks for the provided sap.ui.core.Control in the aggregation begin. and returns its index if found or -1 otherwise.

indexOfBetween

Checks for the provided sap.ui.core.Control in the aggregation between. and returns its index if found or -1 otherwise.

indexOfEnd

Checks for the provided sap.ui.core.Control in the aggregation end. and returns its index if found or -1 otherwise.

insertAction

Inserts a action into the aggregation actions.

insertBegin

Inserts a begin into the aggregation begin.

insertBetween

Inserts a between into the aggregation between.

insertEnd

Inserts a end into the aggregation end.

removeAction

Removes a action from the aggregation actions.

removeAllActions

Removes all the controls from the aggregation actions.

Additionally, it unregisters them from the hosting UIArea.

removeAllBegin

Removes all the controls from the aggregation begin.

Additionally, it unregisters them from the hosting UIArea.

removeAllBetween

Removes all the controls from the aggregation between.

Additionally, it unregisters them from the hosting UIArea.

removeAllEnd

Removes all the controls from the aggregation end.

Additionally, it unregisters them from the hosting UIArea.

removeBegin

Removes a begin from the aggregation begin.

removeBetween

Removes a between from the aggregation between.

removeEnd

Removes a end from the aggregation end.

setUseAsHeader

Sets a new value for property useAsHeader.

Determines whether the toolbar is used as header (e.g. for a table).

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

Default value is true.

addAction

Adds some action to the aggregation actions.

Param Type DefaultValue Description
oAction sap.ui.mdc.actiontoolbar.ActionToolbarAction

The action to add; if empty, nothing is inserted

addBegin

Adds some begin to the aggregation begin.

Param Type DefaultValue Description
oBegin sap.ui.core.Control

The begin to add; if empty, nothing is inserted

addBetween

Adds some between to the aggregation between.

Param Type DefaultValue Description
oBetween sap.ui.core.Control

The between to add; if empty, nothing is inserted

addEnd

Adds some end to the aggregation end.

Param Type DefaultValue Description
oEnd sap.ui.core.Control

The end to add; if empty, nothing is inserted

destroyActions

Destroys all the actions in the aggregation actions.

destroyBegin

Destroys all the begin in the aggregation begin.

destroyBetween

Destroys all the between in the aggregation between.

destroyEnd

Destroys all the end in the aggregation end.

sap.ui.mdc.ActionToolbar.extend

Creates a new subclass of class sap.ui.mdc.ActionToolbar 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.OverflowToolbar.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

getActions

Gets content of aggregation actions.

Further actions in the toolbar.

getBegin

Gets content of aggregation begin.

Content shown at the begin of the toolbar (e.g. Title).

getBetween

Gets content of aggregation between.

Content shown between the title and actions on the toolbar.

getEnd

Gets content of aggregation end.

Content at the end of the toolbar.

sap.ui.mdc.ActionToolbar.getMetadata

Returns a metadata object for class sap.ui.mdc.ActionToolbar.

getUseAsHeader

Gets current value of property useAsHeader.

Determines whether the toolbar is used as header (e.g. for a table).

Default value is true.

indexOfAction

Checks for the provided sap.ui.mdc.actiontoolbar.ActionToolbarAction in the aggregation actions. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oAction sap.ui.mdc.actiontoolbar.ActionToolbarAction

The action whose index is looked for

indexOfBegin

Checks for the provided sap.ui.core.Control in the aggregation begin. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oBegin sap.ui.core.Control

The begin whose index is looked for

indexOfBetween

Checks for the provided sap.ui.core.Control in the aggregation between. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oBetween sap.ui.core.Control

The between whose index is looked for

indexOfEnd

Checks for the provided sap.ui.core.Control in the aggregation end. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oEnd sap.ui.core.Control

The end whose index is looked for

insertAction

Inserts a action into the aggregation actions.

Param Type DefaultValue Description
oAction sap.ui.mdc.actiontoolbar.ActionToolbarAction

The action to insert; if empty, nothing is inserted

iIndex int

The 0-based index the action should be inserted at; for a negative value of iIndex, the action is inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted at the last position

insertBegin

Inserts a begin into the aggregation begin.

Param Type DefaultValue Description
oBegin sap.ui.core.Control

The begin to insert; if empty, nothing is inserted

iIndex int

The 0-based index the begin should be inserted at; for a negative value of iIndex, the begin is inserted at position 0; for a value greater than the current size of the aggregation, the begin is inserted at the last position

insertBetween

Inserts a between into the aggregation between.

Param Type DefaultValue Description
oBetween sap.ui.core.Control

The between to insert; if empty, nothing is inserted

iIndex int

The 0-based index the between should be inserted at; for a negative value of iIndex, the between is inserted at position 0; for a value greater than the current size of the aggregation, the between is inserted at the last position

insertEnd

Inserts a end into the aggregation end.

Param Type DefaultValue Description
oEnd sap.ui.core.Control

The end to insert; if empty, nothing is inserted

iIndex int

The 0-based index the end should be inserted at; for a negative value of iIndex, the end is inserted at position 0; for a value greater than the current size of the aggregation, the end is inserted at the last position

removeAction

Removes a action from the aggregation actions.

Param Type DefaultValue Description
vAction int string sap.ui.mdc.actiontoolbar.ActionToolbarAction

The action to remove or its index or id

removeAllActions

Removes all the controls from the aggregation actions.

Additionally, it unregisters them from the hosting UIArea.

removeAllBegin

Removes all the controls from the aggregation begin.

Additionally, it unregisters them from the hosting UIArea.

removeAllBetween

Removes all the controls from the aggregation between.

Additionally, it unregisters them from the hosting UIArea.

removeAllEnd

Removes all the controls from the aggregation end.

Additionally, it unregisters them from the hosting UIArea.

removeBegin

Removes a begin from the aggregation begin.

Param Type DefaultValue Description
vBegin int string sap.ui.core.Control

The begin to remove or its index or id

removeBetween

Removes a between from the aggregation between.

Param Type DefaultValue Description
vBetween int string sap.ui.core.Control

The between to remove or its index or id

removeEnd

Removes a end from the aggregation end.

Param Type DefaultValue Description
vEnd int string sap.ui.core.Control

The end to remove or its index or id

setUseAsHeader

Sets a new value for property useAsHeader.

Determines whether the toolbar is used as header (e.g. for a table).

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

Default value is true.

Param Type DefaultValue Description
bUseAsHeader boolean true

New value for property useAsHeader