Package org.fife.ui.rsyntaxtextarea
Class DefaultOccurrenceMarker
java.lang.Object
org.fife.ui.rsyntaxtextarea.DefaultOccurrenceMarker
- All Implemented Interfaces:
OccurrenceMarker
The default implementation of
OccurrenceMarker
. It goes through
the document and marks all instances of the specified token.- Version:
- 1.0
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetTokenToMark
(RSyntaxTextArea textArea) Returns the token to mark occurrences, of, provided it matches the criteria put forth byOccurrenceMarker.isValidType(RSyntaxTextArea, Token)
.boolean
isValidType
(RSyntaxTextArea textArea, Token t) Returns whether the specified token is a type that we can do a "mark occurrences" of.void
markOccurrences
(RSyntaxDocument doc, Token t, RSyntaxTextAreaHighlighter h, SmartHighlightPainter p) Called when occurrences of a token should be marked.static void
markOccurrencesOfToken
(RSyntaxDocument doc, Token t, RSyntaxTextAreaHighlighter h, SmartHighlightPainter p) Highlights all instances of tokens identical tot
in the specified document.
-
Constructor Details
-
DefaultOccurrenceMarker
DefaultOccurrenceMarker()
-
-
Method Details
-
getTokenToMark
Description copied from interface:OccurrenceMarker
Returns the token to mark occurrences, of, provided it matches the criteria put forth byOccurrenceMarker.isValidType(RSyntaxTextArea, Token)
. For most languages, this method should return the token at the caret position.- Specified by:
getTokenToMark
in interfaceOccurrenceMarker
- Parameters:
textArea
- The text area.- Returns:
- The token to (possibly) mark occurrences of, or
null
if none.
-
isValidType
Description copied from interface:OccurrenceMarker
Returns whether the specified token is a type that we can do a "mark occurrences" of. Typically, this will delegate toRSyntaxTextArea.getMarkOccurrencesOfTokenType(int)
.- Specified by:
isValidType
in interfaceOccurrenceMarker
- Parameters:
textArea
- The text area.t
- The token.- Returns:
- Whether we should mark all occurrences of this token.
-
markOccurrences
public void markOccurrences(RSyntaxDocument doc, Token t, RSyntaxTextAreaHighlighter h, SmartHighlightPainter p) Description copied from interface:OccurrenceMarker
Called when occurrences of a token should be marked.- Specified by:
markOccurrences
in interfaceOccurrenceMarker
- Parameters:
doc
- The document.t
- The document whose relevant occurrences should be marked.h
- The highlighter to add the highlights to.p
- The painter for the highlights.
-
markOccurrencesOfToken
public static void markOccurrencesOfToken(RSyntaxDocument doc, Token t, RSyntaxTextAreaHighlighter h, SmartHighlightPainter p) Highlights all instances of tokens identical tot
in the specified document.- Parameters:
doc
- The document.t
- The document whose relevant occurrences should be marked.h
- The highlighter to add the highlights to.p
- The painter for the highlights.
-