jas.util
Class JASDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      jas.util.JASDialog

All Implemented Interfaces:

MouseListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, DocumentListener, RootPaneContainer, WindowConstants

Direct Known Subclasses:

DateChooser, ErrorBox, PropertyDialog, SaveAsDialog, StatsWindow

public class JASDialog
extends JDialog
implements MouseListener, DocumentListener

JASDialog extends the built in java dialog to provide a number of extra features

• Automatic placement relative to parent frame
• OK, Cancel, Apply, and Help buttons at the bottom of the dialog box
• Automatic disposal of the dialog when the user hits OK, Cancel or closes the dialog using the window manager

To make components visible on this dialog, add them to the content pane.

Author:

Tony Johnson

See Also:

getContentPane(), Serialized Form

Nested Class Summary

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

JDialog.AccessibleJDialog

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

Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType

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

Window.AccessibleAWTWindow

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

static int	APPLY_BUTTON Include this in your flags to include an Apply button.
static int	CANCEL_BUTTON Include this in your flags to include a Cancel button.
static int	HELP_BUTTON Include this in your flags to include a Help button.
static int	OK_BUTTON Include this in your flags to include an OK button.

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

JASDialog(Dialog dlg, String title)
Creates a modal dialog with OK and Cancel buttons.

JASDialog(Dialog dlg, String title, boolean modal)
Creates a dialog with OK and Cancel buttons.

JASDialog(Dialog dlg, String t, boolean modal, int flags)
Creates a dialog box with any combination of buttons.

JASDialog(Frame frame, String title)
Creates a modal dialog with OK and Cancel buttons.

JASDialog(Frame frame, String title, boolean modal)
Creates a dialog with OK and Cancel buttons.

JASDialog(Frame f, String t, boolean modal, int flags)
Creates a dialog box with any combination of buttons.

Method Summary

protected void	callEnable() Forces the dialog to re-evaluate button enabling.
void	changedUpdate(DocumentEvent e) Calls callEnable() by default.
static JASDialog	create(Component c, String t, boolean modal, int flags)
static JASDialog	create(Frame frame, String title)
static JASDialog	create(Frame frame, String title, boolean modal)
void	defaultPack() Causes default pack; does not move dialog.
boolean	doModal() Forces a modal display of the dialog box
protected void	enableApply(JASState state) Override to customize when Apply is enabled.
protected void	enableHelp(JASState state) Override to customize when Help is enabled.
protected void	enableOK(JASState state) Override to customize when OK is enabled.
Container	getContentPane() Returns the content pane for the JASDialog, which is the panel (not including the buttons) where components can be added.
void	insertUpdate(DocumentEvent e) Calls callEnable() by default.
void	mouseClicked(MouseEvent e) Does nothing by default.
void	mouseEntered(MouseEvent e) Does nothing by default.
void	mouseExited(MouseEvent e) Does nothing by default.
void	mousePressed(MouseEvent e) Does nothing by default.
void	mouseReleased(MouseEvent e) Does nothing by default.
protected void	onApply() Called when the Apply button is pushed.
protected void	onCancel() Called when the Cancel button is pushed.
protected void	onOK() Called when the OK button is pushed.
void	pack() Causes a default pack(), but also places the dialog in the center of the parent frame.
void	processEvent(AWTEvent e) This method is public as an implementation side effect; do not call or override.
void	removeUpdate(DocumentEvent e) Calls callEnable() by default.
void	setApplyLabel(String label) Set the label on the Apply button.
void	setApplyMnemonic(char mnemonic) Sets the mnnemonic (or keyboard shortcut) for the Apply button.
void	setCancelLabel(String label) Set the label on the Cancel button.
void	setCancelMnemonic(char mnemonic) Sets the mnnemonic (or keyboard shortcut) for the Cancel button.
void	setContentPane(Container c) Sets the content pane.
void	setHelpTopic(String topic) Sets the name for the help topic that the Help button opens.
void	setOKLabel(String label) Set the label on the OK button.
void	setOKMnemonic(char mnemonic) Sets the mnnemonic (or keyboard shortcut) for the OK button.
void	show()

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, 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, setVisible, 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, postEvent, 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, paint, 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

