org.tigris.swidgets
Class Dialog

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjava.awt.Window
              extended byjava.awt.Dialog
                  extended byjavax.swing.JDialog
                      extended byorg.tigris.swidgets.Dialog
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public abstract class Dialog
extends javax.swing.JDialog
implements java.awt.event.ActionListener

Base class for all dialogs, setting borders and component spacing.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JDialog
javax.swing.JDialog.AccessibleJDialog
 
Nested classes inherited from class java.awt.Dialog
java.awt.Dialog.AccessibleAWTDialog
 
Nested classes inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
protected static int CLOSE_OPTION
          Option type: CLOSE_OPTION
protected static int DEFAULT_OPTION
          Option type: DEFAULT_OPTION
protected static int OK_CANCEL_HELP_OPTION
          Option type: OK_CANCEL_HELP_OPTION
static int OK_CANCEL_OPTION
          Option type: OK_CANCEL_OPTION
protected static int YES_NO_CANCEL_HELP_OPTION
          Option type: YES_NO_CANCEL_HELP_OPTION
protected static int YES_NO_CANCEL_OPTION
          Option type: YES_NO_CANCEL_OPTION
protected static int YES_NO_HELP_OPTION
          Option type: YES_NO_HELP_OPTION
protected static int YES_NO_OPTION
          Option type: YES_NO_OPTION
 
Fields inherited from class javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
 
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, EXIT_ON_CLOSE, HIDE_ON_CLOSE
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
Dialog(java.awt.Frame owner, java.lang.String title, boolean modal)
          Creates a new Dialog with no content component.
Dialog(java.awt.Frame owner, java.lang.String title, int theOptionType, boolean modal)
          Creates a new Dialog with no content component, using the specified optionType to determine the set of available buttons.
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent e)
          Default implementation simply closes the dialog when any of the standard buttons is pressed except the Help button.
 void addButton(javax.swing.JButton button)
          Adds a new button to the set of available option buttons on the dialog.
 void addButton(javax.swing.JButton button, int index)
          Adds a new button to the set of available option buttons on the dialog.
protected  javax.swing.JButton getCancelButton()
           
protected  javax.swing.JButton getCloseButton()
           
protected  int getComponentGap()
           
 javax.swing.JComponent getContent()
          Returns the main component that is displayed within the dialog.
protected  javax.swing.JButton getHelpButton()
           
protected  int getLabelGap()
           
protected  javax.swing.JButton getNoButton()
           
protected  javax.swing.JButton getOkButton()
           
protected  javax.swing.JButton getYesButton()
           
protected abstract  void nameButtons()
          Subclasses may override this method to change the names and mnemonics of the various JButtons which appear at the bottom of the dialog.
 void setContent(javax.swing.JComponent theContent)
          Sets the main component to be displayed within the dialog.
 
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Dialog
addNotify, dispose, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, 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, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, 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, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, 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, isOpaque, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLOSE_OPTION

protected static final int CLOSE_OPTION
Option type: CLOSE_OPTION

See Also:
Constant Field Values

YES_NO_OPTION

protected static final int YES_NO_OPTION
Option type: YES_NO_OPTION

See Also:
Constant Field Values

YES_NO_HELP_OPTION

protected static final int YES_NO_HELP_OPTION
Option type: YES_NO_HELP_OPTION

See Also:
Constant Field Values

YES_NO_CANCEL_OPTION

protected static final int YES_NO_CANCEL_OPTION
Option type: YES_NO_CANCEL_OPTION

See Also:
Constant Field Values

YES_NO_CANCEL_HELP_OPTION

protected static final int YES_NO_CANCEL_HELP_OPTION
Option type: YES_NO_CANCEL_HELP_OPTION

See Also:
Constant Field Values

OK_CANCEL_OPTION

public static final int OK_CANCEL_OPTION
Option type: OK_CANCEL_OPTION

See Also:
Constant Field Values

OK_CANCEL_HELP_OPTION

protected static final int OK_CANCEL_HELP_OPTION
Option type: OK_CANCEL_HELP_OPTION

See Also:
Constant Field Values

DEFAULT_OPTION

protected static final int DEFAULT_OPTION
Option type: DEFAULT_OPTION

See Also:
Constant Field Values
Constructor Detail

Dialog

public Dialog(java.awt.Frame owner,
              java.lang.String title,
              boolean modal)
Creates a new Dialog with no content component. The default set of button(s) will be displayed. After creating the Dialog, call setContent() to configure the dialog before calling show() to display it.

Parameters:
owner - the owning Frame
title - the title String for the dialog
modal - true if the dialog is modal

Dialog

public Dialog(java.awt.Frame owner,
              java.lang.String title,
              int theOptionType,
              boolean modal)
Creates a new Dialog with no content component, using the specified optionType to determine the set of available buttons. After creating the Dialog, call setContent() to configure the dialog before calling show() to display it.

Parameters:
owner - the owning Frame
title - the title String for the dialog
theOptionType - defines which buttons will be available on the dialog
modal - true if the dialog is modal
Method Detail

getContent

public javax.swing.JComponent getContent()
Returns the main component that is displayed within the dialog.

Returns:
main component displayed in dialog

setContent

public final void setContent(javax.swing.JComponent theContent)
Sets the main component to be displayed within the dialog. Note: this method is final because it is most likely to be used in subclass constructors, and calling a class's overridable methods in its own constructor is not good practice.

Parameters:
theContent - main component to display in dialog

addButton

public void addButton(javax.swing.JButton button)
Adds a new button to the set of available option buttons on the dialog. The button will appear after the buttons specified by the optionType.

Parameters:
button - the button to add to the dialog.

addButton

public void addButton(javax.swing.JButton button,
                      int index)
Adds a new button to the set of available option buttons on the dialog. The button will appear at the specified index.

Parameters:
button - the button to add to the dialog.
index - index at which to insert new button (0 for first button)

getOkButton

protected javax.swing.JButton getOkButton()
Returns:
the requested button

getCancelButton

protected javax.swing.JButton getCancelButton()
Returns:
the requested button

getCloseButton

protected javax.swing.JButton getCloseButton()
Returns:
the requested button

getYesButton

protected javax.swing.JButton getYesButton()
Returns:
the requested button

getNoButton

protected javax.swing.JButton getNoButton()
Returns:
the requested button

getHelpButton

protected javax.swing.JButton getHelpButton()
Returns:
the requested button

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)
Default implementation simply closes the dialog when any of the standard buttons is pressed except the Help button.

Specified by:
actionPerformed in interface java.awt.event.ActionListener
See Also:
ActionListener.actionPerformed(java.awt.event.ActionEvent)

nameButtons

protected abstract void nameButtons()
Subclasses may override this method to change the names and mnemonics of the various JButtons which appear at the bottom of the dialog.


getComponentGap

protected int getComponentGap()
Returns:
Returns the componentGap.

getLabelGap

protected int getLabelGap()
Returns:
Returns the labelGap.