SurfaceToolGUI

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - org.openscience.jmol.app.surfacetool.SurfaceToolGUI

All Implemented Interfaces:

ActionListener, WindowFocusListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, ChangeListener, ListSelectionListener, WindowConstants
```
class SurfaceToolGUI
extends JPanel
implements WindowConstants, WindowListener, WindowFocusListener, ChangeListener, ActionListener, ListSelectionListener
```
GUI for the Jmol surfaceTool

Author:

Jonathan Gutow (gutow@uwosh.edu)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

(package private) class SurfaceToolGUI.SurfaceListCellRenderer
- 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

Nested Classes
Modifier and Type	Class and Description
`(package private) class`	`SurfaceToolGUI.SurfaceListCellRenderer`

Field Summary

Fields
Modifier and Type	Field and Description
`private JRadioButton`	`absoluteButton`
`private JComboBox<String>`	`angleUnitsList`
`private JPanel`	`angleUnitsPanel`
`private JSlider`	`angleXYSlider`
`private JSlider`	`angleZSlider`
`private JCheckBox`	`boundaryPlaneCheck`
`private JCheckBox`	`capCheck`
`private JPanel`	`capPlanesPanel`
`private JCheckBox`	`ghostCheck`
`private JPanel`	`ghostPanel`
`private HistoryFile`	`historyFile`
`private String`	`histWinName`
`private JPanel`	`normAnglePanel`
`private JPanel`	`objectsPanel`
`private JPanel`	`originPanel`
`private JSlider`	`positionSlider`
`private JPanel`	`positionThicknessPanel`
`private SurfaceTool`	`slicer`
`private JFrame`	`slicerFrame`
`private JPanel`	`sliderPanel`
`private JList<SurfaceStatus>`	`surfaceList`
`private JScrollPane`	`surfaceScrollPane`
`private JPanel`	`tabPanel`
`private JSlider`	`thicknessSlider`
`private JPanel`	`topPanel`
`private JRadioButton`	`viewCenterButton`
`private ButtonGroup`	`whichOrigin`

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 javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_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
`SurfaceToolGUI(boolean isDoubleBuffered)`
`SurfaceToolGUI(JmolViewer vwr, HistoryFile hfile, String winName, SurfaceTool slicer)` Builds and opens a GUI to control slicing.
`SurfaceToolGUI(LayoutManager layout)`
`SurfaceToolGUI(LayoutManager layout, boolean isDoubleBuffered)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(ActionEvent e)`
`(package private) JFrame`	`getFrame()`
`(package private) void`	`saveHistory()`
`private void`	`sliceSelected()`
`void`	`stateChanged(ChangeEvent e)`
`(package private) void`	`toFront()` Brings the surfaceTool to the front and updates sliders, etc...
`private void`	`updateAngleSliders()`
`private void`	`updatePositionSlider()`
`(package private) void`	`updateSurfaceList()`
`private void`	`updateThicknessSlider()`
`void`	`valueChanged(ListSelectionEvent e)`
`void`	`windowActivated(WindowEvent e)`
`void`	`windowClosed(WindowEvent e)`
`void`	`windowClosing(WindowEvent e)`
`void`	`windowDeactivated(WindowEvent e)`
`void`	`windowDeiconified(WindowEvent e)`
`void`	`windowGainedFocus(WindowEvent e)`
`void`	`windowIconified(WindowEvent e)`
`void`	`windowLostFocus(WindowEvent e)`
`void`	`windowOpened(WindowEvent e)`

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

historyFile
```
private HistoryFile historyFile
```

histWinName
```
private String histWinName
```

slicerFrame
```
private JFrame slicerFrame
```

slicer
```
private SurfaceTool slicer
```

tabPanel
```
private JPanel tabPanel
```

objectsPanel
```
private JPanel objectsPanel
```

topPanel
```
private JPanel topPanel
```

angleUnitsPanel
```
private JPanel angleUnitsPanel
```

angleUnitsList

private JComboBox<String> angleUnitsList

originPanel
```
private JPanel originPanel
```

viewCenterButton
```
private JRadioButton viewCenterButton
```

absoluteButton
```
private JRadioButton absoluteButton
```

capCheck
```
private JCheckBox capCheck
```

capPlanesPanel
```
private JPanel capPlanesPanel
```

ghostPanel
```
private JPanel ghostPanel
```

ghostCheck
```
private JCheckBox ghostCheck
```

boundaryPlaneCheck
```
private JCheckBox boundaryPlaneCheck
```

sliderPanel
```
private JPanel sliderPanel
```

normAnglePanel
```
private JPanel normAnglePanel
```

angleXYSlider
```
private JSlider angleXYSlider
```

angleZSlider
```
private JSlider angleZSlider
```

positionThicknessPanel
```
private JPanel positionThicknessPanel
```

