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

public interface PersistentHighlightRenderer

Customize the way that the author persistent highlights are displayed. Persistent highlights get serialized as processing instructions in the XML content.

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

Since:

12

Method Summary

HighlightPainter	getHighlightPainter(AuthorPersistentHighlight highlight) Get the painter associated with the given persistent highlight.
java.lang.String	getTooltip(AuthorPersistentHighlight highlight) Get the display tooltip text for a persistent highlight.

Method Detail

getHighlightPainter

HighlightPainter getHighlightPainter(AuthorPersistentHighlight highlight)

Get the painter associated with the given persistent highlight.
If a null value is returned the default highlight painter will be used.
You can use or customize instances of the default ColorHighlightPainter.

Parameters:

highlight - The AuthorPersistentHighlight to get the painter for.

Returns:

The painter.

getTooltip

java.lang.String getTooltip(AuthorPersistentHighlight highlight)

Get the display tooltip text for a persistent highlight.
If a null value is returned the default tooltip text will be used.

Parameters:

highlight - The AuthorPersistentHighlight to get the tooltip for.

Returns:

The tool tip for the highlight.