com.ehsbe.commons.gui
Class JxLoginDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      com.ehsbe.commons.gui.JxDialog
                          com.ehsbe.commons.gui.JxLoginDialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class JxLoginDialog
extends JxDialog

A standard login dialog that provides a reasonable amount of flexibility while also providing ease of use and a professional look.

Author:

rbair

See Also:

Serialized Form

Nested Class Summary

static class

JxLoginDialog.State The states (progress) for this dialog.

Nested classes/interfaces inherited from class com.ehsbe.commons.gui.JxDialog

JxDialog.CloseAction

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

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 String

STOP_LOGIN_CMD the action command of the action/button, used to stop a running login process.

Fields inherited from class com.ehsbe.commons.gui.JxDialog

BORDER_WIDTH, CLOSE_ACTION_CMD, COL_GAP, ROW_GAP

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

JxLoginDialog(Dialog parent, org.jdesktop.swingx.auth.LoginService service, org.jdesktop.swingx.auth.PasswordStore ps, org.jdesktop.swingx.auth.UserNameStore us)
Create a login dialog using the given stores and services.

JxLoginDialog(Frame parent, org.jdesktop.swingx.auth.LoginService service, org.jdesktop.swingx.auth.PasswordStore ps, org.jdesktop.swingx.auth.UserNameStore us)
Create a login dialog using the given stores and services.

Method Summary

static JxLoginDialog	getDialog(Component parent, org.jdesktop.swingx.auth.LoginService service, org.jdesktop.swingx.auth.PasswordStore ps, org.jdesktop.swingx.auth.UserNameStore us) Create a login dialog using the given stores and services.
GuiErrorHandler	getErrorHandler() Get the gui error handler to be used on login errors.
org.jdesktop.swingx.auth.LoginService	getLoginService() Get the service used to find the server url and finally to use for authentication.
org.jdesktop.swingx.auth.PasswordStore	getPasswordStore() Get the PasswordStore for this panel.
JxLoginDialog.State	getState() Get the current state (progress) for this dialog.
org.jdesktop.swingx.auth.UserNameStore	getUserNameStore() Get the UserNameStore for this panel.
protected void	processWindowEvent(WindowEvent e)
void	setErrorHandler(GuiErrorHandler errorHandler) Set the gui error handler to be used on login errors.
void	setLoginService(org.jdesktop.swingx.auth.LoginService service) Set the login service, used to retrieve the server url and finally to use for authentication.
void	setPasswordStore(org.jdesktop.swingx.auth.PasswordStore store) Sets the PasswordStore used to retrieve and store passwords.
void	setUserNameStore(org.jdesktop.swingx.auth.UserNameStore store) Sets the UserNameStore used to retrieve and store user names.
void	setVisible(boolean b)

Methods inherited from class com.ehsbe.commons.gui.JxDialog

addButton, close, getButtonPanel, getDefaultMessageBorder, removeButton, setButtonPanel, setHelp

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, 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, setModal, setModalityType, setResizable, setTitle, setUndecorated, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, 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, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, 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, isOpaque, 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, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

STOP_LOGIN_CMD

public static final String STOP_LOGIN_CMD

the action command of the action/button, used to stop a running login process.

See Also:

Constant Field Values

Constructor Detail

JxLoginDialog

public JxLoginDialog(Frame parent,
                     org.jdesktop.swingx.auth.LoginService service,
                     org.jdesktop.swingx.auth.PasswordStore ps,
                     org.jdesktop.swingx.auth.UserNameStore us)

Create a login dialog using the given stores and services.

Parameters:

parent - determines the frame in which the dialog is displayed; if the parentComponent has no Frame, a default Frame is used

service - service to use for authentication and retrieving the server url

ps - password store to use for storing passwords. Might be null

us - username store to use ofr retrieving/storing usernames. Might be null

JxLoginDialog

public JxLoginDialog(Dialog parent,
                     org.jdesktop.swingx.auth.LoginService service,
                     org.jdesktop.swingx.auth.PasswordStore ps,
                     org.jdesktop.swingx.auth.UserNameStore us)

Create a login dialog using the given stores and services.

Parameters:

parent - determines the frame in which the dialog is displayed; if the parentComponent has no Frame, a default Frame is used

service - service to use for authentication and retrieving the server url

ps - password store to use for storing passwords. Might be null

us - username store to use ofr retrieving/storing usernames. Might be null

Method Detail

setPasswordStore

public void setPasswordStore(org.jdesktop.swingx.auth.PasswordStore store)

Sets the PasswordStore used to retrieve and store passwords.

Parameters:

store - a PasswordStore, which might be null

getPasswordStore

public org.jdesktop.swingx.auth.PasswordStore getPasswordStore()

Get the PasswordStore for this panel.

Returns:

null if not set, the password store otherwise.

setUserNameStore

public void setUserNameStore(org.jdesktop.swingx.auth.UserNameStore store)

Sets the UserNameStore used to retrieve and store user names.

Parameters:

store - a store, which might be null

getUserNameStore

public org.jdesktop.swingx.auth.UserNameStore getUserNameStore()

Get the UserNameStore for this panel.

Returns:

null if not set, the username store otherwise.

setLoginService

public void setLoginService(org.jdesktop.swingx.auth.LoginService service)

Set the login service, used to retrieve the server url and finally to use for authentication.

Parameters:

service - service to use, might be null

getLoginService

public org.jdesktop.swingx.auth.LoginService getLoginService()

Get the service used to find the server url and finally to use for authentication.

Returns:

null if not set, the service otherwise.

getDialog

public static JxLoginDialog getDialog(Component parent,
                                      org.jdesktop.swingx.auth.LoginService service,
                                      org.jdesktop.swingx.auth.PasswordStore ps,
                                      org.jdesktop.swingx.auth.UserNameStore us)

Create a login dialog using the given stores and services.

Parameters:

parent - determines the frame in which the dialog is displayed; if the parentComponent has no Frame, a default Frame is used

service - service to use for authentication and retrieving the server url

ps - password store to use for storing passwords. Might be null

us - username store to use ofr retrieving/storing usernames. Might be null

Returns:

always a new JxLoginDialog

getState

public JxLoginDialog.State getState()

Get the current state (progress) for this dialog.

Returns:

always a none null state

processWindowEvent

protected void processWindowEvent(WindowEvent e)

Overrides:

processWindowEvent in class JDialog

setVisible

public void setVisible(boolean b)

Overrides:

setVisible in class Dialog

getErrorHandler

public GuiErrorHandler getErrorHandler()

Get the gui error handler to be used on login errors.

Returns:

null if not set, the handler otherwise.

setErrorHandler

public void setErrorHandler(GuiErrorHandler errorHandler)

Set the gui error handler to be used on login errors.

Parameters:

errorHandler - null if the default should be used, the handler otherwise.

See Also:

GuiErrorHandler.handleStandard(java.awt.Component, Throwable)