DialogPane (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - loci.visbio.util.DialogPane

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

Direct Known Subclasses:

ColorPane, FontChooserPane, MessagePane, OptionPane, SendToIJPane, SliceToggler, WizardPane
```
public class DialogPane
extends JPanel
implements ActionListener
```
DialogPane provides an extensible interface for creating dialogs with Ok and Cancel buttons.

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
`static int`	`APPROVE_OPTION` Return value if approve (ok) is chosen.
`protected JButton`	`cancel` Cancel button.
`static int`	`CANCEL_OPTION` Return value if cancel is chosen.
`protected JDialog`	`dialog` Currently visible dialog.
`protected JButton`	`ok` Ok button.
`protected JPanel`	`pane` Content pane for dialog.
`protected int`	`rval` Return value of dialog.
`protected String`	`title` Dialog's title.

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

DialogPane(String title)
Creates a dialog pane.

DialogPane(String title, boolean doCancel)
Creates a dialog pane.

Constructors
Constructor and Description
`DialogPane(String title)` Creates a dialog pane.
`DialogPane(String title, boolean doCancel)` Creates a dialog pane.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(ActionEvent e)` Handles button press events.
`protected JPanel`	`doButtonLayout()` Performs button layout.
`protected void`	`makeButtons(boolean doCancel)` Internal method for creating dialog buttons.
`void`	`resetComponents()` Resets the dialog pane's components to their default states.
`protected int`	`showDialog()` Displays a dialog using this dialog pane.
`int`	`showDialog(Component parent)` Displays a dialog using this dialog pane.
`int`	`showDialog(Component parent, boolean modal)` Displays a dialog using this dialog pane.
`int`	`showDialog(Dialog parent)` Displays a dialog using this dialog pane.
`int`	`showDialog(Dialog parent, boolean modal)` Displays a dialog using this dialog pane.
`int`	`showDialog(Frame parent)` Displays a dialog using this dialog pane.
`int`	`showDialog(Frame parent, boolean modal)` Displays a dialog using this dialog pane.

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
  - APPROVE_OPTION
```
public static final int APPROVE_OPTION
```
    Return value if approve (ok) is chosen.
    
    See Also:
    
    Constant Field Values
  - CANCEL_OPTION
```
public static final int CANCEL_OPTION
```
    Return value if cancel is chosen.
    
    See Also:
    
    Constant Field Values
  - ok
```
protected JButton ok
```
    Ok button.
  - cancel
```
protected JButton cancel
```
    Cancel button.
  - dialog
```
protected JDialog dialog
```
    Currently visible dialog.
  - pane
```
protected JPanel pane
```
    Content pane for dialog.
  - title
```
protected String title
```
    Dialog's title.
  - rval
```
protected int rval
```
    Return value of dialog.
- Constructor Detail
  - DialogPane
```
public DialogPane(String title)
```
    Creates a dialog pane.
  - DialogPane
```
public DialogPane(String title,
                  boolean doCancel)
```
    Creates a dialog pane.
- Method Detail
  - showDialog
```
public int showDialog(Component parent)
```
    Displays a dialog using this dialog pane.
  - showDialog
```
public int showDialog(Frame parent)
```
    Displays a dialog using this dialog pane.
  - showDialog
```
public int showDialog(Dialog parent)
```
    Displays a dialog using this dialog pane.
  - showDialog
```
public int showDialog(Component parent,
                      boolean modal)
```
    Displays a dialog using this dialog pane.
  - showDialog
```
public int showDialog(Frame parent,
                      boolean modal)
```
    Displays a dialog using this dialog pane.
  - showDialog
```
public int showDialog(Dialog parent,
                      boolean modal)
```
    Displays a dialog using this dialog pane.
  - resetComponents
```
public void resetComponents()
```
    Resets the dialog pane's components to their default states.
  - makeButtons
```
protected void makeButtons(boolean doCancel)
```
    Internal method for creating dialog buttons.
  - actionPerformed
```
public void actionPerformed(ActionEvent e)
```
    Handles button press events.
    
    Specified by:
    
    actionPerformed in interface ActionListener
  - showDialog
```
protected int showDialog()
```
    Displays a dialog using this dialog pane.
  - doButtonLayout
```
protected JPanel doButtonLayout()
```
    Performs button layout.

Class DialogPane

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

APPROVE_OPTION

CANCEL_OPTION

ok

cancel

dialog

pane

title

rval

Constructor Detail

DialogPane

DialogPane

Method Detail

showDialog

showDialog

showDialog

showDialog

showDialog

showDialog

resetComponents

makeButtons

actionPerformed

showDialog

doButtonLayout