Class orion.editor.AnnotationModel
This object manages annotations for a TextModel
.
See:
orion.editor.Annotation
orion.editor.TextModel
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.editor/web/orion/editor/annotations.js>.
Constructor Attributes | Constructor Name and Description |
---|---|
orion.editor.AnnotationModel(textModel)
Constructs an annotation model.
|
Method Attributes | Method Name and Description |
---|---|
addAnnotation(annotation)
Adds an annotation to the annotation model.
|
|
addEventListener(type, listener, useCapture)
Adds an event listener to this event target.
|
|
dispatchEvent(evt)
Dispatches the given event to the listeners added to this event target.
|
|
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 . |
|
removeEventListener(type, listener, useCapture)
Removes an event listener from the event target.
|
|
replaceAnnotations(remove, add)
Removes and adds the specifed annotations to the annotation model.
|
|
setTextModel(textModel)
Sets the text model of the annotation model.
|
- Parameters:
- {orion.editor.TextModel} textModel
- The text model.
The annotation model listeners are notified of this change.
- Parameters:
- {orion.editor.Annotation} annotation
- the annotation to be added.
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.editor/web/orion/editor/eventTarget.js>.
- Parameters:
- {String} type
- The event type.
- {Function|EventListener} listener
- The function or the EventListener that will be executed when the event happens.
- {Boolean} useCapture Optional, Default: false
true
if the listener should be trigged in the capture phase.
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.editor/web/orion/editor/eventTarget.js>.
- Parameters:
- {Event} evt
- The event to dispatch.
- Parameters:
- {Number} start
- the start offset of the range.
- {Number} end
- the end offset of the range.
- Returns:
- {orion.editor.AnnotationIterator} an annotation iterartor.
- Returns:
- {orion.editor.TextModel} The text model.
The annotation model listeners are notified of this change.
- Parameters:
- {orion.editor.Annotation} annotation
- the modified annotation.
- Parameters:
- {orion.editor.Annotation[]} added
- The list of annotation being added to the model.
- {orion.editor.Annotation[]} changed
- The list of annotation modified in the model.
- {orion.editor.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).
The annotation model listeners are notified of this change.
- Parameters:
- {orion.editor.Annotation} annotation
- the annotation to be removed.
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.
All the parameters must be the same ones used to add the listener.
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.editor/web/orion/editor/eventTarget.js>.
- Parameters:
- {String} type
- The event type
- {Function|EventListener} listener
- The function or the EventListener that will be executed when the event happens.
- {Boolean} useCapture Optional, Default: false
true
if the listener should be trigged in the capture phase.
The annotation model listeners are notified of this change. Only one changed event is generated.
- Parameters:
- {orion.editor.Annotation} remove
- the annotations to be removed.
- {orion.editor.Annotation} add
- the annotations to be added.
- Parameters:
- {orion.editor.TextModel} textModel
- the text model.