org.annotation.wordfreak.viewer
Class TextViewer

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended byorg.annotation.wordfreak.viewer.Viewer
                      extended byorg.annotation.wordfreak.viewer.TextViewer
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, AnnotationSchemeListener, EventListener, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, Plugin, java.io.Serializable, javax.swing.event.TreeModelListener
Direct Known Subclasses:
ColorTextViewer, TypeTextViewer

public abstract class TextViewer
extends Viewer
implements javax.swing.event.TreeModelListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener

Displays the text of the source material and shows annotations within that text.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class org.annotation.wordfreak.viewer.Viewer
currentAnnotation, FEATURE_NAME, features, fontName, groups, HORIZONTAL, labels, NONE, outcomes, relationColor, selection, separators, showRelations, sortCriteria, statusBar, swipe, VERTICAL, view
 
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 java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
TextViewer(java.lang.String type)
           
 
Method Summary
 void addStyle(java.lang.String name, javax.swing.text.AttributeSet as)
          This allows an AnnotationScheme to change the background color for a particular annotation
protected  int adjustMouseOffset(java.awt.event.MouseEvent e)
          Computes adjusted offset for the specified event.
 void adjustSelectionLeft()
           
 void adjustSelectionRight()
           
 void annotation(Annotation a)
          Notifies the listener to focus display the specified annotation.
 void applyComponentOrientation(java.awt.ComponentOrientation o)
           
 void clearAnnotationHighlights()
           
 void clearAnnotationStyle(Annotation a)
           
 void copy()
           
 void cut()
           
 void deselectCurrentChain()
           
 void deselectCurrentRelation()
           
 void file(AnnotationFile af)
          Notifies the listener that the specified annotation file should be presented to the user.
protected  Annotation getAnnotationForOffset(int off)
           
static java.lang.String[] getNames()
           
 int getSplitType()
           
 void highlightAnnotation(Annotation a, java.awt.Color c)
           
 void initialize()
           
 void makeVisible(Annotation a)
          Notifies the listener to make sure the annotation is visible
 void mouseClicked(java.awt.event.MouseEvent e)
           
 void mouseDragged(java.awt.event.MouseEvent e)
           
 void mouseEntered(java.awt.event.MouseEvent e)
           
 void mouseExited(java.awt.event.MouseEvent e)
           
 void mouseMoved(java.awt.event.MouseEvent e)
           
 void mousePressed(java.awt.event.MouseEvent e)
           
 void mouseReleased(java.awt.event.MouseEvent e)
           
 void refresh()
          Notifies the listener that annotated files have been filtered in the scheme and may need to be redisplayed
 void reloadedFiles()
          Notifies the listener that annotated files have been reloaded in the scheme and may have been changed in arbitrary ways.
 void select(Annotation a)
          Notifies the listner that the specified annotation should be displayed as selected.
 void select(AnnotationSelection a)
          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 selectChain(Annotation a)
           
 void selectRelation(Annotation a)
           
 void setAnnotationStyle(Annotation a, java.lang.String name)
           
 void setBackgroundColor(Annotation a, java.awt.Color c)
           
 void setComponentOrientation(java.awt.ComponentOrientation o)
           
 void setFontSize(int size)
          Sets the font used by the viewer to the specified size.
 void setFontType(java.lang.String type)
          Set the name of the font used by the viewer to the specified font name.
 void treeNodesChanged(javax.swing.event.TreeModelEvent e)
           
 void treeNodesInserted(javax.swing.event.TreeModelEvent e)
           
 void treeNodesRemoved(javax.swing.event.TreeModelEvent e)
           
 void treeStructureChanged(javax.swing.event.TreeModelEvent e)
           
 
Methods inherited from class org.annotation.wordfreak.viewer.Viewer
actionPerformed, addAnnotation, addAnnotation, addListener, addProperty, addProperty, addProperty, addProperty, addProperty, clearKeyMaps, colorAttributeSet, deflag, dispose, eventTranspired, flagSpan, flagType, getContentPane, getFeaturesIterator, getPopup, markOutcomes, markOutcomes, moveAnnotation, outcomes, outcomes, outcomes, paste, progress, progress, rebuild, refresh, removeAnnotatedFile, removeAnnotation, removeContextualMenuItems, removeListener, setAnnotationView, setClipboard, setColorScheme, setContextualMenuItems, setContextualMenuItems, setGuiListener, setIcons, setKeyboardComponent, setKeyBuffer, setLayout, setProperty, setProperty, setProperty, setProperty, setProperty, setSortCriteria, showRelations, updateAnnotation
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, 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
 

Constructor Detail

TextViewer

public TextViewer(java.lang.String type)
Method Detail

getSplitType

public int getSplitType()
Overrides:
getSplitType in class Viewer

initialize

public void initialize()

getNames

public static java.lang.String[] getNames()

file

public void file(AnnotationFile af)
Description copied from interface: AnnotationSchemeListener
Notifies the listener that the specified annotation file should be presented to the user. This may be the file that is already displayed.

Specified by:
file in interface AnnotationSchemeListener
Overrides:
file in class Viewer

highlightAnnotation

public void highlightAnnotation(Annotation a,
                                java.awt.Color c)
Specified by:
highlightAnnotation in interface AnnotationSchemeListener
Overrides:
highlightAnnotation in class Viewer

clearAnnotationHighlights

public void clearAnnotationHighlights()
Specified by:
clearAnnotationHighlights in interface AnnotationSchemeListener
Overrides:
clearAnnotationHighlights in class Viewer

selectChain

public void selectChain(Annotation a)

