- 
- All Known Implementing Classes:
- BasicTextUI.BasicHighlighter,- DefaultHighlighter,- LayeredHighlighter
 
 public interface HighlighterAn interface for an object that allows one to mark up the background with colored areas.
- 
- 
Nested Class SummaryNested Classes Modifier and Type Interface Description static interfaceHighlighter.HighlightA highlight.static interfaceHighlighter.HighlightPainterHighlight renderer.
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description ObjectaddHighlight(int p0, int p1, Highlighter.HighlightPainter p)Adds a highlight to the view.voidchangeHighlight(Object tag, int p0, int p1)Changes the given highlight to span a different portion of the document.voiddeinstall(JTextComponent c)Called when the UI is being removed from the interface of a JTextComponent.Highlighter.Highlight[]getHighlights()Fetches the current list of highlights.voidinstall(JTextComponent c)Called when the UI is being installed into the interface of a JTextComponent.voidpaint(Graphics g)Renders the highlights.voidremoveAllHighlights()Removes all highlights this highlighter is responsible for.voidremoveHighlight(Object tag)Removes a highlight from the view.
 
- 
- 
- 
Method Detail- 
installvoid install(JTextComponent c) Called when the UI is being installed into the interface of a JTextComponent. This can be used to gain access to the model that is being navigated by the implementation of this interface.- Parameters:
- c- the JTextComponent editor
 
 - 
deinstallvoid deinstall(JTextComponent c) Called when the UI is being removed from the interface of a JTextComponent. This is used to unregister any listeners that were attached.- Parameters:
- c- the JTextComponent editor
 
 - 
paintvoid paint(Graphics g) Renders the highlights.- Parameters:
- g- the graphics context.
 
 - 
addHighlightObject addHighlight(int p0, int p1, Highlighter.HighlightPainter p) throws BadLocationException Adds a highlight to the view. Returns a tag that can be used to refer to the highlight.- Parameters:
- p0- the beginning of the range >= 0
- p1- the end of the range >= p0
- p- the painter to use for the actual highlighting
- Returns:
- an object that refers to the highlight
- Throws:
- BadLocationException- for an invalid range specification
 
 - 
removeHighlightvoid removeHighlight(Object tag) Removes a highlight from the view.- Parameters:
- tag- which highlight to remove
 
 - 
removeAllHighlightsvoid removeAllHighlights() Removes all highlights this highlighter is responsible for.
 - 
changeHighlightvoid changeHighlight(Object tag, int p0, int p1) throws BadLocationException Changes the given highlight to span a different portion of the document. This may be more efficient than a remove/add when a selection is expanding/shrinking (such as a sweep with a mouse) by damaging only what changed.- Parameters:
- tag- which highlight to change
- p0- the beginning of the range >= 0
- p1- the end of the range >= p0
- Throws:
- BadLocationException- for an invalid range specification
 
 - 
getHighlightsHighlighter.Highlight[] getHighlights() Fetches the current list of highlights.- Returns:
- the highlight list
 
 
- 
 
-