net.sf.juife
Class OkCancelDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      net.sf.juife.EnhancedDialog
                          net.sf.juife.OkCancelDialog

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public abstract class OkCancelDialog
extends EnhancedDialog

This class can be used to simplify the creation of dialogs with 'OK' and 'Cancel' buttons. To create a dialog you only need to specify a Container that will be used as a main pane in the dialog and to implement the EnhancedDialog.onOk() and EnhancedDialog.onCancel() methods. The main pane can be set either by using one of the following constructors to create the dialog

• OkCancelDialog(Frame owner, Container mainPane)
• OkCancelDialog(Frame owner, String title, Container mainPane)
• OkCancelDialog(Frame owner, String title, Container mainPane, boolean modal)
• OkCancelDialog(Dialog owner, Container mainPane)
• OkCancelDialog(Dialog owner, String title, Container mainPane)
• OkCancelDialog(Dialog owner, String title, Container mainPane, boolean modal)

or by using the setMainPane(java.awt.Container) method.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JDialog.AccessibleJDialog

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

java.awt.Dialog.AccessibleAWTDialog

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

java.awt.Window.AccessibleAWTWindow

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

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

OkCancelDialog(java.awt.Dialog owner)
Creates a modal dialog without a title and with the specified Dialog as its owner.

OkCancelDialog(java.awt.Dialog owner, java.awt.Container mainPane)
Creates a modal dialog without a title and with the specified owner and main pane.

OkCancelDialog(java.awt.Dialog owner, java.lang.String title)
Creates a modal dialog with the specified title and owner Dialog.

OkCancelDialog(java.awt.Dialog owner, java.lang.String title, java.awt.Container mainPane)
Creates a modal dialog with the specified title, owner and main pane.

OkCancelDialog(java.awt.Dialog owner, java.lang.String title, java.awt.Container mainPane, boolean modal)
Creates a modal or non-modal dialog with the specified title, owner and main pane.

OkCancelDialog(java.awt.Frame owner)
Creates a modal dialog without a title and with the specified Frame as its owner.

OkCancelDialog(java.awt.Frame owner, java.awt.Container mainPane)
Creates a modal dialog without a title and with the specified owner and main pane.

OkCancelDialog(java.awt.Frame owner, java.lang.String title)
Creates a modal dialog with the specified title and owner Frame.

OkCancelDialog(java.awt.Frame owner, java.lang.String title, java.awt.Container mainPane)
Creates a modal dialog with the specified title, owner and main pane.

OkCancelDialog(java.awt.Frame owner, java.lang.String title, java.awt.Container mainPane, boolean modal)
Creates a modal or non-modal dialog with the specified title, owner and main pane.

Method Summary

boolean	isCancelled() This method can be used when the user closes the dialog to determine whether the dialog was cancelled.
void	setCancelled(boolean b) Sets whether the dialog was cancelled.
void	setMainPane(java.awt.Container mainPane) Sets the main pane of this dialog and centers the dialog relatvely to its owner.

Methods inherited from class net.sf.juife.EnhancedDialog

makeVisible, onCancel, onOk

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, 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, dispose, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, 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, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, firePropertyChange, firePropertyChange, firePropertyChange, 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, getMousePosition, 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, isMaximumSizeSet, isMinimumSizeSet, isOpaque, 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, 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, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OkCancelDialog

public OkCancelDialog(java.awt.Frame owner)

Creates a modal dialog without a title and with the specified Frame as its owner.

Parameters:

owner - Specifies the Frame from which this dialog is displayed.

OkCancelDialog

public OkCancelDialog(java.awt.Frame owner,
                      java.lang.String title)

Creates a modal dialog with the specified title and owner Frame.

Parameters:

owner - Specifies the Frame from which this dialog is displayed.

title - The text to be displayed in the dialog's title bar.

OkCancelDialog

public OkCancelDialog(java.awt.Frame owner,
                      java.awt.Container mainPane)

