org.moyoman.client.reference.util
Class BaseDialog

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javax.swing.JDialog
                                |
                                +--org.moyoman.client.reference.util.BaseDialog

All Implemented Interfaces:

Accessible, IGUIConstants, ImageObserver, MenuContainer, RootPaneContainer, Serializable, WindowConstants

Direct Known Subclasses:

AboutDialog, DebugDialog, DebugModuleDialog, EditMessageDialog, GameDialog, HelperAdminDialog, MessageAdminDialog, ModeAdminDialog, ModuleAdminDialog, NewDialog, NewHelperNameDialog, NewHelperTypeDialog, NewLanguageDialog, NewModuleNameDialog, NewModuleTypeDialog, SystemAdminDialog

public abstract class BaseDialog

extends JDialog

implements IGUIConstants

Provides a generic dialog base class.

Since:

v0.01

Version:

v0.01

Author:

Jeffrey M. Thompson

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JDialog

JDialog.AccessibleJDialog

Nested classes inherited from class java.awt.Dialog

Dialog.AccessibleAWTDialog

Nested classes inherited from class java.awt.Window

Window.AccessibleAWTWindow

Nested classes inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

private boolean	_actionApproved Flag to indicate if this dialog was closed with OK or cancel.
private ActionManager	_actionManager Handle to the action manager.
private JButton	_applyButtonUI Handle to the apply button.
private JButton	_cancelButtonUI Handle to the cancel button.
private boolean	_initialLocationSet Flag indicating whether the initial location has been set.
private boolean	_isDirty Flag to indicate if data in this dialog has been changed.
private JButton	_okButtonUI Handle to the OK button.
private String	_ownerTitle The title string representing the owning application.

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

Fields inherited from class java.awt.Window

Fields inherited from class java.awt.Container

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface org.moyoman.client.reference.util.IGUIConstants

DEBUG, DIRTY_PROPERTY, GAP, MARGIN, TRANSPARENT_COLOR

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

protected	BaseDialog(Frame frame) Construct this dialog with the given parameter.
protected	BaseDialog(Frame frame, String ownerTitle) Construct this dialog with the given parameters.
protected	BaseDialog(JDialog dialog) Construct this dialog with the given parameter.
protected	BaseDialog(JDialog dialog, String ownerTitle) Construct this dialog with the given parameters.

Method Summary

private void	addButtonPanel(int numButtons) Add a panel which contains the given number of buttons.
protected void	addOKButtonPanel() Add a panel which contains the OK button.
protected void	addOKCancelApplyButtonsPanel() Add a panel which contains the OK, cancel, and apply buttons.
protected void	addOKCancelButtonsPanel() Add a panel which contains the OK and cancel buttons.
protected void	applyActionPerformed(ActionEvent event) Apply this dialog's settings..
protected void	cancelActionPerformed(ActionEvent event) Close this dialog with no other action.
protected void	checkComponents() Check components for their enable state.
private JButton	createApplyButton() Create the apply button with the appropriate action listener.
private JButton	createCancelButton() Create the cancel button with the appropriate action listener.
protected JLabel	createLabel(String key) Create a right-aligned label using the given key.
private JButton	createOKButton() Create the OK button with the appropriate action listener.
protected ActionManager	getActionManager() Return the action manager, creating it if necessary.
JButton	getApplyButton() Return the handle to the apply button.
JButton	getCancelButton() Return the handle to the cancel button.
JButton	getOKButton() Return the handle to the OK button.
protected void	init(String ownerTitle) Initialize this dialog.
boolean	isActionApproved() Return true if the action was approved.
boolean	isDirty() Answer true if data was changed in the dialog.
protected void	okActionPerformed(ActionEvent event) Callback for the OK button.
void	setCursorBusy(boolean busy) Set the cursor to show busy.
void	setDirty(boolean isDirty) Set the dirty flag.
void	setTitle(String title) Set the title of this dialog.
void	show() Show this 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, setUndecorated

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

_actionManager

private ActionManager _actionManager

Handle to the action manager.

_applyButtonUI