Field Detail

OK_BUTTON

public static final int OK_BUTTON

Include this in your flags to include an OK button.

See Also:

Constant Field Values

APPLY_BUTTON

public static final int APPLY_BUTTON

Include this in your flags to include an Apply button.

See Also:

Constant Field Values

CANCEL_BUTTON

public static final int CANCEL_BUTTON

Include this in your flags to include a Cancel button.

See Also:

Constant Field Values

HELP_BUTTON

public static final int HELP_BUTTON

Include this in your flags to include a Help button.

See Also:

Constant Field Values

Constructor Detail

JASDialog

public JASDialog(Frame frame,
                 String title)

Creates a modal dialog with OK and Cancel buttons.

Parameters:

frame - the parent frame

title - the title for the dialog box

JASDialog

public JASDialog(Frame frame,
                 String title,
                 boolean modal)

Creates a dialog with OK and Cancel buttons.

Parameters:

frame - the parent frame

title - the title for the dialog box

modal - whether the dialog box is modal

JASDialog

public JASDialog(Frame f,
                 String t,
                 boolean modal,
                 int flags)

Creates a dialog box with any combination of buttons. Use bitwise logic to specify the appropriate flags in the flags parameter. For example,
JASDialog.OK_BUTTON | JASDialog.CANCEL_BUTTON | JASDialog.HELP_BUTTON
when passed as the flags parameter will create a button that has an OK button, a Cancel button, and a Help button.

Parameters:

dlg - the parent Dialog

title - the title for the dialog box

modal - whether the dialog box is modal

flags - option flags

JASDialog

public JASDialog(Dialog dlg,
                 String title)

Creates a modal dialog with OK and Cancel buttons.

Parameters:

frame - the parent frame

title - the title for the dialog box

JASDialog

public JASDialog(Dialog dlg,
                 String title,
                 boolean modal)

Creates a dialog with OK and Cancel buttons.

Parameters:

dlg - the parent Dialog

title - the title for the dialog box

modal - whether the dialog box is modal

JASDialog

public JASDialog(Dialog dlg,
                 String t,
                 boolean modal,
                 int flags)

Creates a dialog box with any combination of buttons. Use bitwise logic to specify the appropriate flags in the flags parameter. For example,
JASDialog.OK_BUTTON | JASDialog.CANCEL_BUTTON | JASDialog.HELP_BUTTON
when passed as the flags parameter will create a button that has an OK button, a Cancel button, and a Help button.

Parameters:

dlg - the parent Dialog

title - the title for the dialog box

modal - whether the dialog box is modal

flags - option flags

Method Detail

create

public static JASDialog create(Frame frame,
                               String title)

create

public static JASDialog create(Frame frame,
                               String title,
                               boolean modal)

create

public static JASDialog create(Component c,
                               String t,
                               boolean modal,
                               int flags)

pack

public void pack()

Causes a default pack(), but also places the dialog in the center of the parent frame.

Overrides:

pack in class Window

See Also:

Window.pack()

defaultPack

public void defaultPack()

Causes default pack; does not move dialog.

processEvent

public void processEvent(AWTEvent e)

This method is public as an implementation side effect; do not call or override.

Overrides:

processEvent in class Window

doModal

public boolean doModal()

Forces a modal display of the dialog box

Returns:

true if the OK button was pushed, otherwise false

show

public void show()

Overrides:

show in class Dialog

setOKLabel

public void setOKLabel(String label)

Set the label on the OK button. Allows for customized button labels.

setOKMnemonic

public void setOKMnemonic(char mnemonic)

Sets the mnnemonic (or keyboard shortcut) for the OK button. If you have changed the label using setOKLabel(String) the default mnemonic ('O') may not be appropriate, so use this method to set a better one.

