JSDoc: Namespace: actions

The apex.actions namespace contains global functions related to the Oracle Application Express actions facility. The methods and properties of the global actions context are also available in the apex.actions namespace but are documented with the actions interface.

Since:

Functions

(static) createContext(pTypeName, pContext) → {actions}

Create a new actions interface object that is scoped to the given DOM element context. Any action buttons or other UI elements must be within the given pContext. And focus must be within pContext for keyboard shortcuts to work. A global context at document.body is created automatically and is accessed from apex.actions. The global context type name is "global".

Parameters:

Name	Type	Description
`pTypeName`	string	Type name of the actions context.
`pContext`	Element	DOM element context that actions are scoped within.

Returns:

The actions interface object that was created.

Type: actions

(static) findContext(pTypeNameopt, pContext) → {actions}

Return the actions object for a given context. The pTypeName is optional but if given must match the type name used when the context was created. This is not often needed because the actions object returned from createContext should be saved by any widget/component that created the context.

Parameters:

Name	Type	Attributes	Description
`pTypeName`	string	<optional>	The type name of the actions context.
`pContext`	Element		DOM element context that actions are scoped within.

Returns:

The actions object or undefined if there is no actions defined for pContext

Type: actions

(static) getContextsForType(pTypeName) → {Array.<actions>}

Return an array of all the actions context instances for a given type.

Parameters:

Name	Type	Description
`pTypeName`	string	The type name of the actions contexts to return.

Returns:

An array of actions.

Type: Array.<actions>

(static) getContextTypes() → {Array.<string>}

Return an array of all the actions context types.

Returns:

An array of context type names.

Type: Array.<string>

(static) removeContext(pTypeName, pContext)

Remove an actions context that was created with apex.actions.createContext.

Parameters:

Name	Type	Description
`pTypeName`	string	Type name of the actions context to remove.
`pContext`	Element	DOM element context that actions are scoped within.

(static) shortcutSupport(pShortcutTypeopt) → {string|undefined}

Get or set the type of shortcut key support. The default is "sequence".

Note: The shortcut key support setting does not affect what shortcuts can be defined for actions but only how what the user types is recognized.

Parameters:

Name	Type	Attributes	Description
`pShortcutType`	string	<optional>	One of "off", "single", "sequence". If not specified the current value is returned.

Returns:

When no arguments are given returns the current setting otherwise returns nothing.

Type: string | undefined

Examples

Get the current setting.

apex.actions.shortcutSupport();

Turn off the ability to use shortcuts on the page for all action contexts.

apex.actions.shortcutSupport( "off" );

Disable shortcut sequences such as C,B.

apex.actions.shortcutSupport( "single" );