Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKai Maetzel2004-06-21 19:14:07 +0000
committerKai Maetzel2004-06-21 19:14:07 +0000
commit1ef22dafac7aae07178f67654ed1f3976b7db2e0 (patch)
treec411dc29b4752ebb640b4e697c24917f8388b4d4
parent1bcf6563825e119e90dc06b00dce6ab0975bd2f0 (diff)
downloadeclipse.platform.text-1ef22dafac7aae07178f67654ed1f3976b7db2e0.tar.gz
eclipse.platform.text-1ef22dafac7aae07178f67654ed1f3976b7db2e0.tar.xz
eclipse.platform.text-1ef22dafac7aae07178f67654ed1f3976b7db2e0.zip
updated Javadoc
-rw-r--r--org.eclipse.text/src/org/eclipse/jface/text/package.html2
-rw-r--r--org.eclipse.text/src/org/eclipse/jface/text/source/Annotation.java21
-rw-r--r--org.eclipse.text/src/org/eclipse/jface/text/source/AnnotationMap.java8
-rw-r--r--org.eclipse.text/src/org/eclipse/jface/text/source/AnnotationModel.java28
-rw-r--r--org.eclipse.text/src/org/eclipse/jface/text/source/AnnotationModelEvent.java21
-rw-r--r--org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationMap.java14
-rw-r--r--org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModel.java20
-rw-r--r--org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModelExtension.java36
-rw-r--r--org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModelListener.java25
-rw-r--r--org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModelListenerExtension.java8
-rw-r--r--org.eclipse.text/src/org/eclipse/jface/text/source/package.html16
11 files changed, 123 insertions, 76 deletions
diff --git a/org.eclipse.text/src/org/eclipse/jface/text/package.html b/org.eclipse.text/src/org/eclipse/jface/text/package.html
index f36c097e8..fbaa19f8a 100644
--- a/org.eclipse.text/src/org/eclipse/jface/text/package.html
+++ b/org.eclipse.text/src/org/eclipse/jface/text/package.html
@@ -2,7 +2,7 @@
<html><head>
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<meta content="IBM" name="Author">
- <meta content="Mozilla/4.75 [en] (Windows NT 5.0; U) [Netscape]" name="GENERATOR"><title>Linked Position Infrastructure</title></head>
+ <meta content="Mozilla/4.75 [en] (Windows NT 5.0; U) [Netscape]" name="GENERATOR"><title>text infrastructure</title></head>
<body>
<p>Provides a framework for creating and manipulating text documents.</p>
diff --git a/org.eclipse.text/src/org/eclipse/jface/text/source/Annotation.java b/org.eclipse.text/src/org/eclipse/jface/text/source/Annotation.java
index 9ece8375e..6cdd3ecf8 100644
--- a/org.eclipse.text/src/org/eclipse/jface/text/source/Annotation.java
+++ b/org.eclipse.text/src/org/eclipse/jface/text/source/Annotation.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -11,20 +11,19 @@
package org.eclipse.jface.text.source;
-
/**
- * Annotation managed by an <code>IAnnotationModel</code>.
- * Annotations are considered being located at layers and are considered being painted
- * starting with layer 0 upwards. Thus an annotation of layer 5 will be drawn on top of
- * all co-located annotations at the layers 4 - 0. Subclasses must provide the annotations
- * paint method.
- *
- * @see IVerticalRuler
+ * Annotation managed by an
+ * {@link org.eclipse.jface.text.source.IAnnotationModel}.
+ * <p>
+ * Annotations are types, associated text, and can be marked as persistent and
+ * deleted. Annotations which are not explicitly initialized with an annotation
+ * type are of type <code>"org.eclipse.text.annotation.unknown"</code>.
*/
public class Annotation {
/**
- * Constant for unknown annotation types.
+ * Constant for unknown annotation types.<p>
+ * Value: <code>"org.eclipse.text.annotation.unknown"</code>
* @since 3.0
*/
public final static String TYPE_UNKNOWN= "org.eclipse.text.annotation.unknown"; //$NON-NLS-1$
@@ -75,7 +74,7 @@ public class Annotation {
}
/**
- * Creates a new annotation.
+ * Creates a new annotation with the given persistence state.
*
* @param isPersistent <code>true</code> if persistent, <code>false</code> otherwise
* @since 3.0
diff --git a/org.eclipse.text/src/org/eclipse/jface/text/source/AnnotationMap.java b/org.eclipse.text/src/org/eclipse/jface/text/source/AnnotationMap.java
index 6fa57e175..df0194437 100644
--- a/org.eclipse.text/src/org/eclipse/jface/text/source/AnnotationMap.java
+++ b/org.eclipse.text/src/org/eclipse/jface/text/source/AnnotationMap.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -10,6 +10,7 @@
*******************************************************************************/
package org.eclipse.jface.text.source;
+
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
@@ -17,8 +18,9 @@ import java.util.Iterator;
import java.util.Map;
import java.util.Set;
+
/**
- * Internal implementation of <code>IAnnotationMap</code>.
+ * Internal implementation of {@link org.eclipse.jface.text.source.IAnnotationMap}.
*
* @since 3.0
*/
@@ -26,7 +28,7 @@ class AnnotationMap implements IAnnotationMap {
/**
* The lock object used to synchronize the operations explicitly defined by
- * IAnnotationMap
+ * <code>IAnnotationMap</code>
*/
private Object fLockObject;
diff --git a/org.eclipse.text/src/org/eclipse/jface/text/source/AnnotationModel.java b/org.eclipse.text/src/org/eclipse/jface/text/source/AnnotationModel.java
index 1cb4d6c00..2e5958442 100644
--- a/org.eclipse.text/src/org/eclipse/jface/text/source/AnnotationModel.java
+++ b/org.eclipse.text/src/org/eclipse/jface/text/source/AnnotationModel.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -27,9 +27,12 @@ import org.eclipse.jface.text.Position;
/**
- * Standard implementation of <code>IAnnotationModel</code>. This class can directly
- * be used by clients. Subclasses may adapt this annotation model to other existing
- * annotation mechanisms.
+ * Standard implementation of {@link IAnnotationModel}and its extension
+ * interfaces. This class can directly be used by clients. Subclasses may adapt
+ * this annotation model to other existing annotation mechanisms. This class
+ * also implements {@link org.eclipse.jface.text.ISynchronizable}. All
+ * modifications of the model's internal annotation map are synchronized using
+ * the model's lock object.
*/
public class AnnotationModel implements IAnnotationModel, IAnnotationModelExtension, ISynchronizable {
@@ -156,7 +159,7 @@ public class AnnotationModel implements IAnnotationModel, IAnnotationModelExtens
}
/*
- * @see IAnnotationModel#addAnnotation(Annotation, Position)
+ * @see org.eclipse.jface.text.source.IAnnotationModel#addAnnotation(org.eclipse.jface.text.source.Annotation, org.eclipse.jface.text.Position)
*/
public void addAnnotation(Annotation annotation, Position position) {
try {
@@ -167,7 +170,7 @@ public class AnnotationModel implements IAnnotationModel, IAnnotationModelExtens
}
/*
- * @see IAnnotationModelExtension#replaceAnnotations(Annotation[], Map)
+ * @see org.eclipse.jface.text.source.IAnnotationModelExtension#replaceAnnotations(org.eclipse.jface.text.source.Annotation[], java.util.Map)
* @since 3.0
*/
public void replaceAnnotations(Annotation[] annotationsToRemove, Map annotationsToAdd) {
@@ -236,7 +239,7 @@ public class AnnotationModel implements IAnnotationModel, IAnnotationModelExtens
}
/*
- * @see IAnnotationModel#addAnnotationModelListener(IAnnotationModelListener)
+ * @see org.eclipse.jface.text.source.IAnnotationModel#addAnnotationModelListener(org.eclipse.jface.text.source.IAnnotationModelListener)
*/
public void addAnnotationModelListener(IAnnotationModelListener listener) {
if (!fAnnotationModelListeners.contains(listener)) {
@@ -279,7 +282,7 @@ public class AnnotationModel implements IAnnotationModel, IAnnotationModelExtens
}
/*
- * @see IAnnotationModel#connect(IDocument)
+ * @see org.eclipse.jface.text.source.IAnnotationModel#connect(org.eclipse.jface.text.IDocument)
*/
public void connect(IDocument document) {
Assert.isTrue(fDocument == null || fDocument == document);
@@ -322,7 +325,7 @@ public class AnnotationModel implements IAnnotationModel, IAnnotationModelExtens
}
/*
- * @see IAnnotationModel#disconnect(IDocument)
+ * @see org.eclipse.jface.text.source.IAnnotationModel#disconnect(org.eclipse.jface.text.IDocument)
*/
public void disconnect(IDocument document) {
@@ -442,6 +445,7 @@ public class AnnotationModel implements IAnnotationModel, IAnnotationModelExtens
*
* @param fireModelChanged indicates whether to notify all model listeners
* @param forkNotification <code>true</code> iff notification should be done in a new thread
+ * @since 3.0
*/
private void cleanup(boolean fireModelChanged, boolean forkNotification) {
if (fDocumentChanged) {
@@ -472,7 +476,7 @@ public class AnnotationModel implements IAnnotationModel, IAnnotationModelExtens
}
/*
- * @see IAnnotationModel#getAnnotationIterator()
+ * @see org.eclipse.jface.text.source.IAnnotationModel#getAnnotationIterator()
*/
public Iterator getAnnotationIterator() {
return getAnnotationIterator(true, true);
@@ -556,7 +560,7 @@ public class AnnotationModel implements IAnnotationModel, IAnnotationModelExtens
}
/*
- * @see IAnnotationModel#getPosition(Annotation)
+ * @see org.eclipse.jface.text.source.IAnnotationModel#getPosition(org.eclipse.jface.text.source.Annotation)
*/
public Position getPosition(Annotation annotation) {
Position position= (Position) fAnnotations.get(annotation);
@@ -605,7 +609,7 @@ public class AnnotationModel implements IAnnotationModel, IAnnotationModelExtens
}
/*
- * @see IAnnotationModel#removeAnnotation(Annotation)
+ * @see org.eclipse.jface.text.source.IAnnotationModel#removeAnnotation(org.eclipse.jface.text.source.Annotation)
*/
public void removeAnnotation(Annotation annotation) {
removeAnnotation(annotation, true);
diff --git a/org.eclipse.text/src/org/eclipse/jface/text/source/AnnotationModelEvent.java b/org.eclipse.text/src/org/eclipse/jface/text/source/AnnotationModelEvent.java
index 775251e67..f188b0921 100644
--- a/org.eclipse.text/src/org/eclipse/jface/text/source/AnnotationModelEvent.java
+++ b/org.eclipse.text/src/org/eclipse/jface/text/source/AnnotationModelEvent.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -8,9 +8,9 @@
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
-
package org.eclipse.jface.text.source;
+
import org.eclipse.jface.text.Position;
import java.util.HashMap;
@@ -18,17 +18,22 @@ import java.util.HashSet;
import java.util.Map;
import java.util.Set;
+
/**
- * Specification of changes applied to annotation models.
- * The event carries the changed annotation model
- * as well as added, removed, and modified annotations.
- *
- * @see IAnnotationModel
+ * Specification of changes applied to annotation models. The event carries the
+ * changed annotation model as well as added, removed, and modified annotations.
+ * <p>
+ * An event can be sealed. Afterwards it can not be modified. Thus, the normal
+ * process is that an empty event is created, filled with the changed
+ * information, and before it is sent to the listeners, the event is sealed.
+ *
+ * @see org.eclipse.jface.text.source.IAnnotationModel
+ * @see org.eclipse.jface.text.source.IAnnotationModelListenerExtension
* @since 2.0
*/
public class AnnotationModelEvent {
- /** The model this event refers to. For internal use only. */
+ /** The model this event refers to. */
private IAnnotationModel fAnnotationModel;
/**
* The added annotations.
diff --git a/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationMap.java b/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationMap.java
index 5860e0b61..752778d33 100644
--- a/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationMap.java
+++ b/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationMap.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -10,6 +10,7 @@
*******************************************************************************/
package org.eclipse.jface.text.source;
+
import java.util.Collection;
import java.util.Iterator;
import java.util.Map;
@@ -17,19 +18,22 @@ import java.util.Set;
import org.eclipse.jface.text.ISynchronizable;
+
/**
* An annotation map is a map specialized for the requirements of an annotation
* model. The annotation map supports a customizable lock object which is used
- * to synchronize concurrent operations on the map. The map supports two
+ * to synchronize concurrent operations on the map (see
+ * {@link org.eclipse.jface.text.ISynchronizable}. The map supports two
* iterator methods, one for the values and one for the keys of the map. The
* returned iterators are robust, i.e. they work on a copy of the values and
* keys set that is made at the point in time the iterator methods are called.
* <p>
- * The returned collections of the methods <code>values</code>,<code>entrySet</code>,
- * and <code>keySet</code> are not synchronized on the annotation map's lock
- * object.
+ * The returned collections of the methods <code>values</code>,
+ * <code>entrySet</code>, and <code>keySet</code> are not synchronized on
+ * the annotation map's lock object.
* <p>
*
+ * @see org.eclipse.jface.text.source.IAnnotationModel
* @since 3.0
*/
public interface IAnnotationMap extends Map, ISynchronizable {
diff --git a/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModel.java b/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModel.java
index 509d0da69..0f9fb08d7 100644
--- a/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModel.java
+++ b/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModel.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -11,7 +11,6 @@
package org.eclipse.jface.text.source;
-
import java.util.Iterator;
import org.eclipse.jface.text.IDocument;
@@ -22,13 +21,24 @@ import org.eclipse.jface.text.Position;
* 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 inquerying the current offset and length of an annotation managed
+ * for querying the current position of an annotation managed
* by this model.<p>
+ *
+ * In order to provided backward compatibility for clients of <code>IAnnotationModel</code>, extension
+ * interfaces are used to provide a means of evolution. The following extension interfaces
+ * exist:
+ * <ul>
+ * <li> {@link org.eclipse.jface.text.source.IAnnotationModelExtension} since version 3.0 introducing the concept
+ * of model piggybacking annotation models, modification time stamps, and enhanced manipulation methods.
+ * </li>
+ * </ul>
+ *
* Clients may implement this interface or use the default implementation provided
* by <code>AnnotationModel</code>.
*
- * @see Annotation
- * @see IAnnotationModelListener
+ * @see org.eclipse.jface.text.source.IAnnotationModelExtension
+ * @see org.eclipse.jface.text.source.Annotation
+ * @see org.eclipse.jface.text.source.IAnnotationModelListener
*/
public interface IAnnotationModel {
diff --git a/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModelExtension.java b/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModelExtension.java
index eeb1bdb6b..aa2973e5a 100644
--- a/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModelExtension.java
+++ b/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModelExtension.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -8,17 +8,18 @@
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
-
package org.eclipse.jface.text.source;
+
import java.util.Map;
import org.eclipse.jface.text.Position;
/**
- * Extends <code>IAnnotationModel</code> with the ability to attach additional
- * annotation models to it.
+ * Extends {@link org.eclipse.jface.text.source.IAnnotationModel}with the
+ * ability piggyback other annotation models. It also introduces the concept of
+ * modification time stamps and adds methods for richer manipulation methods.
*
* @since 3.0
*/
@@ -56,15 +57,14 @@ public interface IAnnotationModelExtension {
IAnnotationModel removeAnnotationModel(Object key);
/**
- * Replaces annotations with new annotations for this annotation model. The
- * new annotations are map entries where the annotation is the key and the
- * value is the position for the annotation. Each position describes the
- * range covered by the annotation. All registered annotation model
- * listeners are informed about the change (if any). If the model is
- * connected to a document, the positions are automatically updated on
- * document changes. For each annotation which is already managed by this
- * annotation model or is not associated with a valid position in the
- * connected document nothing happens.
+ * Adds and removes annotations to/from this annotation model in a single
+ * step. The annotations to remove are given in an array. The annotations to
+ * add are provided in a map associating the annotations with the positions
+ * at which they should be added. All registered annotation model listeners
+ * are informed about the change. If the model is connected to a document,
+ * the positions are automatically updated on document changes. Annotations
+ * that are already managed by this annotation model or are not associated
+ * with a valid position in the connected document have no effect.
*
* @param annotationsToRemove the annotations to be removed, may be
* <code>null</code>
@@ -78,11 +78,11 @@ public interface IAnnotationModelExtension {
void replaceAnnotations(Annotation[] annotationsToRemove, Map annotationsToAdd) throws ClassCastException;
/**
- * Modifies the position associated with the given annotation to the given
- * position. If the annotation is not yet managed by this annotation model,
- * the annotation is added. If the given position is <code>null</code> the
- * annotation is removed from the model. All annotation model change
- * listeners will be informed about the change.
+ * Modifies the position associated with the given annotation to equal the
+ * given position. If the annotation is not yet managed by this annotation
+ * model, the annotation is added. If the given position is
+ * <code>null</code> the annotation is removed from the model. All
+ * annotation model change listeners will be informed about the change.
*
* @param annotation the annotation whose associated position should be
* modified
diff --git a/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModelListener.java b/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModelListener.java
index db9708baa..9cadfe039 100644
--- a/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModelListener.java
+++ b/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModelListener.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -11,19 +11,26 @@
package org.eclipse.jface.text.source;
-
/**
- * Interface for objects interested in getting informed about
- * annotation model changes. Changes are the addition or removal
- * of annotations managed by the model. Clients may implement
- * this interface.
- *
- * @see IAnnotationModel
+ * Interface for objects interested in getting informed about annotation model
+ * changes. Changes are the addition or removal of annotations managed by the
+ * model. Clients may implement this interface.
+ *
+ * In order to provided backward compatibility for clients of
+ * <code>IAnnotationModelListener</code>, extension interfaces are used to
+ * provide a means of evolution. The following extension interfaces exist:
+ * <ul>
+ * <li>{@link org.eclipse.jface.text.source.IAnnotationModelListenerExtension}
+ * since version 2.0 replacing the change notification mechanisms.</li>
+ * </ul>
+ *
+ * @see org.eclipse.jface.text.source.IAnnotationModel
*/
public interface IAnnotationModelListener {
/**
- * Called if a model change occurred on the given model.
+ * Called if a model change occurred on the given model.<p>
+ * Replaced by {@link IAnnotationModelListenerExtension#modelChanged(AnnotationModelEvent)}.
*
* @param model the changed annotation model
*/
diff --git a/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModelListenerExtension.java b/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModelListenerExtension.java
index 6e3042fbe..ed4802503 100644
--- a/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModelListenerExtension.java
+++ b/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationModelListenerExtension.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -8,13 +8,13 @@
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
-
package org.eclipse.jface.text.source;
+
/**
- * Extension interface for <code>IAnnotationModelListener</code>. Introduces a
+ * Extension interface for {@link IAnnotationModelListener}. Introduces a
* notification mechanism that notifies the user by means of <code>AnnotationModelEvent</code>s.
- * Thus, more detailed information can be sent to the listener. Will replace the original notification
+ * Thus, more detailed information can be sent to the listener. This mechanism replaces the original notification
* mechanism of <code>IAnnotationModelListener</code>.
*
* @since 2.0
diff --git a/org.eclipse.text/src/org/eclipse/jface/text/source/package.html b/org.eclipse.text/src/org/eclipse/jface/text/source/package.html
new file mode 100644
index 000000000..2ba6d1fd9
--- /dev/null
+++ b/org.eclipse.text/src/org/eclipse/jface/text/source/package.html
@@ -0,0 +1,16 @@
+<!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">
+<html><head>
+ <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
+ <meta content="IBM" name="Author">
+ <meta content="Mozilla/4.75 [en] (Windows NT 5.0; U) [Netscape]" name="GENERATOR"><title>annotation models</title></head>
+
+<body>
+<p>Provides a support for managing annotations attached to a document.</p>
+<h3>Package Specification</h3>
+<p><font face="Courier New, Courier, mono">IAnnotationModels</font> manage <font face="Courier New, Courier, mono">Annotations</font>.
+ When an annotation model is connected to an <font face="Courier New, Courier, mono">IDocument</font>,
+ any change to the document is reflected in the position of the managed annotations.
+ Implementers of <font face="Courier New, Courier, mono">IAnnotationModelListener</font>
+ registered with an <font face="Courier New, Courier, mono">IAnnotationModel</font>
+ object get informed about changes of the model in respect to annotations.</p>
+</body></html> \ No newline at end of file

Back to the top