com.highqsoft.fwk.dialog

Class FwkDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

com.highqsoft.fwk.dialog.FwkDialog

All Implemented Interfaces:

FwkDialogInterface, FwkInterface, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class FwkDialog
extends javax.swing.JDialog
implements FwkDialogInterface

The FwkDialog is the general dialog for FWK components. It builds a dialog consisting of a chooser pane with "Ok", "Cancel", and "Reset" buttons.

Property Keyword	Datatype	Default	Description
FwkDialog.Text.Ok	String	FwkDialog.Text.Ok	The keyword for the Text Ok
FwkDialog.Mnemonic.Ok	char	FwkDialog.Mnemonic.Ok	The keyword for the mnemonic for the Ok button.
FwkDialog.Text.Back	String	FwkDialog.Text.Back	The keyword for the Text Back
FwkDialog.Text.Cancel	String	FwkDialog.Text.Cancel	The keyword for the Text Cancel
FwkDialog.Mnemonic.Cancel	char	FwkDialog.Mnemonic.Cancel	The keyword for the mnemonic for the Cancel button.
FwkDialog.Text.Reset	String	FwkDialog.Text.Reset	The keyword for the Text Reset
FwkDialog.Mnemonic.Reset	char	FwkDialog.Mnemonic.Reset	The keyword for the mnemonic for the Reset button.
FwkDialog.Text.Close	String	FwkDialog.Text.Close	The keyword for the Text Close
FwkDialog.Mnemonic.Close	char	FwkDialog.Mnemonic.Close	The keyword for the mnemonic for the Close button.
FwkDialog.Text.Help	String	FwkDialog.Text.Help	The keyword for the Text Help
FwkDialog.Mnemonic.Help	char	FwkDialog.Mnemonic.Help	The keyword for the mnemonic for the Help button.

Since:

$Date: 2017/04/06 13:29:05 $

Version:

$Revision: 1.19 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FwkDialog.CancelActionListener The cancel listener.
class	FwkDialog.KeyboardListener The keyboard listener.
class	FwkDialog.OkActionListener The main action listener for the ok button.

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
protected java.awt.CardLayout	cardLayout
protected javax.swing.JPanel	cardPanel
protected static FwkHelp	fwkHelp
protected static java.lang.String	HELP_PANEL
protected javax.swing.JPanel	helpPanel
static java.lang.String	version
protected static java.lang.String	WORKING_PANEL

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 com.highqsoft.interfaces.fwk.FwkDialogInterface

CANCEL_BUTTON, CLOSE_BUTTON, HELP_BUTTON, OK_BUTTON, RESET_BUTTON

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
FwkDialog(java.awt.Component parent, java.lang.String title, boolean modal, FwkDialogPaneInterface[] pane, java.awt.event.ActionListener okListener, java.awt.event.ActionListener cancelListener, java.awt.event.ActionListener resetListener, java.awt.event.ActionListener closeListener) The constructor for multi-pane dialogs.
FwkDialog(java.awt.Component parent, java.lang.String title, boolean modal, FwkDialogPaneInterface pane, java.awt.event.ActionListener okListener, java.awt.event.ActionListener cancelListener, java.awt.event.ActionListener closeListener, java.awt.event.ActionListener resetListener) The constructor for single-pane dialogs.
FwkDialog(java.awt.Component parent, java.lang.String title, boolean modal, FwkDialogPaneInterface pane, java.awt.event.ActionListener okListener, java.awt.event.ActionListener cancelListener, java.awt.event.ActionListener closeListener, java.awt.event.ActionListener resetListener, int hqsType) The constructor for single-pane dialogs.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancelDialog() Cancel dialog.
boolean	commitDialog() Commit dialog.
protected javax.swing.JPanel	createHelpPanel() Create a help panel.
FwkDialogPaneValueInterface[]	get() Get the settings.
javax.swing.JComponent	getDialogComponent(int ident) This method returns a component of the dialog.
FwkKeyListenerInterface	getKeyListener() Get the keyboard listener of this dialog.
java.lang.String	getVersion() Return the version string of the FWK component.
void	release() Release the object.
void	reset() Reset the dialog.
boolean	resetDialog() Reset dialog.
void	save() Save the settings.
void	setVisible(boolean flag) Show the dialog.

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

