com.lf.commons.dialog

Class CustomDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

com.lf.commons.dialog.CustomDialog

All Implemented Interfaces:

ConfigurableUnit, java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class CustomDialog
extends javax.swing.JDialog
implements java.awt.event.ActionListener, ConfigurableUnit

Versatile dialog to carry arbitrary center components.

Some possible configurations may be utilized by calling one of the create... methods.

Since:

1.6

Version:

$Revision: 1.28 $, $Date: 2016/01/01 15:43:02 $

Author:

Axel Schwolow

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

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

Fields

Modifier and Type	Field and Description
static int	BUTTON_CANCEL Represents the CANCEL button.
static int	BUTTON_OK Represents the OK button.
protected java.util.Hashtable<java.lang.Integer,javax.swing.JButton>	customButtons Container with custom buttons (optional).
protected int	exitButton Code of the pressed button.
protected java.lang.String	helpID Identifier to call the help system (optional).
protected java.awt.Component	maincomp The custom component in center position.
protected java.awt.event.HierarchyBoundsListener	resizeListener Displays the dimension if resized.

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
CustomDialog() Constructor method for the dialog (modeless).
CustomDialog(java.awt.Dialog owner) Constructor method for the dialog.
CustomDialog(java.awt.Frame owner) Constructor method for the dialog.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Reacts on component interaction.
javax.swing.JButton	addCustomButton(java.lang.String text, java.lang.String tooltip, int code, int index) Sets a new button for this dialog.
void	allowEscapeOnKeyStroke(int strokeval) Adds a keyboard action to escape (close) the dialog (e.g. on escape).
void	configureUnit(java.lang.String id, Configuration config) Restores values from persistent data stores.
static CustomDialog	createCheckBoxDialog(java.awt.Component comp, java.lang.String title, java.lang.String bordertitle, java.lang.String hint) Convenience method to create a preconfigured dialog instance (CheckBoxPage).
static CustomDialog	createDialog(java.awt.Component comp, java.lang.String title, java.lang.String bordertitle, java.lang.String hint, java.awt.Component maincomp) Convenience method to create a preconfigured dialog instance.
static CustomDialog	createJWSUpdateDialog(java.awt.Component comp, DeployProps version) Convenience method to create a preconfigured dialog with JWSUpdateCustom.
static CustomDialog	createListDialog(java.awt.Component comp, java.lang.String title, java.lang.String bordertitle, java.lang.String hint) Convenience method to create a preconfigured dialog instance (JList).
static CustomDialog	createPlainTextDialog(java.awt.Component comp, java.lang.String title, java.lang.String bordertitle, java.lang.String hint) Convenience method to create a preconfigured dialog instance (JTextArea).
static CustomDialog	createRadioButtonDialog(java.awt.Component comp, java.lang.String title, java.lang.String bordertitle, java.lang.String hint) Convenience method to create a preconfigured dialog instance (RadioButtonPage).
static CustomDialog	createStyledTextDialog(java.awt.Component comp, java.lang.String title, java.lang.String bordertitle, java.lang.String hint) Convenience method to create a preconfigured dialog instance (JEditorPane).
int	execute() Shows the dialog on the screen and returns the code of the pressed button.
protected void	finalize() Cares for proper cleanup after releasing the object.
javax.swing.JButton	getButtonCancel() Provides the cancel button.
javax.swing.JButton	getButtonOK() Provides the OK button.
javax.swing.JButton	getCustomButton(int code) Provides a custom button.
java.awt.Component	getMainComponent() Provides the component in center position.
StatusBar	getStatusBar() Provides the component for messages.
boolean	isFlagSelected() Provides the state of the optional flag shown at the bottom of the dialog.
void	setBorderTitle(java.lang.String title) Sets the title displayed by the titled border.
void	setFlagText(java.lang.String text, boolean selected) Sets the text of the optional flag shown at the bottom of the dialog.
void	setHelpID(java.lang.String helpid) Sets the optional help link to call the help system.
void	setHint(java.lang.String hint) Sets the hint text displayed underneath the input field.
void	setShowBorder(boolean enabled) The titled border of the dialog may be disabled here.
void	setVisible(boolean visible) Activates or deactivates the dialog.
void	setVisibleFooter(boolean show) Enables/disables the footer components (hint and flag).
void	storeUnit(java.lang.String id, Configuration config) Stores the current configuration values persistently.
void	unitRegistered(ApplicationModel model, java.lang.String id) Informs the configurable unit that it was registered with a model.
void	unitUnregistered(ApplicationModel model, java.lang.String id) Informs the configurable unit that it was unregistered with a model.

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, 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, 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, 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, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BUTTON_OK

