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
-
Method Summary
Modifier and TypeMethodDescriptiongetActions
(AuthorPersistentHighlight highlight) Gets the available actions for a persistent highlight.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 Details
-
getActions
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 andAction.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 methodAuthorCalloutsController.setCalloutsRenderingInformationProvider(ro.sync.ecss.extensions.api.callouts.CalloutsRenderingInformationProvider)
- Parameters:
highlight
- The highlight for which the actions are requested. Nevernull
.- Returns:
- The list of actions available for the highlight, or
null
if there is no action available for the context highlight. The list can containnull
entries for separators.
-
getDefaultAction
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. Nevernull
.- Returns:
- The default action available for the highlight, or
null
if there is no action available for the context highlight.
-