Package org.eclipse.jface.text.source
Class ChangeRulerColumn
- java.lang.Object
-
- org.eclipse.jface.text.source.ChangeRulerColumn
-
- All Implemented Interfaces:
IRevisionRulerColumn,IChangeRulerColumn,IVerticalRulerColumn,IVerticalRulerInfo,IVerticalRulerInfoExtension
public final class ChangeRulerColumn extends Object implements IChangeRulerColumn, IRevisionRulerColumn
A vertical ruler column displaying line numbers and serving as a UI for quick diff. Clients 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
Constructors Constructor Description ChangeRulerColumn()Deprecated.since 3.2 useChangeRulerColumn(ISharedTextColors)insteadChangeRulerColumn(ISharedTextColors sharedColors)Creates a new revision ruler column.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddVerticalRulerListener(IVerticalRulerListener listener)Registers a vertical ruler listener to be informed if an annotation gets selected on the vertical ruler.ControlcreateControl(CompositeRuler parentRuler, Composite parentControl)Creates the column's SWT control.ControlgetControl()Returns the column's SWT control.IAnnotationHovergetHover()Returns the hover for this vertical ruler (column).intgetLineOfLastMouseButtonActivity()Returns the line number of the last mouse button activity.IAnnotationModelgetModel()Returns the model currently used by the receiver.ISelectionProvidergetRevisionSelectionProvider()Returns the revision selection provider.protected intgetVisibleLinesInViewport()Deprecated.as of 3.2 the number of lines in the viewport cannot be computed because StyledText supports variable line heightsintgetWidth()Returns the width of this column's control.protected voidhandleDispose()Disposes the column's resources.protected booleanisViewerCompletelyShown()Returnstrueif the viewport displays the entire viewer contents, i.e. the viewer is not vertically scrollable.protected voidpostRedraw()Triggers a redraw in the display thread.voidredraw()Redraws this column.voidremoveVerticalRulerListener(IVerticalRulerListener listener)Removes a previously registered listener.voidsetAddedColor(Color addedColor)Sets the background color for added lines.voidsetBackground(Color background)Sets the background color for normal lines.voidsetChangedColor(Color changedColor)Sets the background color for changed lines.voidsetDeletedColor(Color deletedColor)Sets the color for the deleted lines indicator.voidsetFont(Font font)Sets the font of this ruler column.voidsetHover(IAnnotationHover hover)Sets the hover of this ruler column.voidsetModel(IAnnotationModel model)Associates an annotation model with this ruler column.voidsetRevisionInformation(RevisionInformation info)Sets the revision information.inttoDocumentLineNumber(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.
-
-
-
Constructor Detail
-
ChangeRulerColumn
@Deprecated public ChangeRulerColumn()
Deprecated.since 3.2 useChangeRulerColumn(ISharedTextColors)insteadCreates a new ruler column.
-
ChangeRulerColumn
public ChangeRulerColumn(ISharedTextColors sharedColors)
Creates a new revision ruler column.- Parameters:
sharedColors- the colors to look up RGBs- Since:
- 3.2
-
-
Method Detail
-
createControl
public Control createControl(CompositeRuler parentRuler, Composite parentControl)
Description copied from interface:IVerticalRulerColumnCreates the column's SWT control.- Specified by:
createControlin interfaceIVerticalRulerColumn- Parameters:
parentRuler- the parent ruler of this columnparentControl- the control of the parent ruler- Returns:
- the column's SWT control
-
handleDispose
protected void handleDispose()
Disposes the column's resources.
-
getVisibleLinesInViewport
@Deprecated protected int getVisibleLinesInViewport()
Deprecated.as of 3.2 the number of lines in the viewport cannot be computed because StyledText supports variable line heightsReturns the view port height in lines.- Returns:
- the view port height in lines
-
isViewerCompletelyShown
protected final boolean isViewerCompletelyShown()
Returnstrueif the viewport displays the entire viewer contents, i.e. the viewer is not vertically scrollable.- Returns:
trueif the viewport displays the entire contents,falseotherwise- Since:
- 3.2
-
redraw
public void redraw()
Description copied from interface:IVerticalRulerColumnRedraws this column.- Specified by:
redrawin interfaceIVerticalRulerColumn
-
setFont
public void setFont(Font font)
Description copied from interface:IVerticalRulerColumnSets the font of this ruler column.- Specified by:
setFontin interfaceIVerticalRulerColumn- Parameters:
font- the new font of the ruler column
-
getLineOfLastMouseButtonActivity
public int getLineOfLastMouseButtonActivity()
Description copied from interface:IVerticalRulerInfoReturns the line number of the last mouse button activity. Based on the input document of the connected text viewer.- Specified by:
getLineOfLastMouseButtonActivityin interfaceIVerticalRulerInfo- Returns:
- the line number of the last mouse button activity or
-1if the last mouse activity does not correspond to a valid document line
-
toDocumentLineNumber
public int toDocumentLineNumber(int y_coordinate)
Description copied from interface:IVerticalRulerInfoTranslates a y-coordinate of the ruler's SWT control into the according line number of the document of the connected text viewer.- Specified by:
toDocumentLineNumberin interfaceIVerticalRulerInfo- Parameters:
y_coordinate- a y-coordinate of the ruler's SWT control- Returns:
- the line number of that coordinate or
-1if that coordinate does not correspond to a valid document line
-
getHover
public IAnnotationHover getHover()
Description copied from interface:IVerticalRulerInfoExtensionReturns the hover for this vertical ruler (column).- Specified by:
getHoverin interfaceIVerticalRulerInfoExtension- Returns:
- the hover for this column
-
setHover
public void setHover(IAnnotationHover hover)
Description copied from interface:IChangeRulerColumnSets the hover of this ruler column.- Specified by:
setHoverin interfaceIChangeRulerColumn- Parameters:
hover- the hover that will produce hover information text for this ruler column
-
setModel
public void setModel(IAnnotationModel model)
Description copied from interface:IVerticalRulerColumnAssociates an annotation model with this ruler column. A valuenullis acceptable and clears the ruler.- Specified by:
setModelin interfaceIVerticalRulerColumn- Parameters:
model- the new annotation model, may benull
-
setBackground
public void setBackground(Color background)
Description copied from interface:IChangeRulerColumnSets 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:
setBackgroundin interfaceIChangeRulerColumn- Parameters:
background- the new color to be used as standard line background
-
setAddedColor
public void setAddedColor(Color addedColor)
Description copied from interface:IChangeRulerColumnSets 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:
setAddedColorin interfaceIChangeRulerColumn- Parameters:
addedColor- the new color to be used for the added lines background
-
setChangedColor
public void setChangedColor(Color changedColor)
Description copied from interface:IChangeRulerColumnSets 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:
setChangedColorin interfaceIChangeRulerColumn- Parameters:
changedColor- the new color to be used for the changed lines background
-
setDeletedColor
public void setDeletedColor(Color deletedColor)
Description copied from interface:IChangeRulerColumnSets 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:
setDeletedColorin interfaceIChangeRulerColumn- Parameters:
deletedColor- the new color to be used for the deleted lines indicator.
-
getModel
public IAnnotationModel getModel()
Description copied from interface:IVerticalRulerInfoExtensionReturns the model currently used by the receiver.- Specified by:
getModelin interfaceIVerticalRulerInfoExtension- Returns:
- the model of the receiver, or
nullif no model is installed.
-
getControl
public Control getControl()
Description copied from interface:IVerticalRulerColumnReturns the column's SWT control.- Specified by:
getControlin interfaceIVerticalRulerColumn- Specified by:
getControlin interfaceIVerticalRulerInfo- Returns:
- the column's SWT control
-
getWidth
public int getWidth()
Description copied from interface:IVerticalRulerColumnReturns the width of this column's control.- Specified by:
getWidthin interfaceIVerticalRulerColumn- Specified by:
getWidthin interfaceIVerticalRulerInfo- Returns:
- the width of this column's control
-
postRedraw
protected final void postRedraw()
Triggers a redraw in the display thread.
-
addVerticalRulerListener
public void addVerticalRulerListener(IVerticalRulerListener listener)
Description copied from interface:IVerticalRulerInfoExtensionRegisters a vertical ruler listener to be informed if an annotation gets selected on the vertical ruler.- Specified by:
addVerticalRulerListenerin interfaceIVerticalRulerInfoExtension- Parameters:
listener- the listener to be informed
-
removeVerticalRulerListener
public void removeVerticalRulerListener(IVerticalRulerListener listener)
Description copied from interface:IVerticalRulerInfoExtensionRemoves a previously registered listener. Iflisteneris not registered with the receiver, calling this method has no effect.- Specified by:
removeVerticalRulerListenerin interfaceIVerticalRulerInfoExtension- Parameters:
listener- the listener to be removed
-
setRevisionInformation
public void setRevisionInformation(RevisionInformation info)
Description copied from interface:IRevisionRulerColumnSets the revision information.- Specified by:
setRevisionInformationin interfaceIRevisionRulerColumn- Parameters:
info- the new revision information, ornullto reset the ruler
-
getRevisionSelectionProvider
public ISelectionProvider getRevisionSelectionProvider()
Returns the revision selection provider.- Returns:
- the revision selection provider
- Since:
- 3.2
-
-