CSLib
Class InputBox

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--CSLib.ClosableDialog
                                |
                                +--CSLib.InputBox

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.event.ActionListener, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class InputBox

extends CSLib.ClosableDialog

implements java.awt.event.ActionListener

InputBox is a closable dialog box that can receive and translate textual keyword input into various Java types. It can read and convert integers, doubles, strings, and characters.

The user must enter characters into a TextField, and then click on the "Ok" button. If the characters are inappropriate for the particular read that has been requested (for example, if a letter is entered during a call to readInt), then an ErrorBox is raised.

End-of-input is indicated by the user entering nothing into the TextField, and then clicking on the "Ok" button.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class java.awt.Dialog

java.awt.Dialog.AccessibleAWTDialog

Nested classes inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

InputBox()
Constructs an InputBox with a default title.

InputBox(java.lang.String title)
Constructs an InputBox with a specific title.

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e) Catches the clicking of the OK button (presumably after text has been entered in the textfield.
boolean	eoi() Returns the end-of-input status
char	readChar() Reads an Ascii character, and converts it to an char.
double	readDouble() Reads an Ascii real number, and converts it to a double.
int	readInt() Reads an Ascii integer, and converts it to an int.
java.lang.String	readString() Reads an Ascii string.
void	setPrompt(java.lang.String text) Sets the prompt to a particular string.

Methods inherited from class java.awt.Dialog

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

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, setLayout, transferFocusBackward, transferFocusDownCycle, update, 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, 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, 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, isOpaque, 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, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

InputBox

public InputBox()

Constructs an InputBox with a default title.

InputBox

public InputBox(java.lang.String title)

Constructs an InputBox with a specific title.

Parameters:

title - the String to use as the title

Method Detail

setPrompt

public void setPrompt(java.lang.String text)

Sets the prompt to a particular string.

Parameters:

text - the specific String to use for the new prompt

actionPerformed

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

Catches the clicking of the OK button (presumably after text has been entered in the textfield.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

e - the specific ActionEvent that occurred.

readString

public java.lang.String readString()

Reads an Ascii string. End-of-input is indicated by clicking OK without entering anything.

Returns:

the String value read.

readChar

public char readChar()

Reads an Ascii character, and converts it to an char. End-of-input is indicated by clicking OK without entering anything.

Returns:

the char value read.

See Also:

eoi()

readInt

public int readInt()

Reads an Ascii integer, and converts it to an int. Raise an ErrorBox if a non-integer is entered. End-of-input is indicated by clicking OK without entering anything.

Returns:

the int value read.

See Also:

eoi()

readDouble

public double readDouble()

Reads an Ascii real number, and converts it to a double. Raise an ErrorBox if a non-real number is entered. End-of-input is indicated by clicking OK without entering anything.

Returns:

the double value read.

See Also:

eoi()

eoi

public boolean eoi()

Returns the end-of-input status

Returns:

true if end-of-input is true

See Also:

eoi()