OverlayWidget (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - loci.visbio.overlays.OverlayWidget

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, Runnable, EventListener, Accessible, DocumentListener, ListSelectionListener, TransformListener
```
public class OverlayWidget
extends JPanel
implements ActionListener, DocumentListener, ListSelectionListener, Runnable, TransformListener
```
OverlayWidget is a set of GUI controls for an overlay transform.

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
Modifier and Type	Field and Description
`protected ButtonGroup`	`buttonGroup` Button group ensuring only one tool can be selected at a time.
`protected Vector`	`buttons` List of buttons for each overlay tool.
`protected JButton`	`chooseFont` Button for bringing up font chooser.
`protected JButton`	`color` Button for choosing overlay color.
`protected JButton`	`copy` Button for copying selected overlays to the clipboard.
`protected JTextField`	`currentFont` Text field indicating current font.
`protected JButton`	`dist` Button for distributing an overlay across all positions between the copied position and the one selected.
`protected JButton`	`export` Button for exporting overlays to .xls on disk.
`protected JCheckBox`	`filled` Check box indicating whether overlay should be filled or hollow.
`protected BioComboBox`	`groupList` Combo box for selecting an overlay group.
`protected boolean`	`ignoreEvents` Flag indicating AWT/Swing events should be ignored, used for programmatic update of GUI components.
`protected JButton`	`load` Button for loading overlays from disk.
`protected boolean`	`needRefresh` Flag indicating widget components need to be refreshed.
`protected JButton`	`newGroup` Button for creating a new overlay group.
`protected JTextField`	`notes` Text field for miscellaneous notes.
`protected OverlayTransform`	`overlay` Associated overlay object.
`protected JList`	`overlayList` List of overlays.
`protected DefaultListModel`	`overlayListModel` List model for overlay list.
`protected JFileChooser`	`overlayLoadBox` File chooser for loading overlays.
`protected JFileChooser`	`overlaySaveBox` File chooser for saving overlays.
`protected JFileChooser`	`overlayXLSBox` File chooser for exporting overlays to .xls format.
`protected JButton`	`paste` Button for pasting copied overlays onto the current position.
`protected Timer`	`refreshTimer` Timer for refreshing widget components 5 times per second.
`protected JButton`	`remove` Button for removing selected overlays.
`protected JButton`	`save` Button for saving overlays to disk.
`protected JTextArea`	`stats` Text area for overlay statistics.
`protected JTextField`	`text` Text field for text labels.
`protected Vector`	`tools` List of overlay tools.
`protected JTextField`	`x1` Text fields for (X, Y) coordinate pairs.
`protected JTextField`	`x2` Text fields for (X, Y) coordinate pairs.
`protected JTextField`	`y1` Text fields for (X, Y) coordinate pairs.
`protected JTextField`	`y2` Text fields for (X, Y) coordinate pairs.

Fields inherited from class javax.swing.JComponent
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
accessibleContext, 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

OverlayWidget(OverlayTransform overlay)
Creates overlay GUI controls.

Constructors
Constructor and Description
`OverlayWidget(OverlayTransform overlay)` Creates overlay GUI controls.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(ActionEvent e)` Handles button presses.
`void`	`addTool(OverlayTool tool)` Adds the given overlay tool to the overlay widget.
`void`	`changedUpdate(DocumentEvent e)`
`protected void`	`displayErrorMessage(String message)` Displays an error message.
`void`	`documentUpdate(DocumentEvent e)` Handles text field changes.
`Color`	`getActiveColor()` Gets currently active overlay color.
`String`	`getActiveGroup()` Gets currently active overlay group.
`OverlayTool`	`getActiveTool()` Gets the currently selected overlay tool.
`String`	`getNotes()` Gets notes for current overlay.
`String`	`getStatistics()` Gets statistics for current overlay.
`String`	`getText()` Gets text string for current overlay.
`float`	`getX1()` Gets X1 coordinate value for current overlay.
`float`	`getX2()` Gets X2 coordinate value for current overlay.
`float`	`getY1()` Gets Y1 coordinate value for current overlay.
`float`	`getY2()` Gets Y2 coordinate value for current overlay.
`void`	`insertUpdate(DocumentEvent e)`
`boolean`	`isFilled()` Gets whether current overlay is filled.
`protected void`	`launchSpreadsheet(File file)` Launches the spreadsheet.
`protected void`	`notifyListeners(boolean updateGUI)` Sends a TransformEvent to the overlay transform's listeners.
`protected void`	`refreshCurrentFont()` Sets the font text field to reflect the currently chosen font.
`void`	`refreshListObjects()` Updates items on overlay list based on current transform state.
`void`	`refreshListSelection()` Updates overlay list's selection based on current transform state.
`void`	`refreshPasteComponent(boolean enabled)` Updates copy and paste widget components to display data relevant to currently selected overlays.
`void`	`refreshWidgetComponents()` Updates right-hand widget components to display data relevant to currently selected overlays.
`void`	`removeUpdate(DocumentEvent e)`
`void`	`run()` Refreshes the list selection.
`void`	`setActiveColor(Color c)` Sets currently active overlay color.
`void`	`setActiveGroup(String group)` Sets currently active overlay group.
`void`	`setFilled(boolean fill)` Sets whether current overlay is filled.
`void`	`setNotes(String newText)` Sets notes for current overlay.
`void`	`setStatistics(String newText)` Sets statistics for current overlay.
`void`	`transformChanged(TransformEvent e)` Handles font changes.
`void`	`valueChanged(ListSelectionEvent e)` Handles list selection changes.

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, 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

- Field Detail
  - overlay
```
protected OverlayTransform overlay
```
    Associated overlay object.
  - buttonGroup
```
protected ButtonGroup buttonGroup
```
    Button group ensuring only one tool can be selected at a time.
  - tools
```
protected Vector tools
```
    List of overlay tools.
  - buttons
```
protected Vector buttons
```
    List of buttons for each overlay tool.
  - refreshTimer
```
protected Timer refreshTimer
```
    Timer for refreshing widget components 5 times per second.
  - needRefresh
```
protected boolean needRefresh
```
    Flag indicating widget components need to be refreshed.
  - ignoreEvents
```
protected boolean ignoreEvents
```
    Flag indicating AWT/Swing events should be ignored, used for programmatic update of GUI components.
  - overlaySaveBox
```
protected JFileChooser overlaySaveBox
```
    File chooser for saving overlays.
  - overlayLoadBox
```
protected JFileChooser overlayLoadBox
```
    File chooser for loading overlays.
  - overlayXLSBox
```
protected JFileChooser overlayXLSBox
```
    File chooser for exporting overlays to .xls format.
  - currentFont
```
protected JTextField currentFont
```
    Text field indicating current font.
  - chooseFont
```
protected JButton chooseFont
```
    Button for bringing up font chooser.
  - overlayList
```
protected JList overlayList
```
    List of overlays.
  - overlayListModel
```
protected DefaultListModel overlayListModel
```
    List model for overlay list.
  - remove
```
protected JButton remove
```
    Button for removing selected overlays.
  - copy
```
protected JButton copy
```
    Button for copying selected overlays to the clipboard.
  - paste
```
protected JButton paste
```
    Button for pasting copied overlays onto the current position.
  - dist
```
protected JButton dist
```
    Button for distributing an overlay across all positions between the copied position and the one selected.
  - load
```
protected JButton load
```
    Button for loading overlays from disk.
  - save
```
protected JButton save
```
    Button for saving overlays to disk.
  - export
```
protected JButton export
```
    Button for exporting overlays to .xls on disk.
  - x1
```
protected JTextField x1
```
    Text fields for (X, Y) coordinate pairs.
  - y1
```
protected JTextField y1
```
    Text fields for (X, Y) coordinate pairs.
  - x2
```
protected JTextField x2
```
    Text fields for (X, Y) coordinate pairs.
  - y2
```
protected JTextField y2
```
    Text fields for (X, Y) coordinate pairs.
  - text
```
protected JTextField text
```
    Text field for text labels.
  - color
```
protected JButton color
```
    Button for choosing overlay color.
  - filled
```
protected JCheckBox filled
```
    Check box indicating whether overlay should be filled or hollow.
  - groupList
```
protected BioComboBox groupList
```
    Combo box for selecting an overlay group.
  - newGroup
```
protected JButton newGroup
```
    Button for creating a new overlay group.
  - notes
```
protected JTextField notes
```
    Text field for miscellaneous notes.
  - stats
```
protected JTextArea stats
```
    Text area for overlay statistics.
- Constructor Detail
  - OverlayWidget
```
public OverlayWidget(OverlayTransform overlay)
```
    Creates overlay GUI controls.
- Method Detail
  - addTool
```
public void addTool(OverlayTool tool)
```
    Adds the given overlay tool to the overlay widget.
  - getActiveTool
```
public OverlayTool getActiveTool()
```
    Gets the currently selected overlay tool.
  - getX1
```
public float getX1()
```
    Gets X1 coordinate value for current overlay.
  - getY1
```
public float getY1()
```
    Gets Y1 coordinate value for current overlay.
  - getX2
```
public float getX2()
```
    Gets X2 coordinate value for current overlay.
  - getY2
```
public float getY2()
```
    Gets Y2 coordinate value for current overlay.
  - getText
```
public String getText()
```
    Gets text string for current overlay.
  - setActiveColor
```
public void setActiveColor(Color c)
```
    Sets currently active overlay color.
  - getActiveColor
```
public Color getActiveColor()
```
    Gets currently active overlay color.
  - setFilled
```
public void setFilled(boolean fill)
```
    Sets whether current overlay is filled.
  - isFilled
```
public boolean isFilled()
```
    Gets whether current overlay is filled.
  - setActiveGroup
```
public void setActiveGroup(String group)
```
    Sets currently active overlay group.
  - getActiveGroup
```
public String getActiveGroup()
```
    Gets currently active overlay group.
  - setNotes
```
public void setNotes(String newText)
```
    Sets notes for current overlay.
  - getNotes
```
public String getNotes()
```
    Gets notes for current overlay.
  - setStatistics
```
public void setStatistics(String newText)
```
    Sets statistics for current overlay.
  - getStatistics
```
public String getStatistics()
```
    Gets statistics for current overlay.
  - refreshListObjects
```
public void refreshListObjects()
```
    Updates items on overlay list based on current transform state.
  - refreshListSelection
```
public void refreshListSelection()
```
    Updates overlay list's selection based on current transform state.
  - refreshWidgetComponents
```
public void refreshWidgetComponents()
```
    Updates right-hand widget components to display data relevant to currently selected overlays.
  - refreshPasteComponent
```
public void refreshPasteComponent(boolean enabled)
```
    Updates copy and paste widget components to display data relevant to currently selected overlays.
  - actionPerformed
```
public void actionPerformed(ActionEvent e)
```
    Handles button presses.
    
    Specified by:
    
    actionPerformed in interface ActionListener
  - changedUpdate
```
public void changedUpdate(DocumentEvent e)
```
    Specified by:
    
    changedUpdate in interface DocumentListener
  - insertUpdate
```
public void insertUpdate(DocumentEvent e)
```
    Specified by:
    
    insertUpdate in interface DocumentListener
  - removeUpdate
```
public void removeUpdate(DocumentEvent e)
```
    Specified by:
    
    removeUpdate in interface DocumentListener
  - documentUpdate
```
public void documentUpdate(DocumentEvent e)
```
    Handles text field changes.
  - valueChanged
```
public void valueChanged(ListSelectionEvent e)
```
    Handles list selection changes.
    
    Specified by:
    
    valueChanged in interface ListSelectionListener
  - run
```
public void run()
```
    Refreshes the list selection.
    
    Specified by:
    
    run in interface Runnable
  - transformChanged
```
public void transformChanged(TransformEvent e)
```
    Handles font changes.
    
    Specified by:
    
    transformChanged in interface TransformListener
  - refreshCurrentFont
```
protected void refreshCurrentFont()
```
    Sets the font text field to reflect the currently chosen font.
  - notifyListeners
```
protected void notifyListeners(boolean updateGUI)
```
    Sends a TransformEvent to the overlay transform's listeners.
  - launchSpreadsheet
```
protected void launchSpreadsheet(File file)
```
    Launches the spreadsheet.
  - displayErrorMessage
```
protected void displayErrorMessage(String message)
```
    Displays an error message.

Class OverlayWidget

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

Field Detail

overlay

buttonGroup

tools

buttons

refreshTimer

needRefresh

ignoreEvents

overlaySaveBox

overlayLoadBox

overlayXLSBox

currentFont

chooseFont

overlayList

overlayListModel

remove

copy

paste

dist

load

save

export

x1

y1

x2

y2

text

color

filled

groupList

newGroup

notes

stats

Constructor Detail

OverlayWidget

Method Detail

addTool

getActiveTool

getX1

getY1

getX2

getY2

getText

setActiveColor

getActiveColor

setFilled

isFilled

setActiveGroup

getActiveGroup

setNotes

getNotes

setStatistics

getStatistics

refreshListObjects

refreshListSelection

refreshWidgetComponents

refreshPasteComponent

actionPerformed

changedUpdate

insertUpdate

removeUpdate

documentUpdate

valueChanged