ro.sync.ecss.extensions.api.highlights
Interface AuthorPersistentHighlightActionsProvider

@API(type=EXTENDABLE,
     src=PUBLIC)
public interface AuthorPersistentHighlightActionsProvider

The provider for contextual actions that are shown on the contextual menu of the persistent highlight (in the main editor area - not yet supported) and on the associated callout. You can set such a provider by using the AuthorPersistentHighlighter.setHighlightsActionsProvider(AuthorPersistentHighlightActionsProvider) method.

Since:

14
*********************************
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.

Method Summary

java.util.List<javax.swing.AbstractAction>	getActions(AuthorPersistentHighlight highlight) Gets the available actions for a persistent highlight.
javax.swing.AbstractAction	getDefaultAction(AuthorPersistentHighlight highlight) Gets the action that will be invoked when the user double clicks a callout representation, or a persistent highlight in the main editing area (not yet supported).

Method Detail

getActions

java.util.List<javax.swing.AbstractAction> getActions(AuthorPersistentHighlight highlight)

Gets the available actions for a persistent highlight. This method is called only for the highlights that have a a callout associated.
Only the following action properties are used in oXygen Eclipse plugin: Action.SMALL_ICON is used as action image in the menu and Action.NAME is used as action name (label).
In the future, this will be called also for the custom persistent highlights that are displayed in the main editing area.
To associate callout information to custom persistent highlights use the method AuthorCalloutsController.setCalloutsRenderingInformationProvider( ro.sync.ecss.extensions.api.callouts.CalloutsRenderingInformationProvider)

Parameters:

highlight - The highlight for which the actions are requested. Never null.

Returns:

The list of actions available for the highlight, or null if there is no action available for the context highlight. The list can contain null entries for separators.

getDefaultAction

javax.swing.AbstractAction getDefaultAction(AuthorPersistentHighlight highlight)

Gets the action that will be invoked when the user double clicks a callout representation, or a persistent highlight in the main editing area (not yet supported).

Is not necessary that this action to be included in the ones returned by getActions(AuthorPersistentHighlight).

Parameters:

highlight - The highlight for which the default action is requested. Never null.

Returns:

The default action available for the highlight, or null if there is no action available for the context highlight.