Class orion.textview.AnnotationModel
This object manages annotations for a TextModel
.
See:
orion.textview.Annotation
orion.textview.TextModel
Defined in: </shared/eclipse/e4/orion/I201110211442/plugins/org.eclipse.orion.client.editor/web/orion/textview/annotations.js>.
Constructor Attributes | Constructor Name and Description |
---|---|
orion.textview.AnnotationModel(textModel)
Constructs an annotation model.
|
Method Attributes | Method Name and Description |
---|---|
addAnnotation(annotation)
Adds an annotation to the annotation model.
|
|
addListener(listener)
Adds a listener to the model.
|
|
getAnnotations(start, end)
Returns an iterator of annotations for the given range of text.
|
|
Returns the text model.
|
|
modifyAnnotation(annotation)
Notifies the annotation model that the given annotation has been modified.
|
|
onChanged(added, changed, removed, textModelChangedEvent)
Notifies all listeners that the annotation model has changed.
|
|
removeAnnotation(annotation)
Removes an annotation from the annotation model.
|
|
removeAnnotations(type)
Removes all annotations of the given
type . |
|
removeListener(listener)
Removes a listener from the model.
|
|
replaceAnnotations(remove, add)
Removes and adds the specifed annotations to the annotation model.
|
|
setTextModel(textModel)
Sets the text model of the annotation model.
|
Class Detail
orion.textview.AnnotationModel(textModel)
Constructs an annotation model.
- Parameters:
- {textModel} textModel
- The text model.
Method Detail
addAnnotation(annotation)
Adds an annotation to the annotation model.
The annotation model listeners are notified of this change.
- Parameters:
- {orion.textview.Annotation} annotation
- the annotation to be added.
- See:
- #removeAnnotation
addListener(listener)
Adds a listener to the model.
- Parameters:
- {Object} listener
- the listener to add.
- {Function} listener.onChanged Optional
- see #onChanged.
- See:
- #removeListener
{orion.textview.AnnotationIterator}
getAnnotations(start, end)
Returns an iterator of annotations for the given range of text.
- Parameters:
- {Number} start
- the start offset of the range.
- {Number} end
- the end offset of the range.
- Returns:
- {orion.textview.AnnotationIterator} an annotation iterartor.
{orion.textview.TextModel}
getTextModel()
Returns the text model.
- Returns:
- {orion.textview.TextModel} The text model.
- See:
- #setTextModel
modifyAnnotation(annotation)
Notifies the annotation model that the given annotation has been modified.
The annotation model listeners are notified of this change.
- Parameters:
- {orion.textview.Annotation} annotation
- the modified annotation.
- See:
- #addAnnotation
onChanged(added, changed, removed, textModelChangedEvent)
Notifies all listeners that the annotation model has changed.
- Parameters:
- {orion.textview.Annotation[]} added
- The list of annotation being added to the model.
- {orion.textview.Annotation[]} changed
- The list of annotation modified in the model.
- {orion.textview.Annotation[]} removed
- The list of annotation being removed from the model.
- {ModelChangedEvent} textModelChangedEvent
- the text model changed event that trigger this change, can be null if the change was trigger by a method call (for example, #addAnnotation).
removeAnnotation(annotation)
Removes an annotation from the annotation model.
The annotation model listeners are notified of this change.
- Parameters:
- {orion.textview.Annotation} annotation
- the annotation to be removed.
- See:
- #addAnnotation
removeAnnotations(type)
Removes all annotations of the given
type
. All annotations
are removed if the type is not specified.
The annotation model listeners are notified of this change. Only one changed event is generated.
- Parameters:
- {Object} type
- the type of annotations to be removed.
- See:
- #removeAnnotation
removeListener(listener)
Removes a listener from the model.
- Parameters:
- {Object} listener
- the listener to remove
- See:
- #addListener
replaceAnnotations(remove, add)
Removes and adds the specifed annotations to the annotation model.
The annotation model listeners are notified of this change. Only one changed event is generated.
- Parameters:
- {orion.textview.Annotation} remove
- the annotations to be removed.
- {orion.textview.Annotation} add
- the annotations to be added.
setTextModel(textModel)
Sets the text model of the annotation model. The annotation
model listens for changes in the text model to update and remove
annotations that are affected by the change.
- Parameters:
- {orion.textview.TextModel} textModel
- the text model.
- See:
- #getTextModel