|
FreeHEP API Version v1.2.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--hep.aida.ref.Annotation
Field Summary | |
protected boolean |
fillable
|
protected Vector |
keyVector
|
protected Vector |
stkVector
|
static String |
titleKey
|
protected Vector |
valVector
|
Constructor Summary | |
Annotation()
Creates a new instance of Annotation. |
Method Summary | |
void |
addItem(String key,
String value)
Add a key/value pair with a given visibility. |
void |
addItem(String key,
String value,
boolean sticky)
|
protected void |
checkIndex(int index)
Utility method to check if an index is valid for the current configuration of the Annotation. |
boolean |
isSticky(int index)
Get the stickyness corresponding to the item in a give position in the Annotation. |
boolean |
isSticky(String key)
Get the stickyness for a given key. |
String |
key(int index)
Get the key corresponding to the item in a given position in the Annotation. |
void |
removeItem(String key)
Remove the item indicated by a given key. |
void |
reset()
Reset the contents of the Annotation. |
void |
setFillable(boolean fillable)
If annotation is fillable, can modified. |
void |
setSticky(String key,
boolean sticky)
Set stickyness for a given key. |
void |
setValue(String key,
String value)
Set value for a given key. |
int |
size()
Get the number of items in the Annotation. |
String |
value(int index)
Get the value corresponding to the item in a given position in the Annotation. |
String |
value(String key)
Retrieve the value for a given key. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected Vector keyVector
protected Vector valVector
protected Vector stkVector
protected boolean fillable
public static String titleKey
Constructor Detail |
public Annotation()
Method Detail |
public void setFillable(boolean fillable)
public void addItem(String key, String value)
addItem
in interface hep.aida.IAnnotation
public void addItem(String key, String value, boolean sticky)
addItem
in interface hep.aida.IAnnotation
public void removeItem(String key)
removeItem
in interface hep.aida.IAnnotation
public String value(String key)
value
in interface hep.aida.IAnnotation
public void setValue(String key, String value)
setValue
in interface hep.aida.IAnnotation
key
- The item's key.value
- The new value for the correponding item.public boolean isSticky(String key)
key
- The item's key.
public void setSticky(String key, boolean sticky)
setSticky
in interface hep.aida.IAnnotation
key
- The item's key.sticky
- The new stickyness for the correponding item.public int size()
size
in interface hep.aida.IAnnotation
public String key(int index)
key
in interface hep.aida.IAnnotation
index
- The item's index.
public String value(int index)
value
in interface hep.aida.IAnnotation
index
- The item's index.
public boolean isSticky(int index)
public void reset()
reset
in interface hep.aida.IAnnotation
protected void checkIndex(int index)
index
- The index to be checked.
|
FreeHEP API Version v1.2.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |