gate.gui
Class DocumentEditor

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by gate.creole.AbstractVisualResource
                      extended by gate.gui.DocumentEditor
All Implemented Interfaces:
ANNIEConstants, Resource, FeatureBearer, NameBearer, VisualResource, ImageObserver, MenuContainer, Serializable, Accessible

Deprecated.

public class DocumentEditor
extends AbstractVisualResource
implements ANNIEConstants

This class implements a viewer/editor for the annotations on a document. As a viewer, this visual resource will display all the annotations found on the document. The editor needs to have some data about annotation types in order to allow the editing of annotations. This data comes from the AnnotationSchema objects that are loaded in the Gate system at a given moment. If there are no such objects the editing of annotations will be restricted to a very crude method allowing the user to add any type of annotations having any features with any String values. This class has been deprecated! The document editing functionality is now provided by the DocumentEditor class.

See Also:
Serialized Form

Nested Class Summary
protected  class DocumentEditor.AnnotationsTableModel
          Deprecated. A custom table model used to render a table containing the annotations from a set of annotation sets.
protected  class DocumentEditor.CorefData
          Deprecated.  
(package private)  class DocumentEditor.CorefNodeRenderer
          Deprecated. A tree node renderer used by the coref tree
(package private)  class DocumentEditor.CorefNodeRenderer1
          Deprecated. A tree node renderer used byt the coref tree
 class DocumentEditor.CustomLabelView
          Deprecated. Fixes the 4406598 bug in swing text components.
 class DocumentEditor.CustomStyledEditorKit
          Deprecated. Fixes the 4406598 bug in swing text components.
 class DocumentEditor.CustomStyledViewFactory
          Deprecated. Fixes the 4406598 bug in swing text components.
protected  class DocumentEditor.DeleteSelectedAnnotationsAction
          Deprecated.  
protected  class DocumentEditor.EditAnnotationAction
          Deprecated. The action that is fired when the user wants to edit an annotation.
(package private)  class DocumentEditor.EventsHandler
          Deprecated. All the events from the document or its annotation sets are handled by this inner class.
protected  class DocumentEditor.HighlightAnnotationMenu
          Deprecated. The popup menu items used to select annotations at right click.
(package private)  class DocumentEditor.LazyJPanel
          Deprecated. Panels used in cell/node renderers
(package private)  class DocumentEditor.NewAnnotationAction
          Deprecated. The action that is fired when the user wants to create a new annotation.
(package private)  class DocumentEditor.NodeRenderer
          Deprecated. Displays an entry in the right hand side tree.
(package private)  class DocumentEditor.NodeRenderer1
          Deprecated. Displays an entry in the right hand side tree.
protected  class DocumentEditor.PrintAction
          Deprecated.  
(package private)  class DocumentEditor.Range
          Deprecated. Describes a range in the data structure.
protected  class DocumentEditor.SearchAction
          Deprecated.  
protected  class DocumentEditor.SearchDialog
          Deprecated.  
(package private)  class DocumentEditor.SelectionBlinker
          Deprecated. This class handles the blinking for the selected annotations in the text display.
(package private)  class DocumentEditor.SwingDocumentListener
          Deprecated. Listens for updates from the text editor and updates the GATE document accordingly
 class DocumentEditor.TypeData
          Deprecated. Holds the GUI metadata for a given annotation type.
 
Nested classes/interfaces inherited from class javax.swing.JPanel
JPanel.AccessibleJPanel
 
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
protected  XJTable annotationsTable
          Deprecated. The table placed below the text display used for showing annotations
protected  DocumentEditor.AnnotationsTableModel annotationsTableModel
          Deprecated. Model for the annotations table
private  boolean annotationsTableVisible
          Deprecated.  
private  JToggleButton annotationsTableVisibleBtn
          Deprecated.  
protected  ColorGenerator colGenerator
          Deprecated. A random colour generator used to generate initial default colours for highlighting various types of annotations.
private  boolean coreferenceVisible
          Deprecated.  
