CasAnnotationViewer (Apache UIMA Java SDK: uimaj 2.5.0 API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - org.apache.uima.tools.viewer.CasAnnotationViewer

All Implemented Interfaces:

ActionListener, ItemListener, MouseListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, TreeExpansionListener, TreeWillExpandListener
```
public class CasAnnotationViewer
extends JPanel
implements ActionListener, MouseListener, TreeWillExpandListener, TreeExpansionListener, ItemListener
```
A Swing component that displays annotations in a text pane with highlighting. There is also a tree view for display details of annotations on which the user clicks. This class extends JPanel and so can be reused within any Swing application.
To launch the viewer, call the setCAS(CAS) method with the CAS to be viewed.
The viewer is configurable via the following methods:
- setConsistentColors(boolean) - if set to true (default), the color assigned to any annotation type will be the same across all documents. If set to false, colors may vary across documents.
- setDisplayedTypes(String[]) - specifies a set of types that will be highlighted in the viewer's text pane.
- setHiddenTypes(String[]) - specifies a set of types that will NOT be highlighted in the viewer's text pane.
- setHiddenFeatures(String[]) - specifies a set of features that will never shown in the viewer's annotation details tree.
- setHighFrequencyTypes(String[]) - this can be used to specify a set of types that occur frequently. These types will the be assigned the most distinguishable colors.
- setInitiallySelectedTypes(String[]) - this can be used to specify a set of types that will initially be selected (i.e. have their checkboxes checked) in the viewer. The default is for all types to be initially selected.
- setRightToLeftTextOrientation(boolean) - switches the text pane from left-to-right (default) to right-to-left mode. This is needed to support languages such as Arabic and Hebrew, which are read from right to left.
See Also:
Serialized Form

Nested Class Summary
- 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
- 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

Constructors
Constructor and Description
`CasAnnotationViewer()` Creates a CAS Annotation Viewer.
`CasAnnotationViewer(boolean aEntityViewEnabled)` Deprecated. use the zero-argument constructor and call `setEntityViewEnabled(boolean)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(ActionEvent e)`
`protected void`	`addAnnotationToTree(AnnotationFS aAnnotation)` Adds an annotation to the selected annotations tree.
`void`	`applyBoldfaceToKeywords(String[] aWords)` Causes the specified words to appear in boldface wherever they occur in the document.
`void`	`applyBoldfaceToSpans(int[] aSpans)` Causes the specified spans to appear in boldface.
`void`	`assignCheckedFromList(ArrayList aNotChecked)` Assign initially checked to the specified types, pairing up down the lists
`void`	`assignColorsFromList(List aColors, ArrayList aTypeNames)` Assign colors to the specified types, pairing up down the lists
`void`	`configureViewForXmlFragmentsQuery(String aQuery)` Configures the viewer appropriately for displaying a hit against an XML fragments query.
`void`	`configureViewForXmlFragmentsQuery(String aQuery, String aTypeNamespace)` Configures the viewer appropriately for displaying a hit against an XML fragments query.
`protected JTree`	`getSelectedAnnotationTree()` Gets the selected annotation tree component.
`ArrayList`	`getUserTypes()`
`void`	`itemStateChanged(ItemEvent e)`
`void`	`mouseClicked(MouseEvent e)`
`void`	`mouseEntered(MouseEvent e)`
`void`	`mouseExited(MouseEvent e)`
`void`	`mousePressed(MouseEvent e)`
`void`	`mouseReleased(MouseEvent e)`
`void`	`setCAS(CAS aCAS)` Sets the CAS to be viewed.
`void`	`setConsistentColors(boolean aConsistent)` Sets whether colors will be consistent in all documents viewed using this viewer.
`void`	`setDisplayedTypes(String[] aDisplayedTypeNames)` Set the list of types that will be highlighted in the viewer.
`void`	`setEntityResolver(EntityResolver aEntityResolver)` Sets the `EntityResolver` to use when the viewer is in entity mode.
`void`	`setEntityViewEnabled(boolean aEnabled)` Configures whether the viewer will allow the user to switch to "Entity" view, which highlight entities rather than annotations.
`void`	`setHiddenFeatures(String[] aFeatureNames)` Configures the viewer to hide certain features in the annotation deatail pane.
`void`	`setHiddenTypes(String[] aTypeNames)` Set the list of types that will NOT be highlighted in the viewer.
`void`	`setHideUnselectedCheckboxes(boolean aHideUnselected)` Sets whether unselected (unchecked) checkboxes will be hidden entirely from the legend.
`void`	`setHighFrequencyTypes(String[] aTypeNames)` Set the list of types that occur most frequently.
`void`	`setInitiallySelectedTypes(String[] aTypeNames)` Configures the initially selected types in the viewer.
`void`	`setRightToLeftTextOrientation(boolean aRightToLeft)` Sets the text orientation.
`void`	`setSize(Dimension d)`
`void`	`setUserTypes(ArrayList userTypes)`
`void`	`treeCollapsed(TreeExpansionEvent event)`
`void`	`treeExpanded(TreeExpansionEvent event)`
`void`	`treeWillCollapse(TreeExpansionEvent event)`
`void`	`treeWillExpand(TreeExpansionEvent event)`

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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, addPropertyChangeListener, addPropertyChangeListener, 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, 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, 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, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CasAnnotationViewer
```
public CasAnnotationViewer()
```
    Creates a CAS Annotation Viewer.
  - CasAnnotationViewer
```
@Deprecated
public CasAnnotationViewer(boolean aEntityViewEnabled)
```
    Deprecated. use the zero-argument constructor and call setEntityViewEnabled(boolean)
- Method Detail
  - getUserTypes
```
public ArrayList getUserTypes()
```
    Returns:
    Returns the userTypes.
  - setUserTypes
```
public void setUserTypes(ArrayList userTypes)
```
    Parameters:
    userTypes - The userTypes to set.
  - setHighFrequencyTypes
```
public void setHighFrequencyTypes(String[] aTypeNames)
```
    Set the list of types that occur most frequently. This method assigns the most distinguishable colors to these types.
    
    Parameters:
    aTypeNames - names of types that are occur frequently. Ideally these should be ordered by frequency, with the most frequent being first.
  - setDisplayedTypes
```
public void setDisplayedTypes(String[] aDisplayedTypeNames)
```
    Set the list of types that will be highlighted in the viewer. Types not in this list will not appear in the legend and will never be highlighted. If this method is not called, the default is to show all types in the CAS (except those specifically hidden by a call to setHiddenTypes(String[]).
    
    Parameters:
    aDisplayedTypeNames - names of types that are to be highlighted. Null indicates that all types in the CAS should be highlighted.
  - setHiddenTypes
```
public void setHiddenTypes(String[] aTypeNames)
```
    Set the list of types that will NOT be highlighted in the viewer.
    
    Parameters:
    aTypeNames - names of types that are never to be highlighted.
  - setInitiallySelectedTypes
```
public void setInitiallySelectedTypes(String[] aTypeNames)
```
    Configures the initially selected types in the viewer. If not called, all types will be initially selected.
    
    Parameters:
    aTypeNames - array of fully-qualified names of types to be initially selected
  - setHiddenFeatures
```
public void setHiddenFeatures(String[] aFeatureNames)
```
    Configures the viewer to hide certain features in the annotation deatail pane.
    
    Parameters:
    aFeatureNames - array of (short) feature names to be hidden
  - setEntityViewEnabled
```
public void setEntityViewEnabled(boolean aEnabled)
```
    Configures whether the viewer will allow the user to switch to "Entity" view, which highlight entities rather than annotations. Entity mode is typically only useful if the setEntityResolver(EntityResolver) method has been called with a user-supplied class that can determine which annotations refer to the same entity.
    
    Parameters:
    aEnabled - true to enable entity viewing mode, false to allow annotation viewing only. The default is false.
  - setEntityResolver
```
public void setEntityResolver(EntityResolver aEntityResolver)
```
    Sets the EntityResolver to use when the viewer is in entity mode. Entity mode must be turned on using the setEntityViewEnabled(boolean) method.
    
    Parameters:
    aEntityResolver - user-supplied class that can determine which annotations correspond to the same entity.
  - setConsistentColors
```
public void setConsistentColors(boolean aConsistent)
```
    Sets whether colors will be consistent in all documents viewed using this viewer. If set to true, assignments of color to annotation type will persist across documents; if false, colors will be reassigned in each new document. (Note that if high frequency types are set via setHighFrequencyTypes(String[]), the colors for those types will always be consistent, regardless of the value passed to this method.
    
    Parameters:
    aConsistent - true (the default) causes colors to be consistent across documents, false allows them to vary
  - setRightToLeftTextOrientation
```
public void setRightToLeftTextOrientation(boolean aRightToLeft)
```
    Sets the text orientation. The default is left-to-right, but needs to be set to right-to-left to properly display some languages, most notably Arabic and Hebrew.
    
    Parameters:
    aRightToLeft - true to put the viewer in right-to-left mode, false for left-to-right (the default).
  - setHideUnselectedCheckboxes
```
public void setHideUnselectedCheckboxes(boolean aHideUnselected)
```
    Sets whether unselected (unchecked) checkboxes will be hidden entirely from the legend. This mode makes for a cleaner legend at the expense of making it more difficult to toggle which types are selected. There's also a button in the GUI that lets the user change this setting.
    
    Parameters:
    aHideUnselected -
  - setCAS
```
public void setCAS(CAS aCAS)
```
    Sets the CAS to be viewed. This must be called before display().
    
    Parameters:
    aCAS - the CSA to be viewed
  - applyBoldfaceToKeywords
```
public void applyBoldfaceToKeywords(String[] aWords)
```
    Causes the specified words to appear in boldface wherever they occur in the document. This is case-insensitive. Call this method after setCAS(CAS). It wil apply only to the current document, and will be reset on the next call to setCAS(CAS).
    
    Parameters:
    aWords - array of words to highlight in boldface.
  - applyBoldfaceToSpans
```
public void applyBoldfaceToSpans(int[] aSpans)
```
    Causes the specified spans to appear in boldface. This is case-insensitive. Call this method after setCAS(CAS). It wil apply only to the current document, and will be reset on the next call to setCAS(CAS).
    
    Parameters:
    aSpans - spans to appear in boldface (begin1, end1, begin2, end2, ...)
  - configureViewForXmlFragmentsQuery
```
public void configureViewForXmlFragmentsQuery(String aQuery,
                                     String aTypeNamespace)
```
    Configures the viewer appropriately for displaying a hit against an XML fragments query. This does not use a sophisticated algorithm for determining the location of the document that matched the query. Currently all it does is call setInitiallySelectedTypes(String[]) with the list of types mentioned in the query and applyBoldfaceToKeywords(String[]) on any keywords mentioned in the query.
    
    Parameters:
    aQuery - an XML fragments query
    aTypeNamespace - namespace to prepend to the element names in the query in order to form fully-qualified CAS type names. This is optional; if not specified, type namespaces are ignored and any type whose local name matches the query will be selected.
  - configureViewForXmlFragmentsQuery
```
public void configureViewForXmlFragmentsQuery(String aQuery)
```
    Configures the viewer appropriately for displaying a hit against an XML fragments query. This does not use a sophisticated algorithm for determining the location of the document that matched the query. Currently all it does is call setInitiallySelectedTypes(String[]) with the list of types mentioned in the query and applyBoldfaceToKeywords(String[]) on any keywords mentioned in the query.
    
    Parameters:
    aQuery - an XML fragments query
  - assignCheckedFromList
```
public void assignCheckedFromList(ArrayList aNotChecked)
```
    Assign initially checked to the specified types, pairing up down the lists
    
    Parameters:
    aNotChecked - list of types not to be initially checked JMP
  - assignColorsFromList
```
public void assignColorsFromList(List aColors,
                        ArrayList aTypeNames)
```
    Assign colors to the specified types, pairing up down the lists
    
    Parameters:
    aColors - list of colors
    aTypeNames - list of type names JMP
  - addAnnotationToTree
```
protected void addAnnotationToTree(AnnotationFS aAnnotation)
```
    Adds an annotation to the selected annotations tree. Annotations in the tree are grouped by type.
    
    Parameters:
    aAnnotation - the annotation to add
  - setSize
```
public void setSize(Dimension d)
```
    Overrides:
    
    setSize in class Component
    
    See Also:
    Component.setSize(Dimension)
  - actionPerformed
```
public void actionPerformed(ActionEvent e)
```
    Specified by:
    
    actionPerformed in interface ActionListener
  - mouseClicked
```
public void mouseClicked(MouseEvent e)
```
    Specified by:
    
    mouseClicked in interface MouseListener
  - mouseEntered
```
public void mouseEntered(MouseEvent e)
```
    Specified by:
    
    mouseEntered in interface MouseListener
  - mouseExited
```
public void mouseExited(MouseEvent e)
```
    Specified by:
    
    mouseExited in interface MouseListener
  - mousePressed
```
public void mousePressed(MouseEvent e)
```
    Specified by:
    
    mousePressed in interface MouseListener
  - mouseReleased
```
public void mouseReleased(MouseEvent e)
```
    Specified by:
    
    mouseReleased in interface MouseListener
  - treeWillCollapse
```
public void treeWillCollapse(TreeExpansionEvent event)
                      throws ExpandVetoException
```
    Specified by:
    
    treeWillCollapse in interface TreeWillExpandListener
    
    Throws:
    
    ExpandVetoException
  - treeWillExpand
```
public void treeWillExpand(TreeExpansionEvent event)
                    throws ExpandVetoException
```
    Specified by:
    
    treeWillExpand in interface TreeWillExpandListener
    
    Throws:
    
    ExpandVetoException
  - treeCollapsed
```
public void treeCollapsed(TreeExpansionEvent event)
```
    Specified by:
    
    treeCollapsed in interface TreeExpansionListener
  - treeExpanded
```
public void treeExpanded(TreeExpansionEvent event)
```
    Specified by:
    
    treeExpanded in interface TreeExpansionListener
  - itemStateChanged
```
public void itemStateChanged(ItemEvent e)
```
    Specified by:
    
    itemStateChanged in interface ItemListener
  - getSelectedAnnotationTree
```
protected JTree getSelectedAnnotationTree()
```
    Gets the selected annotation tree component.
    
    Returns:
    the tree that displays annotation details about annotations overlapping the point where the user last clicked in the text.

Class CasAnnotationViewer

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Constructor Detail

CasAnnotationViewer

CasAnnotationViewer

Method Detail

getUserTypes

setUserTypes

setHighFrequencyTypes

setDisplayedTypes

setHiddenTypes

setInitiallySelectedTypes

setHiddenFeatures

setEntityViewEnabled

setEntityResolver

setConsistentColors

setRightToLeftTextOrientation

setHideUnselectedCheckboxes

setCAS

applyBoldfaceToKeywords

applyBoldfaceToSpans

configureViewForXmlFragmentsQuery

configureViewForXmlFragmentsQuery

assignCheckedFromList

assignColorsFromList

addAnnotationToTree

setSize

actionPerformed

mouseClicked

mouseEntered

mouseExited

mousePressed

mouseReleased

treeWillCollapse

treeWillExpand

treeCollapsed

treeExpanded

itemStateChanged

getSelectedAnnotationTree