org.eclipse.cdt.internal.ui.editor
Interface ICAnnotation

All Known Implementing Classes:
CMarkerAnnotation

public interface ICAnnotation

ICAnnotation Interface of annotations representing markers and problems.

See Also:
IMarker, IProblem

Method Summary
 void addOverlaid(ICAnnotation annotation)
          Adds the given annotation to the list of annotations which are overlaid by this annotations.
 java.lang.String[] getArguments()
           
 int getId()
           
 java.util.Iterator getOverlaidIterator()
          Returns an iterator for iterating over the annotation which are overlaid by this annotation.
 ICAnnotation getOverlay()
          Returns the overlay of this annotation.
 java.lang.String getText()
           
 org.eclipse.cdt.core.model.ITranslationUnit getTranslationUnit()
          Returns the compilation unit corresponding to the document on which the annotation is set or null if no corresponding co0mpilationunit exists.
 java.lang.String getType()
           
 boolean hasOverlay()
          Returns whether this annotation is overlaid.
 boolean isMarkedDeleted()
           
 boolean isPersistent()
           
 boolean isProblem()
          Tells whether this annotation is a problem annotation.
 void removeOverlaid(ICAnnotation annotation)
          Removes the given annotation from the list of annotations which are overlaid by this annotation.
 

Method Detail

getType

java.lang.String getType()
See Also:
Annotation.getType()

isPersistent

boolean isPersistent()
See Also:
Annotation.isPersistent()

isMarkedDeleted

boolean isMarkedDeleted()
See Also:
Annotation.isMarkedDeleted()

getText

java.lang.String getText()
See Also:
Annotation.getText()

hasOverlay

boolean hasOverlay()
Returns whether this annotation is overlaid.

Returns:
true if overlaid

getOverlay

ICAnnotation getOverlay()
Returns the overlay of this annotation.

Returns:
the annotation's overlay

getOverlaidIterator

java.util.Iterator getOverlaidIterator()
Returns an iterator for iterating over the annotation which are overlaid by this annotation.

Returns:
an iterator over the overlaid annotaions

addOverlaid

void addOverlaid(ICAnnotation annotation)
Adds the given annotation to the list of annotations which are overlaid by this annotations.

Parameters:
annotation - the problem annoation

removeOverlaid

void removeOverlaid(ICAnnotation annotation)
Removes the given annotation from the list of annotations which are overlaid by this annotation.

Parameters:
annotation - the problem annoation

isProblem

boolean isProblem()
Tells whether this annotation is a problem annotation.

Returns:
true if it is a problem annotation

getTranslationUnit

org.eclipse.cdt.core.model.ITranslationUnit getTranslationUnit()
Returns the compilation unit corresponding to the document on which the annotation is set or null if no corresponding co0mpilationunit exists.


getArguments

java.lang.String[] getArguments()

getId

int getId()