ASCIIPrompter

java.lang.Object
- BasicIO.ASCIIPrompter

```
public class ASCIIPrompter
extends java.lang.Object
```
ASCIIPrompter is used as a quick way to get text input from the user. It presents a form with a labeled (prompted) text field. It simulates input from a text file, working the same way that ASCIIDataFile does. When a read is performed, the ASCIIPrompter will become visible, the user enters text into the provided field and presses OK and the ASCIIPrompter converts the field into the desired format and returns the value. Pressing End instead of OK simulates EOF (End of File). A read operation can fail (successful returns false) if either the text cannot be interpreted as the desired type (isDataError returns true) or if the user pressed End (simulating EOF, isEOF returns true).

Version:

1.0 July 2008

Author:

Andrew Cheesman

Constructor Summary

Constructors
Constructor and Description
`ASCIIPrompter()` Creates a form with a labeled text field to prompt the user for text input.
`ASCIIPrompter(boolean logIt)` Creates a form with a labeled text field to prompt the user for text input.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the ASCIIPrompter and frees resources.
`boolean`	`isDataEror()` This method returns true if the last operation failed due to a data error.
`boolean`	`isEOF()` This method returns true if the last operation failed due to an end of file simulated by the user pressing End.
`boolean`	`readBoolean()` Reads a boolean from the textfield.
`byte`	`readByte()` Reads a byte from the textfield.
`char`	`readC()` Reads a char from the textfield.
`char`	`readChar()` Reads a char from the textfield.
`double`	`readDouble()` Reads a double from the textfield.
`float`	`readFloat()` Reads a float from the textfield.
`int`	`readInt()` Reads an int from the textfield.
`long`	`readLong()` Reads a long from the textfield.
`short`	`readShort()` Reads a short from the textfield.
`java.lang.String`	`readString()` Reads a String from the textfield.
`void`	`setLabel(java.lang.String label)` Changes the text of the label (prompt) on the form.
`boolean`	`successful()` This method returns true if the last opperation was successful, false otherwise.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ASCIIPrompter
```
public ASCIIPrompter()
```
    Creates a form with a labeled text field to prompt the user for text input. There are two buttons, OK and End, OK indicates the input should be accepted and End indicates the input should not be accepted, simulating end of file (EOF). No log file is created.
  - ASCIIPrompter
```
public ASCIIPrompter(boolean logIt)
```
    Creates a form with a labeled text field to prompt the user for text input. There are two buttons, OK and End, OK indicates the input should be accepted and End indicates the input should not be accepted, simulating end of file (EOF). If the parameter is true a file will be created to log all input done via this prompter, otherwise no log file is created.
    
    Parameters:
    
    logIt - whether a log file should be created
- Method Detail
  - successful
```
public boolean successful()
```
    This method returns true if the last opperation was successful, false otherwise. isDataError and isEOF may be called to determine why the last operation may have failed.
    
    Returns:
    
    true if last opperation was successful, false otherwise.
  - isDataEror
```
public boolean isDataEror()
```
    This method returns true if the last operation failed due to a data error. An example of a data error would be from reading an int value when the characters "hello world" were enetered which may not be interpreted as a int.
    
    Returns:
    
    true if last operation failed due to a data error, false otherwise.
  - isEOF
```
public boolean isEOF()
```
    This method returns true if the last operation failed due to an end of file simulated by the user pressing End.
    
    Returns:
    
    true if last operation failed due to an end of file, false otherwise.
  - close
```
public void close()
```
    Closes the ASCIIPrompter and frees resources. The ASCIIPrompter should not be used thereafter.
  - setLabel
```
public void setLabel(java.lang.String label)
```
    Changes the text of the label (prompt) on the form.
    
    Parameters:
    
    label - The text to be displayed in the label
  - readByte
```
public byte readByte()
```
    Reads a byte from the textfield.
    
    Returns:
    
    the textfield as a byte value.
  - readChar
```
public char readChar()
```
    Reads a char from the textfield.
    
    Returns:
    
    the textfield as a char value.
  - readC
```
public char readC()
```
    Reads a char from the textfield.
    
    Returns:
    
    the textfield as a char value.
  - readDouble
```
public double readDouble()
```
    Reads a double from the textfield.
    
    Returns:
    
    the textfield as a double value.
  - readFloat
```
public float readFloat()
```
    Reads a float from the textfield.
    
    Returns:
    
    the textfield as a float value.
  - readInt
```
public int readInt()
```
    Reads an int from the textfield.
    
    Returns:
    
    the textfield as an int value.
  - readShort
```
public short readShort()
```
    Reads a short from the textfield.
    
    Returns:
    
    the textfield as a short value.
  - readLong
```
public long readLong()
```
    Reads a long from the textfield.
    
    Returns:
    
    the textfield as a long value.
  - readString
```
public java.lang.String readString()
```
    Reads a String from the textfield.
    
    Returns:
    
    the textfield as a String value.
  - readBoolean
```
public boolean readBoolean()
```
    Reads a boolean from the textfield.
    
    Returns:
    
    the textfield as a boolean value.

Class ASCIIPrompter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ASCIIPrompter

ASCIIPrompter

Method Detail

successful

isDataEror

isEOF

close

setLabel

readByte

readChar

readC

readDouble

readFloat

readInt

readShort

readLong

readString

readBoolean