com.metamatrix.console.ui.dialog
Class ConsoleLoginWindow

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      com.metamatrix.console.ui.dialog.ConsoleLoginWindow

All Implemented Interfaces:

IconConstants, ButtonConstants, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class ConsoleLoginWindow
extends javax.swing.JFrame
implements ButtonConstants, IconConstants

This window should be used by all MetaMatrix products as the means for a user to login to a system and begin using the product. The calling thread will be blocked while the window is displayed.

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.JFrame

javax.swing.JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class java.awt.Frame

java.awt.Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow

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 inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

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.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.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 javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

ConsoleLoginWindow(java.lang.String title, ConsoleLoginPanel panel, boolean showSelectConnectionCheckBox, boolean insertDefaultUserName)
Creates a ConsoleLoginWindow containing the specified ConsoleLoginPanel, and with the specified title appended to the specified prefix.

Method Summary

protected void	exit(java.awt.AWTEvent event) Called when the user selects the exit button.
javax.swing.AbstractButton	getDisplayedExitButton()
ButtonWidget	getExitButton()
ButtonWidget	getLoginButton()
ConsoleLoginPanel	getLoginPanel()
void	hide() Overridden to notify show method to stop blocking.
protected void	initializeLoginWindow(boolean showSelectConnectionCheckBox, boolean insertDefaultUserName) Builds the contents of the ConsoleLoginWindow, including a company logo; three default fields for the user to enter a user name, password, and system; and buttons to login or exit the selected/entered system.
protected void	login(java.awt.event.ActionEvent event) Called when the user selects the login button.
protected void	processWindowEvent(java.awt.event.WindowEvent event) Overridden to call the cancel() method in the event that the user cancels the window via its close button (the 'X' icon) or the 'Close' option in the system menu.
boolean	selectNewConnection()
void	setExitingBlocked(boolean flag)
void	show() Overridden to block until the window is closed.
static void	show(java.lang.String title, boolean isFirstLogin) Creates and displays a ConsoleLoginWindow centered on the screen with the specified title, containing a default LoginPanel.
static void	show(java.lang.String title, ConsoleLoginPanel panel, boolean isFirstLogin) Creates and displays a ConsoleLoginWindow centered on the screen with the specified title, containing the specified LoginPanel.

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated

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, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setVisible, toBack, 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, 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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Constructor Detail

ConsoleLoginWindow

public ConsoleLoginWindow(java.lang.String title,
                          ConsoleLoginPanel panel,
                          boolean showSelectConnectionCheckBox,
                          boolean insertDefaultUserName)

Creates a ConsoleLoginWindow containing the specified ConsoleLoginPanel, and with the specified title appended to the specified prefix.

Parameters:

title - The text to be appended to the window's title

panel - The LoginPanel that the window will contain

Since:

2.0

Method Detail

show

public static void show(java.lang.String title,
                        boolean isFirstLogin)

Creates and displays a ConsoleLoginWindow centered on the screen with the specified title, containing a default LoginPanel.

Since:

2.0

show

public static void show(java.lang.String title,
                        ConsoleLoginPanel panel,
                        boolean isFirstLogin)

Creates and displays a ConsoleLoginWindow centered on the screen with the specified title, containing the specified LoginPanel.

Since:

2.0

getLoginPanel

public ConsoleLoginPanel getLoginPanel()

Returns:

The contained DialogPanel

Since:

2.0

getDisplayedExitButton

public javax.swing.AbstractButton getDisplayedExitButton()

setExitingBlocked

public void setExitingBlocked(boolean flag)

exit

protected void exit(java.awt.AWTEvent event)

Called when the user selects the exit button. Exits the applicatio by default.

Parameters:

event - The original event

Since:

2.0

getExitButton

public ButtonWidget getExitButton()

Returns:

The exit button

Since:

2.0

getLoginButton

public ButtonWidget getLoginButton()

Returns:

The login button

Since:

2.0

initializeLoginWindow

protected void initializeLoginWindow(boolean showSelectConnectionCheckBox,
                                     boolean insertDefaultUserName)

Builds the contents of the ConsoleLoginWindow, including a company logo; three default fields for the user to enter a user name, password, and system; and buttons to login or exit the selected/entered system.

Since:

2.0

login

protected void login(java.awt.event.ActionEvent event)

Called when the user selects the login button. Simply disposes the window by default.

Parameters:

event - The original event

Since:

2.0

processWindowEvent

protected void processWindowEvent(java.awt.event.WindowEvent event)

Overridden to call the cancel() method in the event that the user cancels the window via its close button (the 'X' icon) or the 'Close' option in the system menu.

Overrides:

processWindowEvent in class javax.swing.JFrame

Parameters:

event - The window event to be processed

Since:

2.0

hide

public void hide()

Overridden to notify show method to stop blocking.

Overrides:

hide in class java.awt.Window

Since:

2.0

show

public void show()

Overridden to block until the window is closed.

Overrides:

show in class java.awt.Window

Since:

2.0

selectNewConnection

public boolean selectNewConnection()