|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface defines a visual component which may serve text viewers as an annotation presentation area. Implementers of this interface have to define the presentation modus. This can either depend on the connected viewer's view port or not. If the modus is view port dependent the ruler only shows those annotations that are attached to document regions that are visible in the view port. If independent, the presented annotations can also be attached to invisible document regions. This interfaces comprises three contracts:
IVerticalRulerInfo
).
In order to provide backward compatibility for clients of
IVerticalRuler
, extension interfaces are used as a means of
evolution. The following extension interfaces exist:
IVerticalRulerExtension
since
version 2.0 introducing setters for font and mouse button activity location.CompositeRuler
and
VerticalRuler
.
IVerticalRulerExtension
,
ITextViewer
Method Summary | |
Control |
createControl(Composite parent,
ITextViewer textViewer)
Creates the ruler's SWT control. |
IAnnotationModel |
getModel()
Returns the current annotation model of this ruler or null
if the ruler has no model. |
void |
setModel(IAnnotationModel model)
Associates an annotation model with this ruler. |
void |
update()
Forces the vertical ruler to synchronize itself with its annotation model and its viewer's view port. |
Methods inherited from interface org.eclipse.jface.text.source.IVerticalRulerInfo |
getControl, getLineOfLastMouseButtonActivity, getWidth, toDocumentLineNumber |
Method Detail |
public void setModel(IAnnotationModel model)
null
is acceptable and clears the ruler.
model
- the new annotation model, may be null
public IAnnotationModel getModel()
null
if the ruler has no model.
null
if there is no modelpublic void update()
public Control createControl(Composite parent, ITextViewer textViewer)
parent
- the parent control of the ruler's controltextViewer
- the text viewer to which this ruler belongs
|
Eclipse Platform Release 3.0 |
||||||||||
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, 2004. All rights reserved.