javabook
Class InputBox

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javabook.JavaBookDialog
                                |
                                +--javabook.InputBox

public class InputBox

extends JavaBookDialog

implements java.awt.event.ActionListener, java.awt.event.KeyListener

This class is used for getting an input from the user. An InputBox dialog is modal and capable of accepting integers, real numbers, and strings. An InputBox dialog will remain on the screen until a valid input is entered.

This class is provided as freeware. You are free to use as provided or modify to your heart's content. But you use it at your own risk. No implied or explicit warranty is given.

See Also:

Serialized Form

Fields inherited from class javabook.JavaBookDialog

font, wasMoved

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Constructor Summary

InputBox()
Default constructor.

InputBox(java.awt.Frame owner)
Creates an instance of InputBox with a default title and error message.

InputBox(java.awt.Frame owner, java.lang.String title)
Creates an instance of InputBox with the title set to the second parameter and the error message set to a default message.

InputBox(java.awt.Frame owner, java.lang.String title, java.lang.String errorMsg)
Creates an instance of InputBox with the title set to the second parameter and the error message set to the third parameter.

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e) Implements the required method of the ActionListener.
protected void	adjustSize() Implements the abstract method of the superclass JavaBookDialog.
double	getDouble() Returns a double value entered the user.
double	getDouble(java.lang.String text) Returns a double value entered the user.
float	getFloat() Returns a float value entered the user.
float	getFloat(java.lang.String text) Returns a float value entered the user.
int	getInteger() Returns an int value entered the user.
int	getInteger(java.lang.String text) Returns an int value entered the user.
java.lang.String	getString() Returns a String value entered the user.
java.lang.String	getString(java.lang.String text) Returns a String value entered the user.
void	keyPressed(java.awt.event.KeyEvent e) Implements the required method of the KeyListener.
void	keyReleased(java.awt.event.KeyEvent e) Implements the required method of the KeyListener.
void	keyTyped(java.awt.event.KeyEvent e) Implements the required method of the KeyListener.

Methods inherited from class javabook.JavaBookDialog

moveToCenter, setVisible, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened

Methods inherited from class java.awt.Dialog

addNotify, dispose, getTitle, hide, isModal, isResizable, paramString, setModal, setResizable, setTitle, show

Methods inherited from class java.awt.Window

addWindowListener, applyResourceBundle, applyResourceBundle, finalize, getFocusOwner, getInputContext, getLocale, getOwnedWindows, getOwner, getToolkit, getWarningString, isShowing, pack, postEvent, processEvent, processWindowEvent, removeWindowListener, setCursor, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setFont, setLayout, update, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputMethodRequests, getLocation, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

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

Constructor Detail

InputBox

public InputBox()

Default constructor.

InputBox

public InputBox(java.awt.Frame owner)

Creates an instance of InputBox with a default title and error message.

Parameters:

owner - any Frame object, but most commonly expected is a MainWindow object

InputBox

public InputBox(java.awt.Frame owner,
                java.lang.String title)

Creates an instance of InputBox with the title set to the second parameter and the error message set to a default message.

Parameters:

owner - any Frame object, but most commonly expected is a MainWindow object

title - the InputBox title

InputBox

public InputBox(java.awt.Frame owner,
                java.lang.String title,
                java.lang.String errorMsg)

Creates an instance of InputBox with the title set to the second parameter and the error message set to the third parameter.

Parameters:

owner - any Frame object, but most commonly expected is a MainWindow object

title - the InputBox title

errorMsg - the error message to be displayed for an invalid input

Method Detail

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Implements the required method of the ActionListener. Do not call this method. The Java virtual machine handles the action event processing.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

e - the ActionEvent object.

getDouble

public double getDouble()

Returns a double value entered the user. Prompts the user for a double value, and the dialog will not close until the user enters a valid double vale.

Returns:

an input double value

getDouble

public double getDouble(java.lang.String text)

Returns a double value entered the user. Prompts the user for a double value using the second parameter as the prompt text. The dialog will not close until the user enters a valid double vale.

Parameters:

text - the text for prompting the user

Returns:

an input double value

getFloat

public float getFloat()

Returns a float value entered the user. Prompts the user for a float value, and the dialog will not close until the user enters a valid float vale.

Returns:

an input float value

getFloat

public float getFloat(java.lang.String text)

Returns a float value entered the user. Prompts the user for a float value using the second parameter as the prompt text. The dialog will not close until the user enters a valid float vale.

Parameters:

text - the text for prompting the user

Returns:

an input float value

getInteger

public int getInteger()

Returns an int value entered the user. Prompts the user for an int value, and the dialog will not close until the user enters a valid int vale.

Returns:

an input int value

getInteger

public int getInteger(java.lang.String text)

Returns an int value entered the user. Prompts the user for an int value using the second parameter as the prompt text. The dialog will not close until the user enters a valid int vale.

Parameters:

text - the text for prompting the user

Returns:

an input int value

getString

public java.lang.String getString()

Returns a String value entered the user. Prompts the user for a String value using a generic prompt text.

Returns:

an input String value

getString

public java.lang.String getString(java.lang.String text)

Returns a String value entered the user. Prompts the user for a String value using the second parameter as the prompt text.

Parameters:

text - the text for prompting the user

Returns:

an input String value

keyTyped

public void keyTyped(java.awt.event.KeyEvent e)

Implements the required method of the KeyListener. This method does nothing. Do not call this method. The Java virtual machine handles the key event processing.

Specified by:

keyTyped in interface java.awt.event.KeyListener

Parameters:

e - the KeyEvent object.

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)

Implements the required method of the KeyListener. This method does nothing. Do not call this method. The Java virtual machine handles the key event processing.

Specified by:

keyPressed in interface java.awt.event.KeyListener

Parameters:

e - the KeyEvent object.

keyReleased

public void keyReleased(java.awt.event.KeyEvent e)

Implements the required method of the KeyListener. Do not call this method. The Java virtual machine handles the key event processing. This method is called by the system when the key is (pressed and) released. If the key released was the Enter (Return) key, this dialog is closed.

Specified by:

keyReleased in interface java.awt.event.KeyListener

Parameters:

e - the KeyEvent object.

adjustSize

protected void adjustSize()

Implements the abstract method of the superclass JavaBookDialog. This method places the required GUI components and adjusts the dialog's dimension accordingly.

Overrides:

adjustSize in class JavaBookDialog