Class sap.ui.table.RowActionModule: sap/ui/table/RowAction

extends Control

The RowAction control allows to display multiple action items which can be selected by the user. If more action items are available as the available space allows to display an overflow mechanism is provided. This control must only be used in the context of the sap.ui.table.Table control to define row actions.
Since: 1.45.0.
Constructor Summary
new sap.ui.table.RowAction(sId?, mSettings?)Constructor for a new RowAction.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.table.RowAction.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.table.RowAction with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.table.RowAction.getMetadata()Returns a metadata object for class sap.ui.table.RowAction.
addItem(oItem)Adds some item to the aggregation items.
destroyItems()Destroys all the items in the aggregation items.
getItems()Gets content of aggregation items.
getVisible()Gets current value of property visible.
indexOfItem(oItem)Checks for the provided sap.ui.table.RowActionItem in the aggregation items.
insertItem(oItem, iIndex)Inserts a item into the aggregation items.
removeAllItems()Removes all the controls from the aggregation items.
removeItem(vItem)Removes a item from the aggregation items.
setVisible(bVisible)Sets a new value for property visible.
Constructor Detail
new sap.ui.table.RowAction(sId?, mSettings?)

Constructor for a new RowAction.

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

  • Aggregations

    • items : sap.ui.table.RowActionItem[] (default)

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
stringsId?ID for the new control, generated automatically if no ID is given
objectmSettings?Initial settings for the new control
Method Detail
sap.ui.table.RowAction.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.table.RowAction 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:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.ui.table.RowAction.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.table.RowAction.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addItem(oItem): sap.ui.table.RowAction
Adds some item to the aggregation items.
Parameters:
sap.ui.table.RowActionItemoItemthe item to add; if empty, nothing is inserted
Returns:
sap.ui.table.RowActionReference to this in order to allow method chaining
destroyItems(): sap.ui.table.RowAction
Destroys all the items in the aggregation items.
Returns:
sap.ui.table.RowActionReference to this in order to allow method chaining

Gets content of aggregation items.

The action items which should be displayed.

Returns:
sap.ui.table.RowActionItem[]
getVisible(): boolean

Gets current value of property visible.

Whether the control should be visible on the screen. If set to false, the control is hidden.

Default value is true.

Returns:
booleanValue of property visible
indexOfItem(oItem): int
Checks for the provided sap.ui.table.RowActionItem in the aggregation items. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.table.RowActionItemoItemThe item whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertItem(oItem, iIndex): sap.ui.table.RowAction
Inserts a item into the aggregation items.
Parameters:
sap.ui.table.RowActionItemoItemthe item to insert; if empty, nothing is inserted
intiIndexthe 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.table.RowActionReference to this in order to allow method chaining
removeAllItems(): sap.ui.table.RowActionItem[]

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.table.RowActionItem[]An array of the removed elements (might be empty)
removeItem(vItem): sap.ui.table.RowActionItem
Removes a item from the aggregation items.
Parameters:
int|string|sap.ui.table.RowActionItemvItemThe item to remove or its index or id
Returns:
sap.ui.table.RowActionItemThe removed item or null
setVisible(bVisible): sap.ui.table.RowAction

Sets a new value for property visible.

Whether the control should be visible on the screen. If set to false, the control is hidden.

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

Default value is true.

Parameters:
booleanbVisibleNew value for property visible
Returns:
sap.ui.table.RowActionReference to this in order to allow method chaining