private  JToggleButton coreferenceVisibleBtn
          Deprecated.  
private  boolean corefOptionAvailable
          Deprecated.  
protected  JScrollPane corefScroll
          Deprecated. The scroller for the coref list
protected  JTree corefTree
          Deprecated. The Jtree that displays the coreference data
protected  DefaultTreeModel corefTreeModel
          Deprecated. The model for the coref tree
protected  DefaultMutableTreeNode corefTreeRoot
          Deprecated. The root for the coref tree
protected  List data
          Deprecated. holds the data for the annotations table: a list of Annotation objects
private  Document document
          Deprecated. The Document currently displayed.
private  boolean editable
          Deprecated. Should this component bahave as an editor as well as an viewer
protected  DocumentEditor.EventsHandler eventHandler
          Deprecated. The listener for the events coming from the document (annotations and annotation sets added or removed).
protected  Highlighter highlighter
          Deprecated. The highlighter used to help the user select annotations that overlap and for highligting in the text the annotations selected in the lower table.
protected  JSplitPane leftSplit
          Deprecated.  
protected  Object lock
          Deprecated. Object used to sychronise all the various threads involved in GUI updating;
private  Vector longLinesCorrectionPositions
          Deprecated. Keep cut places in very long lines inside document
protected  JSplitPane mainSplit
          Deprecated. The main horizontal split that contains all the contents of this viewer
private  int MAX_LINE_SIZE
          Deprecated. Max unbreaked line size
protected  Handle myHandle
          Deprecated.  
protected  JProgressBar progressBar
          Deprecated. The progress bar used during updating the text
protected  Box progressBox
          Deprecated. A box containing a JProgressBar used to keep the user entertained while the text display is being updated
private  PropertyChangeSupport propertyChangeListeners
          Deprecated.  
protected  List ranges
          Deprecated. a list containing DocumentEditor.Range objects.
protected  JSplitPane rightSplit
          Deprecated. The split that contains the styles tree and the coreference viewer.
protected  DocumentEditor.SearchDialog searchDialog
          Deprecated. The dialog used for text search
protected  DocumentEditor.SelectionBlinker selectionBlinker
          Deprecated. The object responsible with blinking the selected annotations.
protected  Highlighter selectionHighlighter
          Deprecated. This highlighter is actually used as a data structure.
protected  TextAttributesChooser styleChooser
          Deprecated. The dialog used for editing the styles used to highlight annotations
protected  JTree stylesTree
          Deprecated. The right hand side tree with all the annotation sets and types of annotations
protected  DefaultTreeModel stylesTreeModel
          Deprecated. The model for the styles tree
protected  DefaultMutableTreeNode stylesTreeRoot
          Deprecated. The root for the styles tree
protected  JScrollPane stylesTreeScroll
          Deprecated. Scroller for the styles tree
protected  JScrollPane tableScroll
          Deprecated. Scroller for the annotations table
protected  JTextPane textPane
          Deprecated. The text display.
protected  JScrollPane textScroll
          Deprecated. Scroller used for the text diaplay
private  boolean textVisible
          Deprecated.  
private  JToggleButton textVisibleBtn
          Deprecated.  
protected  JToolBar toolbar
          Deprecated. The toolbar displayed on the top part of the component
protected  Map typeDataMap
          Deprecated. A composed map used to get the metadata for an annotation type starting from the annotation set name and the type name.
private  boolean typesTreeVisible
          Deprecated.  
private  JToggleButton typesTreeVisibleBtn
          Deprecated.  
 
