Class orion.editor.OverviewRuler

Extends orion.editor.Ruler.
This objects implements an overview ruler.

See:
orion.editor.AnnotationRuler
orion.editor.Ruler

Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.editor/web/orion/editor/rulers.js>.

Class Summary
Constructor Attributes	Constructor Name and Description
	orion.editor.OverviewRuler(annotationModel, rulerLocation, rulerStyle) Constructs a new overview ruler.

Methods borrowed from class orion.editor.Ruler:: addAnnotationType, getAnnotationModel, getAnnotations, getAnnotationsByType, getAnnotationTypePriority, getLocation, getOverview, getRulerStyle, getView, getWidestAnnotation, isAnnotationTypeVisible, removeAnnotationType, setAnnotationModel, setMultiAnnotation, setMultiAnnotationOverlay, setView

Events borrowed from class orion.editor.Ruler:: onClick, onDblClick, onMouseMove, onMouseOut, onMouseOver

Class Detail

orion.editor.OverviewRuler(annotationModel, rulerLocation, rulerStyle)

Constructs a new overview ruler.

The overview ruler is used in conjunction with a AnnotationRuler, for each annotation in the AnnotationRuler this ruler displays a mark in the overview. Clicking on the mark causes the view to scroll to the annotated line.

Parameters:
{orion.editor.AnnotationModel} annotationModel: the annotation model for the ruler.
{String} rulerLocation Optional, Default: "left": the location for the ruler.
{orion.editor.Style} rulerStyle Optional, Default: undefined: the style for the ruler.

Classes

Class orion.editor.OverviewRuler