private JButton _applyButtonUI

Handle to the apply button.

_cancelButtonUI

private JButton _cancelButtonUI

Handle to the cancel button.

_okButtonUI

private JButton _okButtonUI

Handle to the OK button.

_ownerTitle

private String _ownerTitle

The title string representing the owning application.

_actionApproved

private boolean _actionApproved

Flag to indicate if this dialog was closed with OK or cancel.

_initialLocationSet

private boolean _initialLocationSet

Flag indicating whether the initial location has been set.

_isDirty

private boolean _isDirty

Flag to indicate if data in this dialog has been changed.

Constructor Detail

BaseDialog

protected BaseDialog(Frame frame)

Construct this dialog with the given parameter.

Parameters:

frame - The owning frame.

Since:

v0.01

BaseDialog

protected BaseDialog(JDialog dialog)

Construct this dialog with the given parameter.

Parameters:

dialog - The owning dialog.

Since:

v0.01

BaseDialog

protected BaseDialog(Frame frame,
                     String ownerTitle)

Construct this dialog with the given parameters.

Parameters:

frame - The owning frame.

Since:

v0.01

BaseDialog

protected BaseDialog(JDialog dialog,
                     String ownerTitle)

Construct this dialog with the given parameters.

Parameters:

dialog - The owning dialog.

Since:

v0.01

Method Detail

isActionApproved

public boolean isActionApproved()

Return true if the action was approved.

Since:

v0.01

getApplyButton

public JButton getApplyButton()

Return the handle to the apply button.

Since:

v0.01

getCancelButton

public JButton getCancelButton()

Return the handle to the cancel button.

Since:

v0.01

setCursorBusy

public void setCursorBusy(boolean busy)

Set the cursor to show busy.

Since:

v0.01

setDirty

public void setDirty(boolean isDirty)

Set the dirty flag.

Since:

v0.01

isDirty

public boolean isDirty()

Answer true if data was changed in the dialog.

Since:

v0.01

getOKButton

public JButton getOKButton()

Return the handle to the OK button.

Since:

v0.01

setTitle

public void setTitle(String title)

Set the title of this dialog.

Overrides:

setTitle in class Dialog

Since:

v0.01

show

public void show()

Show this dialog. If this is the first time, also set the dialog's location.

Overrides:

show in class Dialog

Since:

v0.01

getActionManager

protected ActionManager getActionManager()

Return the action manager, creating it if necessary.

Since:

v0.01

addOKButtonPanel

protected void addOKButtonPanel()

Add a panel which contains the OK button.

Since:

v0.01

addOKCancelApplyButtonsPanel

protected void addOKCancelApplyButtonsPanel()

Add a panel which contains the OK, cancel, and apply buttons.

Since:

v0.01

addOKCancelButtonsPanel

protected void addOKCancelButtonsPanel()

Add a panel which contains the OK and cancel buttons.

Since:

v0.01

applyActionPerformed

protected void applyActionPerformed(ActionEvent event)

Apply this dialog's settings..

Since:

v0.01

cancelActionPerformed

protected void cancelActionPerformed(ActionEvent event)

Close this dialog with no other action.

Since:

v0.01

checkComponents

protected void checkComponents()

Check components for their enable state. This method is called when the dirty flag is changed.

Since:

v0.01

createLabel

protected JLabel createLabel(String key)

Create a right-aligned label using the given key.

Since:

v0.02

init

protected void init(String ownerTitle)

Initialize this dialog.

Since:

v0.01

okActionPerformed

protected void okActionPerformed(ActionEvent event)

Callback for the OK button.

Since:

v0.01

addButtonPanel

private void addButtonPanel(int numButtons)

Add a panel which contains the given number of buttons.

Since:

v0.01

createApplyButton

private JButton createApplyButton()

Create the apply button with the appropriate action listener.

Since:

v0.01

createCancelButton

private JButton createCancelButton()

Create the cancel button with the appropriate action listener.

Since:

v0.01

createOKButton

private JButton createOKButton()

Create the OK button with the appropriate action listener.

Since:

v0.01