Eclipse Platform
Release 3.1

Uses of Class
org.eclipse.jface.text.source.Annotation

Packages that use Annotation
org.eclipse.jface.text.source Provides a support for managing annotations attached to a document. 
org.eclipse.jface.text.source.projection   
org.eclipse.ui.texteditor Provides a framework for text editors obeying to the desktop rules.  
 

Uses of Annotation in org.eclipse.jface.text.source
 

Methods in org.eclipse.jface.text.source that return Annotation
 Annotation[] AnnotationModelEvent.getAddedAnnotations()
          Returns the added annotations.
 Annotation[] AnnotationModelEvent.getRemovedAnnotations()
          Returns the removed annotations.
 Annotation[] AnnotationModelEvent.getChangedAnnotations()
          Returns the changed annotations.
 Annotation VerticalRulerEvent.getSelectedAnnotation()
           
 

Methods in org.eclipse.jface.text.source with parameters of type Annotation
 void IAnnotationModelExtension.replaceAnnotations(Annotation[] annotationsToRemove, Map annotationsToAdd)
          Adds and removes annotations to/from this annotation model in a single step.
 void IAnnotationModelExtension.modifyAnnotationPosition(Annotation annotation, Position position)
          Modifies the position associated with the given annotation to equal the given position.
 void IAnnotationModel.addAnnotation(Annotation annotation, Position position)
          Adds a annotation to this annotation model.
 void IAnnotationModel.removeAnnotation(Annotation annotation)
          Removes the given annotation from the model.
 Position IAnnotationModel.getPosition(Annotation annotation)
          Returns the position associated with the given annotation.
 void AnnotationModelEvent.annotationAdded(Annotation annotation)
          Adds the given annotation to the set of annotations that are reported as being added from the model.
 void AnnotationModelEvent.annotationRemoved(Annotation annotation)
          Adds the given annotation to the set of annotations that are reported as being removed from the model.
 void AnnotationModelEvent.annotationRemoved(Annotation annotation, Position position)
          Adds the given annotation to the set of annotations that are reported as being removed from the model.
 Position AnnotationModelEvent.getPositionOfRemovedAnnotation(Annotation annotation)
          Returns the position of the removed annotation at that point in time when the annotation has been removed.
 void AnnotationModelEvent.annotationChanged(Annotation annotation)
          Adds the given annotation to the set of annotations that are reported as being changed from the model.
 void AnnotationModel.addAnnotation(Annotation annotation, Position position)
           
 void AnnotationModel.replaceAnnotations(Annotation[] annotationsToRemove, Map annotationsToAdd)
           
protected  void AnnotationModel.replaceAnnotations(Annotation[] annotationsToRemove, Map annotationsToAdd, boolean fireModelChanged)
          Replaces the given annotations in this model and if advised fires a model change event.
protected  void AnnotationModel.addAnnotation(Annotation annotation, Position position, boolean fireModelChanged)
          Adds the given annotation to this model.
 Position AnnotationModel.getPosition(Annotation annotation)
           
 void AnnotationModel.removeAnnotation(Annotation annotation)
           
protected  void AnnotationModel.removeAnnotation(Annotation annotation, boolean fireModelChanged)
          Removes the given annotation from the annotation model.
 void AnnotationModel.modifyAnnotationPosition(Annotation annotation, Position position)
           
protected  void AnnotationModel.modifyAnnotationPosition(Annotation annotation, Position position, boolean fireModelChanged)
          Modifies the associated position of the given annotation to the given position.
protected  void AnnotationModel.modifyAnnotation(Annotation annotation, boolean fireModelChanged)
          Modifies the given annotation if the annotation is managed by this annotation model.
 void VerticalRulerEvent.setSelectedAnnotation(Annotation annotation)
           
 void SourceViewer.setRangeIndicator(Annotation rangeIndicator)
           
 void ISourceViewer.setRangeIndicator(Annotation rangeIndicator)
          Sets the annotation used by this viewer as range indicator.
 String IAnnotationAccessExtension.getTypeLabel(Annotation annotation)
          Returns the label for the given annotation's type.
 int IAnnotationAccessExtension.getLayer(Annotation annotation)
          Returns the layer for given annotation.
 void IAnnotationAccessExtension.paint(Annotation annotation, GC gc, Canvas canvas, Rectangle bounds)
          Draws a graphical representation of the given annotation within the given bounds.
 boolean IAnnotationAccessExtension.isPaintable(Annotation annotation)
          Returns true if painting annotation will produce something meaningful, false if not.
 Object IAnnotationAccess.getType(Annotation annotation)
          Deprecated. use Annotation.getType()
 boolean IAnnotationAccess.isMultiLine(Annotation annotation)
          Deprecated. assumed to always return true
 boolean IAnnotationAccess.isTemporary(Annotation annotation)
          Deprecated. use Annotation.isPersistent()
