Oxygen XML Editor 16.1 Author API

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

All Superinterfaces:
ActionsProvider

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

Provides access to actions defined in the Author page.

Since:
12.1

Method Summary
 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 invokeAuthorExtensionActionInContext(java.lang.Object action, int offset)
          If an Author extension action which was contributed in the document type configuration 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) and have it executed at a certain offset.
 
Methods inherited from interface ro.sync.exml.workspace.api.editor.page.author.actions.ActionsProvider
addActionPerformedListener, getActionID, invokeAction, removeActionPerformedListener
 

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

invokeAuthorExtensionActionInContext

void invokeAuthorExtensionActionInContext(java.lang.Object action,
                                          int offset)
If an Author extension action which was contributed in the document type configuration 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) and have it executed at a certain offset. If the action is not an extension action, the method runs it without a context offset. The action will be invoked only if it is enabled in the execution context offset.

Parameters:
action - The action to invoke
offset - The offset in the document where to invoke the action.
Since:
16

*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.


Oxygen XML Editor 16.1 Author API

© Copyright SyncRO Soft SRL 2002 - 2014. All rights reserved.