gate.gui.annedit

Interface AnnotationEditorOwner

All Known Implementing Classes:

AnnotationListView, AnnotationSetsView

public interface AnnotationEditorOwner

Objects of this type control the interaction with an OwnedAnnotationEditor.

Method Summary

Modifier and Type	Method and Description
void	annotationChanged(Annotation ann, AnnotationSet set, String oldType) Called by the annotation editor when an annotation has been changed.
Document	getDocument() Gets the document currently being edited.
Annotation	getNextAnnotation() Called by the editor for obtaining the next annotation to be edited.
Annotation	getPreviousAnnotation() Called by the editor for obtaining the previous annotation to be edited.
JTextComponent	getTextComponent() Gets the UI component used to display the document text.
void	selectAnnotation(AnnotationData aData) Called by the editor when a new annotation needs to be selected.

Method Detail

getDocument

Document getDocument()

Gets the document currently being edited.

Returns:

a Document object.

getTextComponent

JTextComponent getTextComponent()

Gets the UI component used to display the document text. This is used by the annotation editor for obtaining positioning information.

Returns:

a JTextComponent object.

annotationChanged

void annotationChanged(Annotation ann,
                       AnnotationSet set,
                       String oldType)

Called by the annotation editor when an annotation has been changed.

Parameters:

ann - the annotation modified (after the modification occurred).

set - the parent annotation set for the annotation

oldType - the old type of the annotation. This value is only set if the annotation modification included a change of type.

selectAnnotation

void selectAnnotation(AnnotationData aData)

Called by the editor when a new annotation needs to be selected.

getNextAnnotation

Annotation getNextAnnotation()

Called by the editor for obtaining the next annotation to be edited.

Returns:

an Annotation value.

getPreviousAnnotation

Annotation getPreviousAnnotation()

Called by the editor for obtaining the previous annotation to be edited.

Returns:

an Annotation value.