gate.gui.docview

Interface DocumentView

All Superinterfaces:

ActionsPublisher, FeatureBearer, NameBearer, Resource, Serializable, VisualResource

All Known Subinterfaces:

AnnotationList

All Known Implementing Classes:

AbstractDocumentView, AnnotationListView, AnnotationSetsView, AnnotationStackView, CorefEditor, TextualDocumentView

public interface DocumentView
extends ActionsPublisher, VisualResource

A document viewer is composed out of several views (like the one showing the text, the one showing the annotation sets, the on showing the annotations table, etc.). This is the base interface for all the document views. All document views are panes inside a DocumentEditor object.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CENTRAL Constant for the CENTRAL type of the view inside the document editor.
static int	HORIZONTAL Constant for the HORIZONTAL type of the view inside the document editor.
static int	VERTICAL Constant for the VERTICAL type of the view inside the document editor.

Method Summary

Modifier and Type	Method and Description
Component	getGUI() Returns the actual UI component this view represents.
int	getType() Returns the type of this view.
boolean	isActive() Returns the active state of this view.
void	setActive(boolean active) Notifies this view that it has become active or inactive.
void	setOwner(DocumentEditor editor) Notifies this view of its owner.
void	setSelectedAnnotations(List<AnnotationData> selectedAnnots) Some document views can use the concept of selected annotations.

Methods inherited from interface gate.gui.ActionsPublisher

getActions

Methods inherited from interface gate.VisualResource

setHandle, setTarget, targetReinitialised

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

Field Detail

CENTRAL

static final int CENTRAL

Constant for the CENTRAL type of the view inside the document editor. Views of this type are placed in the center of the document editor.

See Also:

Constant Field Values

VERTICAL

static final int VERTICAL

Constant for the VERTICAL type of the view inside the document editor. Views of this type are placed as a vertical band on the right side of the document editor.

See Also:

Constant Field Values

HORIZONTAL

static final int HORIZONTAL

Constant for the HORIZONTAL type of the view inside the document editor. Views of this type are placed as a horizontal band on the lower side of the document editor.

See Also:

Constant Field Values

Method Detail

getGUI

Component getGUI()

Returns the actual UI component this view represents.

Returns:

a Component value.

getType

int getType()

Returns the type of this view.

Returns:

an int value

See Also:

CENTRAL, HORIZONTAL, VERTICAL

setActive

void setActive(boolean active)

Notifies this view that it has become active or inactive. Implementers are encouraged to lazily populate the UI elements, that is to use as little CPU time as possible before the view becomes active.

Parameters:

active - a boolean value.

isActive

boolean isActive()

Returns the active state of this view.

Returns:

a boolean value

setOwner

void setOwner(DocumentEditor editor)

Notifies this view of its owner.

Parameters:

editor - the DocumentEditor that contains this view.

setSelectedAnnotations

void setSelectedAnnotations(List<AnnotationData> selectedAnnots)

Some document views can use the concept of selected annotations. This method is called to change the set of selected annotations. The recommended way to change the selected annotations set is by calling the DocumentEditor.setSelectedAnnotations(List) method.

Parameters:

selectedAnnots -