Class orion.textview.AnnotationRuler
Extends
orion.textview.Ruler.
This objects implements an annotation ruler.
See:
orion.textview.Ruler
orion.textview.Annotation
Defined in: </shared/eclipse/e4/orion/I201107200200/plugins/org.eclipse.orion.client.editor/web/orion/textview/rulers.js>.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
orion.textview.AnnotationRuler(rulerLocation, rulerStyle, defaultAnnotation)
Contructs a new annotation ruler.
|
| Method Attributes | Method Name and Description |
|---|---|
|
Removes all annotations in the ruler.
|
|
|
getAnnotation(lineIndex)
Returns the annotation for the given line index.
|
|
|
setAnnotation(lineIndex, annotation)
Sets the annotation in the given line index.
|
- 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.AnnotationRuler(rulerLocation, rulerStyle, defaultAnnotation)
Contructs a new annotation ruler.
- 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.Annotation} defaultAnnotation Optional
- the default annotation.
Method Detail
clearAnnotations()
Removes all annotations in the ruler.
{orion.textview.Annotation}
getAnnotation(lineIndex)
Returns the annotation for the given line index.
- Parameters:
- {Number} lineIndex
- the line index
- Returns:
- {orion.textview.Annotation} the annotation for the given line, or undefined
- See:
- #setAnnotation
setAnnotation(lineIndex, annotation)
Sets the annotation in the given line index.
- Parameters:
- {Number} lineIndex
- the line index
- {orion.textview.Annotation} annotation
- the annotation