dip.gui.dialog
Class XDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      dip.gui.dialog.XDialog

All Implemented Interfaces:

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

Direct Known Subclasses:

HeaderDialog, PressDialog

public class XDialog

extends javax.swing.JDialog

Extended JDialog

Features:

1. Automatically disposes dialog if close-button pressed, although this behavior can be changed by over-riding close()
2. Closes dialog if ESC pressed (calls close())
3. Internationalized button text, by default
4. Button constants
5. Help support

To add a default button, use JRootPane.setDefaultButton(); note that if a text panel/field is present then this will not work. If a read-only (non-editable) text component is present, it can be sub-classed to avoid receiving any keyboard input (override isFocusable()). See TextViewer for an example.

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

static java.lang.String	TEXT_ACCEPT Internationalized button text for "Accept"
static java.lang.String	TEXT_CANCEL Internationalized button text for "Cancel"
static java.lang.String	TEXT_CLOSE Internationalized button text for "Close"
static java.lang.String	TEXT_OK Internationalized button text for "OK"

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

XDialog()
Create an XDialog

XDialog(java.awt.Dialog owner)
Create an XDialog

XDialog(java.awt.Dialog owner, boolean modal)
Create an XDialog

XDialog(java.awt.Dialog owner, java.lang.String title)
Create an XDialog

XDialog(java.awt.Dialog owner, java.lang.String title, boolean modal)
Create an XDialog

XDialog(java.awt.Frame owner)
Create an XDialog

XDialog(java.awt.Frame owner, boolean modal)
Create an XDialog

XDialog(java.awt.Frame owner, java.lang.String title)
Create an XDialog

XDialog(java.awt.Frame owner, java.lang.String title, boolean modal)
Create an XDialog

Method Summary

protected void	close() Called when closing.
protected javax.swing.JRootPane	createRootPane() Adds the ESC key listener
protected void	dialogInit() Dialog setup, including adding Window-Close listener
void	setDefaultCloseOperation(int operation) Throws an IllegalArgumentException()
void	setHelpID(Help.HelpID helpID) Set the HelpID (see dip.misc.Help).

Methods inherited from class javax.swing.JDialog

addImpl, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, 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

TEXT_OK

public static final java.lang.String TEXT_OK

Internationalized button text for "OK"

TEXT_CANCEL

public static final java.lang.String TEXT_CANCEL

Internationalized button text for "Cancel"

TEXT_CLOSE

public static final java.lang.String TEXT_CLOSE

Internationalized button text for "Close"

TEXT_ACCEPT

public static final java.lang.String TEXT_ACCEPT

Internationalized button text for "Accept"

Constructor Detail

XDialog

public XDialog()

Create an XDialog

XDialog

public XDialog(java.awt.Frame owner)

Create an XDialog

XDialog

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

Create an XDialog

XDialog

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

Create an XDialog

XDialog

public XDialog(java.awt.Frame owner,
               java.lang.String title,
               boolean modal)

Create an XDialog

XDialog

public XDialog(java.awt.Dialog owner)

Create an XDialog

XDialog

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

Create an XDialog

XDialog

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

Create an XDialog

XDialog

public XDialog(java.awt.Dialog owner,
               java.lang.String title,
               boolean modal)

Create an XDialog

Method Detail

close

protected void close()

Called when closing. By default, calls dispose().

dialogInit

protected void dialogInit()

Dialog setup, including adding Window-Close listener

createRootPane

protected javax.swing.JRootPane createRootPane()

Adds the ESC key listener

setDefaultCloseOperation

public void setDefaultCloseOperation(int operation)

Throws an IllegalArgumentException()

setHelpID

public void setHelpID(Help.HelpID helpID)

Set the HelpID (see dip.misc.Help). If non-null, sets the Window-Level help for this dialog.