Class Index | File Index

Classes


Class orion.textview.OverviewRuler


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

See:
orion.textview.AnnotationRuler
orion.textview.Ruler


Defined in: </shared/eclipse/e4/orion/I201107200200/plugins/org.eclipse.orion.client.editor/web/orion/textview/rulers.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
orion.textview.OverviewRuler(rulerLocation, rulerStyle, annotationRuler)
Contructs an overview ruler.
Methods borrowed from class orion.textview.Ruler:
getAnnotations, getHTML, getLocation, getOverview, getStyle, setView
Events borrowed from class orion.textview.Ruler:
onClick, onDblClick
Class Detail
orion.textview.OverviewRuler(rulerLocation, rulerStyle, annotationRuler)
Contructs an 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:
{String} rulerLocation Optional, Default: "left"
the location for the ruler.
{orion.textview.Style} rulerStyle Optional, Default: undefined
the style for the ruler.
{orion.textview.AnnotationRuler} annotationRuler Optional
the annotation ruler for the overview.

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Jul 20 2011 02:04:44 GMT-0400 (EDT)