List of predefined actions

Important:

The predefined actions described in these tables are created depending on the usage context described in the Context descriptions notes.

Automatic actions (implicitly created)

Automatic actions are implicitly created by dialogs, and may be overwritten by ON ACTION handlers.

Table 1. Automatic actions
Name Description Context
accept Validates the current interactive instruction (1)
cancel Cancels the current interactive instruction (1)
close Triggers a cancel key in the current interactive instruction (by default) (7)
insert Inserts a new row before current row (2)
append Appends a new row at the end of the list (2)
delete Deletes the current row (2)
find Opens the fglfind dialog window to let the user enter a search value, and seeks to the row matching the value (4)
findnext Seeks the next row matching the value entered during the fglfind dialog (4)
nextrow Moves to the next row (4)
prevrow Moves to the previous row (4)
firstrow Moves to the first row (4)
lastrow Moves to the last row (4)
help Shows the help topic defined by the HELP clause (1)
editcopy Copy selected rows (or current row if MRS is off) to the clipboard (8)
expandall A tree node is completly expanded (8)
collapseall A tree node is completly collapsed (8)

Particular actions (ON ACTION is not required)

Particular actions do not need an ON ACTION handler. They are automatically enabled depending on the context, and produce a specific event in the AUI protocol.

Table 2. Particular actions
Name Description Context
interrupt Sends an interruption request to the program when processing. For more details, see User interruption handling. (5)

Special actions (ON ACTION is required)

Special actions have a specific behavior and need an ON ACTION handler to be activated.

Table 3. Special actions
Name Description Context
browser_back Sent when the user hits the back button in a web browser (web front-end only). (6)
browser_forward Sent when the user hits the forward button in a web browser (web front-end only). (6)
dialogtouched Sent by the front-end each time the user modifies the value of a field. For more details, see Immediate detection of user changes. (7)
enterbackground

On Mobile devices, this action is fired when the app goes to background mode.

With GBC in a web browser, this action is fired when the browser window or current tab gets hidden to the user, because a browser window/tab switch occurred, or the browser window got minimized.

With GDC/UR, the enterbackground action is fired when the window container is minimized.

For more details, see Foreground and background modes.

 (6)
enterforeground

On Mobile devices, this action is fired when the app goes to foreground mode.

With GBC in a web browser, this action is fired when the browser window or current tab is shown to the user, because a browser window/tab switch occurred, or the browser window is restored.

With GDC/UR, the enterforeground action is fired when the window container is restored.

For more details, see Foreground and background modes.

 (6)
windowresized
Important:

This feature is deprecated, its use is discouraged although not prohibited.

On Mobile devices, this action is sent when changing the orientation of the device. On other front-ends, it is sent when the current active window is resized. For more details, see Adapting to viewport changes.

 (6)
notificationpushed On Mobile devices, this action is fired when receiving a push notification message. See mobile.getRemoteNotifications (6)
notificationselected On Mobile devices, this action is sent when the user selects a local or push notification. See mobile.getLastNotificationInteractions. (6)
cordovacallback On Mobile devices, this action is fired when receiving Cordova plugin results. See cordova.callWithoutWaiting. (6)

Context descriptions

  1. CONSTRUCT, INPUT, PROMPT, INPUT ARRAY and DISPLAY ARRAY.
  2. INPUT ARRAY only.
  3. CONSTRUCT, INPUT and INPUT ARRAY.
  4. INPUT ARRAY and DISPLAY ARRAY.
  5. Only possible when no interactive instruction is active.
  6. Possible in any kind of interactive instruction (MENU included).
  7. DIALOG, CONSTRUCT, INPUT, PROMPT, INPUT ARRAY and DISPLAY ARRAY.
  8. DISPLAY ARRAY only.