com.Ostermiller.util
Class PasswordDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      com.Ostermiller.util.PasswordDialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class PasswordDialog
extends JDialog

A modal dialog that asks the user for a user name and password. More information about this class is available from ostermiller.org.

 PasswordDialog p = new PasswordDialog(null, "Test");
 if(p.showDialog()){
     System.out.println("Name: " + p.getName());
     System.out.println("Pass: " + p.getPass());
 } else {
     System.out.println("User selected cancel");
 }
 

Since:

ostermillerutils 1.00.00

See Also:

Serialized Form

Nested Class Summary

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

JDialog.AccessibleJDialog

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

Dialog.AccessibleAWTDialog

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.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected JButton	cancelButton The cancel button.
protected ResourceBundle	labels Locale specific strings displayed to the user.
protected JTextField	name Where the name is typed.
protected JLabel	nameLabel The label for the field in which the name is typed.
protected JButton	okButton The OK button.
protected JPasswordField	pass Where the password is typed.
protected JLabel	passLabel The label for the field in which the password is typed.

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

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

PasswordDialog()
Create this dialog with the default title.

PasswordDialog(Frame parent)
Create this dialog with the given parent and the default title.

PasswordDialog(Frame parent, String title)
Create this dialog with the given parent and title.

Method Summary

protected void	dialogInit() Called by constructors to initialize the dialog.
String	getName() Get the name that was entered into the dialog before the dialog was closed.
String	getPass() Get the password that was entered into the dialog before the dialog was closed.
boolean	okPressed() Finds out if user used the OK button or an equivalent action to close the dialog.
void	setCancelText(String cancel) Set the label on the cancel button.
void	setLocale(Locale locale) Set the locale used for getting localized strings.
void	setName(String name) Set the name that appears as the default An empty string will be used if this in not specified before the dialog is displayed.
void	setNameLabel(String name) Set the label for the field in which the name is entered.
void	setOKText(String ok) Set the label on the OK button.
void	setPass(String pass) Set the password that appears as the default An empty string will be used if this in not specified before the dialog is displayed.
void	setPassLabel(String pass) Set the label for the field in which the password is entered.
boolean	showDialog() Shows the dialog and returns true if the user pressed ok.

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.awt.Dialog

addNotify, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, 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, removeNotify, 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, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocation, setLocation, setMaximumSize, setMinimumSize, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

labels

protected ResourceBundle labels

Locale specific strings displayed to the user.

Since:

ostermillerutils 1.00.00

name

protected JTextField name

Where the name is typed.

Since:

ostermillerutils 1.00.00

pass

protected JPasswordField pass

Where the password is typed.

Since:

ostermillerutils 1.00.00

okButton

protected JButton okButton

The OK button.

Since:

ostermillerutils 1.00.00

cancelButton

protected JButton cancelButton

The cancel button.

Since:

ostermillerutils 1.00.00

nameLabel

protected JLabel nameLabel

The label for the field in which the name is typed.

Since:

ostermillerutils 1.00.00

passLabel

protected JLabel passLabel

The label for the field in which the password is typed.

Since:

ostermillerutils 1.00.00

Constructor Detail

PasswordDialog

public PasswordDialog(Frame parent,
                      String title)

Create this dialog with the given parent and title.

Parameters:

parent - window from which this dialog is launched

title - the title for the dialog box window

Since:

ostermillerutils 1.00.00

PasswordDialog

public PasswordDialog(Frame parent)

Create this dialog with the given parent and the default title.

Parameters:

parent - window from which this dialog is launched

Since:

ostermillerutils 1.00.00

PasswordDialog

public PasswordDialog()

Create this dialog with the default title.

Since:

ostermillerutils 1.00.00

Method Detail

setLocale

public void setLocale(Locale locale)

Set the locale used for getting localized strings.

Overrides:

setLocale in class Component

Parameters:

locale - Locale used to for i18n.

Since:

ostermillerutils 1.00.00

setName

public void setName(String name)

Set the name that appears as the default An empty string will be used if this in not specified before the dialog is displayed.

Overrides:

setName in class Component

Parameters:

name - default name to be displayed.

Since:

ostermillerutils 1.00.00

setPass

public void setPass(String pass)

Set the password that appears as the default An empty string will be used if this in not specified before the dialog is displayed.

Parameters:

pass - default password to be displayed.

Since:

ostermillerutils 1.00.00

setOKText

public void setOKText(String ok)

Set the label on the OK button. The default is a localized string.

Parameters:

ok - label for the ok button.

Since:

ostermillerutils 1.00.00

setCancelText

public void setCancelText(String cancel)

Set the label on the cancel button. The default is a localized string.

Parameters:

cancel - label for the cancel button.

Since:

ostermillerutils 1.00.00

setNameLabel

public void setNameLabel(String name)

Set the label for the field in which the name is entered. The default is a localized string.

Parameters:

name - label for the name field.

Since:

ostermillerutils 1.00.00

setPassLabel

public void setPassLabel(String pass)

Set the label for the field in which the password is entered. The default is a localized string.

Parameters:

pass - label for the password field.

Since:

ostermillerutils 1.00.00

getName

public String getName()

Get the name that was entered into the dialog before the dialog was closed.

Overrides:

getName in class Component

Returns:

the name from the name field.

Since:

ostermillerutils 1.00.00

getPass

public String getPass()

Get the password that was entered into the dialog before the dialog was closed.

Returns:

the password from the password field.

Since:

ostermillerutils 1.00.00

okPressed

public boolean okPressed()

Finds out if user used the OK button or an equivalent action to close the dialog. Pressing enter in the password field may be the same as 'OK' but closing the dialog and pressing the cancel button are not.

Returns:

true if the the user hit OK, false if the user canceled.

Since:

ostermillerutils 1.00.00

dialogInit

protected void dialogInit()

Called by constructors to initialize the dialog.

Overrides:

dialogInit in class JDialog

Since:

ostermillerutils 1.00.00

showDialog

public boolean showDialog()

Shows the dialog and returns true if the user pressed ok.

Returns:

true if the the user hit OK, false if the user canceled.

Since:

ostermillerutils 1.00.00