|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface defines how an AnnotationScheme
communicates with listening objects.
Once registered with the scheme, listeners will be notified of scheme events via the methods in this interface.
viewers and chooser components typically implement this interface.
Viewer
,
ChooserComponent
Method Summary | |
void |
addAnnotation(Annotation a)
Designates that the specified annotation has been added |
void |
addAnnotation(Annotation a,
Annotation p)
|
void |
addProperty(DynamicFeature f)
|
void |
addProperty(DynamicFeature f,
java.lang.String s)
|
void |
addProperty(DynamicFeature f,
java.lang.String l,
java.lang.String s)
|
void |
addProperty(java.lang.String p)
|
void |
addProperty(java.lang.String p,
java.lang.String s)
|
void |
addStyle(java.lang.String name,
javax.swing.text.AttributeSet as)
This allows an AnnotationScheme to change the
background color for a particular annotation |
void |
annotation(Annotation a)
Notifies the listener to focus display the specified annotation. |
void |
clearAnnotationHighlights()
|
void |
file(AnnotationFile af)
Notifies the listener that the specified annotation file should be presented to the user. |
void |
highlightAnnotation(Annotation a,
java.awt.Color c)
|
void |
makeVisible(Annotation a)
Notifies the listener to make sure the annotation is visible |
void |
markOutcomes(Annotation[] codes,
java.awt.Color c)
|
void |
markOutcomes(java.lang.String[] codes,
java.awt.Color c)
Specifies a set of outcomes for this annotation and designates the color that should be used to disply them. |
void |
moveAnnotation(Annotation a)
Designates that the specified annotation is about to be moved. |
void |
outcomes(java.lang.String[] names)
This allows an AnnotationScheme to change the
outcomes presented to the user. |
void |
outcomes(java.lang.String[] names,
java.lang.String[] codes)
This allows an AnnotationScheme to change the
outcomes presented to the user. |
void |
outcomes(java.lang.String[] names,
java.lang.String[] codes,
java.util.Map groups)
This allows an AnnotationScheme to change the
outcomes presented to the user. |
void |
progress(double p)
|
void |
progress(int x,
int n)
|
void |
refresh()
Notifies the listener that annotated files have been filtered in the scheme and may need to be redisplayed |
void |
refresh(Annotation a)
Notifies the listen that the specified annotation needs to be redrawn. |
void |
reloadedFiles()
Notifies the listener that annotated files have been reloaded in the scheme and may have been changed in arbitrary ways. |
void |
removeAnnotation(Annotation a)
Designates that the specified annotation has been removed. |
void |
removeContextualMenuItems(javax.swing.JMenuItem[] menus)
|
void |
select(Annotation a)
Notifies the listner that the specified annotation should be displayed as selected. |
void |
select(AnnotationSelection selection)
Notifies the listener that the specified selection should be displayed as selected. |
void |
select(Span selectionSpan)
Notifies the listner that the specified selection span should be displayed as selected. |
void |
setAnnotationStyle(Annotation a,
java.lang.String name)
|
void |
setAnnotationView(AnnotationView view)
Indicates that annotations from the specified view should be processed. |
void |
setBackgroundColor(Annotation a,
java.awt.Color c)
|
void |
setColorScheme(java.util.Map cs)
Provides a mapping between outcomes and colors for display purposes. |
void |
setContextualMenuItems(javax.swing.JMenuItem[] menus)
|
void |
setContextualMenuItems(javax.swing.JMenuItem[] menus,
java.lang.String[] alt_names,
int[] mods)
|
void |
setIcons(javax.swing.Icon[] icons)
|
void |
setProperty(DynamicFeature f)
|
void |
setProperty(DynamicFeature f,
java.lang.String s)
|
void |
setProperty(DynamicFeature f,
java.lang.String l,
java.lang.String s)
|
void |
setProperty(java.lang.String property)
Designates that the specified property should be used for displaying label information about annotations handled by the caller. |
void |
setProperty(java.lang.String p,
java.lang.String s)
|
void |
setSortCriteria(SortCriteria sortCriteria)
Indicates that the annotations will be sorted based on the specified sort criteria. |
void |
showRelations(boolean showRelations)
Specifies whether the scheme wants relations to be displayed based on the specified parameter. |
void |
updateAnnotation(Annotation a)
Designates that the specified annotation has been changed. |
Method Detail |
public void outcomes(java.lang.String[] names)
AnnotationScheme
to change the
outcomes presented to the user.
names
- The names for the outcome to be displayed to the user and used in the file..public void outcomes(java.lang.String[] names, java.lang.String[] codes)
AnnotationScheme
to change the
outcomes presented to the user.
names
- The names for the outcome to be displayed to the user.codes
- The string to be stored in the file for this selection.public void outcomes(java.lang.String[] names, java.lang.String[] codes, java.util.Map groups)
AnnotationScheme
to change the
outcomes presented to the user.
names
- The names for the outcome to be displayed to the user.codes
- The string to be stored in the file for this selection.groups
- A mapping from group labels to a set of names for that group.public void setIcons(javax.swing.Icon[] icons)
public void file(AnnotationFile af)
public void annotation(Annotation a)
a
- The annotation to be displayed.public void refresh(Annotation a)
a
- The annotation that needs to be refreshed.public void select(Annotation a)
a
- the annotation to be selected.public void select(Span selectionSpan)
selectionSpan
- the span to be selected.public void select(AnnotationSelection selection)
selection
- the selection to be selected.public void makeVisible(Annotation a)
a
- the annotation to make visiblepublic void addStyle(java.lang.String name, javax.swing.text.AttributeSet as)
AnnotationScheme
to change the
background color for a particular annotation
public void setAnnotationStyle(Annotation a, java.lang.String name)
public void setBackgroundColor(Annotation a, java.awt.Color c)
public void highlightAnnotation(Annotation a, java.awt.Color c)
public void clearAnnotationHighlights()
public void showRelations(boolean showRelations)
showRelations
- indicates that relations should or shouldn't be displayed.public void updateAnnotation(Annotation a)
a
- The changed annotation.public void addAnnotation(Annotation a)
a
- The added annotation.public void addAnnotation(Annotation a, Annotation p)
public void removeAnnotation(Annotation a)
a
- The annotation which is being removed.public void moveAnnotation(Annotation a)
a
- The annotation which is being moved.public void progress(int x, int n)
public void progress(double p)
public void markOutcomes(java.lang.String[] codes, java.awt.Color c)
public void markOutcomes(Annotation[] codes, java.awt.Color c)
public void setColorScheme(java.util.Map cs)
public void setProperty(java.lang.String property)
property
- the name of the property to be used as the default label property.public void setProperty(java.lang.String p, java.lang.String s)
public void addProperty(java.lang.String p)
public void addProperty(java.lang.String p, java.lang.String s)
public void setProperty(DynamicFeature f)
public void setProperty(DynamicFeature f, java.lang.String s)
public void setProperty(DynamicFeature f, java.lang.String l, java.lang.String s)
public void addProperty(DynamicFeature f)
public void addProperty(DynamicFeature f, java.lang.String s)
public void addProperty(DynamicFeature f, java.lang.String l, java.lang.String s)
public void reloadedFiles()
public void refresh()
public void setSortCriteria(SortCriteria sortCriteria)
sortCriteria
- public void setAnnotationView(AnnotationView view)
null
then there are currently no annotations to process.
Typically processing entails displaying the annotations.
view
- The current view for the scheme.public void setContextualMenuItems(javax.swing.JMenuItem[] menus)
public void setContextualMenuItems(javax.swing.JMenuItem[] menus, java.lang.String[] alt_names, int[] mods)
public void removeContextualMenuItems(javax.swing.JMenuItem[] menus)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |