Class orion.textview.AnnotationTypeList
This represents an interface of prioritized annotation types.
Defined in: </shared/eclipse/e4/orion/I201301232230/plugins/org.eclipse.orion.client.editor/web/orion/textview/annotations.js>.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Constructs a new AnnotationTypeList object.
|
| Method Attributes | Method Name and Description |
|---|---|
|
addAnnotationType(type)
Adds an annotation type to the receiver.
|
|
|
getAnnotationsByType(annotationModel, start, end)
Returns an array of annotations in the specified annotation model for the given range of text sorted by type.
|
|
|
Gets the annotation type priority.
|
|
|
isAnnotationTypeVisible(type)
Returns whether the receiver shows annotations of the specified type.
|
|
|
removeAnnotationType(type)
Removes an annotation type from the receiver.
|
Method Detail
addAnnotationType(type)
Adds an annotation type to the receiver.
Only annotations of the specified types will be shown by the receiver.
- Parameters:
- {Object} type
- the annotation type to be shown
{orion.textview.Annotation[]}
getAnnotationsByType(annotationModel, start, end)
Returns an array of annotations in the specified annotation model for the given range of text sorted by type.
- Parameters:
- {orion.textview.AnnotationModel} annotationModel
- the annotation model.
- {Number} start
- the start offset of the range.
- {Number} end
- the end offset of the range.
- Returns:
- {orion.textview.Annotation[]} an annotation array.
getAnnotationTypePriority(type)
Gets the annotation type priority. The priority is determined by the
order the annotation type is added to the receiver. Annotation types
added first have higher priority.
Returns 0 if the annotation type is not added.
- Parameters:
- {Object} type
- the annotation type
{Boolean}
isAnnotationTypeVisible(type)
Returns whether the receiver shows annotations of the specified type.
- Parameters:
- {Object} type
- the annotation type
- Returns:
- {Boolean} whether the specified annotation type is shown
removeAnnotationType(type)
Removes an annotation type from the receiver.
- Parameters:
- {Object} type
- the annotation type to be removed