Interface PersistentHighlightRenderer
@API(type=EXTENDABLE,
src=PUBLIC)
public interface PersistentHighlightRenderer
Customize the way that the author persistent highlights are displayed.
Persistent highlights get serialized as processing instructions in the XML content.
- Since:
- 12
-
Method Summary
Modifier and TypeMethodDescriptiongetHighlightPainter
(AuthorPersistentHighlight highlight) Get the painter associated with the given persistent highlight.getTooltip
(AuthorPersistentHighlight highlight) Get the display tooltip text for a persistent highlight.
-
Method Details
-
getHighlightPainter
Get the painter associated with the given persistent highlight.
If anull
value is returned the default highlight painter will be used.
You can use or customize instances of the defaultColorHighlightPainter
.- Parameters:
highlight
- TheAuthorPersistentHighlight
to get the painter for.- Returns:
- The painter.
-
getTooltip
Get the display tooltip text for a persistent highlight.
If anull
value is returned the default tooltip text will be used.- Parameters:
highlight
- TheAuthorPersistentHighlight
to get the tooltip for.- Returns:
- The tool tip for the highlight.
-