ro.sync.exml.workspace.api.editor.page.author.actions
Interface AuthorActionsProvider

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface AuthorActionsProvider

Provides access to actions defined in the Author page.

Since:

12.1

Method Summary

java.lang.String	getActionID(java.lang.Object action) Get an unique ID (which does not depend on the action name) for an action Oxygen has mounted on the main JMenuBar or on the toolbars.
java.util.Map<java.lang.String,java.lang.Object>	getAuthorCommonActions() Get the map of author common actions (undo, redo, cut, copy, paste, etc).
java.util.Map<java.lang.String,java.lang.Object>	getAuthorExtensionActions() Get the map of author extension actions.
void	invokeAction(java.lang.Object action) If an action was obtained using one of the methods in this interface this method provides means to invoke an action on AWT thread (for the standalone distribution) or SWT thread (for the eclipse distribution).

Method Detail

getAuthorCommonActions

java.util.Map<java.lang.String,java.lang.Object> getAuthorCommonActions()

Get the map of author common actions (undo, redo, cut, copy, paste, etc).

Returns:

The map with (action id, Action) pairs with the actions defined for working in the Author. If the standalone Oxygen implementation is used, the actions are instance of javax.swing.Action If the eclipse plugin Oxygen implementation is used, the actions are instance of org.eclipse.jface.action.Action

getAuthorExtensionActions

java.util.Map<java.lang.String,java.lang.Object> getAuthorExtensionActions()

Get the map of author extension actions. Can be null if the author page does not have an associated document type. This should get called after each load as the extension actions depend on the loaded document type.

Returns:

The map with (action id, Action) pairs with the actions defined in the Author framework. Can be null if no actions available. If the standalone Oxygen implementation is used, the actions are instance of javax.swing.Action If the eclipse plugin Oxygen implementation is used, the actions are instance of org.eclipse.jface.action.Action

Since:

12.1

invokeAction

void invokeAction(java.lang.Object action)

If an action was obtained using one of the methods in this interface this method provides means to invoke an action on AWT thread (for the standalone distribution) or SWT thread (for the eclipse distribution).

Parameters:

action - The action to invoke

Since:

12.1

getActionID

java.lang.String getActionID(java.lang.Object action)

Get an unique ID (which does not depend on the action name) for an action Oxygen has mounted on the main JMenuBar or on the toolbars. If the action appears on a contextual menu but is not installed on a main menu it will pe prefixed with the constant "ACTION_WITH_NO_SHORTCUT/"

Parameters:

action - The action for which to retrieve the ID.

Returns:

The unique ID or null if the action is not one provided by Oxygen.

Since:

13.2