Package org.eclipse.jface.text.source
Class MatchingCharacterPainter
- java.lang.Object
-
- org.eclipse.jface.text.source.MatchingCharacterPainter
-
- All Implemented Interfaces:
EventListener,IPainter,PaintListener,SWTEventListener
public final class MatchingCharacterPainter extends Object implements IPainter, PaintListener
Highlights the peer character matching the character near the caret position, or a pair of peer characters enclosing the caret position. This painter can be configured with anICharacterPairMatcheror anICharacterPairMatcherExtension.Clients instantiate and configure an object of this class.
- Since:
- 2.1
-
-
Field Summary
-
Fields inherited from interface org.eclipse.jface.text.IPainter
CONFIGURATION, INTERNAL, KEY_STROKE, MOUSE_BUTTON, SELECTION, TEXT_CHANGE
-
-
Constructor Summary
Constructors Constructor Description MatchingCharacterPainter(ISourceViewer sourceViewer, ICharacterPairMatcher matcher)Creates a new MatchingCharacterPainter for the given source viewer using the given character pair matcher.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddeactivate(boolean redraw)Deactivates this painter.voiddispose()Disposes this painter.voidpaint(int reason)Requests this painter to repaint because of the given reason.voidpaintControl(PaintEvent event)Sent when a paint event occurs for the control.voidsetColor(Color color)Sets the color in which to highlight the match character.voidsetHighlightCharacterAtCaretLocation(boolean highlightCharacterAtCaretLocation)Sets whether to highlight the character at caret location or not.voidsetHighlightEnclosingPeerCharacters(boolean highlightEnclosingPeerCharcters)Sets whether to highlight enclosing peer characters or not.voidsetPositionManager(IPaintPositionManager manager)Sets the paint position manager that can be used by this painter or removes any previously set paint position manager.
-
-
-
Constructor Detail
-
MatchingCharacterPainter
public MatchingCharacterPainter(ISourceViewer sourceViewer, ICharacterPairMatcher matcher)
Creates a new MatchingCharacterPainter for the given source viewer using the given character pair matcher. The character matcher is not adopted by this painter. Thus, it is not disposed. However, this painter requires exclusive access to the given pair matcher.- Parameters:
sourceViewer- the source viewermatcher- the character pair matcher
-
-
Method Detail
-
setHighlightCharacterAtCaretLocation
public void setHighlightCharacterAtCaretLocation(boolean highlightCharacterAtCaretLocation)
Sets whether to highlight the character at caret location or not.- Parameters:
highlightCharacterAtCaretLocation- whether to highlight the character at caret location or not- Since:
- 3.8
-
setHighlightEnclosingPeerCharacters
public void setHighlightEnclosingPeerCharacters(boolean highlightEnclosingPeerCharcters)
Sets whether to highlight enclosing peer characters or not.- Parameters:
highlightEnclosingPeerCharcters- whether to highlight enclosing peer characters or not- Since:
- 3.8
-
setColor
public void setColor(Color color)
Sets the color in which to highlight the match character.- Parameters:
color- the color
-
dispose
public void dispose()
Description copied from interface:IPainterDisposes this painter. Prior to disposing, a painter should be deactivated. A disposed painter can not be reactivated.- Specified by:
disposein interfaceIPainter- See Also:
IPainter.deactivate(boolean)
-
deactivate
public void deactivate(boolean redraw)
Description copied from interface:IPainterDeactivates this painter. If the painter is inactive, this call does not have any effect.redrawindicates whether the painter should remove any decoration it previously applied. A deactivated painter can be reactivated by callingpaint.- Specified by:
deactivatein interfaceIPainter- Parameters:
redraw-trueif any previously applied decoration should be removed- See Also:
IPainter.paint(int)
-
paintControl
public void paintControl(PaintEvent event)
Description copied from interface:PaintListenerSent when a paint event occurs for the control.- Specified by:
paintControlin interfacePaintListener- Parameters:
event- an event containing information about the paint
-
paint
public void paint(int reason)
Description copied from interface:IPainterRequests this painter to repaint because of the given reason. Based on the given reason the painter can decide whether it will repaint or not. If it repaints and is inactive, it will activate itself.
-
setPositionManager
public void setPositionManager(IPaintPositionManager manager)
Description copied from interface:IPainterSets the paint position manager that can be used by this painter or removes any previously set paint position manager.- Specified by:
setPositionManagerin interfaceIPainter- Parameters:
manager- the paint position manager ornull
-
-