de.schwarzrot.ui.control.support
Class AbstractDialogBase

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              de.schwarzrot.ui.control.support.AbstractDialogBase

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

AboutDialog, AbstractDetailsView, ApplicationConfigDialog, ColorChooser, FileChooser, FontChooser, HelpBrowser, MappingDetailDialog, MappingsDialog, OptionBundleDialog, OptionBundleListDialog, OptionDialog

public abstract class AbstractDialogBase
extends JComponent
implements Accessible

base class for common handling of application dialogs. Creates the button pane depending on the dialog mode and handles lifetime.

Standard dialogs consists of two components:

• the dialog, that pops up (with showDialog and closes on user action
• the derived class of this class, which is stil alive after the visual part has already been closed.

The visual part of the dialog will be created on the fly - buildPanel() is the function, that builds up the visual pane. Dialog decoration is also added on the fly.

This class has different lifetime, to allow access to changed data and/or allow multiple usage.

Author:

Reinhard Mantey

See Also:

Serialized Form

Nested Class Summary

static class	AbstractDialogBase.DialogMode
static class	AbstractDialogBase.Orientation

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

JComponent.AccessibleJComponent

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	APPROVE_OPTION
static int	CANCEL_OPTION
protected static FormComponentFactory	componentFactory
protected JDialog	dialog
static int	ERROR_OPTION
protected static MessageSource	msgSource
protected int	returnValue

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

protected	AbstractDialogBase()
protected	AbstractDialogBase(AbstractDialogBase.DialogMode dialogMode)

Method Summary

protected JComponent	buildButtonPane(JDialog dialog)
protected JComponent	buildButtonPane(JDialog dlg, AbstractDialogBase.Orientation orientation)
protected abstract JComponent	buildPanel()
protected JDialog	createDialog(Window parent)
JComponent	createPanel()
String	getApproveId()
Window	getDialog()
AbstractDialogBase.DialogMode	getDialogMode()
protected abstract String	getDialogTitle()
protected org.apache.commons.logging.Log	getLogger()
int	getReturnValue()
Dimension	getStartupSize()
protected void	performApprove()
protected void	performCancel()
protected void	performClose()
protected void	performReset()
void	setApproveId(String approveId)
void	setDialogMode(AbstractDialogBase.DialogMode dialogMode)
protected void	setReturnValue(int returnValue)
void	setStartupSize(Dimension startupSize)
int	showDialog(Component parent)
int	showDialog(Window parent)
int	showDialog(Window parent, String approveId)

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.accessibility.Accessible

getAccessibleContext

Field Detail

CANCEL_OPTION

public static final int CANCEL_OPTION

See Also:

Constant Field Values

APPROVE_OPTION

public static final int APPROVE_OPTION

See Also:

Constant Field Values

ERROR_OPTION

public static final int ERROR_OPTION

See Also:

Constant Field Values

msgSource

protected static MessageSource msgSource

componentFactory

protected static FormComponentFactory componentFactory

dialog

protected JDialog dialog

returnValue

protected int returnValue

Constructor Detail

AbstractDialogBase

protected AbstractDialogBase()

AbstractDialogBase

protected AbstractDialogBase(AbstractDialogBase.DialogMode dialogMode)

Method Detail

createPanel

public JComponent createPanel()

getApproveId

public final String getApproveId()

getDialog

public final Window getDialog()

getDialogMode

public final AbstractDialogBase.DialogMode getDialogMode()

getReturnValue

public final int getReturnValue()

getStartupSize

public final Dimension getStartupSize()

setApproveId

public final void setApproveId(String approveId)

setDialogMode

public final void setDialogMode(AbstractDialogBase.DialogMode dialogMode)

setStartupSize

public final void setStartupSize(Dimension startupSize)

showDialog

public int showDialog(Component parent)
               throws HeadlessException

Throws:

HeadlessException

showDialog

public int showDialog(Window parent)
               throws HeadlessException

Throws:

HeadlessException

showDialog

public int showDialog(Window parent,
                      String approveId)
               throws HeadlessException

Throws:

HeadlessException

buildButtonPane

protected JComponent buildButtonPane(JDialog dialog)

buildButtonPane

protected JComponent buildButtonPane(JDialog dlg,
                                     AbstractDialogBase.Orientation orientation)

buildPanel

protected abstract JComponent buildPanel()

createDialog

protected JDialog createDialog(Window parent)
                        throws HeadlessException

Throws:

HeadlessException

getDialogTitle

protected abstract String getDialogTitle()

getLogger

protected final org.apache.commons.logging.Log getLogger()

performApprove

protected void performApprove()

performCancel

protected void performCancel()

performClose

protected void performClose()

performReset

protected void performReset()

setReturnValue

protected final void setReturnValue(int returnValue)