Package org.eclipse.jface.text.source
Class CompositeRuler
- java.lang.Object
-
- org.eclipse.jface.text.source.CompositeRuler
-
- All Implemented Interfaces:
IVerticalRuler,IVerticalRulerExtension,IVerticalRulerInfo,IVerticalRulerInfoExtension
public class CompositeRuler extends Object implements IVerticalRuler, IVerticalRulerExtension, IVerticalRulerInfoExtension
Standard implementation ofIVerticalRuler.This ruler does not have a a visual representation of its own. The presentation comes from the configurable list of vertical ruler columns. Such columns must implement the
IVerticalRulerColumn. interface.Clients may instantiate and configure this class.
- Since:
- 2.0
- See Also:
IVerticalRulerColumn,ITextViewer
-
-
Constructor Summary
Constructors Constructor Description CompositeRuler()Constructs a new composite vertical ruler.CompositeRuler(int gap)Constructs a new composite ruler with the given gap between its columns.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddDecorator(int index, IVerticalRulerColumn rulerColumn)Inserts the given column at the specified slot to this composite ruler.voidaddVerticalRulerListener(IVerticalRulerListener listener)Registers a vertical ruler listener to be informed if an annotation gets selected on the vertical ruler.ControlcreateControl(Composite parent, ITextViewer textViewer)Creates the ruler's SWT control.voidfireAnnotationContextMenuAboutToShow(VerticalRulerEvent event, Menu menu)Informs all registered vertical ruler listeners that the content menu on a selected annotation\ is about to be shown.voidfireAnnotationDefaultSelected(VerticalRulerEvent event)Fires the annotation default selected event to all registered vertical ruler listeners.voidfireAnnotationSelected(VerticalRulerEvent event)Fires the annotation selected event to all registered vertical ruler listeners.ControlgetControl()Returns the ruler's SWT control.Iterator<IVerticalRulerColumn>getDecoratorIterator()Returns an iterator over theIVerticalRulerColumnsthat make up this composite column.IAnnotationHovergetHover()Returns the hover for this vertical ruler (column).intgetLineOfLastMouseButtonActivity()Returns the line number of the last mouse button activity.IAnnotationModelgetModel()Returns the current annotation model of this ruler ornullif the ruler has no model.ITextViewergetTextViewer()Returns this ruler's text viewer.intgetWidth()Returns the width of this ruler's control.voidimmediateUpdate()Immediately redraws the entire ruler (without asynchronous posting).voidrelayout()Relayouts the receiver.voidremoveDecorator(int index)Removes the decorator in the specified slot from this composite ruler.voidremoveDecorator(IVerticalRulerColumn rulerColumn)Removes the given decorator from the composite ruler.voidremoveVerticalRulerListener(IVerticalRulerListener listener)Removes a previously registered listener.voidsetFont(Font font)Sets the font of this vertical ruler.voidsetLocationOfLastMouseButtonActivity(int x, int y)Sets the location of the last mouse button activity.voidsetModel(IAnnotationModel model)Associates an annotation model with this ruler.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.voidupdate()Forces the vertical ruler to synchronize itself with its annotation model and its viewer's view port.protected static intwidgetLine2ModelLine(ITextViewer viewer, int widgetLine)Returns the line in the given viewer's document that correspond to the given line of the viewer's widget.
-
-
-
Method Detail
-
addDecorator
public void addDecorator(int index, IVerticalRulerColumn rulerColumn)Inserts the given column at the specified slot to this composite ruler. Columns are counted from left to right.- Parameters:
index- the indexrulerColumn- the decorator to be inserted
-
removeDecorator
public void removeDecorator(int index)
Removes the decorator in the specified slot from this composite ruler.- Parameters:
index- the index
-
removeDecorator
public void removeDecorator(IVerticalRulerColumn rulerColumn)
Removes the given decorator from the composite ruler.- Parameters:
rulerColumn- the ruler column to be removed- Since:
- 3.0
-
getControl
public Control getControl()
Description copied from interface:IVerticalRulerInfoReturns the ruler's SWT control.- Specified by:
getControlin interfaceIVerticalRulerInfo- Returns:
- the ruler's SWT control
-
createControl
public Control createControl(Composite parent, ITextViewer textViewer)
Description copied from interface:IVerticalRulerCreates the ruler's SWT control.- Specified by:
createControlin interfaceIVerticalRuler- Parameters:
parent- the parent control of the ruler's controltextViewer- the text viewer to which this ruler belongs- Returns:
- the ruler's SWT control
-
setModel
public void setModel(IAnnotationModel model)
Description copied from interface:IVerticalRulerAssociates an annotation model with this ruler. A valuenullis acceptable and clears the ruler.- Specified by:
setModelin interfaceIVerticalRuler- Parameters:
model- the new annotation model, may benull
-
getModel
public IAnnotationModel getModel()
Description copied from interface:IVerticalRulerReturns the current annotation model of this ruler ornullif the ruler has no model.- Specified by:
getModelin interfaceIVerticalRuler- Specified by:
getModelin interfaceIVerticalRulerInfoExtension- Returns:
- this ruler's annotation model or
nullif there is no model
-
update
public void update()
Description copied from interface:IVerticalRulerForces the vertical ruler to synchronize itself with its annotation model and its viewer's view port.- Specified by:
updatein interfaceIVerticalRuler
-
immediateUpdate
public void immediateUpdate()
Immediately redraws the entire ruler (without asynchronous posting).- Since:
- 3.2
-
setFont
public void setFont(Font font)
Description copied from interface:IVerticalRulerExtensionSets the font of this vertical ruler.- Specified by:
setFontin interfaceIVerticalRulerExtension- Parameters:
font- the new font of the vertical ruler
-
getWidth
public int getWidth()
Description copied from interface:IVerticalRulerInfoReturns the width of this ruler's control.- Specified by:
getWidthin interfaceIVerticalRulerInfo- Returns:
- the width of this ruler's control
-
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
-
widgetLine2ModelLine
protected static final int widgetLine2ModelLine(ITextViewer viewer, int widgetLine)
Returns the line in the given viewer's document that correspond to the given line of the viewer's widget.- Parameters:
viewer- the viewerwidgetLine- the widget line- Returns:
- the corresponding line the viewer's document
- Since:
- 2.1
-
getTextViewer
public ITextViewer getTextViewer()
Returns this ruler's text viewer.- Returns:
- this ruler's text viewer
-
setLocationOfLastMouseButtonActivity
public void setLocationOfLastMouseButtonActivity(int x, int y)Description copied from interface:IVerticalRulerExtensionSets the location of the last mouse button activity. This method is used for example by external mouse listeners.- Specified by:
setLocationOfLastMouseButtonActivityin interfaceIVerticalRulerExtension- Parameters:
x- the x-coordinatey- the y-coordinate
-
getDecoratorIterator
public Iterator<IVerticalRulerColumn> getDecoratorIterator()
Returns an iterator over theIVerticalRulerColumnsthat make up this composite column.- Returns:
- an iterator over the contained columns.
- Since:
- 3.0
-
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
-
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
-
fireAnnotationSelected
public void fireAnnotationSelected(VerticalRulerEvent event)
Fires the annotation selected event to all registered vertical ruler listeners. TODO use robust iterators- Parameters:
event- the event to fire- Since:
- 3.0
-
fireAnnotationDefaultSelected
public void fireAnnotationDefaultSelected(VerticalRulerEvent event)
Fires the annotation default selected event to all registered vertical ruler listeners. TODO use robust iterators- Parameters:
event- the event to fire- Since:
- 3.0
-
fireAnnotationContextMenuAboutToShow
public void fireAnnotationContextMenuAboutToShow(VerticalRulerEvent event, Menu menu)
Informs all registered vertical ruler listeners that the content menu on a selected annotation\ is about to be shown. TODO use robust iterators- Parameters:
event- the event to firemenu- the menu that is about to be shown- Since:
- 3.0
-
relayout
public void relayout()
Relayouts the receiver.- Since:
- 3.3
-
-