com.fathzer.soft.ajlib.swing.dialog

Class AbstractDialog<T,V>

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

com.fathzer.soft.ajlib.swing.dialog.AbstractDialog<T,V>

Type Parameters:

T - The class of the parameter of the dialog (information that is useful to build the center pane).

V - The class of the result of the dialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public abstract class AbstractDialog<T,V>
extends JDialog

An abstract dialog with a customizable center pane, an Ok and/or a Cancel button.
By default, the dialog:

• is not resizable, call this.setResizable(true) to change this behavior (don't forget to call pack and set the minimum size after calling setResizable).
• has default close operation sets to DISPOSE_ON_CLOSE.

The dialog automatically wrap its center component in a JScollPane to guarantee that the dialog will never be bigger than the screen (in such a case ok/cancel buttons would be hidden).

Author:

Jean-Marc Astesana
License: LGPL v3

See Also:

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, Window.Type

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

Fields

Modifier and Type	Field and Description
protected T	data The data passed to the dialog's constructor.

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

Constructors

Constructor and Description
AbstractDialog(Window owner, String title, T data) Constructor

Method Summary

Modifier and Type	Method and Description
protected abstract V	buildResult() This method is called when the user clicks the ok button.
protected void	cancel() This method is called when the user clicks the cancel button.
protected void	confirm() This method is called when the user clicks the ok button.
protected JPanel	createButtonsPane() Gets the panel that contains the ok and cancel buttons.
protected abstract JPanel	createCenterPane() Gets the center pane of this dialog.
protected JComponent	createExtraComponent() Gets an extra component displayed on the same line as the buttons panel (see createButtonsPane()) on the left side.
protected JButton	getCancelButton() Gets the cancel button.
protected JButton	getOkButton() Gets the ok button.
protected String	getOkDisabledCause() Checks if the user input is consistent and return a short explanation of why it is not.
static Window	getOwnerWindow(Component component) Deprecated.
Dimension	getPreferredSize()
V	getResult() Gets the result of this dialog.
void	updateOkButtonEnabled() Forces the state of the users input to be evaluated and updates the state of the ok button.

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, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, 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, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, 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, 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, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

data

protected T data

The data passed to the dialog's constructor.

Constructor Detail

AbstractDialog

public AbstractDialog(Window owner,
                      String title,
                      T data)

Constructor

Parameters:

owner - Dialog's parent frame

title - Dialog's title

data - optional data (will be transfered to createContentPane)

Method Detail

createButtonsPane

protected JPanel createButtonsPane()

Gets the panel that contains the ok and cancel buttons.
This method creates a new JPanel with flow layout and ok and cancel buttons. Then, it defines ok has the default button.
It can be override to add more buttons.

Returns:

a JPanel

createExtraComponent

protected JComponent createExtraComponent()

Gets an extra component displayed on the same line as the buttons panel (see createButtonsPane()) on the left side.
By default, this method returns null.

Returns:

A JComponent or null if no component is provided.

getOkButton

protected JButton getOkButton()

Gets the ok button.
If you want the dialog not to have an ok button, you may set the visibility of this button to false with (getOkButton.setVisible(false)).

Returns:

The ok button.

getCancelButton

protected JButton getCancelButton()

Gets the cancel button. If you want the dialog not to have a cancel button, you may set the visibility of this button to false (getCancelButton.setVisible(false)).

Returns:

the cancel button.

createCenterPane

protected abstract JPanel createCenterPane()

Gets the center pane of this dialog. This method is called once by the constructor of the dialog. The data attribute is already set to the data parameter passed to the constructor.

Returns:

a panel

buildResult

protected abstract V buildResult()

This method is called when the user clicks the ok button.
This method should return the object, result of the dialog, that will be returned by getResult.
Note that it is not a good practice to override this method and set its visibility to public. You should prefer calling the getResult method as buildResult may instantiate a new object each time it is called.

Returns:

an object

See Also:

getResult()

confirm

protected void confirm()

This method is called when the user clicks the ok button.
It calls the buildResult method, stores the result, then closes the dialog.

See Also:

getResult()

cancel

protected void cancel()

This method is called when the user clicks the cancel button.
This default implementation closes the dialog.

getOkDisabledCause

protected String getOkDisabledCause()

Checks if the user input is consistent and return a short explanation of why it is not.
In this implementation, this method returns null. You should override this method if the input can be inconsistent.

Returns:

a short message explaining why the ok button is disabled or null if the ok button has to be enabled. This message will be displayed in the ok button toolTip.

getResult

public V getResult()

Gets the result of this dialog.

Returns:

an object, or null if the dialog was cancelled.

updateOkButtonEnabled

public void updateOkButtonEnabled()

Forces the state of the users input to be evaluated and updates the state of the ok button.

See Also:

getOkDisabledCause()

getPreferredSize

public Dimension getPreferredSize()

Overrides:

getPreferredSize in class Container

getOwnerWindow

@Deprecated
public static Window getOwnerWindow(Component component)

Deprecated.

Gets the window which contains a component.

Parameters:

component - the component

Returns:

The window containing the component or null if no window contains the component.

See Also:

Utils.getOwnerWindow(Component)