Eclipse Platform
Release 3.2

org.eclipse.jface.text.source
Class LineNumberChangeRulerColumn

java.lang.Object
  extended byorg.eclipse.jface.text.source.LineNumberRulerColumn
      extended byorg.eclipse.jface.text.source.LineNumberChangeRulerColumn
All Implemented Interfaces:
IChangeRulerColumn, IRevisionRulerColumn, IVerticalRulerColumn, IVerticalRulerInfo, IVerticalRulerInfoExtension

public final class LineNumberChangeRulerColumn
extends LineNumberRulerColumn
implements IVerticalRulerInfo, IVerticalRulerInfoExtension, IChangeRulerColumn, IRevisionRulerColumn

A vertical ruler column displaying line numbers and serving as a UI for quick diff. Clients usually instantiate and configure object of this class.

Since:
3.0

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 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.
 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.IVerticalRulerInfo
getControl, getWidth
 
Methods inherited from interface org.eclipse.jface.text.source.IVerticalRulerColumn
getControl, getWidth, redraw, setFont
 

Constructor Detail

LineNumberChangeRulerColumn

public LineNumberChangeRulerColumn(ISharedTextColors sharedColors)
Creates a new instance.

Parameters:
sharedColors - the shared colors provider to use
Method Detail

createControl

public Control createControl(CompositeRuler parentRuler,
                             Composite parentControl)
Description copied from interface: IVerticalRulerColumn
Creates the column's SWT control.

Specified by:
createControl in interface IVerticalRulerColumn
Overrides:
createControl in class LineNumberRulerColumn

getLineOfLastMouseButtonActivity

public int getLineOfLastMouseButtonActivity()
Description copied from interface: IVerticalRulerInfo
Returns the line number of the last mouse button activity. Based on the input document of the connected text viewer. The smallest possible line number is 0.

Specified by:
getLineOfLastMouseButtonActivity in interface IVerticalRulerInfo
Returns:
the line number of the last mouse button activity

toDocumentLineNumber

public int toDocumentLineNumber(int y_coordinate)
Description copied from interface: IVerticalRulerInfo
Translates a y-coordinate of the ruler's SWT control into the according line number of the document of the connected text viewer.

Specified by:
toDocumentLineNumber in interface IVerticalRulerInfo
Parameters:
y_coordinate - a y-coordinate of the ruler's SWT control
Returns:
the line number of that coordinate or -1 if that coordinate does not correspond to a valid document line

setModel

public void setModel(IAnnotationModel model)
Description copied from interface: IVerticalRulerColumn
Associates an annotation model with this ruler column. A value null is acceptable and clears the ruler.

Specified by:
setModel in interface IVerticalRulerColumn
Overrides:
setModel in class LineNumberRulerColumn

setDisplayMode

public void setDisplayMode(boolean characterMode)
Sets the display mode of the ruler. If character mode is set to true, diff information will be displayed textually on the line number ruler.

Parameters:
characterMode - true if diff information is to be displayed textually.

getModel

public IAnnotationModel getModel()
Description copied from interface: IVerticalRulerInfoExtension
Returns the model currently used by the receiver.

Specified by:
getModel in interface IVerticalRulerInfoExtension
Returns:
the model of the receiver, or null if no model is installed.

createDisplayString

protected String createDisplayString(int line)
Description copied from class: LineNumberRulerColumn
Computes the string to be printed for line. The default implementation returns Integer.toString(line + 1).

Overrides:
createDisplayString in class LineNumberRulerColumn
Parameters:
line - the line number for which the line number string is generated
Returns:
the string to be printed on the line number bar for line

computeNumberOfDigits

protected int computeNumberOfDigits()
Description copied from class: LineNumberRulerColumn
Does the real computation of the number of digits. Subclasses may override this method if they need extra space on the line number ruler.

Overrides:
computeNumberOfDigits in class LineNumberRulerColumn
Returns:
the number of digits to be displayed on the line number ruler.

addVerticalRulerListener

public void addVerticalRulerListener(IVerticalRulerListener listener)
Description copied from interface: IVerticalRulerInfoExtension
Registers a vertical ruler listener to be informed if an annotation gets selected on the vertical ruler.

Specified by:
addVerticalRulerListener in interface IVerticalRulerInfoExtension
Parameters:
listener - the listener to be informed

removeVerticalRulerListener

public void removeVerticalRulerListener(IVerticalRulerListener listener)
Description copied from interface: IVerticalRulerInfoExtension
Removes a previously registered listener. If listener is not registered with the receiver, calling this method has no effect.

Specified by:
removeVerticalRulerListener in interface IVerticalRulerInfoExtension
Parameters:
listener - the listener to be removed

getHover

public IAnnotationHover getHover()
Description copied from interface: IVerticalRulerInfoExtension
Returns the hover for this vertical ruler (column).

Specified by:
getHover in interface IVerticalRulerInfoExtension
Returns:
the hover for this column

setHover

public void setHover(IAnnotationHover hover)
Description copied from interface: IChangeRulerColumn
Sets the hover of this ruler column.

Specified by:
setHover in interface IChangeRulerColumn
Parameters:
hover - the hover that will produce hover information text for this ruler column

setBackground

public void setBackground(Color background)
Description copied from interface: IChangeRulerColumn
Sets the background color for normal lines. The color has to be disposed of by the caller when the receiver is no longer used.

Specified by:
setBackground in interface IChangeRulerColumn
Overrides:
setBackground in class LineNumberRulerColumn
Parameters:
background - the background color

setAddedColor

public void setAddedColor(Color addedColor)
Description copied from interface: IChangeRulerColumn
Sets the background color for added lines. The color has to be disposed of by the caller when the receiver is no longer used.

Specified by:
setAddedColor in interface IChangeRulerColumn
Parameters:
addedColor - the new color to be used for the added lines background

setChangedColor

public void setChangedColor(Color changedColor)
Description copied from interface: IChangeRulerColumn
Sets the background color for changed lines. The color has to be disposed of by the caller when the receiver is no longer used.

Specified by:
setChangedColor in interface IChangeRulerColumn
Parameters:
changedColor - the new color to be used for the changed lines background

setDeletedColor

public void setDeletedColor(Color deletedColor)
Description copied from interface: IChangeRulerColumn
Sets the color for the deleted lines indicator. The color has to be disposed of by the caller when the receiver is no longer used.

Specified by:
setDeletedColor in interface IChangeRulerColumn
Parameters:
deletedColor - the new color to be used for the deleted lines indicator.

setRevisionInformation

public void setRevisionInformation(RevisionInformation info)
Description copied from interface: IRevisionRulerColumn
Sets the revision information.

Specified by:
setRevisionInformation in interface IRevisionRulerColumn
Parameters:
info - the new revision information, or null to reset the ruler

getRevisionSelectionProvider

public ISelectionProvider getRevisionSelectionProvider()
Returns the revision selection provider.

Returns:
the revision selection provider
Since:
3.2

Eclipse Platform
Release 3.2

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.