Oxygen XML Editor 14.2 Author API

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

See:
          Description

Interface Summary
AuthorHighlighter The highlighter which will be available to users to add, remove and check highlights
AuthorPersistentHighlight Defines the Author Persistent Highlight which get serialized in the XML as processing instruction.
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.
AuthorPersistentHighlightConstants Constants used in the serialization process of the Author Persistent Highlights.
AuthorPersistentHighlighter 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 from WSAuthorEditorPageBase.getPersistentHighlighter().
Highlight The highlight interface.
HighlightPainter Highlight renderer.
PersistentHighlightRenderer Customize the way that the author persistent highlights are displayed.
TextForegroundHighlighterPainter Can also draw the text foreground with a certain color.
 

Class Summary
AuthorPersistentHighlightsListener Listener for all the events related to the AuthorPersistentHighlight.
ColorHighlightPainter 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.
HighlightPainterInfo Information needed by the painter.
RectangleHighlightPainter Fill a rectangle for the given highlight.
 

Enum Summary
AuthorPersistentHighlight.PersistentHighlightType The Author Persistent Highlight type.
ColorHighlightPainter.TextDecoration The decoration added to text.
 

Package ro.sync.ecss.extensions.api.highlights Description

API used to interact with persistent (change tracking, comments, user persistent highlights) and non persistent highlights in the Author page


Oxygen XML Editor 14.2 Author API

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