Fields inherited from class gate.creole.AbstractVisualResource
features, handle
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface gate.creole.ANNIEConstants
ANNOTATION_COREF_FEATURE_NAME, DATE_ANNOTATION_TYPE, DATE_POSTED_ANNOTATION_TYPE, DEFAULT_FILE, DOCUMENT_COREF_FEATURE_NAME, JOB_ID_ANNOTATION_TYPE, LOCATION_ANNOTATION_TYPE, LOOKUP_ANNOTATION_TYPE, LOOKUP_CLASS_FEATURE_NAME, LOOKUP_INSTANCE_FEATURE_NAME, LOOKUP_LANGUAGE_FEATURE_NAME, LOOKUP_MAJOR_TYPE_FEATURE_NAME, LOOKUP_MINOR_TYPE_FEATURE_NAME, LOOKUP_ONTOLOGY_FEATURE_NAME, MONEY_ANNOTATION_TYPE, ORGANIZATION_ANNOTATION_TYPE, PERSON_ANNOTATION_TYPE, PERSON_GENDER_FEATURE_NAME, PLUGIN_DIR, PR_NAMES, SENTENCE_ANNOTATION_TYPE, SPACE_TOKEN_ANNOTATION_TYPE, TOKEN_ANNOTATION_TYPE, TOKEN_CATEGORY_FEATURE_NAME, TOKEN_KIND_FEATURE_NAME, TOKEN_LENGTH_FEATURE_NAME, TOKEN_ORTH_FEATURE_NAME, TOKEN_STRING_FEATURE_NAME
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
DocumentEditor()
          Deprecated. Default constructor.
 
Method Summary
 void addPropertyChangeListener(PropertyChangeListener l)
          Deprecated.  
 void addPropertyChangeListener(String propertyName, PropertyChangeListener l)
          Deprecated.  
 void cleanup()
          Deprecated. Does nothing now, but meant to clear all internal data
private  Vector correctLongLines(StringBuffer buff)
          Deprecated. Cut very long lines to pieces not grater than MAX_LINE_SIZE This is a correction of SWING problem with very long lines of text
Return positions of new line insertion.
protected  Set getAnnotationSchemas()
          Deprecated. Gets all the AnnotationSchema objects currently loaded in the system.
private  Vector getBreakPositions(String content)
          Deprecated. Get positions of cut points inside a very large text without new line
 Set getDisplayedAnnotations()
          Deprecated. This method returns a list of annotations which are currently shown in the annotations table or null of the table is empty.
 Document getDocument()
          Deprecated. Return the current selected document
protected  DocumentEditor.TypeData getTypeData(String setName, String type)
          Deprecated. Gets the data related to a given annotation type.
 Resource init()
          Deprecated. Initialise this resource, and return it.
protected  void initGuiComponents()
          Deprecated. Builds all the graphical components
protected  void initListeners()
          Deprecated. Initialises all the listeners that this component has to register with other classes.
protected  void initLocalData()
          Deprecated. Initialises the local variables to their default values
 boolean isAnnotationsTableVisible()
          Deprecated.  
 boolean isCoreferenceVisible()
          Deprecated.  
 boolean isCorefOptionAvailable()
          Deprecated.  
 boolean isEditable()
          Deprecated. Is the editor functionality enabled
private  boolean isTextSelected()
          Deprecated. This method returns true if a text is selected in the textPane
 boolean isTextVisible()
          Deprecated.  
 boolean isTypesTreeVisible()
          Deprecated.  
protected  void layoutComponents()
          Deprecated. Creates the layout of this component acording to the set of subcomponents (text display, annotations table, etc.) that need to be visible.
private  int longLinesCorrection(int position)
          Deprecated. Compute correction for additional new line in very long lines of text
protected  void paintHighlights(Set annotations, AttributeSet style)
          Deprecated.  
 void removePropertyChangeListener(PropertyChangeListener l)
          Deprecated.  
protected  void repairHighlights(int start, int end)
          Deprecated. Called whenever a part of the textual display needs to be repainted because, for instance, of an edit operation.
