|
Eclipse Platform Release 3.3 |
|||||||||||
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
A vertical ruler column displaying line numbers and serving as a UI for quick diff. Clients usually instantiate and configure object of this class.
Nested Class Summary |
---|
Nested classes inherited from class org.eclipse.jface.text.revisions.IRevisionRulerColumnExtension |
---|
IRevisionRulerColumnExtension.RenderingMode |
Field Summary |
---|
Fields inherited from interface org.eclipse.jface.text.source.IChangeRulerColumn |
---|
QUICK_DIFF_MODEL_ID |
Fields inherited from interface org.eclipse.jface.text.revisions.IRevisionRulerColumnExtension |
---|
AGE, AUTHOR, AUTHOR_SHADED_BY_AGE |
Constructor Summary | |
---|---|
LineNumberChangeRulerColumn(ISharedTextColors sharedColors)
Creates a new instance. |
Method Summary | |
---|---|
void |
addRevisionListener(IRevisionListener listener)
Adds a revision listener that will be notified when the displayed revision information changes. |
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. |
int |
getWidth()
Returns the width of this ruler's control. |
protected void |
handleDispose()
Disposes the column's resources. |
boolean |
isShowingChangeInformation()
Returns true if the ruler is showing change information, false
otherwise |
boolean |
isShowingLineNumbers()
Returns true if the ruler is showing line numbers, false
otherwise |
boolean |
isShowingRevisionInformation()
Returns true if the ruler is showing revision information, false
otherwise |
void |
removeRevisionListener(IRevisionListener listener)
Removes a previously registered revision listener; nothing happens if listener
was not registered with the receiver. |
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 |
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. |
void |
setRevisionRenderingMode(IRevisionRulerColumnExtension.RenderingMode renderingMode)
Changes the rendering mode and triggers redrawing if needed. |
void |
showLineNumbers(boolean showNumbers)
Sets the line number display mode. |
void |
showRevisionAuthor(boolean show)
Enables showing the revision author. |
void |
showRevisionId(boolean show)
Enables showing the revision id. |
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, 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.IVerticalRulerInfo |
---|
getControl |
Methods inherited from interface org.eclipse.jface.text.source.IVerticalRulerColumn |
---|
getControl, redraw, setFont |
Constructor Detail |
public LineNumberChangeRulerColumn(ISharedTextColors sharedColors)
sharedColors
- the shared colors provider to useMethod Detail |
public Control createControl(CompositeRuler parentRuler, Composite parentControl)
IVerticalRulerColumn
createControl
in interface IVerticalRulerColumn
createControl
in class LineNumberRulerColumn
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 void setModel(IAnnotationModel model)
IVerticalRulerColumn
null
is acceptable and clears the ruler.
setModel
in interface IVerticalRulerColumn
setModel
in class LineNumberRulerColumn
public 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 IVerticalRulerInfoExtension
null
if no model is
installed.protected String createDisplayString(int line)
LineNumberRulerColumn
line
. The default implementation returns
Integer.toString(line + 1)
.
createDisplayString
in class LineNumberRulerColumn
line
- the line number for which the line number string is generated
line
protected int computeNumberOfDigits()
LineNumberRulerColumn
computeNumberOfDigits
in class LineNumberRulerColumn
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 removedpublic 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 setBackground(Color background)
IChangeRulerColumn
setBackground
in interface IChangeRulerColumn
setBackground
in class LineNumberRulerColumn
background
- the background colorpublic 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 void setRevisionInformation(RevisionInformation info)
IRevisionRulerColumn
setRevisionInformation
in interface IRevisionRulerColumn
info
- the new revision information, or null
to reset the rulerpublic ISelectionProvider getRevisionSelectionProvider()
IRevisionRulerColumnExtension
getRevisionSelectionProvider
in interface IRevisionRulerColumnExtension
public void setRevisionRenderingMode(IRevisionRulerColumnExtension.RenderingMode renderingMode)
IRevisionRulerColumnExtension
setRevisionRenderingMode
in interface IRevisionRulerColumnExtension
renderingMode
- the rendering modepublic void showLineNumbers(boolean showNumbers)
showNumbers
- true
to show numbers, false
to only show
diff / revision info.public int getWidth()
IVerticalRulerInfo
getWidth
in interface IVerticalRulerInfo
getWidth
in class LineNumberRulerColumn
public boolean isShowingLineNumbers()
true
if the ruler is showing line numbers, false
otherwise
true
if line numbers are shown, false
otherwisepublic boolean isShowingRevisionInformation()
true
if the ruler is showing revision information, false
otherwise
true
if revision information is shown, false
otherwisepublic boolean isShowingChangeInformation()
true
if the ruler is showing change information, false
otherwise
true
if change information is shown, false
otherwisepublic void showRevisionAuthor(boolean show)
IRevisionRulerColumnExtension
showRevisionAuthor
in interface IRevisionRulerColumnExtension
show
- true
to show the author, false
to hide itpublic void showRevisionId(boolean show)
IRevisionRulerColumnExtension
showRevisionId
in interface IRevisionRulerColumnExtension
show
- true
to show the revision, false
to hide itpublic void addRevisionListener(IRevisionListener listener)
IRevisionRulerColumnExtension
addRevisionListener
in interface IRevisionRulerColumnExtension
listener
- the listener to addpublic void removeRevisionListener(IRevisionListener listener)
IRevisionRulerColumnExtension
listener
was not registered with the receiver.
removeRevisionListener
in interface IRevisionRulerColumnExtension
listener
- the listener to removeprotected void handleDispose()
LineNumberRulerColumn
handleDispose
in class LineNumberRulerColumn
|
Eclipse Platform Release 3.3 |
|||||||||||
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, 2007. All rights reserved.