gate

Interface VisualResource

All Superinterfaces:

FeatureBearer, NameBearer, Resource, Serializable

All Known Subinterfaces:

AnnotationList, AnnotationVisualResource, DocumentView, OwnedAnnotationEditor, ResizableVisualResource

All Known Implementing Classes:

AbstractDocumentView, AbstractVisualResource, AnnotationEditor, AnnotationListView, AnnotationSetsView, AnnotationStackView, ControllerMetadataViewer, CorefEditor, CorpusAnnotationDiff, CorpusEditor, CorpusQualityAssurance, DocumentEditor, FeaturesSchemaEditor, LuceneDataStoreSearchGUI, PRViewer, RelationSetView, SerialControllerEditor, SerialDatastoreViewer, TextualDocumentView

public interface VisualResource
extends Resource

Models all sorts of visual resources.

Method Summary

Modifier and Type	Method and Description
void	setHandle(Handle handle) Used by the main GUI to tell this VR what handle created it.
void	setTarget(Object target) Called by the GUI when this viewer/editor has to initialise itself for a specific object.
default void	targetReinitialised() Used by the main GUI to tell this VR that the object it's displaying has been reinitialised and so the VR may need to update it's display.

Methods inherited from interface gate.Resource

cleanup, getParameterValue, init, setParameterValue, setParameterValues

Methods inherited from interface gate.util.FeatureBearer

getFeatures, setFeatures

Methods inherited from interface gate.util.NameBearer

getName, setName

Method Detail

setTarget

void setTarget(Object target)
        throws IllegalArgumentException

Called by the GUI when this viewer/editor has to initialise itself for a specific object.

Parameters:

target - the object (be it a Resource, DataStore or whatever) this viewer has to display

Throws:

IllegalArgumentException - if the view is incapable of displaying the supplied target resource, for whatever reason.

setHandle

void setHandle(Handle handle)

Used by the main GUI to tell this VR what handle created it. The VRs can use this information e.g. to add items to the popup for the resource.

targetReinitialised

default void targetReinitialised()

Used by the main GUI to tell this VR that the object it's displaying has been reinitialised and so the VR may need to update it's display. The default implementation does nothing which replicates the behaviour from before the method was added.