public static final int BUTTON_OK

Represents the OK button.

See Also:

Constant Field Values

BUTTON_CANCEL

public static final int BUTTON_CANCEL

Represents the CANCEL button.

See Also:

Constant Field Values

exitButton

protected int exitButton

Code of the pressed button.

helpID

protected java.lang.String helpID

Identifier to call the help system (optional).

maincomp

protected java.awt.Component maincomp

The custom component in center position.

resizeListener

protected java.awt.event.HierarchyBoundsListener resizeListener

Displays the dimension if resized.

customButtons

protected java.util.Hashtable<java.lang.Integer,javax.swing.JButton> customButtons

Container with custom buttons (optional).

Constructor Detail

CustomDialog

public CustomDialog()

Constructor method for the dialog (modeless).

Since:

1.6

CustomDialog

public CustomDialog(java.awt.Frame owner)

Constructor method for the dialog.

Parameters:

owner - The owner frame

Since:

1.6

CustomDialog

public CustomDialog(java.awt.Dialog owner)

Constructor method for the dialog.

Parameters:

owner - The owner dialog

Since:

1.6

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Cares for proper cleanup after releasing the object.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

Since:

1.6

setVisible

public void setVisible(boolean visible)

Activates or deactivates the dialog.

Overrides:

setVisible in class java.awt.Dialog

Parameters:

visible - The state of the dialog

Since:

1.6

allowEscapeOnKeyStroke

public void allowEscapeOnKeyStroke(int strokeval)

Adds a keyboard action to escape (close) the dialog (e.g. on escape).

The dialog is not disposed here since it may be recycled by an application. If the dialog can be closed by an escape character it also can be closed with the "X" window button. Normally this functionality is disabled.

Parameters:

strokeval - The desired escape key stroke like KeyEvent.VK_ESCAPE

Since:

1.6

setBorderTitle

public void setBorderTitle(java.lang.String title)

Sets the title displayed by the titled border.

Parameters:

title - Title displayed by the titled border, may be null

Since:

1.6

setShowBorder

public void setShowBorder(boolean enabled)

The titled border of the dialog may be disabled here.

Parameters:

enabled - Show border?

Since:

1.6

setHint

public void setHint(java.lang.String hint)

Sets the hint text displayed underneath the input field.

Parameters:

hint - Hint text, may be null

Since:

1.6

setVisibleFooter

public void setVisibleFooter(boolean show)

Enables/disables the footer components (hint and flag).

Parameters:

show - Show footer?

Since:

1.6

execute

public int execute()

Shows the dialog on the screen and returns the code of the pressed button.

Returns:

Code of the pressed button

createDialog

public static CustomDialog createDialog(java.awt.Component comp,
                        java.lang.String title,
                        java.lang.String bordertitle,
                        java.lang.String hint,
                        java.awt.Component maincomp)

Convenience method to create a preconfigured dialog instance.

If the parent window cannot be determined the dialog is created modeless instead. All texts and buttons have to be added manually.

Parameters:

comp - The component to search the parental window

title - The text displayed by the window decoration

bordertitle - The text displayed by the titled border

hint - The text displayed under the input field, may be null

maincomp - The component in center position

Returns:

The dialog

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

createStyledTextDialog

public static CustomDialog createStyledTextDialog(java.awt.Component comp,
                                  java.lang.String title,
                                  java.lang.String bordertitle,
                                  java.lang.String hint)

Convenience method to create a preconfigured dialog instance (JEditorPane).

Remember that you get a JScrollPane if you request the custom component!

Parameters:

comp - The component to search the parental window

title - The text displayed by the dialog

bordertitle - The text displayed by the titled border

hint - The text displayed under the input field, may be null

Returns:

The dialog

Since:

1.6

createPlainTextDialog

public static CustomDialog createPlainTextDialog(java.awt.Component comp,
                                 java.lang.String title,
                                 java.lang.String bordertitle,
                                 java.lang.String hint)

Convenience method to create a preconfigured dialog instance (JTextArea).

Remember that you get a JScrollPane if you request the custom component!

Parameters:

comp - The component to search the parental window

title - The text displayed by the dialog

bordertitle - The text displayed by the titled border

