JHotDrawImageCanvas (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - net.imagej.ui.swing.viewer.image.JHotDrawImageCanvas

All Implemented Interfaces:

AdjustmentListener, ComponentListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, FigureSelectionListener, Disposable
```
public class JHotDrawImageCanvas
extends JPanel
implements AdjustmentListener, ComponentListener, FigureSelectionListener, Disposable
```
A renderer of an ImageCanvas, which uses JHotDraw's DefaultDrawingView component to do most of the work.

Author:

Curtis Rueden, Lee Kamentsky

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

JHotDrawImageCanvas(SwingImageDisplayViewer displayViewer)

Constructors
Constructor and Description
`JHotDrawImageCanvas(SwingImageDisplayViewer displayViewer)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEventDispatcher(AWTDropTargetEventDispatcher dispatcher)`
`void`	`addEventDispatcher(AWTInputEventDispatcher dispatcher)`
`void`	`adjustmentValueChanged(AdjustmentEvent e)`
`Dataset`	`capture()` Captures the current view of data displayed in the canvas, including all JHotDraw embellishments.
`void`	`componentHidden(ComponentEvent e)`
`void`	`componentMoved(ComponentEvent e)`
`void`	`componentResized(ComponentEvent e)`
`void`	`componentShown(ComponentEvent e)`
`void`	`dispose()` Clears any resources associated with this canvas.
`Drawing`	`getDrawing()`
`DrawingEditor`	`getDrawingEditor()`
`DefaultDrawingView`	`getDrawingView()`
`protected void`	`onEvent(DataViewDeselectedEvent event)`
`protected void`	`onEvent(DataViewSelectedEvent event)`
`protected void`	`onEvent(DisplayDeletedEvent event)`
`protected void`	`onEvent(FigureCreatedEvent event)` When a tool creates an overlay, add the overlay/figure combo to an `OverlayFigureView`.
`protected void`	`onEvent(MouseCursorEvent event)`
`protected void`	`onEvent(PanZoomEvent event)`
`protected void`	`onEvent(ToolActivatedEvent event)`
`void`	`selectionChanged(FigureSelectionEvent event)` Responds to the JHotDraw figure selection event by selecting and deselecting views whose state has changed.

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

- Constructor Detail
  - JHotDrawImageCanvas
```
public JHotDrawImageCanvas(SwingImageDisplayViewer displayViewer)
```
- Method Detail
  - getDrawing
```
public Drawing getDrawing()
```
  - getDrawingView
```
public DefaultDrawingView getDrawingView()
```
  - getDrawingEditor
```
public DrawingEditor getDrawingEditor()
```
  - addEventDispatcher
```
public void addEventDispatcher(AWTInputEventDispatcher dispatcher)
```
  - addEventDispatcher
```
public void addEventDispatcher(AWTDropTargetEventDispatcher dispatcher)
```
  - capture
```
public Dataset capture()
```
    Captures the current view of data displayed in the canvas, including all JHotDraw embellishments.
  - adjustmentValueChanged
```
public void adjustmentValueChanged(AdjustmentEvent e)
```
    Specified by:
    
    adjustmentValueChanged in interface AdjustmentListener
  - selectionChanged
```
public void selectionChanged(FigureSelectionEvent event)
```
    Responds to the JHotDraw figure selection event by selecting and deselecting views whose state has changed.
    
    Specified by:
    
    selectionChanged in interface FigureSelectionListener
    
    Parameters:
    
    event - Event indicating that the figure selections have changed.
  - componentResized
```
public void componentResized(ComponentEvent e)
```
    Specified by:
    
    componentResized in interface ComponentListener
  - componentMoved
```
public void componentMoved(ComponentEvent e)
```
    Specified by:
    
    componentMoved in interface ComponentListener
  - componentShown
```
public void componentShown(ComponentEvent e)
```
    Specified by:
    
    componentShown in interface ComponentListener
  - componentHidden
```
public void componentHidden(ComponentEvent e)
```
    Specified by:
    
    componentHidden in interface ComponentListener
  - onEvent
```
protected void onEvent(DataViewSelectedEvent event)
```
  - onEvent
```
protected void onEvent(DataViewDeselectedEvent event)
```
  - onEvent
```
protected void onEvent(ToolActivatedEvent event)
```
  - onEvent
```
protected void onEvent(DisplayDeletedEvent event)
```
  - onEvent
```
protected void onEvent(PanZoomEvent event)
```
  - onEvent
```
protected void onEvent(MouseCursorEvent event)
```
  - onEvent
```
protected void onEvent(FigureCreatedEvent event)
```
    When a tool creates an overlay, add the overlay/figure combo to an OverlayFigureView.
  - dispose
```
public void dispose()
```
    Clears any resources associated with this canvas. This is necessary to avoid deadlocks where finalization-dependent cleanup operations (e.g. PhantomReference queueing) are unable to proceed because this object is being held by a hard reference by the Finalizer (which the downstream resources are waiting on) implicit in upstream JViewport use.
    
    Specified by:
    
    dispose in interface Disposable

Class JHotDrawImageCanvas

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

JHotDrawImageCanvas

Method Detail

getDrawing

getDrawingView

getDrawingEditor

addEventDispatcher

addEventDispatcher

capture

adjustmentValueChanged

selectionChanged

componentResized

componentMoved

componentShown

componentHidden

onEvent

onEvent

onEvent

onEvent

onEvent

onEvent

onEvent

dispose