|
Eclipse Platform Release 3.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.jface.text.source.LineNumberRulerColumn
org.eclipse.jface.text.source.LineNumberChangeRulerColumn
public final class LineNumberChangeRulerColumn
A vertical ruler column displaying line numbers and serving as a UI for quick diff. Clients usually 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 | |
|---|---|
LineNumberChangeRulerColumn(ISharedTextColors sharedColors)
Creates a new instance. |
|
| Method Summary | |
|---|---|
void |
addVerticalRulerListener(IVerticalRulerListener listener)
Registers a vertical ruler listener to be informed if an annotation gets selected on the vertical ruler. |
protected int |
computeNumberOfDigits()
Does the real computation of the number of digits. |
Control |
createControl(CompositeRuler parentRuler,
Composite parentControl)
Creates the column's SWT control. |
protected String |
createDisplayString(int line)
Computes the string to be printed for line. |
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. |
ISelectionProvider |
getRevisionSelectionProvider()
Returns the revision selection provider. |
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 of this column. |
void |
setChangedColor(Color changedColor)
Sets the background color for changed lines. |
void |
setDeletedColor(Color deletedColor)
Sets the color for the deleted lines indicator. |
void |
setDisplayMode(boolean characterMode)
Sets the display mode of the ruler. |
void |
setHover(IAnnotationHover hover)
Sets the hover of this ruler column. |
void |
setModel(IAnnotationModel model)
Associates an annotation model with this ruler column. |
void |
setRevisionInformation(RevisionInformation info)
Sets the revision information. |
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 org.eclipse.jface.text.source.LineNumberRulerColumn |
|---|
computeIndentations, getBackground, getControl, getForeground, getParentRuler, getVisibleLinesInViewport, getWidth, handleDispose, isViewerCompletelyShown, layout, paintLine, postRedraw, redraw, setFont, setForeground, updateNumberOfDigits |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.eclipse.jface.text.source.IVerticalRulerColumn |
|---|
getControl, getWidth, redraw, setFont |
| Methods inherited from interface org.eclipse.jface.text.source.IVerticalRulerColumn |
|---|
getControl, getWidth, redraw, setFont |
| Constructor Detail |
|---|
public LineNumberChangeRulerColumn(ISharedTextColors sharedColors)
sharedColors - the shared colors provider to use| Method Detail |
|---|
public Control createControl(CompositeRuler parentRuler,
Composite parentControl)
IVerticalRulerColumn
createControl in interface IVerticalRulerColumncreateControl in class LineNumberRulerColumnparentRuler - the parent ruler of this columnparentControl - the control of the parent ruler
public int getLineOfLastMouseButtonActivity()
IVerticalRulerInfo0.
getLineOfLastMouseButtonActivity in interface IVerticalRulerInfopublic int toDocumentLineNumber(int y_coordinate)
IVerticalRulerInfo
toDocumentLineNumber in interface IVerticalRulerInfoy_coordinate - a y-coordinate of the ruler's SWT control
-1 if that
coordinate does not correspond to a valid document linepublic void setModel(IAnnotationModel model)
IVerticalRulerColumnnull is acceptable and clears the ruler.
setModel in interface IVerticalRulerColumnsetModel in class LineNumberRulerColumnmodel - the new annotation model, may be nullpublic void setDisplayMode(boolean characterMode)
true, diff
information will be displayed textually on the line number ruler.
characterMode - true if diff information is to be displayed textually.public IAnnotationModel getModel()
IVerticalRulerInfoExtension
getModel in interface IVerticalRulerInfoExtensionnull if no model is
installed.protected String createDisplayString(int line)
LineNumberRulerColumnline. The default implementation returns
Integer.toString(line + 1).
createDisplayString in class LineNumberRulerColumnline - the line number for which the line number string is generated
lineprotected int computeNumberOfDigits()
LineNumberRulerColumn
computeNumberOfDigits in class LineNumberRulerColumnpublic void addVerticalRulerListener(IVerticalRulerListener listener)
IVerticalRulerInfoExtension
addVerticalRulerListener in interface IVerticalRulerInfoExtensionlistener - the listener to be informedpublic void removeVerticalRulerListener(IVerticalRulerListener listener)
IVerticalRulerInfoExtensionlistener is not registered
with the receiver, calling this method has no effect.
removeVerticalRulerListener in interface IVerticalRulerInfoExtensionlistener - the listener to be removedpublic IAnnotationHover getHover()
IVerticalRulerInfoExtension
getHover in interface IVerticalRulerInfoExtensionpublic void setHover(IAnnotationHover hover)
IChangeRulerColumn
setHover in interface IChangeRulerColumnhover - the hover that will produce hover information text for this ruler columnpublic void setBackground(Color background)
LineNumberRulerColumn
setBackground in interface IChangeRulerColumnsetBackground in class LineNumberRulerColumnbackground - the background colorpublic void setAddedColor(Color addedColor)
IChangeRulerColumn
setAddedColor in interface IChangeRulerColumnaddedColor - the new color to be used for the added lines backgroundpublic void setChangedColor(Color changedColor)
IChangeRulerColumn
setChangedColor in interface IChangeRulerColumnchangedColor - the new color to be used for the changed lines backgroundpublic void setDeletedColor(Color deletedColor)
IChangeRulerColumn
setDeletedColor in interface IChangeRulerColumndeletedColor - the new color to be used for the deleted lines indicator.public void setRevisionInformation(RevisionInformation info)
IRevisionRulerColumn
setRevisionInformation in interface IRevisionRulerColumninfo - the new revision information, or null to reset the rulerpublic ISelectionProvider getRevisionSelectionProvider()
|
Eclipse Platform Release 3.2 |
|||||||||
| 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, 2006. All rights reserved.