Package ro.sync.ecss.extensions.api.highlights
package ro.sync.ecss.extensions.api.highlights
API used to interact with persistent (change tracking, comments, user persistent highlights)
and non persistent highlights in the Author page
-
ClassDescriptionThe highlighter which will be available to users to add, remove and check highlights.Listener for the author highlighter events.Defines the Author Persistent Highlight which get serialized in the XML as processing instruction.The
Author Persistent Highlighttype.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.Constants used in the serialization process of the Author Persistent Highlights.Manage the user custom persistent highlights which get serialized in the XML as processing instructions with the form:
<?oxy_custom_start prop1="val1"....?> xml content <?oxy_custom_end?>
The Highlighter is accessible fromWSAuthorEditorPageBase.getPersistentHighlighter().Filter for theAuthorPersistentHighlightpresented in the author page, callouts section and review panel.Listener for all the events related to theAuthorPersistentHighlight.Painter that can be used to customize the way that a highlight is displayed by setting custom text decoration, text decoration stroke, background color or stroke color.The decoration added to text.The highlight interface.Provider for the actions available for a highlight.The rendering style of the actions associated with a highlight.Highlight renderer.Information needed by the painter.Customize the way that the author persistent highlights are displayed.A highlight painter that can be prioritized, by telling it to paint all its highlight on a specific layer.Layers where a painter can paint its highlights.Fill a rectangle for the given highlight.Can also draw the text foreground with a certain color.