Parameters:

mnemonic - the new key shortcut to use

See Also:

setOKLabel(String)

setCancelLabel

public void setCancelLabel(String label)

Set the label on the Cancel button. Allows for customized button labels.

setCancelMnemonic

public void setCancelMnemonic(char mnemonic)

Sets the mnnemonic (or keyboard shortcut) for the Cancel button. If you have changed the label using setCancelLabel(String) the default mnemonic ('C') may not be appropriate, so use this method to set a better one.

Parameters:

mnemonic - the new key shortcut to use

See Also:

setCancelLabel(String)

setApplyLabel

public void setApplyLabel(String label)

Set the label on the Apply button. Allows for customized button labels.

setApplyMnemonic

public void setApplyMnemonic(char mnemonic)

Sets the mnnemonic (or keyboard shortcut) for the Apply button. If you have changed the label using setApplyLabel(String) the default mnemonic ('A') may not be appropriate, so use this method to set a better one.

Parameters:

mnemonic - the new key shortcut to use

See Also:

setApplyLabel(String)

onOK

protected void onOK()

Called when the OK button is pushed. Override to provide customized functionality for derived dialog boxes.

onCancel

protected void onCancel()

Called when the Cancel button is pushed. Override to provide customized functionality for derived dialog boxes.

onApply

protected void onApply()

Called when the Apply button is pushed. Override to provide customized functionality for derived dialog boxes.

callEnable

protected void callEnable()

Forces the dialog to re-evaluate button enabling.

enableOK

protected void enableOK(JASState state)

Override to customize when OK is enabled. OK is enabled by default.

enableHelp

protected void enableHelp(JASState state)

Override to customize when Help is enabled. By default, Help is enabled if both a help book and help topic have been set.

See Also:

setHelpTopic(String)

enableApply

protected void enableApply(JASState state)

Override to customize when Apply is enabled. By default, Apply is disenabled.

getContentPane

public Container getContentPane()

Returns the content pane for the JASDialog, which is the panel (not including the buttons) where components can be added. Add components to this container to have them appear in the dialog.

Specified by:

getContentPane in interface RootPaneContainer

Overrides:

getContentPane in class JDialog

setContentPane

public void setContentPane(Container c)

Sets the content pane. The buttons are not members of this content pane.

Specified by:

setContentPane in interface RootPaneContainer

Overrides:

setContentPane in class JDialog

setHelpTopic

public final void setHelpTopic(String topic)

Sets the name for the help topic that the Help button opens. Note: This is now being used to set the XML target for JavaHelp.

mouseClicked

public void mouseClicked(MouseEvent e)

Does nothing by default. To use this class as a MouseListener, override only the method(s) you need.

Specified by:

mouseClicked in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)

Does nothing by default. To use this class as a MouseListener, override only the method(s) you need.

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

Does nothing by default. To use this class as a MouseListener, override only the method(s) you need.

Specified by:

mouseReleased in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Does nothing by default. To use this class as a MouseListener, override only the method(s) you need.

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Does nothing by default. To use this class as a MouseListener, override only the method(s) you need.

Specified by:

mouseExited in interface MouseListener

insertUpdate

public void insertUpdate(DocumentEvent e)

Calls callEnable() by default. To use this class as a DocumentListener, override only the method(s) you need.

Specified by:

insertUpdate in interface DocumentListener

See Also:

callEnable()

removeUpdate

public void removeUpdate(DocumentEvent e)

Calls callEnable() by default. To use this class as a DocumentListener, override only the method(s) you need.

Specified by:

removeUpdate in interface DocumentListener

See Also:

callEnable()

changedUpdate

public void changedUpdate(DocumentEvent e)

Calls callEnable() by default. To use this class as a DocumentListener, override only the method(s) you need.

Specified by:

changedUpdate in interface DocumentListener

See Also:

callEnable()