Show TOC

Actions in the List ATSLocate this document in the navigation structure

An action in this sense is a UI element, such as a button, a link to action, or an input field, that is capable of raising an FPM event. There are several places in a List ATS component where you can set actions.

You can set actions in the following places in the List ATS UIBB:
  • Toolbar
  • Inside cells
  • Inside the Action column (known as 'one-click actions')
Actions in the Toolbar

Actions must first be defined in the feeder class using the method GET_DEFINITION, parameter ET_ACTION_DEFINITION. Additionally, actions must be added to the Toolbar Schema panel in the FPM configuration editor, FLUID, to ensure that they appear at runtime.

At runtime, the actions will raise the FPM Event ID that has been specified using the attribute ID in parameter ET_ACTION_DEFINITION.

It is possible to render the action in the toolbar of the OVP assignment block in which the list is embedded, instead of in the toolbar of the List ATS UIBB. To do this, set the flag Exposable of parameter ET_ACTION_DEFINITION to TRUE.

You can change properties such as Visibility, or Enabled of the toolbar elements in the feeder class method GET_DATA using parameter CT_ACTION_USAGE.

You can assign a particular action (corresponding to one entry in ET_ACTION_DEFINITION) to more than one UI element in the toolbar. However, when doing so, be aware of the following restriction: In feeder class method GET_DATA it is possible to change properties of the UI elements in the toolbar using parameter CT_ACTION_USAGE. For actions that have been used more than once, it is only possible to change the Visibility and Enable/Disable properties.

Actions inside Cells

In the FPM configuration editor, you can set several Display Types (Input Field, Button, Checkbox, and Link to Action) to raise an event.

The standard behavior of all cell actions is to raise the same event, IF_FPM_GUIBB_LIST=>GC_GUIBB_LIST_ON_CELL_ACTION. Using the event parameter IF_FPM_GUIBB_LIST=>GC_EVENT_PAR_COLUMN_NAME, you can determine which cell has raised which action. However, you can change the standard behavior in the FPM configuration editor. In addition to the standard behavior, there is the possibility to un-assign an action (no action at all), or to assign a specific action (in which case the action must be specified by the feeder class in method GET_DEFINITION, parameter ET_ACTION_DEFINITION).

One-Click Actions

One-click actions are actions that are specific to a certain table row, and are executed with a single mouse-click, such as deleting a row, editing a row, or setting the status of a row. One-click actions have the display type Link to Action, and are rendered in one single column known as the action column. In accordance with current UI guidelines, there is only one action column, and it is the first column in the table.

To use one-click actions, complete the following steps:
  1. Define actions in the feeder class method GET_DEFINITION, parameter ET_ROW_ACTIONS.
    Note There must be a minimum of 2 entries in parameter ET_ROW_ACTIONS.
  2. Edit the configuration in the FPM configuration editor, FLUID. If the feeder class has defined one-click actions, the Repositories panel displays a special column, FPM_ROW_ACTIONS_COLUMN; you can drag this in to the List UIBB Schema panel.
  3. To add one-click actions to the action column, select the action column in the List UIBB Schema, and then add single actions using the Attributes panel.
At runtime, it is possible to disable, or hide, single one-click actions per row. To do this, you must define a new technical column of type BOOLEAN in the feeder class that controls the enablement or visibility of the one-click action. To do this, add the column in feeder class method GET_DEFINITION, parameter EO_FIELD_CATALOG, and mark it is as Technical using parameter ET_FIELD_DESCRIPTION, and attribute TECHNICAL_FIELD. The ID of that column must be put into the one-click action definition (method GET_DEFINITION, parameter ET_ROW_ACTIONS, attribute VISIBLE_REF, or ENABLED_REF). Fill the content of the technical column according to your requirements in method GET_DATA.
Note One-click actions are also available in the previous List component (FPM_LIST_UIBB).