hint - The text displayed under the input field, may be null

Returns:

The dialog

Since:

1.6

createCheckBoxDialog

public static CustomDialog createCheckBoxDialog(java.awt.Component comp,
                                java.lang.String title,
                                java.lang.String bordertitle,
                                java.lang.String hint)

Convenience method to create a preconfigured dialog instance (CheckBoxPage).

Parameters:

comp - The component to search the parental window

title - The text displayed by the dialog

bordertitle - The text displayed by the titled border

hint - The text displayed under the input field, may be null

Returns:

The dialog

Since:

1.6

createRadioButtonDialog

public static CustomDialog createRadioButtonDialog(java.awt.Component comp,
                                   java.lang.String title,
                                   java.lang.String bordertitle,
                                   java.lang.String hint)

Convenience method to create a preconfigured dialog instance (RadioButtonPage).

Parameters:

comp - The component to search the parental window

title - The text displayed by the dialog

bordertitle - The text displayed by the titled border

hint - The text displayed under the input field, may be null

Returns:

The dialog

Since:

1.6

createListDialog

public static CustomDialog createListDialog(java.awt.Component comp,
                            java.lang.String title,
                            java.lang.String bordertitle,
                            java.lang.String hint)

Convenience method to create a preconfigured dialog instance (JList).

Parameters:

comp - The component to search the parental window

title - The text displayed by the dialog

bordertitle - The text displayed by the titled border

hint - The text displayed under the input field, may be null

Returns:

The dialog

Since:

1.6

createJWSUpdateDialog

public static CustomDialog createJWSUpdateDialog(java.awt.Component comp,
                                 DeployProps version)

Convenience method to create a preconfigured dialog with JWSUpdateCustom.

Exit codes: 0 = Update, 1 = Cancel, 3 = Update & Remove.

Parameters:

comp - The component to search the parental window

version - The application variables (required)

Returns:

The dialog

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

configureUnit

public void configureUnit(java.lang.String id,
                 Configuration config)

Restores values from persistent data stores.

Specified by:

configureUnit in interface ConfigurableUnit

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

storeUnit

public void storeUnit(java.lang.String id,
             Configuration config)

Stores the current configuration values persistently.

Specified by:

storeUnit in interface ConfigurableUnit

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

unitRegistered

public void unitRegistered(ApplicationModel model,
                  java.lang.String id)

Informs the configurable unit that it was registered with a model.

Specified by:

unitRegistered in interface ConfigurableUnit

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6

unitUnregistered

public void unitUnregistered(ApplicationModel model,
                    java.lang.String id)

Informs the configurable unit that it was unregistered with a model.

Specified by:

unitUnregistered in interface ConfigurableUnit

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6

setHelpID

public void setHelpID(java.lang.String helpid)

Sets the optional help link to call the help system.

Parameters:

helpid - The help system link

Since:

1.6

getButtonOK

public javax.swing.JButton getButtonOK()

Provides the OK button.

Returns:

The OK button

Since:

1.6

getButtonCancel

public javax.swing.JButton getButtonCancel()

Provides the cancel button.

Returns:

The cancel button

Since:

1.6

getCustomButton

public javax.swing.JButton getCustomButton(int code)

Provides a custom button.

Parameters:

code - The button code

Returns:

The button, may be null otherwise

Since:

1.6

getMainComponent

public java.awt.Component getMainComponent()

Provides the component in center position.

Returns:

The component

Since:

1.6

getStatusBar

public StatusBar getStatusBar()

Provides the component for messages.

Returns:

The bar

Since:

1.6

setFlagText

public void setFlagText(java.lang.String text,
               boolean selected)

Sets the text of the optional flag shown at the bottom of the dialog.

Parameters:

text - Text for the optional flag, null deactivates flag (default)

selected - Shall the flag be selected?

Since:

1.6

isFlagSelected

public boolean isFlagSelected()

Provides the state of the optional flag shown at the bottom of the dialog.

Returns:

Flag selected?

Since:

1.6

addCustomButton

public javax.swing.JButton addCustomButton(java.lang.String text,
                                  java.lang.String tooltip,
                                  int code,
                                  int index)

Sets a new button for this dialog.

Parameters:

text - The button text

tooltip - The button tooltip

code - The button code

index - The index to insert the new button, appended if -1

Returns:

The new button

Since:

1.6

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Reacts on component interaction.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

e - Event to be processed

Since:

1.6