com.lf.commons.dialog

Class LoginDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

com.lf.commons.dialog.LoginDialog

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.event.DocumentListener, javax.swing.RootPaneContainer, javax.swing.WindowConstants

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

Dialog to enter user name and password.

Since:

1.6

Version:

$Revision: 1.19 $, $Date: 2012/12/28 11:44:25 $

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.

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
LoginDialog() Constructor method for the dialog (modeless).
LoginDialog(java.awt.Dialog owner) Constructor method for the dialog.
LoginDialog(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.
void	allowEscapeOnKeyStroke(int strokeval) Adds a keyboard action to escape (close) the dialog (e.g. on escape).
void	changedUpdate(javax.swing.event.DocumentEvent e) Gives notification that an attribute or set of attributes changed.
void	configureUnit(java.lang.String id, Configuration config) Restores values from persistent data stores.
static LoginDialog	createDefaultDialog(java.awt.Component comp, java.lang.String title, java.lang.String header) Convenience method to create a pre-configured dialog instance.
int	execute() Shows the dialog on the screen and returns the code of the pressed button.
javax.swing.JButton	getButtonCancel() Provides the cancel button.
javax.swing.JButton	getButtonOK() Provides the OK button.
int	getExitButton() Returns the code of the pressed button.
javax.swing.JTextField	getFieldPassword() Provides the password field.
javax.swing.JTextField	getFieldUser() Provides the user name field.
java.lang.String	getPassword() Provides the current contents of the password field.
java.lang.String	getUser() Provides the current contents of the user name field.
void	hideFlag() Sets the visibility of the remember flag.
void	hideUser() Sets the visibility of the user name row.
void	insertUpdate(javax.swing.event.DocumentEvent e) Gives notification that there was an insert into the document.
boolean	isFlagSelected() Provides the state of the flag to remember the password for the specified user name.
void	removeUpdate(javax.swing.event.DocumentEvent e) Gives notification that a portion of the document has been removed.
void	setBorderTitle(java.lang.String title) Sets the title displayed by the titled border.
void	setButtonCancel(java.lang.String text) Sets the current text of the Cancel button.
void	setButtonOK(java.lang.String text) Sets the current text of the OK button.
void	setEmptyAllowed(boolean emptyallowed) Can the dialog be closed with empty user name/password fields by clicking the OK button?
void	setExitButton(int value) Sets the default exit code.
void	setFlagSelected(boolean selected) Sets the state of the flag to remember the password for the specified user name.
void	setHelpID(java.lang.String helpid) Sets the optional help link to call the help system.
void	setLabelPassword(java.lang.String text) Sets the current text of the password label.
void	setLabelUser(java.lang.String text) Sets the current text of the user name label.
void	setPassword(java.lang.String password) Sets the password.
void	setUser(java.lang.String username) Sets the user name.
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.
void	updateButtons() Updates the button states (enabled/disabled).

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

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

Constructor Detail

LoginDialog

public LoginDialog()

Constructor method for the dialog (modeless).

Since:

1.6

LoginDialog

public LoginDialog(java.awt.Frame owner)

Constructor method for the dialog.

Parameters:

owner - The owner frame

Since:

1.6

LoginDialog

public LoginDialog(java.awt.Dialog owner)

Constructor method for the dialog.

Parameters:

owner - The owner dialog

Since:

1.6

Method Detail

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

setEmptyAllowed

public void setEmptyAllowed(boolean emptyallowed)

Can the dialog be closed with empty user name/password fields by clicking the OK button?

Sometimes it is necessary to force input from the user to avoid errors. The default behaviour of this dialog is that the OK button is disabled as long as the password field is empty (no empty field allowed).

Parameters:

emptyallowed - Empty user name/password allowed (default is no)?

Since:

1.6

getFieldUser

public javax.swing.JTextField getFieldUser()

Provides the user name field.

Returns:

The user name field

Since:

1.6

getUser

public java.lang.String getUser()

Provides the current contents of the user name field.

Returns:

The current user name, may be empty if allowed explicitely

Since:

1.6

setUser

public void setUser(java.lang.String username)

Sets the user name.

Parameters:

username - The user name

Since:

1.6

setPassword

public void setPassword(java.lang.String password)

Sets the password.

Parameters:

password - The password

Since:

1.6

hideUser

public void hideUser()

Sets the visibility of the user name row.

Since:

1.6

getFieldPassword

public javax.swing.JTextField getFieldPassword()

Provides the password field.

Returns:

The password field

Since:

1.6

getPassword

public java.lang.String getPassword()

Provides the current contents of the password field.

Returns:

The current password text, may be empty if allowed explicitely

Since:

1.6

setLabelUser

public void setLabelUser(java.lang.String text)

Sets the current text of the user name label.

Parameters:

text - The text of the user name label

Since:

1.6

setLabelPassword

public void setLabelPassword(java.lang.String text)

Sets the current text of the password label.

Parameters:

text - The text of the password label

Since:

1.6

updateButtons

public void updateButtons()

Updates the button states (enabled/disabled).

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

createDefaultDialog

public static LoginDialog createDefaultDialog(java.awt.Component comp,
                              java.lang.String title,
                              java.lang.String header)

Convenience method to create a pre-configured dialog instance.

Parameters:

comp - The component to search the parental window

title - The text displayed by the window decoration

header - The text displayed by the titled border

Returns:

The dialog

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

setFlagSelected

public void setFlagSelected(boolean selected)

Sets the state of the flag to remember the password for the specified user name.

Parameters:

selected - Flag selected?

Since:

1.6

isFlagSelected

public boolean isFlagSelected()

Provides the state of the flag to remember the password for the specified user name.

Returns:

Flag selected?

Since:

1.6

hideFlag

public void hideFlag()

Sets the visibility of the remember flag.

Since:

1.6

setButtonOK

public void setButtonOK(java.lang.String text)

Sets the current text of the OK button.

Parameters:

text - The text of the OK button

Since:

1.6

setButtonCancel

public void setButtonCancel(java.lang.String text)

Sets the current text of the Cancel button.

Parameters:

text - The text of the Cancel button

Since:

1.6

getButtonOK

public javax.swing.JButton getButtonOK()

Provides the OK button.

Returns:

The button

Since:

1.6

getButtonCancel

public javax.swing.JButton getButtonCancel()

Provides the cancel button.

Returns:

The button

Since:

1.6

getExitButton

public int getExitButton()

Returns the code of the pressed button.

Returns:

Code of the pressed button

setExitButton

public void setExitButton(int value)

Sets the default exit code.

Parameters:

value - Default exit code

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

changedUpdate

public void changedUpdate(javax.swing.event.DocumentEvent e)

Gives notification that an attribute or set of attributes changed.

Specified by:

changedUpdate in interface javax.swing.event.DocumentListener

Parameters:

e - Event object reference

Since:

1.6

insertUpdate

public void insertUpdate(javax.swing.event.DocumentEvent e)

Gives notification that there was an insert into the document.

Specified by:

insertUpdate in interface javax.swing.event.DocumentListener

Parameters:

e - Event object reference

Since:

1.6

removeUpdate

public void removeUpdate(javax.swing.event.DocumentEvent e)

Gives notification that a portion of the document has been removed.

Specified by:

removeUpdate in interface javax.swing.event.DocumentListener

Parameters:

e - Event object reference

Since:

1.6