com.metamatrix.toolbox.ui.widget
Class LoginPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.metamatrix.toolbox.ui.widget.DialogPanel
                      com.metamatrix.toolbox.ui.widget.LoginPanel

All Implemented Interfaces:

IconConstants, UIConstants, ButtonConstants, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

Direct Known Subclasses:

ConsoleLoginPanel

public class LoginPanel
extends DialogPanel
implements IconConstants

This panel should be used by all MetaMatrix products as the means for a user to login to a system.

Since:

2.0

Version:

2.0

Author:

John P. A. Verhaeg

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

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

static java.lang.String	FIELD_COLUMNS_PROPERTY
static java.lang.String	LOGO_BORDER_PROPERTY
static java.lang.String	PASSWORD_LABEL_PROPERTY
static java.lang.String	PROPERTY_PREFIX
static java.lang.String	SYSTEM_LABEL_PROPERTY
static java.lang.String	USER_NAME_LABEL_PROPERTY

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.metamatrix.toolbox.ui.IconConstants

ADD_ICON_PROPERTY, ALL_LEFT_ICON_PROPERTY, ALL_RIGHT_ICON_PROPERTY, DELETE_ICON_PROPERTY, DOWN_ICON_PROPERTY, ERROR_ICON_PROPERTY, HEX_ICON_PROPERTY, ICON_PROPERTY_PREFIX, LEFT_ICON_PROPERTY, LOGO_AND_NAME_ICON_PROPERTY, LOGO_ICON_PROPERTY, NOTIFICATION_ICON_PROPERTY, RIGHT_ICON_PROPERTY, SUBTRACT_ICON_PROPERTY, UP_ICON_PROPERTY, WARNING_ICON_PROPERTY

Fields inherited from interface com.metamatrix.toolbox.ui.widget.ButtonConstants

ACCEPT_BUTTON, APPLY_BUTTON, BACK_BUTTON, CANCEL_BUTTON, CONTEXT_SENSITIVE_HELP, DEFAULTS_BUTTON, DETAILS_BUTTON, EXIT_BUTTON, FINISH_BUTTON, HELP_BUTTON, LOGIN_BUTTON, NEXT_BUTTON, NO_BUTTON, OVERWRITE_BUTTON, REPLACE_BUTTON, RETRY_BUTTON, SKIP_BUTTON, YES_BUTTON

Fields inherited from interface com.metamatrix.toolbox.ui.UIConstants

DATE_FORMAT_PROPERTY, SPACER_HORIZONTAL_LENGTH_PROPERTY, WINDOW_BORDER_PROPERTY

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

LoginPanel()
Creates a login panel containing a name, password, and system field

LoginPanel(boolean addSystemField)
Creates a login panel containing a name and password field, and a system field if the specified

LoginPanel(boolean addSystemField, javax.swing.Icon icon)
Creates a login panel containing a name and password field, and a system field if the specified

Method Summary

protected LabelWidget	addField(java.awt.Container container, java.lang.String text, javax.swing.JComponent component) Adds the specified text (within a LabelWidget) and component to the specified container in a horizontal layout, with the LabelWidget positioned to the left of the component.
void	addField(java.lang.String text, javax.swing.JComponent component) Adds the specified text (within a LabelWidget) and component to the panel in a horizontal layout, with the LabelWidget positioned to the left of the component.
protected void	alignLabels() Makes all labels the same width, which effectively aligns them right-justified.
protected ButtonWidget	createAcceptButton() Creates a login button with a default label (as determined by the ToolboxStandards class).
ButtonWidget	getLoginButton()
javax.swing.JPasswordField	getPasswordField()
javax.swing.JComboBox	getSystemField()
TextFieldWidget	getUserNameField()
protected void	initializeLoginPanel(boolean addSystemField) Builds the contents of the LoginPanel, including a company logo; three default fields for the user to enter a user name, password, and system; a button to login to the selected/entered system; and a button to cancel the login.

Methods inherited from class com.metamatrix.toolbox.ui.widget.DialogPanel

