Package org.eclipse.jface.text
Class WhitespaceCharacterPainter
- java.lang.Object
-
- org.eclipse.jface.text.WhitespaceCharacterPainter
-
- All Implemented Interfaces:
EventListener
,IPainter
,PaintListener
,SWTEventListener
public class WhitespaceCharacterPainter extends Object implements IPainter, PaintListener
A painter for drawing visible characters for (invisible) whitespace characters.- Since:
- 3.3
-
-
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 WhitespaceCharacterPainter(ITextViewer textViewer)
Creates a new painter for the given text viewer.WhitespaceCharacterPainter(ITextViewer viewer, boolean showLeadingSpaces, boolean showEnclosedSpaces, boolean showTrailingSpaces, boolean showLeadingIdeographicSpaces, boolean showEnclosedIdeographicSpaces, boolean showTrailingIdeographicSpace, boolean showLeadingTabs, boolean showEnclosedTabs, boolean showTrailingTabs, boolean showCarriageReturn, boolean showLineFeed, int alpha)
Creates a new painter for the given text viewer and the painter options.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
deactivate(boolean redraw)
Deactivates this painter.void
dispose()
Disposes this painter.void
paint(int reason)
Requests this painter to repaint because of the given reason.void
paintControl(PaintEvent event)
Sent when a paint event occurs for the control.void
setPositionManager(IPaintPositionManager manager)
Sets the paint position manager that can be used by this painter or removes any previously set paint position manager.
-
-
-
Constructor Detail
-
WhitespaceCharacterPainter
public WhitespaceCharacterPainter(ITextViewer textViewer)
Creates a new painter for the given text viewer.- Parameters:
textViewer
- the text viewer the painter should be attached to
-
WhitespaceCharacterPainter
public WhitespaceCharacterPainter(ITextViewer viewer, boolean showLeadingSpaces, boolean showEnclosedSpaces, boolean showTrailingSpaces, boolean showLeadingIdeographicSpaces, boolean showEnclosedIdeographicSpaces, boolean showTrailingIdeographicSpace, boolean showLeadingTabs, boolean showEnclosedTabs, boolean showTrailingTabs, boolean showCarriageReturn, boolean showLineFeed, int alpha)
Creates a new painter for the given text viewer and the painter options.- Parameters:
viewer
- the text viewer the painter should be attached toshowLeadingSpaces
- iftrue
, show leading SpacesshowEnclosedSpaces
- iftrue
, show enclosed SpacesshowTrailingSpaces
- iftrue
, show trailing SpacesshowLeadingIdeographicSpaces
- iftrue
, show leading Ideographic SpacesshowEnclosedIdeographicSpaces
- iftrue
, show enclosed Ideographic SpacesshowTrailingIdeographicSpace
- iftrue
, show trailing Ideographic SpacesshowLeadingTabs
- iftrue
, show leading TabsshowEnclosedTabs
- iftrue
, show enclosed TabsshowTrailingTabs
- iftrue
, show trailing TabsshowCarriageReturn
- iftrue
, show Carriage ReturnsshowLineFeed
- iftrue
, show Line Feedsalpha
- the alpha value- Since:
- 3.7
-
-
Method Detail
-
dispose
public void dispose()
Description copied from interface:IPainter
Disposes this painter. Prior to disposing, a painter should be deactivated. A disposed painter can not be reactivated.- Specified by:
dispose
in interfaceIPainter
- See Also:
IPainter.deactivate(boolean)
-
paint
public void paint(int reason)
Description copied from interface:IPainter
Requests 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.
-
deactivate
public void deactivate(boolean redraw)
Description copied from interface:IPainter
Deactivates this painter. If the painter is inactive, this call does not have any effect.redraw
indicates whether the painter should remove any decoration it previously applied. A deactivated painter can be reactivated by callingpaint
.- Specified by:
deactivate
in interfaceIPainter
- Parameters:
redraw
-true
if any previously applied decoration should be removed- See Also:
IPainter.paint(int)
-
setPositionManager
public void setPositionManager(IPaintPositionManager manager)
Description copied from interface:IPainter
Sets the paint position manager that can be used by this painter or removes any previously set paint position manager.- Specified by:
setPositionManager
in interfaceIPainter
- Parameters:
manager
- the paint position manager ornull
-
paintControl
public void paintControl(PaintEvent event)
Description copied from interface:PaintListener
Sent when a paint event occurs for the control.- Specified by:
paintControl
in interfacePaintListener
- Parameters:
event
- an event containing information about the paint
-
-