org.eclipse.jface.text.source
Interface IAnnotationModel
-
All Known Implementing Classes:
-
AbstractMarkerAnnotationModel,
AnnotationModel,
ProjectionAnnotationModel,
ResourceMarkerAnnotationModel
-
public interface IAnnotationModel
This interface defines the model for managing annotations attached to a document.
The model maintains a set of annotations for a given document and notifies registered annotation
model listeners about annotation model changes. It also provides methods
for querying the current position of an annotation managed
by this model.
In order to provide backward compatibility for clients of IAnnotationModel, extension
interfaces are used to provide a means of evolution. The following extension interfaces
exist:
-
IAnnotationModelExtension since version 3.0 introducing the concept
of model piggybacking annotation models, modification time stamps, and enhanced manipulation methods.
-
IAnnotationModelExtension2 since version 3.4 allows to retrieve
annotations within a given region.
Clients may implement this interface or use the default implementation provided
by
AnnotationModel.
-
See Also:
-
IAnnotationModelExtension,
IAnnotationModelExtension2,
Annotation,
IAnnotationModelListener
addAnnotationModelListener
void addAnnotationModelListener(
IAnnotationModelListener listener)
- Registers the annotation model listener with this annotation model.
After registration listener is informed about each change of this model.
If the listener is already registered nothing happens.
-
-
Parameters:
-
listener - the listener to be registered, may not be null
removeAnnotationModelListener
void removeAnnotationModelListener(
IAnnotationModelListener listener)
- Removes the listener from the model's list of annotation model listeners.
If the listener is not registered with the model nothing happens.
-
-
Parameters:
-
listener - the listener to be removed, may not be null
connect
void connect(
IDocument document)
- Connects the annotation model to a document. The annotations managed
by this model must subsequently update according to the changes applied
to the document. Once an annotation model is connected to a document,
all further
connect calls must mention the document the
model is already connected to. An annotation model primarily uses
connect and disconnect for reference counting
the document. Reference counting frees the clients from keeping tracker
whether a model has already been connected to a document.
-
-
Parameters:
-
document - the document the model gets connected to,
may not be null
-
See Also:
-
disconnect(IDocument)
disconnect
void disconnect(
IDocument document)
- Disconnects this model from a document. After that, document changes no longer matter.
An annotation model may only be disconnected from a document to which it has been
connected before. If the model reference counts the connections to a document,
the connection to the document may only be terminated if the reference count does
down to 0.
-
-
Parameters:
-
document - the document the model gets disconnected from,
may not be null
-
See Also:
-
for further specification details
addAnnotation
void addAnnotation(
Annotation annotation,
Position position)
- Adds a annotation to this annotation model. The annotation is associated with
with the given position which describes the range covered by the annotation.
All registered annotation model listeners are informed about the change.
If the model is connected to a document, the position is automatically
updated on document changes. If the annotation is already managed by
this annotation model or is not a valid position in the connected document
nothing happens.
Performance hint: Use
IAnnotationModelExtension.replaceAnnotations(Annotation[], java.util.Map)
if several annotations are added and/or removed.
-
-
Parameters:
-
annotation - the annotation to add, may not be null
-
position - the position describing the range covered by this annotation,
may not be null
removeAnnotation
void removeAnnotation(
Annotation annotation)
- Removes the given annotation from the model. I.e. the annotation is no
longer managed by this model. The position associated with the annotation
is no longer updated on document changes. If the annotation is not
managed by this model, nothing happens.
Performance hint: Use
IAnnotationModelExtension.replaceAnnotations(Annotation[], java.util.Map)
if several annotations are removed and/or added.
-
-
Parameters:
-
annotation - the annotation to be removed from this model,
may not be null
getAnnotationIterator
Iterator getAnnotationIterator()
- Returns all annotations managed by this model.
-
-
Returns:
- all annotations managed by this model (element type:
Annotation)
getPosition
Position getPosition(
Annotation annotation)
- Returns the position associated with the given annotation.
-
-
Parameters:
-
annotation - the annotation whose position should be returned
-
Returns:
- the position of the given annotation or
null if no
associated annotation exists
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