Creates a modal dialog without a title and with the specified owner and main pane.

Parameters:

owner - Specifies the Frame from which this dialog is displayed.

mainPane - A non-null Container instance that will be used as a main pane for this dialog.

Throws:

java.lang.IllegalArgumentException - If mainPane is null.

OkCancelDialog

public OkCancelDialog(java.awt.Frame owner,
                      java.lang.String title,
                      java.awt.Container mainPane)

Creates a modal dialog with the specified title, owner and main pane.

Parameters:

owner - Specifies the Frame from which this dialog is displayed.

title - The text to be displayed in the dialog's title bar.

mainPane - A non-null Container instance that will be used as a main pane for this dialog.

Throws:

java.lang.IllegalArgumentException - If mainPane is null.

OkCancelDialog

public OkCancelDialog(java.awt.Frame owner,
                      java.lang.String title,
                      java.awt.Container mainPane,
                      boolean modal)

Creates a modal or non-modal dialog with the specified title, owner and main pane.

Parameters:

owner - Specifies the Frame from which this dialog is displayed.

title - The text to be displayed in the dialog's title bar.

mainPane - A non-null Container instance that will be used as a main pane for this dialog.

modal - Specifies whether this dialog should be modal or not.

Throws:

java.lang.IllegalArgumentException - If mainPane is null.

OkCancelDialog

public OkCancelDialog(java.awt.Dialog owner)

Creates a modal dialog without a title and with the specified Dialog as its owner.

Parameters:

owner - Specifies the Dialog from which this dialog is displayed.

OkCancelDialog

public OkCancelDialog(java.awt.Dialog owner,
                      java.lang.String title)

Creates a modal dialog with the specified title and owner Dialog.

Parameters:

owner - Specifies the Dialog from which this dialog is displayed.

title - The text to be displayed in the dialog's title bar.

OkCancelDialog

public OkCancelDialog(java.awt.Dialog owner,
                      java.awt.Container mainPane)

Creates a modal dialog without a title and with the specified owner and main pane.

Parameters:

owner - Specifies the Dialog from which this dialog is displayed.

mainPane - A non-null Container instance that will be used as a main pane for this dialog.

Throws:

java.lang.IllegalArgumentException - If mainPane is null.

OkCancelDialog

public OkCancelDialog(java.awt.Dialog owner,
                      java.lang.String title,
                      java.awt.Container mainPane)

Creates a modal dialog with the specified title, owner and main pane.

Parameters:

owner - Specifies the Dialog from which this dialog is displayed.

title - The text to be displayed in the dialog's title bar.

mainPane - A non-null Container instance that will be used as a main pane for this dialog.

Throws:

java.lang.IllegalArgumentException - If mainPane is null.

OkCancelDialog

public OkCancelDialog(java.awt.Dialog owner,
                      java.lang.String title,
                      java.awt.Container mainPane,
                      boolean modal)

Creates a modal or non-modal dialog with the specified title, owner and main pane.

Parameters:

owner - Specifies the Dialog from which this dialog is displayed.

title - The text to be displayed in the dialog's title bar.

mainPane - A non-null Container instance that will be used as a main pane for this dialog.

modal - Specifies whether this dialog should be modal or not.

Throws:

java.lang.IllegalArgumentException - If mainPane is null.

Method Detail

isCancelled

public boolean isCancelled()

This method can be used when the user closes the dialog to determine whether the dialog was cancelled.

Returns:

true if the user cancels the dialog, false otherwise.

setCancelled

public void setCancelled(boolean b)

Sets whether the dialog was cancelled.

Parameters:

b - Specify true to indicate that this dialog was cancelled; false otherwise.

setMainPane

public void setMainPane(java.awt.Container mainPane)

Sets the main pane of this dialog and centers the dialog relatvely to its owner.

Parameters:

mainPane - A non-null Container instance that will be used as a main pane for this dialog.

Throws:

java.lang.IllegalArgumentException - If mainPane is null.