positionSlider
```
private JSlider positionSlider
```

thicknessSlider
```
private JSlider thicknessSlider
```

whichOrigin
```
private ButtonGroup whichOrigin
```

surfaceScrollPane
```
private JScrollPane surfaceScrollPane
```

surfaceList

private JList<SurfaceStatus> surfaceList

Constructor Detail
- SurfaceToolGUI
```
SurfaceToolGUI(JmolViewer vwr,
               HistoryFile hfile,
               String winName,
               SurfaceTool slicer)
```
  Builds and opens a GUI to control slicing. Called automatically when a new SurfaceTool is created with useGUI = true.
  
  Parameters:
  
  vwr - (JmolViewer) the vwr that called for this surfaceTool.
  
  hfile - (HistoryFile) the history file used by this instance of Jmol
  
  winName - (String) name used for this window in history probably JmolPanel.SURFACETOOL_WINDOW_NAME
  
  slicer - (SurfaceTool) the surfaceTool that activated this GUI
- SurfaceToolGUI
```
SurfaceToolGUI(LayoutManager layout)
```
  Parameters:
  
  layout -
- SurfaceToolGUI
```
SurfaceToolGUI(boolean isDoubleBuffered)
```
  Parameters:
  
  isDoubleBuffered -
- SurfaceToolGUI
```
SurfaceToolGUI(LayoutManager layout,
               boolean isDoubleBuffered)
```
  Parameters:
  
  layout -
  
  isDoubleBuffered -

Method Detail
- actionPerformed
```
public void actionPerformed(ActionEvent e)
```
  Specified by:
  
  actionPerformed in interface ActionListener
- stateChanged
```
public void stateChanged(ChangeEvent e)
```
  Specified by:
  
  stateChanged in interface ChangeListener
- valueChanged
```
public void valueChanged(ListSelectionEvent e)
```
  Specified by:
  
  valueChanged in interface ListSelectionListener
- sliceSelected
```
private void sliceSelected()
```
- updatePositionSlider
```
private void updatePositionSlider()
```
- updateThicknessSlider
```
private void updateThicknessSlider()
```
- updateAngleSliders
```
private void updateAngleSliders()
```
- updateSurfaceList
```
void updateSurfaceList()
```
- saveHistory
```
void saveHistory()
```
- getFrame
```
JFrame getFrame()
```
  Returns:
  
  (JFrame) The frame for the slicerGUI
- toFront
```
void toFront()
```
  Brings the surfaceTool to the front and updates sliders, etc...
- windowGainedFocus
```
public void windowGainedFocus(WindowEvent e)
```
  Specified by:
  
  windowGainedFocus in interface WindowFocusListener
- windowLostFocus
```
public void windowLostFocus(WindowEvent e)
```
  Specified by:
  
  windowLostFocus in interface WindowFocusListener
- windowOpened
```
public void windowOpened(WindowEvent e)
```
  Specified by:
  
  windowOpened in interface WindowListener
- windowClosing
```
public void windowClosing(WindowEvent e)
```
  Specified by:
  
  windowClosing in interface WindowListener
- windowClosed
```
public void windowClosed(WindowEvent e)
```
  Specified by:
  
  windowClosed in interface WindowListener
- windowIconified
```
public void windowIconified(WindowEvent e)
```
  Specified by:
  
  windowIconified in interface WindowListener
- windowDeiconified
```
public void windowDeiconified(WindowEvent e)
```
  Specified by:
  
  windowDeiconified in interface WindowListener
- windowActivated
```
public void windowActivated(WindowEvent e)
```
  Specified by:
  
  windowActivated in interface WindowListener
- windowDeactivated
```
public void windowDeactivated(WindowEvent e)
```
  Specified by:
  
  windowDeactivated in interface WindowListener

Class SurfaceToolGUI

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 javax.swing.WindowConstants

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

historyFile

histWinName

slicerFrame

slicer

tabPanel

objectsPanel

topPanel

angleUnitsPanel

angleUnitsList

originPanel

viewCenterButton

absoluteButton

capCheck

capPlanesPanel

ghostPanel

ghostCheck

boundaryPlaneCheck

sliderPanel

normAnglePanel

angleXYSlider

angleZSlider

positionThicknessPanel

positionSlider

thicknessSlider

whichOrigin

surfaceScrollPane

surfaceList

Constructor Detail

SurfaceToolGUI

SurfaceToolGUI

SurfaceToolGUI

SurfaceToolGUI

Method Detail

actionPerformed

stateChanged

valueChanged

sliceSelected

updatePositionSlider

updateThicknessSlider

updateAngleSliders

updateSurfaceList

saveHistory

getFrame

toFront

windowGainedFocus

windowLostFocus

windowOpened

windowClosing

windowClosed

windowIconified

windowDeiconified

windowActivated

windowDeactivated