DisplayWindow (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - java.awt.Window
    - - java.awt.Frame
      - javax.swing.JFrame
        
        loci.visbio.view.DisplayWindow

All Implemented Interfaces:

ActionListener, KeyListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants, Dynamic, Saveable, DisplayListener
```
public class DisplayWindow
extends JFrame
implements ActionListener, DisplayListener, Dynamic, KeyListener, Saveable
```
DisplayWindow is a window containing a 2D or 3D VisAD display and associated controls.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JFrame
  JFrame.AccessibleJFrame
- Nested classes/interfaces inherited from class java.awt.Frame
  Frame.AccessibleAWTFrame
- Nested classes/interfaces inherited from class java.awt.Window
  Window.AccessibleAWTWindow, Window.Type
- 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 CaptureHandler`	`captureHandler` Handles logic for capturing the display screenshots and movies.
`protected BreakawayPanel`	`controls` Breakaway panel for display controls.
`protected DisplayImpl`	`display` Associated VisAD display.
`protected String`	`initialEdge` Initial edge of breakaway panel.
`protected DisplayManager`	`manager` Associated display manager.
`protected String`	`name` Name of this display.
`protected JPanel`	`sliders` Panel containing dimensional slider widgets.
`protected static GraphicsConfiguration`	`STEREO` Stereo graphics configuration.
`protected String`	`string` String representation of this display.
`protected boolean`	`threeD` True if this display is 3D, false if 2D.
`protected TransformHandler`	`transformHandler` Handles logic for linking data transforms to the VisAD display.
`protected ViewHandler`	`viewHandler` Handles logic for controlling the VisAD display's view.

Fields inherited from class javax.swing.JFrame
accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description
`DisplayWindow()` Creates an uninitialized display object.
`DisplayWindow(DisplayManager dm)` Creates an uninitialized display object.
`DisplayWindow(DisplayManager dm, String name, boolean threeD)` Creates a new display object according to the given parameters.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(ActionEvent e)` Handles button presses.
`void`	`addTransform(DataTransform trans)` Links the given data transform to the display.
`protected void`	`createHandlers()` Constructs logic handlers.
`void`	`discard()` Called when this object is being discarded in favor of another object with a matching state.
`void`	`displayChanged(DisplayEvent e)` Listens for keyboard presses within the display.
`CaptureHandler`	`getCaptureHandler()` Gets the capture handler.
`BreakawayPanel`	`getControls()` Gets associated breakaway control panel.
`DisplayImpl`	`getDisplay()` Gets the associated VisAD display.
`static DisplayWindow`	`getDisplayWindow(DisplayImpl d)` Figures out which DisplayWindow contains the given display, if any.
`DisplayManager`	`getManager()` Gets associated display manager.
`String`	`getName()` Gets the name of this display.
`TransformHandler`	`getTransformHandler()` Gets the transform handler.
`ViewHandler`	`getViewHandler()` Gets the view handler.
`VisBioFrame`	`getVisBio()` Gets associated VisBio frame.
`boolean`	`hasTransform(DataTransform trans)` Gets whether the given transform is currently linked to the display.
`void`	`initState(Dynamic dyn)` Modifies this object's state to match that of the given object.
`boolean`	`is3D()` Gets whether this view handler's display is 3D.
`boolean`	`isCompatible(Dynamic dyn)` Tests whether the given dynamic object can be used as an argument to initState, for initializing this dynamic object.
`void`	`keyPressed(KeyEvent e)` Handles key presses.
`void`	`keyReleased(KeyEvent e)` Handles key releases.
`void`	`keyTyped(KeyEvent e)` Handles key strokes.
`boolean`	`matches(Dynamic dyn)` Tests whether two dynamic objects are equivalent.
`protected void`	`refresh()` Refreshes GUI components.
`void`	`removeAllTransforms()` Unlinks all data transforms from the display.
`void`	`removeTransform(DataTransform trans)` Removes the given data transform from the display.
`void`	`repack()` Enlarges the display to its preferred width and/or height if it is too small, keeping the display itself square.
`void`	`restoreState(Element el)` Restores the current state from the given DOM element ("Display").
`void`	`saveState(Element el)` Writes the current state to the given DOM element ("Displays").
`void`	`set3DTexturing(boolean texture3d)` Sets whether volume rendering uses 3D texturing.
`void`	`setTextureMapping(boolean textureMapping)` Sets wehther texture mapping is enabled.
`void`	`setTransparencyMode(boolean nice)` Sets whether transparency mode is nicest vs fastest.
`void`	`setVisible(boolean b)` Shows or hides this window.
`String`	`toString()` Gets a string representation of this display (just its name).

Methods inherited from class java.awt.Frame
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, show, toBack, toFront

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

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

Methods inherited from interface java.awt.MenuContainer
getFont, postEvent

- Field Detail
  - STEREO
```
protected static final GraphicsConfiguration STEREO
```
    Stereo graphics configuration.
  - name
```
protected String name
```
    Name of this display.
  - threeD
```
protected boolean threeD
```
    True if this display is 3D, false if 2D.
  - viewHandler
```
protected ViewHandler viewHandler
```
    Handles logic for controlling the VisAD display's view.
  - captureHandler
```
protected CaptureHandler captureHandler
```
    Handles logic for capturing the display screenshots and movies.
  - transformHandler
```
protected TransformHandler transformHandler
```
    Handles logic for linking data transforms to the VisAD display.
  - manager
```
protected DisplayManager manager
```
    Associated display manager.
  - display
```
protected DisplayImpl display
```
    Associated VisAD display.
  - sliders
```
protected JPanel sliders
```
    Panel containing dimensional slider widgets.
  - controls
```
protected BreakawayPanel controls
```
    Breakaway panel for display controls.
  - initialEdge
```
protected String initialEdge
```
    Initial edge of breakaway panel.
  - string
```
protected String string
```
    String representation of this display.
- Constructor Detail
  - DisplayWindow
```
public DisplayWindow()
```
    Creates an uninitialized display object.
  - DisplayWindow
```
public DisplayWindow(DisplayManager dm)
```
    Creates an uninitialized display object.
  - DisplayWindow
```
public DisplayWindow(DisplayManager dm,
                     String name,
                     boolean threeD)
```
    Creates a new display object according to the given parameters.
- Method Detail
  - repack
```
public void repack()
```
    Enlarges the display to its preferred width and/or height if it is too small, keeping the display itself square.
  - getVisBio
```
public VisBioFrame getVisBio()
```
    Gets associated VisBio frame.
  - getManager
```
public DisplayManager getManager()
```
    Gets associated display manager.
  - getDisplay
```
public DisplayImpl getDisplay()
```
    Gets the associated VisAD display.
  - getControls
```
public BreakawayPanel getControls()
```
    Gets associated breakaway control panel.
  - getViewHandler
```
public ViewHandler getViewHandler()
```
    Gets the view handler.
  - getCaptureHandler
```
public CaptureHandler getCaptureHandler()
```
    Gets the capture handler.
  - getTransformHandler
```
public TransformHandler getTransformHandler()
```
    Gets the transform handler.
  - getName
```
public String getName()
```
    Gets the name of this display.
    
    Overrides:
    
    getName in class Component
  - is3D
```
public boolean is3D()
```
    Gets whether this view handler's display is 3D.
  - addTransform
```
public void addTransform(DataTransform trans)
```
    Links the given data transform to the display.
  - removeTransform
```
public void removeTransform(DataTransform trans)
```
    Removes the given data transform from the display.
  - removeAllTransforms
```
public void removeAllTransforms()
```
    Unlinks all data transforms from the display.
  - hasTransform
```
public boolean hasTransform(DataTransform trans)
```
    Gets whether the given transform is currently linked to the display.
  - setTransparencyMode
```
public void setTransparencyMode(boolean nice)
```
    Sets whether transparency mode is nicest vs fastest.
  - setTextureMapping
```
public void setTextureMapping(boolean textureMapping)
```
    Sets wehther texture mapping is enabled.
  - set3DTexturing
```
public void set3DTexturing(boolean texture3d)
```
    Sets whether volume rendering uses 3D texturing.
  - setVisible
```
public void setVisible(boolean b)
```
    Shows or hides this window.
    
    Overrides:
    
    setVisible in class Window
  - toString
```
public String toString()
```
    Gets a string representation of this display (just its name).
    
    Overrides:
    
    toString in class Component
  - actionPerformed
```
public void actionPerformed(ActionEvent e)
```
    Handles button presses.
    
    Specified by:
    
    actionPerformed in interface ActionListener
  - displayChanged
```
public void displayChanged(DisplayEvent e)
```
    Listens for keyboard presses within the display.
    
    Specified by:
    
    displayChanged in interface DisplayListener
  - matches
```
public boolean matches(Dynamic dyn)
```
    Tests whether two dynamic objects are equivalent.
    
    Specified by:
    
    matches in interface Dynamic
  - isCompatible
```
public boolean isCompatible(Dynamic dyn)
```
    Tests whether the given dynamic object can be used as an argument to initState, for initializing this dynamic object.
    
    Specified by:
    
    isCompatible in interface Dynamic
  - initState
```
public void initState(Dynamic dyn)
```
    Modifies this object's state to match that of the given object. If the argument is null, the object is initialized according to its current state instead.
    
    Specified by:
    
    initState in interface Dynamic
  - discard
```
public void discard()
```
    Called when this object is being discarded in favor of another object with a matching state.
    
    Specified by:
    
    discard in interface Dynamic
  - keyPressed
```
public void keyPressed(KeyEvent e)
```
    Handles key presses.
    
    Specified by:
    
    keyPressed in interface KeyListener
  - keyReleased
```
public void keyReleased(KeyEvent e)
```
    Handles key releases.
    
    Specified by:
    
    keyReleased in interface KeyListener
  - keyTyped
```
public void keyTyped(KeyEvent e)
```
    Handles key strokes.
    
    Specified by:
    
    keyTyped in interface KeyListener
  - saveState
```
public void saveState(Element el)
               throws SaveException
```
    Writes the current state to the given DOM element ("Displays").
    
    Specified by:
    
    saveState in interface Saveable
    
    Throws:
    
    SaveException
  - restoreState
```
public void restoreState(Element el)
                  throws SaveException
```
    Restores the current state from the given DOM element ("Display").
    
    Specified by:
    
    restoreState in interface Saveable
    
    Throws:
    
    SaveException
  - createHandlers
```
protected void createHandlers()
```
    Constructs logic handlers.
  - refresh
```
protected void refresh()
```
    Refreshes GUI components.
  - getDisplayWindow
```
public static DisplayWindow getDisplayWindow(DisplayImpl d)
```
    Figures out which DisplayWindow contains the given display, if any.

Class DisplayWindow

Nested Class Summary

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

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

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

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

Fields inherited from class java.awt.Frame

Fields inherited from class java.awt.Component

Fields inherited from interface javax.swing.WindowConstants

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JFrame

Methods inherited from class java.awt.Frame

Methods inherited from class java.awt.Window

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Methods inherited from interface java.awt.MenuContainer

Field Detail

STEREO

name

threeD

viewHandler

captureHandler

transformHandler

manager

display

sliders

controls

initialEdge

string

Constructor Detail

DisplayWindow

DisplayWindow

DisplayWindow

Method Detail

repack

getVisBio

getManager

getDisplay

getControls

getViewHandler

getCaptureHandler

getTransformHandler

getName

is3D

addTransform

removeTransform

removeAllTransforms

hasTransform

setTransparencyMode

setTextureMapping

set3DTexturing

setVisible

toString

actionPerformed

displayChanged

matches

isCompatible

initState

discard

keyPressed

keyReleased

keyTyped

saveState

restoreState

createHandlers

refresh

getDisplayWindow