Field Detail

HELP_PANEL

protected static final java.lang.String HELP_PANEL

See Also:

Constant Field Values

WORKING_PANEL

protected static final java.lang.String WORKING_PANEL

See Also:

Constant Field Values

version

public static final java.lang.String version

See Also:

Constant Field Values

cardPanel

protected javax.swing.JPanel cardPanel

fwkHelp

protected static FwkHelp fwkHelp

helpPanel

protected javax.swing.JPanel helpPanel

cardLayout

protected java.awt.CardLayout cardLayout

Constructor Detail

FwkDialog

public FwkDialog(java.awt.Component parent,
         java.lang.String title,
         boolean modal,
         FwkDialogPaneInterface pane,
         java.awt.event.ActionListener okListener,
         java.awt.event.ActionListener cancelListener,
         java.awt.event.ActionListener closeListener,
         java.awt.event.ActionListener resetListener)

The constructor for single-pane dialogs.

Parameters:

parent - The parent component.

title - The titel string.

modal - If true the dialog box is modal.

scrollable - If true the dialog box will be created a scrollable pane.

pane - The chooser panel.

okListener - The OK button callback.

cancelListener - The CANCEL callback.

resetListener - The RESET callback.

FwkDialog

public FwkDialog(java.awt.Component parent,
         java.lang.String title,
         boolean modal,
         FwkDialogPaneInterface pane,
         java.awt.event.ActionListener okListener,
         java.awt.event.ActionListener cancelListener,
         java.awt.event.ActionListener closeListener,
         java.awt.event.ActionListener resetListener,
         int hqsType)

The constructor for single-pane dialogs.

Parameters:

parent - The parent component.

title - The titel string.

modal - If true the dialog box is modal.

scrollable - If true the dialog box will be created a scrollable pane.

pane - The chooser panel.

okListener - The OK button callback.

cancelListener - The CANCEL callback.

resetListener - The RESET callback.

hqsType - the HQS panel type (use -1 to ommit hqs panel).

FwkDialog

public FwkDialog(java.awt.Component parent,
         java.lang.String title,
         boolean modal,
         FwkDialogPaneInterface[] pane,
         java.awt.event.ActionListener okListener,
         java.awt.event.ActionListener cancelListener,
         java.awt.event.ActionListener resetListener,
         java.awt.event.ActionListener closeListener)

The constructor for multi-pane dialogs.

Parameters:

parent - The parent component.

title - The titel string.

modal - If true the dialog box is modal.

pane - The chooser panel array.

okListener - The OK button callback.

cancelListener - The CANCEL callback.

resetListener - The RESET callback.

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: FwkInterface

Return the version string of the FWK component.

Specified by:

getVersion in interface FwkInterface

release

public void release()

Release the object.

Specified by:

release in interface FwkInterface

createHelpPanel

protected javax.swing.JPanel createHelpPanel()

Create a help panel.

Returns:

the help panel.

cancelDialog

public boolean cancelDialog()

Cancel dialog.

Specified by:

cancelDialog in interface FwkDialogInterface

Returns:

trueif successful.

resetDialog

public boolean resetDialog()

Reset dialog.

Specified by:

resetDialog in interface FwkDialogInterface

Returns:

trueif successful.

commitDialog

public boolean commitDialog()

Commit dialog.

Specified by:

commitDialog in interface FwkDialogInterface

Returns:

trueif successful.

getDialogComponent

public javax.swing.JComponent getDialogComponent(int ident)

This method returns a component of the dialog.

Specified by:

getDialogComponent in interface FwkDialogInterface

Parameters:

ident - The ident of the component. Use the predefined idents to specify what component is requested.

Returns:

The dialog component or null if not available.

getKeyListener

public FwkKeyListenerInterface getKeyListener()

Get the keyboard listener of this dialog.

Returns:

The keyboard listener.

setVisible

public void setVisible(boolean flag)

Show the dialog.

Overrides:

setVisible in class java.awt.Dialog

save

public void save()

Save the settings.

get

public FwkDialogPaneValueInterface[] get()

Get the settings.

reset

public void reset()

Reset the dialog.