net.java.sip.communicator.util.swing
Class AuthenticationWindow

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      net.java.sip.communicator.util.swing.SIPCommDialog
                          net.java.sip.communicator.util.swing.AuthenticationWindow

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants

public class AuthenticationWindow
extends SIPCommDialog
implements ActionListener

The AuthenticationWindow is the window where the user should type his user identifier and password to login.

Author:

Yana Stamcheva

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class net.java.sip.communicator.util.swing.SIPCommDialog

SIPCommDialog.DialogWindowAdapter

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

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

AuthenticationWindow(Dialog owner, String userName, char[] password, String server, boolean isUserNameEditable, ImageIcon icon)
Creates an instance of the LoginWindow.

AuthenticationWindow(String server, boolean isUserNameEditable, ImageIcon icon)
Creates an instance of the LoginWindow.

AuthenticationWindow(String userName, char[] password, String server, boolean isUserNameEditable, ImageIcon icon)
Creates an instance of the LoginWindow.

AuthenticationWindow(String userName, char[] password, String server, boolean isUserNameEditable, ImageIcon icon, String errorMessage)
Creates an instance of the LoginWindow.

Method Summary

void	actionPerformed(ActionEvent evt) Handles the ActionEvent triggered when one of the buttons is clicked.
protected void	close(boolean isEscaped) Automatically clicks the cancel button, when this window is closed.
char[]	getPassword() Returns the password entered by the user.
String	getUserName() Returns the user name entered by the user or previously set if the user name is not editable.
boolean	isCanceled() Indicates if this window has been canceled.
boolean	isRememberPassword() Indicates if the password should be remembered.
void	setAllowSavePassword(boolean allow) Shows or hides the "save password" checkbox.
void	setVisible(boolean isVisible) Shows this modal dialog.

Methods inherited from class net.java.sip.communicator.util.swing.SIPCommDialog

addKeyBinding, dispose

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

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, 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, paint, 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, 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

Constructor Detail

AuthenticationWindow

public AuthenticationWindow(String server,
                            boolean isUserNameEditable,
                            ImageIcon icon)

Creates an instance of the LoginWindow.

Parameters:

server - the server name

isUserNameEditable - indicates if the user name is editable

icon - the icon to display on the left of the authentication window

AuthenticationWindow

public AuthenticationWindow(String userName,
                            char[] password,
                            String server,
                            boolean isUserNameEditable,
                            ImageIcon icon,
                            String errorMessage)

Creates an instance of the LoginWindow.

Parameters:

userName - the user name to set by default

password - the password to set by default

server - the server name this authentication window is about

isUserNameEditable - indicates if the user name should be editable by the user or not

icon - the icon displayed on the left of the authentication window

errorMessage - an error message explaining a reason for opening the authentication dialog (when a wrong password was provided, etc.)

AuthenticationWindow

public AuthenticationWindow(String userName,
                            char[] password,
                            String server,
                            boolean isUserNameEditable,
                            ImageIcon icon)

Creates an instance of the LoginWindow.

Parameters:

userName - the user name to set by default

password - the password to set by default

server - the server name this authentication window is about

isUserNameEditable - indicates if the user name should be editable by the user or not

icon - the icon displayed on the left of the authentication window

AuthenticationWindow

public AuthenticationWindow(Dialog owner,
                            String userName,
                            char[] password,
                            String server,
                            boolean isUserNameEditable,
                            ImageIcon icon)

Creates an instance of the LoginWindow.

Parameters:

owner - the owner of this dialog

userName - the user name to set by default

password - the password to set by default

server - the server name this authentication window is about

isUserNameEditable - indicates if the user name should be editable by the user or not

icon - the icon displayed on the left of the authentication window

Method Detail

setAllowSavePassword

public void setAllowSavePassword(boolean allow)

Shows or hides the "save password" checkbox.

Parameters:

allow - the checkbox is shown when allow is true

actionPerformed

public void actionPerformed(ActionEvent evt)

Handles the ActionEvent triggered when one of the buttons is clicked. When "Login" button is chosen installs a new account from the user input and logs in.

Specified by:

actionPerformed in interface ActionListener

Parameters:

evt - the action event that has just occurred.

close

protected void close(boolean isEscaped)

Automatically clicks the cancel button, when this window is closed.

Overrides:

close in class SIPCommDialog

Parameters:

isEscaped - indicates if the window has been closed by pressing the Esc key

setVisible

public void setVisible(boolean isVisible)

Shows this modal dialog.

Overrides:

setVisible in class SIPCommDialog

Parameters:

isVisible - specifies whether we should be showing or hiding the window.

isCanceled

public boolean isCanceled()

Indicates if this window has been canceled.

Returns:

true if this window has been canceled, false - otherwise

getUserName

public String getUserName()

Returns the user name entered by the user or previously set if the user name is not editable.

Returns:

the user name

getPassword

public char[] getPassword()

Returns the password entered by the user.

Returns:

the password

isRememberPassword

public boolean isRememberPassword()

Indicates if the password should be remembered.

Returns:

true if the password should be remembered, false - otherwise