namespace sap.ui.rta.service.Action

Control sample: sap.ui.rta.service.Action
Visiblity: restricted
Available since: N/A
Module: sap/ui/rta/service/Action
Application Component: CA-UI5-FL-RTA

Provides necessary functionality to get and execute actions on controls. Actions are UI operations available in key user adaptation such as rename, remove, move etc.


Nodes Overview

Node Description
sap.ui.rta.service.Action.ActionObject

Object containing the detailed information about the action.


Methods Overview

Method Description
sap.ui.rta.service.Action.execute

Returns a list of available actions for the specified control(s).

sap.ui.rta.service.Action.get

Returns a list of available actions for the specified control(s) wrapped in a promise.

Example:

[
    {
        "id": "CTX_RENAME",
        "text": "Rename",
        "enabled": false,
        "rank": 10,
        "icon": "sap-icon://edit"
    },
    {
        "id": "CTX_ADD_ELEMENTS_AS_SIBLING",
        "text": "Add Field",
        "enabled": false,
        "rank": 20,
        "icon": "sap-icon://add",
        "group": "Add"
    },
    {
        "id": "CTX_REMOVE",
        "text": "Remove",
        "enabled": true,
        "rank": 60,
        "icon": "sap-icon://decline"
    },
    {
        "id": "CTX_CUT",
        "text": "Cut",
        "enabled": false,
        "rank": 70,
        "icon": "sap-icon://scissors"
    },
    {
        "id": "CTX_PASTE",
        "text": "Paste",
        "enabled": false,
        "rank": 80,
        "icon": "sap-icon://paste"
    }
]

sap.ui.rta.service.Action.execute

Returns a list of available actions for the specified control(s).

Param Type DefaultValue Description
vControlIds string string[]

Control ID or an array of IDs to get actions for

sActionId string

Action ID to be executed on the specified controls

sap.ui.rta.service.Action.get

Returns a list of available actions for the specified control(s) wrapped in a promise.

Example:

[
    {
        "id": "CTX_RENAME",
        "text": "Rename",
        "enabled": false,
        "rank": 10,
        "icon": "sap-icon://edit"
    },
    {
        "id": "CTX_ADD_ELEMENTS_AS_SIBLING",
        "text": "Add Field",
        "enabled": false,
        "rank": 20,
        "icon": "sap-icon://add",
        "group": "Add"
    },
    {
        "id": "CTX_REMOVE",
        "text": "Remove",
        "enabled": true,
        "rank": 60,
        "icon": "sap-icon://decline"
    },
    {
        "id": "CTX_CUT",
        "text": "Cut",
        "enabled": false,
        "rank": 70,
        "icon": "sap-icon://scissors"
    },
    {
        "id": "CTX_PASTE",
        "text": "Paste",
        "enabled": false,
        "rank": 80,
        "icon": "sap-icon://paste"
    }
]

Param Type DefaultValue Description
vControlIds string string[]

Control ID or an array of IDs to get actions for