All Known Subinterfaces:
All Known Implementing Classes:
public interface IVerticalRuler
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:
- The vertical ruler retrieves the annotations it presents from an
- The ruler is a visual component which must be integrated in a hierarchy
of SWT controls.
- The ruler provides interested clients with mapping and interaction
information. This covers the mapping between coordinates of the ruler's
control and line numbers based on the connected text viewer's document (see
In order to provide backward compatibility for clients of
IVerticalRuler, extension interfaces are used as a means of
evolution. The following extension interfaces exist:
Clients may implement this interface or use the default implementation
- Associates an annotation model with this ruler.
null is acceptable and clears the ruler.
model - the new annotation model, may be
- Returns the current annotation model of this ruler or
if the ruler has no model.
- this ruler's annotation model or
null if there is no model
- Forces the vertical ruler to synchronize itself with its
annotation model and its viewer's view port.
- Creates the ruler's SWT control.
parent - the parent control of the ruler's control
textViewer - the text viewer to which this ruler belongs
- the ruler's SWT control
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.