protected  void selectAnnotation(String set, Annotation ann)
          Deprecated. Updates the GUI when the user has selected an annotation e.g. by using the right click popup.
 void setAnnotationsTableVisible(boolean annotationsTableVisible)
          Deprecated.  
 void setCoreferenceVisible(boolean coreferenceVisible)
          Deprecated.  
 void setCorefOptionAvailable(boolean corefOptionAvailable)
          Deprecated.  
 void setEditable(boolean newEditable)
          Deprecated. Should the editor functionality of this component be enabled
 void setHandle(Handle handle)
          Deprecated. Used by the main GUI to tell this VR what handle created it.
 void setTarget(Object target)
          Deprecated. Sets the document to be displayed
 void setTextVisible(boolean textVisible)
          Deprecated.  
 void setTypesTreeVisible(boolean typesTreeVisible)
          Deprecated.  
protected  void showHighlights(Set annotations, AttributeSet style)
          Deprecated. Repaints the highlighting for annotation types in the text display.
protected  void this_documentChanged()
          Deprecated. Updates this component when the underlying document is changed.
protected  void updateCorefTree()
          Deprecated. Updates the coref tree from the coref data on the document's features
 
Methods inherited from class gate.creole.AbstractVisualResource
getFeatures, getParameterValue, setFeatures, setParameterValue, setParameterValues
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface gate.util.NameBearer
getName, setName
 

Field Detail

propertyChangeListeners

private transient PropertyChangeSupport propertyChangeListeners
Deprecated. 

document

private Document document
Deprecated. 
The Document currently displayed.


colGenerator

protected ColorGenerator colGenerator
Deprecated. 
A random colour generator used to generate initial default colours for highlighting various types of annotations.


textPane

protected JTextPane textPane
Deprecated. 
The text display.


textScroll

protected JScrollPane textScroll
Deprecated. 
Scroller used for the text diaplay


annotationsTable

protected XJTable annotationsTable
Deprecated. 
The table placed below the text display used for showing annotations


annotationsTableModel

protected DocumentEditor.AnnotationsTableModel annotationsTableModel
Deprecated. 
Model for the annotations table


tableScroll

protected JScrollPane tableScroll
Deprecated. 
Scroller for the annotations table


leftSplit

protected JSplitPane leftSplit
Deprecated. 

rightSplit

protected JSplitPane rightSplit
Deprecated. 
The split that contains the styles tree and the coreference viewer.


mainSplit

protected JSplitPane mainSplit
Deprecated. 
The main horizontal split that contains all the contents of this viewer


stylesTree

protected JTree stylesTree
Deprecated. 
The right hand side tree with all the annotation sets and types of annotations


toolbar

protected JToolBar toolbar
Deprecated. 
The toolbar displayed on the top part of the component


stylesTreeScroll

protected JScrollPane stylesTreeScroll
Deprecated. 
Scroller for the styles tree


stylesTreeRoot

protected DefaultMutableTreeNode stylesTreeRoot
Deprecated. 
The root for the styles tree


stylesTreeModel

protected DefaultTreeModel stylesTreeModel
Deprecated. 
The model for the styles tree


searchDialog

protected DocumentEditor.SearchDialog searchDialog
Deprecated. 
The dialog used for text search


styleChooser

protected TextAttributesChooser styleChooser
Deprecated. 
The dialog used for editing the styles used to highlight annotations


corefTree

protected JTree corefTree
Deprecated. 
The Jtree that displays the coreference data


corefTreeRoot

protected DefaultMutableTreeNode corefTreeRoot
Deprecated. 
The root for the coref tree


corefTreeModel

protected DefaultTreeModel corefTreeModel
Deprecated. 
The model for the coref tree


corefScroll

protected JScrollPane corefScroll
Deprecated. 
The scroller for the coref list


progressBox

protected Box progressBox
Deprecated. 
A box containing a JProgressBar used to keep the user entertained while the text display is being updated


progressBar

protected JProgressBar progressBar
Deprecated. 
The progress bar used during updating the text


highlighter

protected Highlighter highlighter
Deprecated. 
The highlighter used to help the user select annotations that overlap and for highligting in the text the annotations selected in the lower table.


selectionHighlighter

protected Highlighter selectionHighlighter
Deprecated. 
This highlighter is actually used as a data structure. It is used to keep the data for the selected annotations; the actual highlighting will be done by the highlighter as using two different highlighters on the same text component is looking for trouble.


