org.stringer.util
Class AbstractDialog

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javax.swing.JDialog
                                |
                                +--org.stringer.util.AbstractDialog

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:

AboutDialog, AvailableDialog, NewFeedDialog

public class AbstractDialog

extends javax.swing.JDialog

AbstractDialog provides a common set of services and a standard presentation for all dialogs within this application. The standard presentation consists of a button panel along the bottom (BorderLayout.SOUTH) of a dialog that may consist of OK, APPLY and/or CANCEL buttons and a main panel (BorderLayout.CENTER) that occupies the center of the dialog area.

Author:

R. Kevin Cole kcole@users.sourceforge.net

See Also:

Serialized Form

Nested Class Summary

private class	AbstractDialog.ApplyAction Handles the apply button.
private class	AbstractDialog.CancelAction Handles the Cancel button.
private class	AbstractDialog.CloseAction Handle the Close button.
private class	AbstractDialog.OkAction Handle the Okay button.

Field Summary

private AbstractDialog.ApplyAction	applyAction
static int	BUTTON_APPLY The button type for the apply button.
static int	BUTTON_CANCEL The button type for the cancel button.
static int	BUTTON_CLOSE The button type for the close button.
static int	BUTTON_NONE The button type for no buttons.
static int	BUTTON_OK The button type for the okay button.
private javax.swing.JPanel	buttonPanel optional buttons are placed in this panel and placed at BorderLayout.SOUTH within the dialog frame.
private AbstractDialog.CancelAction	cancelAction
private AbstractDialog.CloseAction	closeAction
private boolean	closeOnEnter When true, the okay action is invoked when the default enter-key is pressed.
private boolean	isOk
protected static org.apache.log4j.Logger	logger
private javax.swing.JPanel	mainPanel
private AbstractDialog.OkAction	okAction

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 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

AbstractDialog()
Constructs a default, standard dialog with OK and CANCEL buttons.

AbstractDialog(java.awt.Frame owner, java.lang.String title)

AbstractDialog(int buttons)
Constructs a dialog.

AbstractDialog(int buttons, java.awt.Dialog owner, java.lang.String title)

AbstractDialog(int buttons, java.awt.Frame owner, java.lang.String title)

Method Summary

boolean	apply() Dialog is closed, if true is returned.
void	close() Dispose of the dialog.
javax.swing.JPanel	getMainPanel() Returns the main panel.
protected void	initGui(int buttons)
boolean	isOk() Returns true, if the dialog was closed by pressing enter
void	setCloseOnEnter(boolean b)
void	setEnabled(int buttons, boolean b) Enable or disable buttons.
void	setMainComponent(java.awt.Component component) Sets the main component to component.

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, 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

logger

protected static org.apache.log4j.Logger logger

BUTTON_NONE

public static int BUTTON_NONE

The button type for no buttons.

BUTTON_OK

public static int BUTTON_OK

The button type for the okay button.

BUTTON_APPLY

public static int BUTTON_APPLY

The button type for the apply button.

BUTTON_CANCEL

public static int BUTTON_CANCEL

The button type for the cancel button.

BUTTON_CLOSE

public static int BUTTON_CLOSE

The button type for the close button.

applyAction

private AbstractDialog.ApplyAction applyAction

cancelAction

private AbstractDialog.CancelAction cancelAction

closeAction

private AbstractDialog.CloseAction closeAction

okAction

private AbstractDialog.OkAction okAction

isOk

private boolean isOk

buttonPanel

private javax.swing.JPanel buttonPanel

optional buttons are placed in this panel and placed at BorderLayout.SOUTH within the dialog frame.

mainPanel

private javax.swing.JPanel mainPanel

closeOnEnter

private boolean closeOnEnter

When true, the okay action is invoked when the default enter-key is pressed.

Constructor Detail

AbstractDialog

public AbstractDialog()

Constructs a default, standard dialog with OK and CANCEL buttons.

AbstractDialog

public AbstractDialog(int buttons)

Constructs a dialog. The escape key is by default bound to the cancel button.

Parameters:

buttons - a logical and combination of button type constants

AbstractDialog

public AbstractDialog(int buttons,
                      java.awt.Dialog owner,
                      java.lang.String title)

AbstractDialog

public AbstractDialog(int buttons,
                      java.awt.Frame owner,
                      java.lang.String title)

AbstractDialog

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

Method Detail

setEnabled

public void setEnabled(int buttons,
                       boolean b)

Enable or disable buttons.

Parameters:

buttons - a button identifier or a combination of identifiers.

b - the buttons are enabled when true or disabled when false.

setCloseOnEnter

public void setCloseOnEnter(boolean b)

initGui

protected void initGui(int buttons)

apply

public boolean apply()
              throws java.lang.IllegalArgumentException

Dialog is closed, if true is returned.

Throws:

java.lang.IllegalArgumentException

close

public void close()

Dispose of the dialog. Called by the actions to close the dialog.

setMainComponent

public void setMainComponent(java.awt.Component component)

Sets the main component to component.

getMainPanel

public javax.swing.JPanel getMainPanel()

Returns the main panel. Sub classes add components to this panel.

isOk

public boolean isOk()

Returns true, if the dialog was closed by pressing enter