|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ui.texteditor.DefaultMarkerAnnotationAccess
Default class for accessing marker annotation properties.
Field Summary | |
---|---|
static String |
BOOKMARK_SYSTEM_IMAGE
Constant for the bookmark system image. |
static String |
ERROR_SYSTEM_IMAGE
Constant for the error system image. |
protected MarkerAnnotationPreferences |
fMarkerAnnotationPreferences
Deprecated. As of 3.0, no replacement |
static String |
INFO_SYSTEM_IMAGE
Constant for the info system image. |
static String |
TASK_SYSTEM_IMAGE
Constant for the task system image. |
static String |
UNKNOWN
Deprecated. As of 3.0, replaced by Annotation.TYPE_UNKNOWN |
static String |
WARNING_SYSTEM_IMAGE
Constant for the warning system image. |
Fields inherited from interface org.eclipse.jface.text.source.IAnnotationAccessExtension |
---|
DEFAULT_LAYER |
Constructor Summary | |
---|---|
DefaultMarkerAnnotationAccess()
Creates a new default marker annotation access using the standard preference lookup strategy which is the one provided by the enclosing plug-in. |
|
DefaultMarkerAnnotationAccess(MarkerAnnotationPreferences markerAnnotationPreferences)
Deprecated. As of 3.0, replaced by DefaultMarkerAnnotationAccess() |
Method Summary | |
---|---|
protected AnnotationPreferenceLookup |
getAnnotationPreferenceLookup()
Returns the annotation preference lookup used by this annotation access. |
protected org.eclipse.ui.internal.texteditor.AnnotationTypeHierarchy |
getAnnotationTypeHierarchy()
Returns the annotation type hierarchy used by this annotation access. |
int |
getLayer(Annotation annotation)
Returns the layer for given annotation. |
Object[] |
getSupertypes(Object annotationType)
Returns the list of super types for the given annotation type. |
Object |
getType(Annotation annotation)
Returns the type of the given annotation. |
String |
getTypeLabel(Annotation annotation)
Returns the label for the given annotation's type. |
boolean |
isMultiLine(Annotation annotation)
Returns whether the given annotation spans multiple lines. |
boolean |
isPaintable(Annotation annotation)
Returns true if painting annotation will produce something
meaningful, false if not. |
boolean |
isSubtype(Object annotationType,
Object potentialSupertype)
Returns true if the given annotation is of the given type
or false otherwise. |
boolean |
isTemporary(Annotation annotation)
Returns whether the given annotation is temporary rather than persistent. |
void |
paint(Annotation annotation,
GC gc,
Canvas canvas,
Rectangle bounds)
Draws a graphical representation of the given annotation within the given bounds. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String UNKNOWN
public static final String ERROR_SYSTEM_IMAGE
error
public static final String WARNING_SYSTEM_IMAGE
warning
public static final String INFO_SYSTEM_IMAGE
info
public static final String TASK_SYSTEM_IMAGE
task
public static final String BOOKMARK_SYSTEM_IMAGE
bookmark
protected MarkerAnnotationPreferences fMarkerAnnotationPreferences
Constructor Detail |
public DefaultMarkerAnnotationAccess(MarkerAnnotationPreferences markerAnnotationPreferences)
DefaultMarkerAnnotationAccess()
markerAnnotationPreferences
- public DefaultMarkerAnnotationAccess()
Method Detail |
protected AnnotationPreferenceLookup getAnnotationPreferenceLookup()
public Object getType(Annotation annotation)
IAnnotationAccess
getType
in interface IAnnotationAccess
annotation
- the annotation
null
if it has none.public boolean isMultiLine(Annotation annotation)
IAnnotationAccess
isMultiLine
in interface IAnnotationAccess
annotation
- the annotation
true
if the annotation spans multiple lines,
false
otherwisepublic boolean isTemporary(Annotation annotation)
IAnnotationAccess
isTemporary
in interface IAnnotationAccess
annotation
- the annotation
true
if the annotation is temporary,
false
otherwisepublic String getTypeLabel(Annotation annotation)
IAnnotationAccessExtension
getTypeLabel
in interface IAnnotationAccessExtension
annotation
- the annotation
null
if no such label existspublic int getLayer(Annotation annotation)
IAnnotationAccessExtension
getLayer
in interface IAnnotationAccessExtension
annotation
- the annotation
public void paint(Annotation annotation, GC gc, Canvas canvas, Rectangle bounds)
IAnnotationAccessExtension
paint
in interface IAnnotationAccessExtension
annotation
- the given annotationgc
- the drawing GCcanvas
- the canvas to draw onbounds
- the bounds inside the canvas to draw onpublic boolean isPaintable(Annotation annotation)
IAnnotationAccessExtension
true
if painting annotation
will produce something
meaningful, false
if not. E.g. if no image is available.
isPaintable
in interface IAnnotationAccessExtension
annotation
- the annotation to check whether it can be painted
true
if painting annotation
will succeedpublic boolean isSubtype(Object annotationType, Object potentialSupertype)
IAnnotationAccessExtension
true
if the given annotation is of the given type
or false
otherwise.
isSubtype
in interface IAnnotationAccessExtension
annotationType
- the annotation typepotentialSupertype
- the potential super annotation type
true
if annotation type is a sub-type of the potential annotation super typepublic Object[] getSupertypes(Object annotationType)
IAnnotationAccessExtension
getSupertypes
in interface IAnnotationAccessExtension
annotationType
- the annotation type to check
protected org.eclipse.ui.internal.texteditor.AnnotationTypeHierarchy getAnnotationTypeHierarchy()
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.