|
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.jface.text.source.Annotation
Annotation managed by an
IAnnotationModel
.
Annotations are types, associated text, and can be marked as persistent and
deleted. Annotations which are not explicitly initialized with an annotation
type are of type "org.eclipse.text.annotation.unknown"
.
Field Summary | |
---|---|
static String |
TYPE_UNKNOWN
Constant for unknown annotation types. |
Constructor Summary | |
---|---|
protected |
Annotation()
Creates a new annotation that is not persistent and type less. |
|
Annotation(boolean isPersistent)
Creates a new annotation with the given persistence state. |
|
Annotation(String type,
boolean isPersistent,
String text)
Creates a new annotation with the given properties. |
Method Summary | |
---|---|
String |
getText()
Returns the text associated with this annotation. |
String |
getType()
Returns the type of the annotation. |
boolean |
isMarkedDeleted()
Returns whether this annotation is marked as deleted. |
boolean |
isPersistent()
Returns whether this annotation is persistent. |
void |
markDeleted(boolean deleted)
Marks this annotation deleted according to the value of the deleted parameter. |
void |
setText(String text)
Sets the text associated with this annotation. |
void |
setType(String type)
Sets the type of this annotation. |
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_UNKNOWN
Value: "org.eclipse.text.annotation.unknown"
Constructor Detail |
protected Annotation()
public Annotation(String type, boolean isPersistent, String text)
type
- the type of this annotationisPersistent
- true
if this annotation is
persistent, false
otherwisetext
- the text associated with this annotationpublic Annotation(boolean isPersistent)
isPersistent
- true
if persistent, false
otherwiseMethod Detail |
public boolean isPersistent()
true
if this annotation is persistent, false
otherwisepublic void setType(String type)
type
- the annotation typepublic String getType()
public void markDeleted(boolean deleted)
deleted
parameter.
deleted
- true
if annotation should be marked as deletedpublic boolean isMarkedDeleted()
true
if annotation is marked as deleted, false
otherwisepublic void setText(String text)
text
- the text associated with this annotationpublic String getText()
null
|
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.