accept, addAcceptButton, addAcceptButton, addCancelButton, addCancelButton, addHelpButton, addHelpButton, addNavigationButton, addNavigationButton, addNavigationComponent, addNavigationSpacer, addNavigationSpacer, buildNavigationBar, canAccept, canCancel, cancel, createCancelButton, createHelpButton, createNavigationBar, equalizeNavigationButtonWidths, getAcceptButton, getAcceptButtons, getCancelButton, getContent, getContentContainer, getHelpButton, getNavigationBar, getNavigationButton, getNavigationComponent, getNavigationComponentIndex, getSelectedButton, getWindowAncestor, initializeDialogPanel, removeNavigationButton, removeNavigationComponent, removeNavigationSpacer, setCanAccept, setCanCancel, setContent, setLayout, setVisible, validateState, windowActivated, windowAdded

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_PREFIX

public static final java.lang.String PROPERTY_PREFIX

See Also:

Constant Field Values

FIELD_COLUMNS_PROPERTY

public static final java.lang.String FIELD_COLUMNS_PROPERTY

See Also:

Constant Field Values

LOGO_BORDER_PROPERTY

public static final java.lang.String LOGO_BORDER_PROPERTY

See Also:

Constant Field Values

USER_NAME_LABEL_PROPERTY

public static final java.lang.String USER_NAME_LABEL_PROPERTY

See Also:

Constant Field Values

PASSWORD_LABEL_PROPERTY

public static final java.lang.String PASSWORD_LABEL_PROPERTY

See Also:

Constant Field Values

SYSTEM_LABEL_PROPERTY

public static final java.lang.String SYSTEM_LABEL_PROPERTY

See Also:

Constant Field Values

Constructor Detail

LoginPanel

public LoginPanel()

Creates a login panel containing a name, password, and system field

Since:

2.0

LoginPanel

public LoginPanel(boolean addSystemField)

Creates a login panel containing a name and password field, and a system field if the specified

Parameters:

addSystemField - True if a system field should be added to the panel

Since:

2.0

LoginPanel

public LoginPanel(boolean addSystemField,
                  javax.swing.Icon icon)

Creates a login panel containing a name and password field, and a system field if the specified

Parameters:

addSystemField - True if a system field should be added to the panel

Since:

2.0

Method Detail

addField

public void addField(java.lang.String text,
                     javax.swing.JComponent component)

Adds the specified text (within a LabelWidget) and component to the panel in a horizontal layout, with the LabelWidget positioned to the left of the component.

Parameters:

text - The text to be added to the container within a LabelWidget

component - The component to be added to the container

Since:

2.0

addField

protected LabelWidget addField(java.awt.Container container,
                               java.lang.String text,
                               javax.swing.JComponent component)

Adds the specified text (within a LabelWidget) and component to the specified container in a horizontal layout, with the LabelWidget positioned to the left of the component.

Parameters:

container - The container to which the text's LabelWidget and component will be added

text - The text to be added to the container within a LabelWidget

component - The component to be added to the container

Returns:

The LabelWidget containing the specified text. The LoginWindow uses this reference to align the text for all fields.

Since:

2.0

alignLabels

protected void alignLabels()

Makes all labels the same width, which effectively aligns them right-justified.

Since:

2.0

createAcceptButton

protected ButtonWidget createAcceptButton()

Creates a login button with a default label (as determined by the ToolboxStandards class).

Overrides:

createAcceptButton in class DialogPanel

Returns:

The login button

Since:

2.0

getLoginButton

public ButtonWidget getLoginButton()

Returns:

The login button

Since:

2.0

getPasswordField

public javax.swing.JPasswordField getPasswordField()

Returns:

The password field

Since:

2.0

getSystemField

public javax.swing.JComboBox getSystemField()

Returns:

The system field

Since:

2.0

getUserNameField

public TextFieldWidget getUserNameField()

Returns:

The user name field

Since:

2.0

initializeLoginPanel

protected void initializeLoginPanel(boolean addSystemField)

Builds the contents of the LoginPanel, including a company logo; three default fields for the user to enter a user name, password, and system; a button to login to the selected/entered system; and a button to cancel the login.

Since:

2.0