|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.text.source.Annotation
org.eclipse.jface.text.source.projection.ProjectionAnnotation
Annotation used to represent the projection of a master document onto a
ProjectionDocument
. A projection
annotation can be either expanded or collapsed. If expanded it corresponds to
a segment of the projection document. If collapsed, it represents a region of
the master document that does not have a corresponding segment in the
projection document.
Clients may subclass or use as is.
Field Summary | |
---|---|
static String |
TYPE
The type of projection annotations. |
Fields inherited from class org.eclipse.jface.text.source.Annotation |
---|
TYPE_UNKNOWN |
Fields inherited from interface org.eclipse.jface.text.source.IAnnotationPresentation |
---|
DEFAULT_LAYER |
Constructor Summary | |
---|---|
ProjectionAnnotation()
Creates a new expanded projection annotation. |
|
ProjectionAnnotation(boolean isCollapsed)
Creates a new projection annotation. |
Method Summary | |
---|---|
int |
getLayer()
Returns the annotations drawing layer. |
boolean |
isCollapsed()
Returns the state of this annotation. |
void |
markCollapsed()
Marks this annotation as being collapsed. |
void |
markExpanded()
Marks this annotation as being unfolded. |
void |
paint(GC gc,
Canvas canvas,
Rectangle rectangle)
Implement this method to draw a graphical representation of this annotation within the given bounds. |
void |
setRangeIndication(boolean rangeIndication)
Enables and disables the range indication for this annotation. |
Methods inherited from class org.eclipse.jface.text.source.Annotation |
---|
getText, getType, isMarkedDeleted, isPersistent, markDeleted, setText, setType |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String TYPE
Constructor Detail |
public ProjectionAnnotation()
public ProjectionAnnotation(boolean isCollapsed)
isCollapsed
is true
the annotation is initially collapsed.
isCollapsed
- true
if the annotation should initially be collapsed, false
otherwiseMethod Detail |
public void setRangeIndication(boolean rangeIndication)
rangeIndication
- the enable state for the range indicationpublic void paint(GC gc, Canvas canvas, Rectangle rectangle)
IAnnotationPresentation
Note that this method is not used when drawing annotations on the editor's
text widget. This is handled trough a AnnotationPainter.IDrawingStrategy
.
paint
in interface IAnnotationPresentation
gc
- the drawing GCcanvas
- the canvas to draw onrectangle
- the bounds inside the canvas to draw onpublic int getLayer()
IAnnotationPresentation
getLayer
in interface IAnnotationPresentation
public boolean isCollapsed()
true
if collapsedpublic void markCollapsed()
public void markExpanded()
|
Eclipse Platform Release 3.3 |
|||||||||||
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, 2007. All rights reserved.