selectionBlinker

protected DocumentEditor.SelectionBlinker selectionBlinker
Deprecated. 
The object responsible with blinking the selected annotations.


myHandle

protected Handle myHandle
Deprecated. 

data

protected List data
Deprecated. 
holds the data for the annotations table: a list of Annotation objects


ranges

protected List ranges
Deprecated. 
a list containing DocumentEditor.Range objects. These are the ranges in the data structure. A range is a bunch of annotations belonging to the same annotation set that are contiguous in the data structure.


typeDataMap

protected Map typeDataMap
Deprecated. 
A composed map used to get the metadata for an annotation type starting from the annotation set name and the type name. Annotation set name -> Annotation type -> DocumentEditor.TypeData Maps from String to Map to DocumentEditor.TypeData.


eventHandler

protected DocumentEditor.EventsHandler eventHandler
Deprecated. 
The listener for the events coming from the document (annotations and annotation sets added or removed).


lock

protected Object lock
Deprecated. 
Object used to sychronise all the various threads involved in GUI updating;


editable

private boolean editable
Deprecated. 
Should this component bahave as an editor as well as an viewer


textVisibleBtn

private JToggleButton textVisibleBtn
Deprecated. 

typesTreeVisibleBtn

private JToggleButton typesTreeVisibleBtn
Deprecated. 

annotationsTableVisibleBtn

private JToggleButton annotationsTableVisibleBtn
Deprecated. 

coreferenceVisibleBtn

private JToggleButton coreferenceVisibleBtn
Deprecated. 

annotationsTableVisible

private boolean annotationsTableVisible
Deprecated. 

coreferenceVisible

private boolean coreferenceVisible
Deprecated. 

textVisible

private boolean textVisible
Deprecated. 

typesTreeVisible

private boolean typesTreeVisible
Deprecated. 

corefOptionAvailable

private boolean corefOptionAvailable
Deprecated. 

MAX_LINE_SIZE

private final int MAX_LINE_SIZE
Deprecated. 
Max unbreaked line size

See Also:
Constant Field Values

longLinesCorrectionPositions

private Vector longLinesCorrectionPositions
Deprecated. 
Keep cut places in very long lines inside document

Constructor Detail

DocumentEditor

public DocumentEditor()
Deprecated. 
Default constructor. Creats all the components and initialises all the internal data to default values where possible.

Method Detail

init

public Resource init()
Deprecated. 
Description copied from class: AbstractVisualResource
Initialise this resource, and return it.

Specified by:
init in interface Resource
Overrides:
init in class AbstractVisualResource

initListeners

protected void initListeners()
Deprecated. 
Initialises all the listeners that this component has to register with other classes.


initLocalData

protected void initLocalData()
Deprecated. 
Initialises the local variables to their default values


initGuiComponents

protected void initGuiComponents()
Deprecated. 
Builds all the graphical components


isTextSelected

private boolean isTextSelected()
Deprecated. 
This method returns true if a text is selected in the textPane


getAnnotationSchemas

protected Set getAnnotationSchemas()
Deprecated. 
Gets all the AnnotationSchema objects currently loaded in the system.


removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)
Deprecated. 
Overrides:
removePropertyChangeListener in class Component

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)
Deprecated. 
Overrides:
addPropertyChangeListener in class Container

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener l)
Deprecated. 
Overrides:
addPropertyChangeListener in class Container

getDocument

public Document getDocument()
Deprecated. 
Return the current selected document


setTarget

public void setTarget(Object target)
Deprecated. 
Sets the document to be displayed

Specified by:
setTarget in interface VisualResource
Overrides:
setTarget in class AbstractVisualResource
Parameters:
target - the object (be it a Resource, DataStore or whatever) this viewer has to display

setHandle

public void setHandle(Handle handle)
Deprecated. 
Description copied from class: AbstractVisualResource
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.

