org.openbp.swing.components
Class JStandardDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      org.openbp.swing.components.JStandardDialog

All Implemented Interfaces:

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

Direct Known Subclasses:

PasswordDialog

public class JStandardDialog
extends javax.swing.JDialog

The standard dialog consists of a scroll pane and a button pane containing an Ok and (optional) Cancel button. The scroll pane is the content pane of the dialog. Add any dialog component to the scroll pane, which can be retrieved by calling the getContentPane method. If the user clicks the 'Ok' button or presses ENTER, an Ok event will result. If the user clicks the 'Cancel' button, the close button of the title bar or presses ESCAPE, a Cancel event will be generated.
The Ok and Cancel events of the dialog can be processed by overriding the handleOk() and handleCancel() methods. If you want to hide or enable/disable a particular button or change the button text, use the getOkBtn() or getCancelBtn() methods to access the buttons. Show the dialog using the setVisible(boolean) method. The dialog will be displayed centered to the own window of the dialog (or the screen if there is none).

Author:

Heiko Erhardt

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, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

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.BaselineResizeBehavior, 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.Dialog

DEFAULT_MODALITY_TYPE

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

JStandardDialog()
Default constructor for a modal dialog.

JStandardDialog(boolean modal)
Constructor.

JStandardDialog(java.awt.Dialog owner, boolean modal)
Constructor.

JStandardDialog(java.awt.Dialog owner, java.lang.String title, boolean modal, java.awt.GraphicsConfiguration gc, boolean showbuttons)
Constructor.

JStandardDialog(java.awt.Frame owner)
Constructs a modal dialog.

JStandardDialog(java.awt.Frame owner, boolean modal)
Constructor.

JStandardDialog(java.awt.Frame owner, java.lang.String title, boolean modal, java.awt.GraphicsConfiguration gc, boolean showbuttons)
Constructor.

Method Summary

javax.swing.JPanel	getBtnPane() Gets the button pane.
javax.swing.JButton	getCancelBtn() Gets the cancel button.
javax.swing.JPanel	getMainPane() Gets the main content panel, which contains the actual contents of the dialog.
javax.swing.JButton	getOkBtn() Gets the ok button.
protected void	handleCancel() Handles the Ok event.
protected void	handleOk() Handles the Ok event.
boolean	isCancelled() Gets the status flag: Dialog was cancelled.
void	setCancelled(boolean cancelled) Sets the status flag: Dialog was cancelled.
void	setVisible(boolean visible) Shows or hides the dialog

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setModalityType, setResizable, setTitle, setUndecorated, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, 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, 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, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, 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, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

JStandardDialog

public JStandardDialog()

Default constructor for a modal dialog.

JStandardDialog

public JStandardDialog(java.awt.Frame owner)

Constructs a modal dialog.

Parameters:

owner - Owning frame. The dialog will be centered over the owner.

JStandardDialog

public JStandardDialog(boolean modal)

Constructor. Creates a dialog with event handling and buttons.

Parameters:

modal - true Display as modal dialog.
false Display as modeless dialog.

JStandardDialog

public JStandardDialog(java.awt.Frame owner,
                       boolean modal)

Constructor.

Parameters:

owner - Owning frame. The dialog will be centered over the owner.

modal - true Display as modal dialog.
false Display as modeless dialog.

JStandardDialog

public JStandardDialog(java.awt.Dialog owner,
                       boolean modal)

Constructor. Creates a dialog with event handling and buttons.

Parameters:

owner - Owning dialog. The dialog will be centered over the owner.

modal - true Display as modal dialog.
false Display as modeless dialog.

JStandardDialog

public JStandardDialog(java.awt.Frame owner,
                       java.lang.String title,
                       boolean modal,
                       java.awt.GraphicsConfiguration gc,
                       boolean showbuttons)

Constructor.

Parameters:

owner - Owning frame or null

title - Title of the dialog or null

modal - true Creates a modal dialog.
false Creates a modeless dialog.

gc - Graphics configuration or null - i.e. to use alternate desktop

showbuttons - true Shows the Ok and Cancel buttons.
false Does not add the button pane.

JStandardDialog

public JStandardDialog(java.awt.Dialog owner,
                       java.lang.String title,
                       boolean modal,
                       java.awt.GraphicsConfiguration gc,
                       boolean showbuttons)

Constructor.

Parameters:

owner - Owning Dialog or null

title - Title of the dialog or null

modal - true Creates a modal dialog.
false Creates a modeless dialog.

gc - Graphics configuration or null - i.e. to use alternate desktop

showbuttons - true Shows the Ok and Cancel buttons.
false Does not add the button pane.

Method Detail

setVisible

public void setVisible(boolean visible)

Shows or hides the dialog

Overrides:

setVisible in class java.awt.Dialog

Parameters:

visible - true Shows the dialog false Hides the dialog

handleOk

protected void handleOk()

Handles the Ok event. Called if the user clicks the 'Ok' button or presses ENTER. The default implementation hides the dialog and disposes it.

handleCancel

protected void handleCancel()

Handles the Ok event. Called if the user clicks the 'Cancel' button, the close button of the title bar or presses ESCAPE. The default implementation hides the dialog and disposes it.

getMainPane

public javax.swing.JPanel getMainPane()

Gets the main content panel, which contains the actual contents of the dialog.

getBtnPane

public javax.swing.JPanel getBtnPane()

Gets the button pane.

getOkBtn

public javax.swing.JButton getOkBtn()

Gets the ok button.

getCancelBtn

public javax.swing.JButton getCancelBtn()

Gets the cancel button.

isCancelled

public boolean isCancelled()

Gets the status flag: Dialog was cancelled.

setCancelled

public void setCancelled(boolean cancelled)

Sets the status flag: Dialog was cancelled.