Package org.eclipse.jface.text
Class MarginPainter
- java.lang.Object
-
- org.eclipse.jface.text.MarginPainter
-
- All Implemented Interfaces:
EventListener,IPainter,PaintListener,SWTEventListener
public class MarginPainter extends Object implements IPainter, PaintListener
Paints a vertical line (margin line) after a given column respecting the text viewer's font.Clients usually instantiate and configure objects of this class.
This class is not intended to be subclassed.
- Since:
- 2.1
- Restriction:
- This class is not intended to be subclassed by clients.
-
-
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 MarginPainter(ITextViewer textViewer)Creates a new painter for the given text viewer.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddeactivate(boolean redraw)Deactivates this painter.voiddispose()Disposes this painter.voidinitialize()Initializes this painter, by flushing and recomputing all caches and causing the widget to be redrawn.voidpaint(int reason)Requests this painter to repaint because of the given reason.voidpaintControl(PaintEvent e)Sent when a paint event occurs for the control.voidsetMarginRulerColor(Color color)Sets the color of the margin line.voidsetMarginRulerColumn(int width)Sets the column after which to draw the margin line.voidsetMarginRulerStyle(int lineStyle)Sets the line style of the margin line.voidsetMarginRulerWidth(int lineWidth)Sets the line width of the margin line.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
-
MarginPainter
public MarginPainter(ITextViewer textViewer)
Creates a new painter for the given text viewer.- Parameters:
textViewer- the text viewer
-
-
Method Detail
-
setMarginRulerColumn
public void setMarginRulerColumn(int width)
Sets the column after which to draw the margin line.- Parameters:
width- the column
-
setMarginRulerStyle
public void setMarginRulerStyle(int lineStyle)
Sets the line style of the margin line.- Parameters:
lineStyle- aSWTstyle constant describing the line style
-
setMarginRulerWidth
public void setMarginRulerWidth(int lineWidth)
Sets the line width of the margin line.- Parameters:
lineWidth- the line width
-
setMarginRulerColor
public void setMarginRulerColor(Color color)
Sets the color of the margin line. Must be called beforepaintis called the first time.- Parameters:
color- the color
-
initialize
public void initialize()
Initializes this painter, by flushing and recomputing all caches and causing the widget to be redrawn.
-
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)
-
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)
-
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.
-
paintControl
public void paintControl(PaintEvent e)
Description copied from interface:PaintListenerSent when a paint event occurs for the control.- Specified by:
paintControlin interfacePaintListener- Parameters:
e- an event containing information about the paint
-
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
-
-