protected  boolean AnnotationPainter.skip(Annotation annotation)
          Should the given annotation be skipped when handling draw requests?
 void AnnotationPainter.IDrawingStrategy.draw(Annotation annotation, GC gc, StyledText textWidget, int offset, int length, Color color)
          Draws a decoration of the given length start at the given offset in the given color onto the specified GC.
 void AnnotationPainter.SquigglesStrategy.draw(Annotation annotation, GC gc, StyledText textWidget, int offset, int length, Color color)
           
 void AnnotationPainter.NullStrategy.draw(Annotation annotation, GC gc, StyledText textWidget, int offset, int length, Color color)
           
 

Constructors in org.eclipse.jface.text.source with parameters of type Annotation
VerticalRulerEvent(Annotation annotation)
          Creates a new event.
 

Uses of Annotation in org.eclipse.jface.text.source.projection
 

Subclasses of Annotation in org.eclipse.jface.text.source.projection
 class AnnotationBag
          A bag of annotations.
 class ProjectionAnnotation
          Annotation used to represent the projection of a master document onto a ProjectionDocument.
 

Methods in org.eclipse.jface.text.source.projection with parameters of type Annotation
 void ProjectionAnnotationModel.collapse(Annotation annotation)
          Changes the state of the given annotation to collapsed.
 void ProjectionAnnotationModel.expand(Annotation annotation)
          Changes the state of the given annotation to expanded.
 void ProjectionAnnotationModel.toggleExpansionState(Annotation annotation)
          Toggles the expansion state of the given annotation.
 void ProjectionAnnotationModel.modifyAnnotations(Annotation[] deletions, Map additions, Annotation[] modifications)
          Modifies the annotation model.
 void AnnotationBag.add(Annotation annotation)
          Adds the given annotation to the annotation bag.
 void AnnotationBag.remove(Annotation annotation)
          Removes the given annotation from the annotation bag.
 

Uses of Annotation in org.eclipse.ui.texteditor
 

Subclasses of Annotation in org.eclipse.ui.texteditor
 class DefaultRangeIndicator
          Specialized annotation to indicate a particular range of text lines.
 class MarkerAnnotation
          Annotation representing a marker on a resource in the workspace.
 class SimpleMarkerAnnotation
          An annotation representing a marker.
 

Methods in org.eclipse.ui.texteditor that return Annotation
protected  Annotation AbstractTextEditor.getRangeIndicator()
          Returns the editor's range indicator.
 

Methods in org.eclipse.ui.texteditor with parameters of type Annotation
 Image IAnnotationImageProvider.getManagedImage(Annotation annotation)
          Returns the image for the given annotation or null.
 String IAnnotationImageProvider.getImageDescriptorId(Annotation annotation)
          Returns the image descriptor id of the image for the given annotation.
protected  void AbstractTextEditor.setRangeIndicator(Annotation rangeIndicator)
          Sets the annotation which this editor uses to represent the highlight range if the editor is configured to show the entire document.
 Object DefaultMarkerAnnotationAccess.getType(Annotation annotation)
           
 boolean DefaultMarkerAnnotationAccess.isMultiLine(Annotation annotation)
           
 boolean DefaultMarkerAnnotationAccess.isTemporary(Annotation annotation)
           
 String DefaultMarkerAnnotationAccess.getTypeLabel(Annotation annotation)
           
 int DefaultMarkerAnnotationAccess.getLayer(Annotation annotation)
           
 void DefaultMarkerAnnotationAccess.paint(Annotation annotation, GC gc, Canvas canvas, Rectangle bounds)
           
 boolean DefaultMarkerAnnotationAccess.isPaintable(Annotation annotation)
           
 AnnotationPreference AnnotationPreferenceLookup.getAnnotationPreference(Annotation annotation)
          Returns the annotation preference of a given annotation.
 


Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.