edu.northwestern.at.wordhoard.swing.calculator.dialogs
Class SkeletonDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      edu.northwestern.at.utils.swing.ModalDialog
                          edu.northwestern.at.wordhoard.swing.calculator.dialogs.SkeletonDialog

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:

AnalysisDialog, DescribeUserDataObjectDialog, SetDialog

public class SkeletonDialog
extends ModalDialog

Base class providing a skeleton for most WordHoard calculator dialogs..

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

protected java.awt.event.ActionListener	cancel Cancel button action listener.
protected javax.swing.JButton	cancelButton Cancel button, usually Cancel ro Close.
protected java.lang.String	cancelButtonName Cancel/close button name.
protected boolean	cancelled True if dialog cancelled.
protected java.awt.event.ActionListener	ok OK button action listener.
protected javax.swing.JButton	okButton Default button, usually OK or Delete.
protected java.lang.String	okButtonName OK button name.
protected java.awt.Window	parentWindow Parent window for dialog.
protected java.awt.event.ActionListener	revert Handles the Revert button.
protected javax.swing.JButton	revertButton Revert button, usually Revert.
protected java.lang.String	revertButtonName Revert button name.

Fields inherited from class edu.northwestern.at.utils.swing.ModalDialog

usePlatformPositionForDefaultButton

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

SkeletonDialog(java.lang.String dialogTitle, java.awt.Frame parentWindow, java.lang.String okButtonName, java.lang.String cancelButtonName, java.lang.String revertButtonName)
Create new dialog.

Method Summary

protected void	addFields(LabeledColumn dialogFields) Adds fields to the dialog.
protected void	buildDialog() Build the dialog.
protected void	disableAllDialogFields() Disable all dialog fields.
protected void	enableAllDialogFields() Enable all dialog fields.
boolean	getCancelled() Get dialog cancelled flag.
protected void	handleCancelButtonPressed(java.awt.event.ActionEvent event) Process cancel button pressed.
protected void	handleOKButtonPressed(java.awt.event.ActionEvent event) Handles the OK button pressed.
protected void	handleRevertButtonPressed(java.awt.event.ActionEvent event) Process revert button pressed.
protected void	initializeFields() Initialize the dialog fields.

Methods inherited from class edu.northwestern.at.utils.swing.ModalDialog

add, add, add, add, add, addButton, addDefaultButton, fixDefaultButtonPosition, getUsePlatformPositionForDefaultButton, paintImmediately, setInitialFocus, setUsePlatformPositionForDefaultButton, setVisible, show, showUnpacked, showUnpacked

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

Field Detail

parentWindow

protected java.awt.Window parentWindow

Parent window for dialog.

okButton

protected javax.swing.JButton okButton

Default button, usually OK or Delete.

cancelButton

protected javax.swing.JButton cancelButton

Cancel button, usually Cancel ro Close.

revertButton

protected javax.swing.JButton revertButton

Revert button, usually Revert.

okButtonName

protected java.lang.String okButtonName

OK button name.

cancelButtonName

protected java.lang.String cancelButtonName

Cancel/close button name.

revertButtonName

protected java.lang.String revertButtonName

Revert button name.

cancelled

protected boolean cancelled

True if dialog cancelled.

revert

protected java.awt.event.ActionListener revert

Handles the Revert button.

cancel

protected java.awt.event.ActionListener cancel

Cancel button action listener.

ok

protected java.awt.event.ActionListener ok

OK button action listener.

Constructor Detail

SkeletonDialog

public SkeletonDialog(java.lang.String dialogTitle,
                      java.awt.Frame parentWindow,
                      java.lang.String okButtonName,
                      java.lang.String cancelButtonName,
                      java.lang.String revertButtonName)

Create new dialog.

Parameters:

dialogTitle - Title for dialog.

parentWindow - Parent window for dialog.

okButtonName - The OK button name.

cancelButtonName - The Cancel button name.

revertButtonName - The Revert button name.

Method Detail

handleRevertButtonPressed

protected void handleRevertButtonPressed(java.awt.event.ActionEvent event)

Process revert button pressed.

Parameters:

event - The event.

Allows overriding the Revert button handling from a subclass.

handleCancelButtonPressed

protected void handleCancelButtonPressed(java.awt.event.ActionEvent event)

Process cancel button pressed.

Parameters:

event - The event.

Allows overriding the Close/Cancel button handling from a subclass.

handleOKButtonPressed

protected void handleOKButtonPressed(java.awt.event.ActionEvent event)

Handles the OK button pressed. Override in subclasses.

Parameters:

event - The event.

buildDialog

protected void buildDialog()

Build the dialog.

initializeFields

protected void initializeFields()

Initialize the dialog fields. Override in subclasses.

addFields

protected void addFields(LabeledColumn dialogFields)

Adds fields to the dialog. Override in subclasses.

Parameters:

dialogFields - The component holding the dialog fields.

enableAllDialogFields

protected void enableAllDialogFields()

Enable all dialog fields.

disableAllDialogFields

protected void disableAllDialogFields()

Disable all dialog fields.

getCancelled

public boolean getCancelled()

Get dialog cancelled flag.

Returns:

true if dialog cancelled, false otherwise.