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.
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#constructor for a general description of the syntax of the settings object.
new sap.ui.table.RowAction(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 |
Default Aggregation: items
Name | Cardinality | Type | Description |
---|---|---|---|
_icons | 0..n | sap.ui.core.Icon | |
_menu | 0..1 | sap.ui.unified.Menu | |
items (default) | 0..n | sap.ui.table.RowActionItem |
The action items which should be displayed. |
Method | Description |
---|---|
addItem |
Adds some item to the aggregation items. |
destroyItems |
Destroys all the items in the aggregation items. |
sap.ui.table.RowAction.extend |
Creates a new subclass of class sap.ui.table.RowAction with name
|
getItems |
Gets content of aggregation items. The action items which should be displayed. |
sap.ui.table.RowAction.getMetadata |
Returns a metadata object for class sap.ui.table.RowAction. |
getVisible |
Gets current value of property visible. Whether the control should be visible on the screen. If set to Default value is |
indexOfItem |
Checks for the provided |
insertItem |
Inserts a item into the aggregation items. |
removeAllItems |
Removes all the controls from the aggregation items. Additionally, it unregisters them from the hosting UIArea. |
removeItem |
Removes a item from the aggregation items. |
setVisible |
Sets a new value for property visible. Whether the control should be visible on the screen. If set to When called with a value of Default value is |
Adds some item to the aggregation items.
Param | Type | DefaultValue | Description |
---|---|---|---|
oItem | sap.ui.table.RowActionItem |
The item to add; if empty, nothing is inserted |
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.
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 |
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
.
Checks for the provided sap.ui.table.RowActionItem
in the aggregation items. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oItem | sap.ui.table.RowActionItem |
The item whose index is looked for |
Inserts a item into the aggregation items.
Param | Type | DefaultValue | Description |
---|---|---|---|
oItem | sap.ui.table.RowActionItem |
The item to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation items.
Additionally, it unregisters them from the hosting UIArea.
Removes a item from the aggregation items.
Param | Type | DefaultValue | Description |
---|---|---|---|
vItem | int string sap.ui.table.RowActionItem |
The item to remove or its index or id |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bVisible | boolean | true |
New value for property |