selectRelation

public void selectRelation(Annotation a)

deselectCurrentRelation

public void deselectCurrentRelation()

deselectCurrentChain

public void deselectCurrentChain()

refresh

public void refresh()
Description copied from interface: AnnotationSchemeListener
Notifies the listener that annotated files have been filtered in the scheme and may need to be redisplayed

Specified by:
refresh in interface AnnotationSchemeListener
Specified by:
refresh in class Viewer

annotation

public void annotation(Annotation a)
Description copied from interface: AnnotationSchemeListener
Notifies the listener to focus display the specified annotation. This may be the annotation that is currently being displayed.

Specified by:
annotation in interface AnnotationSchemeListener
Overrides:
annotation in class Viewer

select

public void select(Annotation a)
Description copied from interface: AnnotationSchemeListener
Notifies the listner that the specified annotation should be displayed as selected.

Specified by:
select in interface AnnotationSchemeListener
Overrides:
select in class Viewer

select

public void select(AnnotationSelection a)
Description copied from interface: AnnotationSchemeListener
Notifies the listener that the specified selection should be displayed as selected.

Specified by:
select in interface AnnotationSchemeListener
Overrides:
select in class Viewer

select

public void select(Span selectionSpan)
Description copied from interface: AnnotationSchemeListener
Notifies the listner that the specified selection span should be displayed as selected.

Specified by:
select in interface AnnotationSchemeListener
Overrides:
select in class Viewer

makeVisible

public void makeVisible(Annotation a)
Description copied from interface: AnnotationSchemeListener
Notifies the listener to make sure the annotation is visible

Specified by:
makeVisible in interface AnnotationSchemeListener
Overrides:
makeVisible in class Viewer

cut

public void cut()
Overrides:
cut in class Viewer

copy

public void copy()
Overrides:
copy in class Viewer

addStyle

public void addStyle(java.lang.String name,
                     javax.swing.text.AttributeSet as)
Description copied from interface: AnnotationSchemeListener
This allows an AnnotationScheme to change the background color for a particular annotation

Specified by:
addStyle in interface AnnotationSchemeListener
Overrides:
addStyle in class Viewer

clearAnnotationStyle

public void clearAnnotationStyle(Annotation a)

setAnnotationStyle

public void setAnnotationStyle(Annotation a,
                               java.lang.String name)
Specified by:
setAnnotationStyle in interface AnnotationSchemeListener
Overrides:
setAnnotationStyle in class Viewer

setBackgroundColor

public void setBackgroundColor(Annotation a,
                               java.awt.Color c)
Specified by:
setBackgroundColor in interface AnnotationSchemeListener
Overrides:
setBackgroundColor in class Viewer

setFontType

public void setFontType(java.lang.String type)
Description copied from class: Viewer
Set the name of the font used by the viewer to the specified font name.

Overrides:
setFontType in class Viewer
Parameters:
type - The name of the font that the viewer should use.

setFontSize

public void setFontSize(int size)
Description copied from class: Viewer
Sets the font used by the viewer to the specified size.

Overrides:
setFontSize in class Viewer

adjustMouseOffset

protected int adjustMouseOffset(java.awt.event.MouseEvent e)
Computes adjusted offset for the specified event. This is to correct a seemingly random error in viewToModel where sometimes the next character offset is returned.

Parameters:
e - The mouse event.
Returns:
The adjusted offset.

getAnnotationForOffset

protected Annotation getAnnotationForOffset(int off)

reloadedFiles

public void reloadedFiles()
Description copied from interface: AnnotationSchemeListener
Notifies the listener that annotated files have been reloaded in the scheme and may have been changed in arbitrary ways.

Specified by:
reloadedFiles in interface AnnotationSchemeListener
Overrides:
reloadedFiles in class Viewer

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)
Specified by:
mouseClicked in interface java.awt.event.MouseListener

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)
Specified by:
mouseReleased in interface java.awt.event.MouseListener

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)
Specified by:
mouseEntered in interface java.awt.event.MouseListener

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)
Specified by:
mouseExited in interface java.awt.event.MouseListener

mouseMoved

public void mouseMoved(java.awt.event.MouseEvent e)
Specified by:
mouseMoved in interface java.awt.event.MouseMotionListener

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)
Specified by:
mousePressed in interface java.awt.event.MouseListener

mouseDragged

public void mouseDragged(java.awt.event.MouseEvent e)
Specified by:
mouseDragged in interface java.awt.event.MouseMotionListener

adjustSelectionLeft

public void adjustSelectionLeft()

adjustSelectionRight

public void adjustSelectionRight()

applyComponentOrientation

public void applyComponentOrientation(java.awt.ComponentOrientation o)

setComponentOrientation

public void setComponentOrientation(java.awt.ComponentOrientation o)

treeNodesChanged

public void treeNodesChanged(javax.swing.event.TreeModelEvent e)
Specified by:
treeNodesChanged in interface javax.swing.event.TreeModelListener

treeNodesInserted

public void treeNodesInserted(javax.swing.event.TreeModelEvent e)
Specified by:
treeNodesInserted in interface javax.swing.event.TreeModelListener

treeNodesRemoved

public void treeNodesRemoved(javax.swing.event.TreeModelEvent e)
Specified by:
treeNodesRemoved in interface javax.swing.event.TreeModelListener

treeStructureChanged

public void treeStructureChanged(javax.swing.event.TreeModelEvent e)
Specified by:
treeStructureChanged in interface javax.swing.event.TreeModelListener


Copyright © 2004 Thomas Morton and Jeremy LaCivita. All Rights Reserved.