|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.text.source.ChangeRulerColumn
A vertical ruler column displaying line numbers and serving as a UI for quick diff. Clients instantiate and configure object of this class.
Field Summary |
---|
Fields inherited from interface org.eclipse.jface.text.source.IChangeRulerColumn |
---|
QUICK_DIFF_MODEL_ID |
Constructor Summary | |
---|---|
ChangeRulerColumn()
|
Method Summary | |
---|---|
void |
addVerticalRulerListener(IVerticalRulerListener listener)
Registers a vertical ruler listener to be informed if an annotation gets selected on the vertical ruler. |
Control |
createControl(CompositeRuler parentRuler,
Composite parentControl)
Creates the column's SWT control. |
protected Color |
getBackground(Display display)
Returns the System background color for list widgets. |
Control |
getControl()
Returns the column's SWT control. |
IAnnotationHover |
getHover()
Returns the hover for this vertical ruler (column). |
int |
getLineOfLastMouseButtonActivity()
Returns the line number of the last mouse button activity. |
IAnnotationModel |
getModel()
Returns the model currently used by the receiver. |
protected CompositeRuler |
getParentRuler()
Returns the parent (composite) ruler of this ruler column. |
protected int |
getVisibleLinesInViewport()
Returns the view port height in lines. |
int |
getWidth()
Returns the width of this column's control. |
protected void |
handleDispose()
Disposes the column's resources. |
protected void |
paintLine(int line,
int y,
int lineheight,
GC gc,
Display display)
|
protected void |
postRedraw()
Triggers a redraw in the display thread. |
void |
redraw()
Redraws this column. |
void |
removeVerticalRulerListener(IVerticalRulerListener listener)
Removes a previously registered listener. |
void |
setAddedColor(Color addedColor)
Sets the background color for added lines. |
void |
setBackground(Color background)
Sets the background color for normal lines. |
void |
setChangedColor(Color changedColor)
Sets the background color for changed lines. |
void |
setDeletedColor(Color deletedColor)
Sets the color for the deleted lines indicator. |
void |
setFont(Font font)
Sets the font of this ruler column. |
void |
setHover(IAnnotationHover hover)
Sets the hover of this ruler column. |
void |
setModel(IAnnotationModel model)
Associates an annotation model with this ruler column. |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ChangeRulerColumn()
Method Detail |
protected Color getBackground(Display display)
display
- the display the drawing occurs on
public Control createControl(CompositeRuler parentRuler, Composite parentControl)
IVerticalRulerColumn
createControl
in interface IVerticalRulerColumn
parentRuler
- the parent ruler of this columnparentControl
- the control of the parent ruler
protected void handleDispose()
protected int getVisibleLinesInViewport()
public void redraw()
IVerticalRulerColumn
redraw
in interface IVerticalRulerColumn
public void setFont(Font font)
IVerticalRulerColumn
setFont
in interface IVerticalRulerColumn
font
- the new font of the ruler columnprotected CompositeRuler getParentRuler()
protected void paintLine(int line, int y, int lineheight, GC gc, Display display)
public int getLineOfLastMouseButtonActivity()
IVerticalRulerInfo
0
.
getLineOfLastMouseButtonActivity
in interface IVerticalRulerInfo
public 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 linepublic IAnnotationHover getHover()
IVerticalRulerInfoExtension
getHover
in interface IVerticalRulerInfoExtension
public void setHover(IAnnotationHover hover)
IChangeRulerColumn
setHover
in interface IChangeRulerColumn
hover
- the hover that will produce hover information text for this ruler columnpublic void setModel(IAnnotationModel model)
IVerticalRulerColumn
null
is acceptable and clears the ruler.
setModel
in interface IVerticalRulerColumn
model
- the new annotation model, may be null
public void setBackground(Color background)
IChangeRulerColumn
setBackground
in interface IChangeRulerColumn
background
- the new color to be used as standard line backgroundpublic void setAddedColor(Color addedColor)
IChangeRulerColumn
setAddedColor
in interface IChangeRulerColumn
addedColor
- the new color to be used for the added lines backgroundpublic void setChangedColor(Color changedColor)
IChangeRulerColumn
setChangedColor
in interface IChangeRulerColumn
changedColor
- the new color to be used for the changed lines backgroundpublic void setDeletedColor(Color deletedColor)
IChangeRulerColumn
setDeletedColor
in interface IChangeRulerColumn
deletedColor
- the new color to be used for the deleted lines indicator.public IAnnotationModel getModel()
IVerticalRulerInfoExtension
getModel
in interface IVerticalRulerInfoExtension
null
if no model is
installed.public Control getControl()
IVerticalRulerColumn
getControl
in interface IVerticalRulerColumn
public int getWidth()
IVerticalRulerColumn
getWidth
in interface IVerticalRulerColumn
protected final void postRedraw()
public void addVerticalRulerListener(IVerticalRulerListener listener)
IVerticalRulerInfoExtension
addVerticalRulerListener
in interface IVerticalRulerInfoExtension
listener
- the listener to be informedpublic void removeVerticalRulerListener(IVerticalRulerListener listener)
IVerticalRulerInfoExtension
listener
is not registered
with the receiver, calling this method has no effect.
removeVerticalRulerListener
in interface IVerticalRulerInfoExtension
listener
- the listener to be removed
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.