Specified by:
setHandle in interface VisualResource
Overrides:
setHandle in class AbstractVisualResource

cleanup

public void cleanup()
Deprecated. 
Description copied from class: AbstractVisualResource
Does nothing now, but meant to clear all internal data

Specified by:
cleanup in interface Resource
Overrides:
cleanup in class AbstractVisualResource

getDisplayedAnnotations

public Set getDisplayedAnnotations()
Deprecated. 
This method returns a list of annotations which are currently shown in the annotations table or null of the table is empty.


getBreakPositions

private Vector getBreakPositions(String content)
Deprecated. 
Get positions of cut points inside a very large text without new line


correctLongLines

private Vector correctLongLines(StringBuffer buff)
Deprecated. 
Cut very long lines to pieces not grater than MAX_LINE_SIZE This is a correction of SWING problem with very long lines of text
Return positions of new line insertion.


longLinesCorrection

private int longLinesCorrection(int position)
Deprecated. 
Compute correction for additional new line in very long lines of text


this_documentChanged

protected void this_documentChanged()
Deprecated. 
Updates this component when the underlying document is changed. This method is only triggered when the document is changed to a new one and not when the internal data from the document changes.


getTypeData

protected DocumentEditor.TypeData getTypeData(String setName,
                                              String type)
Deprecated. 
Gets the data related to a given annotation type. An annotation type is uniquely identified by the name of its AnnotationSet and the name of the type. For the default annotation set of a document (which has no name) the "<Default>" value is used. Once a DocumentEditor.TypeData value has been obtained it can be used to change the way the respective type of annotations are displayed.

Parameters:
setName - a String, the name of the annotation set
type - a String, the name of the type.
Returns:
a DocumentEditor.TypeData value

showHighlights

protected void showHighlights(Set annotations,
                              AttributeSet style)
Deprecated. 
Repaints the highlighting for annotation types in the text display.


paintHighlights

protected void paintHighlights(Set annotations,
                               AttributeSet style)
Deprecated. 

repairHighlights

protected void repairHighlights(int start,
                                int end)
Deprecated. 
Called whenever a part of the textual display needs to be repainted because, for instance, of an edit operation.

Parameters:
start - the start offset for the area to be repainted
end - the end offset for the area to be repainted.

selectAnnotation

protected void selectAnnotation(String set,
                                Annotation ann)
Deprecated. 
Updates the GUI when the user has selected an annotation e.g. by using the right click popup. That basically means make the appropiate type of annotations visible in case it isn't already.


layoutComponents

protected void layoutComponents()
Deprecated. 
Creates the layout of this component acording to the set of subcomponents (text display, annotations table, etc.) that need to be visible.


updateCorefTree

protected void updateCorefTree()
Deprecated. 
Updates the coref tree from the coref data on the document's features


setEditable

public void setEditable(boolean newEditable)
Deprecated. 
Should the editor functionality of this component be enabled


isEditable

public boolean isEditable()
Deprecated. 
Is the editor functionality enabled


setAnnotationsTableVisible

public void setAnnotationsTableVisible(boolean annotationsTableVisible)
Deprecated. 

isAnnotationsTableVisible

public boolean isAnnotationsTableVisible()
Deprecated. 

setCoreferenceVisible

public void setCoreferenceVisible(boolean coreferenceVisible)
Deprecated. 

isCoreferenceVisible

public boolean isCoreferenceVisible()
Deprecated. 

setTextVisible

public void setTextVisible(boolean textVisible)
Deprecated. 

isTextVisible

public boolean isTextVisible()
Deprecated. 

setTypesTreeVisible

public void setTypesTreeVisible(boolean typesTreeVisible)
Deprecated. 

isTypesTreeVisible

public boolean isTypesTreeVisible()
Deprecated. 

setCorefOptionAvailable

public void setCorefOptionAvailable(boolean corefOptionAvailable)
Deprecated. 

isCorefOptionAvailable

public boolean isCorefOptionAvailable()
Deprecated.