Package org.eclipse.ui.texteditor
Class MarkerAnnotation
- java.lang.Object
-
- org.eclipse.jface.text.source.Annotation
-
- org.eclipse.ui.texteditor.SimpleMarkerAnnotation
-
- org.eclipse.ui.texteditor.MarkerAnnotation
-
- All Implemented Interfaces:
IQuickFixableAnnotation
public class MarkerAnnotation extends SimpleMarkerAnnotation implements IQuickFixableAnnotation
Annotation representing a marker on a resource in the workspace. This class may be instantiated or be subclassed.- See Also:
IMarker
-
-
Field Summary
Fields Modifier and Type Field Description static int
PROBLEM_LAYER
Deprecated.As of 3.0, replaced byIAnnotationAccessExtension
-
Fields inherited from class org.eclipse.jface.text.source.Annotation
TYPE_UNKNOWN
-
-
Constructor Summary
Constructors Constructor Description MarkerAnnotation(String annotationType, IMarker marker)
Creates a new annotation of the given type for the given marker.MarkerAnnotation(IMarker marker)
Creates a new annotation for the given marker.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected Image
getImage(String name)
Deprecated.As of 3.0, visual presentation is no longer supported, annotation with a visible presentation should implementIAnnotationPresentation
protected Image
getImage(Display display)
Deprecated.As of 3.0, visual presentation is no longer supported, annotation with a visible presentation should implementIAnnotationPresentation
protected static Image
getImage(Display display, ImageDescriptor descriptor)
Deprecated.As of 3.0, visual presentation is no longer supported, annotation with a visible presentation should implementIAnnotationPresentation
protected static Map<ImageDescriptor,Image>
getImageRegistry(Display display)
Deprecated.As of 3.0, visual presentation is no longer supported, annotation with a visible presentation should implementIAnnotationPresentation
int
getLayer()
Deprecated.As of 3.0, replaced byIAnnotationAccessExtension.getLayer(org.eclipse.jface.text.source.Annotation)
protected String
getUnknownImageName(IMarker marker)
Deprecated.As of 3.0, visual presentation is no longer supported, annotation with a visible presentation should implementIAnnotationPresentation
protected void
initialize()
Deprecated.As of 3.0, visual presentation is no longer supported, annotation with a visible presentation should implementIAnnotationPresentation
boolean
isQuickFixable()
Tells whether there are quick fixes for this annotation.boolean
isQuickFixableStateSet()
Tells whether the quick fixable state has been set.void
paint(GC gc, Canvas canvas, Rectangle r)
Deprecated.protected void
setImage(Image image)
Deprecated.As of 3.0, visual presentation is no longer supported, annotation with a visible presentation should implementIAnnotationPresentation
protected void
setLayer(int layer)
Deprecated.As of 3.0, annotation with a visible presentation should implementIAnnotationPresentation
void
setQuickFixable(boolean state)
Sets whether there are quick fixes available for this annotation.void
update()
Informs this annotation about changes applied to its underlying marker and adapts to those changes.-
Methods inherited from class org.eclipse.ui.texteditor.SimpleMarkerAnnotation
equals, getMarker, getText, hashCode
-
Methods inherited from class org.eclipse.jface.text.source.Annotation
getType, isMarkedDeleted, isPersistent, markDeleted, setText, setType
-
-
-
-
Field Detail
-
PROBLEM_LAYER
@Deprecated public static final int PROBLEM_LAYER
Deprecated.As of 3.0, replaced byIAnnotationAccessExtension
The layer in which markers representing problem are located.- Since:
- 2.0
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
MarkerAnnotation
public MarkerAnnotation(IMarker marker)
Creates a new annotation for the given marker.- Parameters:
marker
- the marker
-
-
Method Detail
-
getImage
@Deprecated protected static Image getImage(Display display, ImageDescriptor descriptor)
Deprecated.As of 3.0, visual presentation is no longer supported, annotation with a visible presentation should implementIAnnotationPresentation
Returns an image for the given display as specified by the given image descriptor.- Parameters:
display
- the displaydescriptor
- the image descriptor- Returns:
- an image for the display as specified by the descriptor
-
getImageRegistry
@Deprecated protected static Map<ImageDescriptor,Image> getImageRegistry(Display display)
Deprecated.As of 3.0, visual presentation is no longer supported, annotation with a visible presentation should implementIAnnotationPresentation
Returns an image registry for the given display. If no such registry exists the registry is created.- Parameters:
display
- the display- Returns:
- the image registry for the given display
-
setImage
@Deprecated protected void setImage(Image image)
Deprecated.As of 3.0, visual presentation is no longer supported, annotation with a visible presentation should implementIAnnotationPresentation
Sets the marker image to the given image.- Parameters:
image
- the new marker image
-
initialize
@Deprecated protected void initialize()
Deprecated.As of 3.0, visual presentation is no longer supported, annotation with a visible presentation should implementIAnnotationPresentation
Initializes the annotation's icon representation and its drawing layer based upon the properties of the underlying marker.
-
getLayer
@Deprecated public int getLayer()
Deprecated.As of 3.0, replaced byIAnnotationAccessExtension.getLayer(org.eclipse.jface.text.source.Annotation)
Returns the annotations drawing layer.Note: This is only for backward compatibility.
- Returns:
- the annotations drawing layer
- Since:
- 3.0
-
setLayer
@Deprecated protected void setLayer(int layer)
Deprecated.As of 3.0, annotation with a visible presentation should implementIAnnotationPresentation
Sets the layer of this annotation.Note: This is only for backward compatibility.
- Parameters:
layer
- the layer of this annotation- Since:
- 3.0
-
paint
@Deprecated public void paint(GC gc, Canvas canvas, Rectangle r)
Deprecated.Implement this method to draw a graphical representation of this annotation within the given bounds. This default implementation does nothing.Note: This is only for backward compatibility.
- Parameters:
gc
- the drawing GCcanvas
- the canvas to draw onr
- the bounds inside the canvas to draw on- Since:
- 3.0
-
update
public void update()
Informs this annotation about changes applied to its underlying marker and adapts to those changes.- Overrides:
update
in classSimpleMarkerAnnotation
-
getUnknownImageName
@Deprecated protected String getUnknownImageName(IMarker marker)
Deprecated.As of 3.0, visual presentation is no longer supported, annotation with a visible presentation should implementIAnnotationPresentation
Returns the name of an image used to visually represent markers of unknown type. This implementation returnsnull
. Subclasses may replace this method.- Parameters:
marker
- the marker of unknown type- Returns:
- the name of an image for markers of unknown type.
-
getImage
@Deprecated protected Image getImage(String name)
Deprecated.As of 3.0, visual presentation is no longer supported, annotation with a visible presentation should implementIAnnotationPresentation
Returns the image of the given name. Subclasses may extend this method. If so, subclasses must assume responsibility for disposing the images they create.- Parameters:
name
- the name of the requested image- Returns:
- the image or
null
if there is no such image
-
getImage
@Deprecated protected Image getImage(Display display)
Deprecated.As of 3.0, visual presentation is no longer supported, annotation with a visible presentation should implementIAnnotationPresentation
Returns an image for this annotation. It first consults the workbench adapter for this annotation's marker. If none is defined, it tries to find an image for the image name of this annotation.- Parameters:
display
- the display for which the image is requested- Returns:
- the image for this annotation
-
setQuickFixable
public void setQuickFixable(boolean state)
Sets whether there are quick fixes available for this annotation.- Specified by:
setQuickFixable
in interfaceIQuickFixableAnnotation
- Parameters:
state
-true
if there are quick fixes available, false otherwise- Since:
- 3.4
-
isQuickFixableStateSet
public boolean isQuickFixableStateSet()
Tells whether the quick fixable state has been set.Normally this means
IQuickFixableAnnotation.setQuickFixable(boolean)
has been called at least once but it can also be hard-coded, e.g. always returntrue
.- Specified by:
isQuickFixableStateSet
in interfaceIQuickFixableAnnotation
- Returns:
true
if the state has been set- Since:
- 3.4
-
isQuickFixable
public boolean isQuickFixable()
Tells whether there are quick fixes for this annotation.Note: This method must only be called if
IQuickFixableAnnotation.isQuickFixableStateSet()
returnstrue
.- Specified by:
isQuickFixable
in interfaceIQuickFixableAnnotation
- Returns:
true
if this annotation offers quick fixes- Since:
- 3.4
-
-