public final class VerticalRuler extends Object implements IVerticalRuler, IVerticalRulerExtension
IVerticalRuler
.
The same can be achieved by using CompositeRuler
configured
with an AnnotationRulerColumn
. Clients may use this class as
is.
ITextViewer
Constructor and Description |
---|
VerticalRuler(int width)
Constructs a vertical ruler with the given width.
|
VerticalRuler(int width,
IAnnotationAccess annotationAcccess)
Constructs a vertical ruler with the given width and the given annotation
access.
|
Modifier and Type | Method and Description |
---|---|
void |
addMouseListener(MouseListener listener)
Deprecated.
will be removed
|
Control |
createControl(Composite parent,
ITextViewer textViewer)
Creates the ruler's SWT control.
|
protected void |
doPaint(GC gc)
Draws the vertical ruler w/o drawing the Canvas background.
|
protected void |
doPaint1(GC gc)
Draws the vertical ruler w/o drawing the Canvas background.
|
Control |
getControl()
Returns the ruler's SWT control.
|
int |
getLineOfLastMouseButtonActivity()
Returns the line number of the last mouse button activity.
|
IAnnotationModel |
getModel()
Returns the current annotation model of this ruler or
null
if the ruler has no model. |
int |
getWidth()
Returns the width of this ruler's control.
|
void |
removeMouseListener(MouseListener listener)
Deprecated.
will be removed
|
void |
setFont(Font font)
Sets the font of this vertical ruler.
|
void |
setLocationOfLastMouseButtonActivity(int x,
int y)
Sets the location of the last mouse button activity.
|
void |
setModel(IAnnotationModel model)
Associates an annotation model with this ruler.
|
int |
toDocumentLineNumber(int y_coordinate)
Translates a y-coordinate of the ruler's SWT control into
the according line number of the document of the connected text viewer.
|
void |
update()
Thread-safe implementation.
|
protected static int |
widgetLine2ModelLine(ITextViewer viewer,
int widgetLine)
Returns the line of the viewer's document that corresponds to the given widget line.
|
public VerticalRuler(int width)
width
- the width of the vertical rulerpublic VerticalRuler(int width, IAnnotationAccess annotationAcccess)
width
- the width of the vertical rulerannotationAcccess
- the annotation accesspublic Control getControl()
IVerticalRulerInfo
getControl
in interface IVerticalRulerInfo
public Control createControl(Composite parent, ITextViewer textViewer)
IVerticalRuler
createControl
in interface IVerticalRuler
parent
- the parent control of the ruler's controltextViewer
- the text viewer to which this ruler belongsprotected void doPaint(GC gc)
gc
- the GC to draw intoprotected void doPaint1(GC gc)
ITextViewerExtension5
for its implementation. Will replace
doPaint(GC)
.gc
- the GC to draw intopublic void update()
update
in interface IVerticalRuler
public void setModel(IAnnotationModel model)
IVerticalRuler
null
is acceptable and clears the ruler.setModel
in interface IVerticalRuler
model
- the new annotation model, may be null
public IAnnotationModel getModel()
IVerticalRuler
null
if the ruler has no model.getModel
in interface IVerticalRuler
null
if there is no modelpublic int getWidth()
IVerticalRulerInfo
getWidth
in interface IVerticalRulerInfo
public int getLineOfLastMouseButtonActivity()
IVerticalRulerInfo
getLineOfLastMouseButtonActivity
in interface IVerticalRulerInfo
-1
if
the last mouse activity does not correspond to a valid document linepublic int toDocumentLineNumber(int y_coordinate)
IVerticalRulerInfo
toDocumentLineNumber
in interface IVerticalRulerInfo
y_coordinate
- a y-coordinate of the ruler's SWT control-1
if that
coordinate does not correspond to a valid document lineprotected static final int widgetLine2ModelLine(ITextViewer viewer, int widgetLine)
viewer
- the viewerwidgetLine
- the widget linepublic void setFont(Font font)
IVerticalRulerExtension
setFont
in interface IVerticalRulerExtension
font
- the new font of the vertical rulerpublic void setLocationOfLastMouseButtonActivity(int x, int y)
IVerticalRulerExtension
setLocationOfLastMouseButtonActivity
in interface IVerticalRulerExtension
x
- the x-coordinatey
- the y-coordinatepublic void addMouseListener(MouseListener listener)
listener
- the listener to be addedpublic void removeMouseListener(MouseListener listener)
listener
- the listener to be removed
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.