BasicForm

java.lang.Object
- BasicIO.BasicForm

```
public class BasicForm
extends java.lang.Object
```
BasicForm provides an easy way of giving Java applications a graphical user interface.

BasicForm creates a form that may have components added to it: labels, textfields, textareas, checkboxes, sliders, radio buttons, pictures, audio and buttons. These components can be read from and written to, making the BasicForm a source of data input for a program, and a means of the program to display output data.

Adding Components to a BasicForm
For each type of component (with the exception of buttons) there is an addXXXXXX method. (eg. addTextField()) that adds a component of that type to the BasicForm. With each of the add methods there is an optional String parameter for the component's name which is used to access the component for reading, writing, getting attributes etc. If a name is not specified then attributes of the component cannot be accessed, but the component may still be accessed for reading and writing as described in Reading and Writing, below. A BasicForm expands to include all the fields added to it.

Along with the optional name parameter, some components have additional parameters. The list below are the most common ones amongst the components. For specific parameters see the method summaries below.

label - a string to label the component on the BasicForm. The label auto sizes to the size of the text passed. If a label is not specified when the component is created, it cannot be added later on. Similarly the size of the label remains constant from its creation. If a longer string is passed as new text for the label, the text will be truncated, or if a shorter string is passed, it will be padded the right. For this reason it is a good idea to provide a label of ample size when adding components. To make things line up nicely you should provide Strings of equal length for all of your labels.

width and height - the width and height of a component in pixels. TextFields and TextAreas do not have width and height parameters. The height of a TextField is static and cannot be set and it's width may be changed by specifying a size. The size specifies how many characters will be able to fit into the textbox. TextAreas have nRows and nCols, the number of rows and columns the TextArea can display.

x and y - the top left hand corner of the component. If the component has a label, the x and y will be the top left hand corner of the label. In Java the top left hand corner of the window is (0,0) and both x and y increase as you move to the right and down.

Default Parameters
If a parameter is omitted, default values are used as follows:
name - no name, component cannot be accessed in methods by providing a name
label - no label
width and height - each component has its own set of defaults for its size
x and y - the component will be placed directly below the lowest component on the form along the left side of the form with small gaps between it and the component above it and between it and the edge of the window.

Reading and Writing
Reads and writes can be performed on most components. There are 2 ways of specifying which component is read/written from/to.

1. Specifying the component name:
By specifying the name of a component in the read and write methods, you can read/write from/to any component on the BasicForm at any time.

2. Not providing a name of the component:
There is an invisible cursor that cycles through all of the components on the BasicForm. Every time a read or write is performed the cursor moves to the component following the component read/written. When the last component is accessed, the cursor will cycle back to the first component. The order in which the cursor cycles through the components is based on order in which the components are added to the form. If you do not provide the read and write methods with a component name, the read/write is performed on the component indicated by the cursor.
- If all reads/writes are done without supplying a name, the components are read/written from/to in the order in which they were added to the form.
- If a name is used to perform a read/write operation, followed by a read/write operation without providing a name, the second read/write will be perfromed from/to component following the one read/written from/to with the name.

Formats
Format objects can be provided with read and write methods. A Format object may be used to change the visual look of the output, for instance if you write an int of value 1000 while providing a Format object to make it look like a currency the output may be "$1,000.00". If you were to try use readInt without a format the operation would fail as it would be unable to interpret "$1,000.00" as an int. Providing the same Format object with the readInt method here would allow readInt to return the value 1000.

A TextField can have a default formats which will automatically be used to format any data read/written from/to it. If a read or write operation is performed on a textfield that has a default format, then the format object passed in the read/write method temporarily overrides the default format.

The 3 States of a BasicForm
A BasicForm has 3 states:
Invisible - the form is not visible on the screen. The program creating the form is running and can interact with the form. This is the initial state of a form and may be achieved at any time via the hide() method.
Visible - the form is visible on the screen. The program creating the form is running and can interact with the form. The buttons on the form are not visible indicating to the user that s/he cannot interact with the form. This state automatically occurs after the user presses a button when the form is in the User has Control state and may be achieved at any time via the show() method.
User has Control - the form is visible on the screen and the program creating the form is suspended awaiting user input. The buttons are visible and the user may interact with the form. When the user presses a button, the form goes to the Visible state, allowing the program to interact with the form and/or make the form invisible. This state may be achieved via the accept() method.

Buttons
Whenever the form in in User has Control state, one or more buttons are displayed to allow the user to select one or more actions when dismissing the form. A default set of buttons for the form can be specified supplying a set of button names (String) in the BasicForm constructor. If no default button names are provided, the default will be one button named OK. Buttons are shown whenever the accept() method is called. If the accept method has no parameters, the default buttons are displayed. A different set of buttons can be displayed by providing a set of button names (String) as parameters to the accept method. These temporarily override the default buttons.

The buttons on the form are used by the user to dismiss the form, returning it to the Visible state, and giving control back to the program. The accept() method returns an int whose value is based on the button pressed. If the first button was pressed a 0 will be returned, the 2nd button will return a 1. The nth button will return n-1. The buttons are numbered based on the order they were passed to the BasicForm constructor or accept method.

Exceptions
Exceptions can be thrown when 'problems' occur. If an exception occurs and is not caught the program will crash. There are 4 kinds of Exceptions that may occur.
ComponentNotFoundException - is thrown if a read or write operation cannot find a component with the specified name on the form.
IllegalOperationException - is thrown if an operation is performed on an incompatible component, e.g. trying to place a picture onto a textfield.
NameAlreadyExistsException - is thrown if a component is added with a name identical to an existing component on the form.
NoComponentOnFormException - is thrown if an operation is attempted to be performed on a component which does not exist on the form.

Sample Code demonstrating writing and reading from a component.

String field2output;
BasicForm form = new BasicForm();
form.addTextField("field1");
form.addTextField("field2");
form.writeString("field1", "this is field 1");
form.accept();
field2output = form.readString("field2");

Version:

1.0 July 08, 2.0 (09/05/04), 3.0 (09/06/30)

Author:

Andrew Cheesman, David Hughes, David Hughes

Constructor Summary

Constructors
Constructor and Description
`BasicForm()` Creates a form with one default button labeled OK.
`BasicForm(java.lang.String... buttons)` Creates a form with the specified deafult buttons.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`accept()` The form is made visible with the default buttons and the program is suspended, putting the form into User has Control state.
`int`	`accept(java.lang.String... buttons)` The form is made visible with the specified buttons and the program is suspended, putting the form into User has Control state.
`void`	`addCanvas()`
`void`	`addCanvas(int width, int height)`
`void`	`addCanvas(int width, int height, int x, int y)`
`void`	`addCanvas(java.lang.String name)`
`void`	`addCanvas(java.lang.String name, int width, int height)`
`void`	`addCanvas(java.lang.String name, int width, int height, int x, int y)`
`void`	`addCanvas(java.lang.String name, java.lang.String label)`
`void`	`addCanvas(java.lang.String name, java.lang.String label, int width, int height)`
`void`	`addCanvas(java.lang.String name, java.lang.String label, int width, int height, int x, int y)` Adds a canvas with specified name, label, size, and x,y co-ordinates to the form.
`void`	`addCheckBox()`
`void`	`addCheckBox(int x, int y)`
`void`	`addCheckBox(java.lang.String name)`
`void`	`addCheckBox(java.lang.String name, int x, int y)`
`void`	`addCheckBox(java.lang.String name, java.lang.String label)`
`void`	`addCheckBox(java.lang.String name, java.lang.String label, int x, int y)` Adds a checkbox with the specified name, label and x,y co-ordinate to the form.
`void`	`addCustomComponent(javax.swing.JComponent c)` Adds any JComponent to the form.
`void`	`addLabel()`
`void`	`addLabel(int x, int y)`
`void`	`addLabel(java.lang.String name)`
`void`	`addLabel(java.lang.String name, int x, int y)`
`void`	`addLabel(java.lang.String name, java.lang.String label)`
`void`	`addLabel(java.lang.String name, java.lang.String label, int x, int y)` Adds a label with the specified name, text and x,y co-ordinate to the form.
`void`	`addRadioButtons(boolean vertical, int x, int y, java.lang.String... buttons)`
`void`	`addRadioButtons(boolean vertical, java.lang.String... buttons)`
`void`	`addRadioButtons(java.lang.String... buttons)`
`void`	`addRadioButtons(java.lang.String name, boolean vertical, int x, int y, java.lang.String... buttons)`
`void`	`addRadioButtons(java.lang.String name, boolean vertical, java.lang.String... buttons)`
`void`	`addRadioButtons(java.lang.String name, java.lang.String label, boolean vertical, int x, int y, java.lang.String... buttons)` Adds a group of radio buttons with the specified name, label orientation and x,y co-ordinate to the form.
`void`	`addRadioButtons(java.lang.String name, java.lang.String label, boolean vertical, java.lang.String... buttons)`
`void`	`addSlider()`
`void`	`addSlider(int min, int max)`
`void`	`addSlider(int min, int max, int size)`
`void`	`addSlider(int min, int max, int size, int x, int y)`
`void`	`addSlider(java.lang.String name)`
`void`	`addSlider(java.lang.String name, int min, int max)`
`void`	`addSlider(java.lang.String name, int min, int max, int size)`
`void`	`addSlider(java.lang.String name, int min, int max, int size, int x, int y)`
`void`	`addSlider(java.lang.String name, java.lang.String label)`
`void`	`addSlider(java.lang.String name, java.lang.String label, int min, int max)`
`void`	`addSlider(java.lang.String name, java.lang.String label, int min, int max, int size)`
`void`	`addSlider(java.lang.String name, java.lang.String label, int min, int max, int size, int x, int y)` Adds a slider with the specified name, label, range, size and x,y co-ordinate to the form.
`void`	`addSound()`
`void`	`addSound(int x, int y)`
`void`	`addSound(Sound s)`
`void`	`addSound(Sound s, int x, int y)`
`void`	`addSound(java.lang.String name)`
`void`	`addSound(java.lang.String name, int x, int y)`
`void`	`addSound(java.lang.String name, Sound s)`
`void`	`addSound(java.lang.String name, java.lang.String label)`
`void`	`addSound(java.lang.String name, java.lang.String label, int x, int y)`
`void`	`addSound(java.lang.String name, java.lang.String label, Sound s)`
`void`	`addSound(java.lang.String name, java.lang.String label, Sound s, int x, int y)` Adds a sound player (a button that when pressed will play the sound associated with the player) with specified name, label, sound and x,y co-ordinate to the form.
`void`	`addTextArea()`
`void`	`addTextArea(int nRow, int nCol)`
`void`	`addTextArea(int nRow, int nCol, int x, int y)`
`void`	`addTextArea(java.lang.String name)`
`void`	`addTextArea(java.lang.String name, int nRow, int nCol)`
`void`	`addTextArea(java.lang.String name, int nRow, int nCol, int x, int y)`
`void`	`addTextArea(java.lang.String name, java.lang.String label)`
`void`	`addTextArea(java.lang.String name, java.lang.String label, int nRow, int nCol)`
`void`	`addTextArea(java.lang.String name, java.lang.String label, int nRow, int nCol, int x, int y)` Adds a text area, with the specified name, label, number of columns, number of rows and x,y co-ordinate to the form.
`void`	`addTextField()`
`void`	`addTextField(java.text.Format f)`
`void`	`addTextField(java.text.Format f, int size)`
`void`	`addTextField(java.text.Format f, int size, int x, int y)`
`void`	`addTextField(int size)`
`void`	`addTextField(int size, int x, int y)`
`void`	`addTextField(java.lang.String name)`
`void`	`addTextField(java.lang.String name, java.text.Format f)`
`void`	`addTextField(java.lang.String name, java.text.Format f, int size)`
`void`	`addTextField(java.lang.String name, java.text.Format f, int size, int x, int y)`
`void`	`addTextField(java.lang.String name, int size)`
`void`	`addTextField(java.lang.String name, int size, int x, int y)`
`void`	`addTextField(java.lang.String name, java.lang.String label)`
`void`	`addTextField(java.lang.String name, java.lang.String label, java.text.Format f)`
`void`	`addTextField(java.lang.String name, java.lang.String label, java.text.Format f, int size)`
`void`	`addTextField(java.lang.String name, java.lang.String label, java.text.Format f, int size, int x, int y)` Adds a text field with the specified name, label, default format, size and x,y co-ordinate to the form.
`void`	`addTextField(java.lang.String name, java.lang.String label, int size)`
`void`	`addTextField(java.lang.String name, java.lang.String label, int size, int x, int y)`
`void`	`clear()`
`void`	`clear(java.lang.String name)` Clears the value displayed in the specified component on the form.
`void`	`clearAll()` Clears the values displayed in all components of the form.
`void`	`close()` Closes the form and frees resources.
`int`	`getHeight(java.lang.String name)` Returns the height in pixels of component on the form
`Picture`	`getPicture(java.lang.String name)` Gets a picture from a canvas.
`Sound`	`getSound(java.lang.String name)` Gets a sound from a sound player.
`Turtle`	`getTurtle(java.lang.String name)` Gets a turtle from a canvas.
`int`	`getWidth(java.lang.String name)` Returns the width in pixels of component on the form
`int`	`getX(java.lang.String name)` Returns the x co-ordinate of the top left corner of a component on the form
`int`	`getY(java.lang.String name)` Returns the y co-ordinate of the top left corner of a component on the form
`void`	`hide()` Makes the form invisible on the screen, putting the form into the Invisible state.
`boolean`	`isDataError()` Returns true if last operation failed due to being unable to convert the data to the specified type.
`boolean`	`isEditable(java.lang.String name)` Returns true if the component is set to editable, false otherwise.
`boolean`	`isEOF()` Returns true if last operation failed due to reading when at EOF.
`boolean`	`isFormatException()` Returns true if last operation failed due to being unable to format data.
`void`	`newLine()`
`void`	`newLine(java.lang.String name)` Writes a newline character to the specified component on the form.
`void`	`nextLine()`
`void`	`nextLine(java.lang.String name)` The next read from the specified component on the form will start at the first character of the next line.
`void`	`placePicture(java.lang.String name, Picture p)` Places a picture onto a canvas.
`void`	`placeSound(java.lang.String name, Sound s)` Places a sound into a sound player on the form
`void`	`placeTurtle(java.lang.String name, Turtle t)` Places a turtle onto a canvas.
`boolean`	`readBoolean()`
`boolean`	`readBoolean(java.lang.String name)` Reads a boolean from the specified component on the form.
`byte`	`readByte()`
`byte`	`readByte(java.text.Format f)`
`byte`	`readByte(java.lang.String name)`
`byte`	`readByte(java.lang.String name, java.text.Format f)` Reads a byte from the specified component on the form.
`char`	`readC()`
`char`	`readC(java.lang.String name)` Reads a char from the specified component on the form.
`char`	`readChar()`
`char`	`readChar(java.lang.String name)` Reads a char from the specified component on the form.
`double`	`readDouble()`
`double`	`readDouble(java.text.Format f)`
`double`	`readDouble(java.lang.String name)`
`double`	`readDouble(java.lang.String name, java.text.Format f)` Reads a double from the specified component on the form.
`float`	`readFloat()`
`float`	`readFloat(java.text.Format f)`
`float`	`readFloat(java.lang.String name)`
`float`	`readFloat(java.lang.String name, java.text.Format f)` Reads a float from the specified component on the form.
`int`	`readInt()`
`int`	`readInt(java.text.Format f)`
`int`	`readInt(java.lang.String name)`
`int`	`readInt(java.lang.String name, java.text.Format f)` Reads an int from the specified component on the form.
`java.lang.String`	`readLine()`
`java.lang.String`	`readLine(java.lang.String name)` Reads a line of text as a String from the specified component on the form.
`long`	`readLong()`
`long`	`readLong(java.text.Format f)`
`long`	`readLong(java.lang.String name)`
`long`	`readLong(java.lang.String name, java.text.Format f)` Reads a long from the specified component on the form.
`short`	`readShort()`
`short`	`readShort(java.text.Format f)`
`short`	`readShort(java.lang.String name)`
`short`	`readShort(java.lang.String name, java.text.Format f)` Reads a short from the specified component on the form.
`java.lang.String`	`readString()`
`java.lang.String`	`readString(java.lang.String name)` Reads a String from the specified component on the form.
`void`	`setEditable(java.lang.String name, boolean editable)` Sets the edit state of the component.
`void`	`setLabel(java.lang.String name, java.lang.String label)` Changes the text of a label of a component.
`void`	`setSound(java.lang.String name, Sound s)` Deprecated. use placeSound instead
`void`	`setTitle(java.lang.String title)` Sets the title in the title bar of the form to the String passed.
`void`	`setTurtle(java.lang.String name, Turtle t)` Deprecated. use placeTurtle instead
`void`	`show()` Makes the form visible on the screen, putting the form into the Visible state.
`void`	`skipToEOL()` Deprecated. Use nextLine() instead.
`void`	`skipToEOL(java.lang.String name)` Deprecated. use nextLine(name) instead.
`boolean`	`successful()` Returns true if the last operation (eg readxxx, writexxx) was succesful, false otherwise.
`void`	`writeBoolean(boolean b)`
`void`	`writeBoolean(java.lang.String name, boolean b)` Writes a boolean value to the specified component on the form.
`void`	`writeByte(byte b)`
`void`	`writeByte(byte b, java.text.Format f)`
`void`	`writeByte(byte b, java.text.Format f, int size)`
`void`	`writeByte(byte b, int size)`
`void`	`writeByte(java.lang.String name, byte b)`
`void`	`writeByte(java.lang.String name, byte b, java.text.Format f)`
`void`	`writeByte(java.lang.String name, byte b, java.text.Format f, int size)` Writes a byte value to the specified component on the form.
`void`	`writeByte(java.lang.String name, byte b, int size)`
`void`	`writeC(char c)`
`void`	`writeC(java.lang.String name, char c)` Writes a char value to the specified component on the form.
`void`	`writeChar(char c)`
`void`	`writeChar(java.lang.String name, char c)` Writes a char value to the specified component on the form.
`void`	`writeDouble(double d)`
`void`	`writeDouble(double d, java.text.Format f)`
`void`	`writeDouble(double d, java.text.Format f, int size)`
`void`	`writeDouble(double d, int size)`
`void`	`writeDouble(java.lang.String name, double d)`
`void`	`writeDouble(java.lang.String name, double d, java.text.Format f)`
`void`	`writeDouble(java.lang.String name, double d, java.text.Format f, int size)` Writes a double value to the specified component on the form.
`void`	`writeDouble(java.lang.String name, double d, int size)`
`void`	`writeEOL()` Deprecated. use newLine() instead
`void`	`writeEOL(java.lang.String name)` Deprecated. Use newLine() instead.
`void`	`writeFloat(float f)`
`void`	`writeFloat(float f, java.text.Format format)`
`void`	`writeFloat(float f, java.text.Format fmt, int size)`
`void`	`writeFloat(float f, int size)`
`void`	`writeFloat(java.lang.String name, float f)`
`void`	`writeFloat(java.lang.String name, float f, java.text.Format format)`
`void`	`writeFloat(java.lang.String name, float f, java.text.Format fmt, int size)` Writes a float value to the specified component on the form.
`void`	`writeFloat(java.lang.String name, float f, int size)`
`void`	`writeInt(int i)`
`void`	`writeInt(int i, java.text.Format f)`
`void`	`writeInt(int i, java.text.Format f, int size)`
`void`	`writeInt(int i, int size)`
`void`	`writeInt(java.lang.String name, int i)`
`void`	`writeInt(java.lang.String name, int i, java.text.Format f)`
`void`	`writeInt(java.lang.String name, int i, java.text.Format f, int size)` Writes an int value to the specified component on the form.
`void`	`writeInt(java.lang.String name, int i, int size)`
`void`	`writeLine(java.lang.String s)`
`void`	`writeLine(java.lang.String name, java.lang.String s)` Writes a string as a line to the specified component on the form.
`void`	`writeLong(long l)`
`void`	`writeLong(long l, java.text.Format f)`
`void`	`writeLong(long l, java.text.Format f, int size)`
`void`	`writeLong(long l, int size)`
`void`	`writeLong(java.lang.String name, long l)`
`void`	`writeLong(java.lang.String name, long l, java.text.Format f)`
`void`	`writeLong(java.lang.String name, long l, java.text.Format f, int size)` Writes a long value to the specified component on the form.
`void`	`writeLong(java.lang.String name, long l, int size)`
`void`	`writeShort(short s)`
`void`	`writeShort(short s, java.text.Format f)`
`void`	`writeShort(short s, java.text.Format f, int size)`
`void`	`writeShort(short s, int size)`
`void`	`writeShort(java.lang.String name, short s)`
`void`	`writeShort(java.lang.String name, short s, java.text.Format f)`
`void`	`writeShort(java.lang.String name, short s, java.text.Format f, int size)` Writes a short value to the specified component on the form.
`void`	`writeShort(java.lang.String name, short s, int size)`
`void`	`writeString(java.lang.String s)`
`void`	`writeString(java.lang.String s, java.text.Format f)`
`void`	`writeString(java.lang.String s, java.text.Format f, int size)`
`void`	`writeString(java.lang.String s, int size)`
`void`	`writeString(java.lang.String name, java.lang.String s)`
`void`	`writeString(java.lang.String name, java.lang.String s, java.text.Format f)`
`void`	`writeString(java.lang.String name, java.lang.String s, java.text.Format f, int size)` Writes a String value to the specified component on the form.
`void`	`writeString(java.lang.String name, java.lang.String s, int size)`

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

- Constructor Detail
  - BasicForm
```
public BasicForm(java.lang.String... buttons)
```
    Creates a form with the specified deafult buttons. If no Strings are provided there will be one default button labeled OK. Otherwise each String passed will be a default button, with the String being the text on the button.
    
    Parameters:
    
    buttons - the Strings which represent the default buttons on the form.
  - BasicForm
```
public BasicForm()
```
    Creates a form with one default button labeled OK. // * // * @param width the minimum width of the form // * @param height the minimum height of the form
- Method Detail
  - successful
```
public boolean successful()
```
    Returns true if the last operation (eg readxxx, writexxx) was succesful, false otherwise. An operation can be unsuccessul if:
    - the data can not be converted to the required type, isDataError returns true.
    - the data can not be formated, isFormatException returns true.
    - the EOF has been reach on the component when a read operation is performed, isEOF returns true.
    
    Returns:
    
    boolean indicating if last operation was successful.
  - isEOF
```
public boolean isEOF()
```
    Returns true if last operation failed due to reading when at EOF.
    
    Returns:
    
    a boolean indicating if last operation failed due reading when at EOF.
  - isFormatException
```
public boolean isFormatException()
```
    Returns true if last operation failed due to being unable to format data.
    
    Returns:
    
    a boolean indicating if last operation failed due to being unable to format data.
  - isDataError
```
public boolean isDataError()
```
    Returns true if last operation failed due to being unable to convert the data to the specified type.
    
    Returns:
    
    a boolean indicating if last operation failed due to being unable to convert the data to the specified type.
  - setTitle
```
public void setTitle(java.lang.String title)
```
    Sets the title in the title bar of the form to the String passed.
    
    Parameters:
    
    title - will become the title on the form.
  - getX
```
public int getX(java.lang.String name)
         throws ComponentNotFoundException
```
    Returns the x co-ordinate of the top left corner of a component on the form
    
    Parameters:
    
    name - the name of the component.
    
    Returns:
    
    the x co-ordinate of the top left corner of the component.
    
    Throws:
    
    ComponentNotFoundException - none of the components on the BasicForm have the specified name.
  - getY
```
public int getY(java.lang.String name)
         throws ComponentNotFoundException
```
    Returns the y co-ordinate of the top left corner of a component on the form
    
    Parameters:
    
    name - the name of the component.
    
    Returns:
    
    the y co-ordinate of the top left corner of the component.
    
    Throws:
    
    ComponentNotFoundException - none of the components on the BasicForm have the specified name.
  - getWidth
```
public int getWidth(java.lang.String name)
             throws ComponentNotFoundException
```
    Returns the width in pixels of component on the form
    
    Parameters:
    
    name - the name of the component.
    
    Returns:
    
    the width of the component.
    
    Throws:
    
    ComponentNotFoundException - none of the components on the BasicForm have the specified name.
  - getHeight
```
public int getHeight(java.lang.String name)
              throws ComponentNotFoundException
```
    Returns the height in pixels of component on the form
    
    Parameters:
    
    name - the name of the component.
    
    Returns:
    
    the height of the component.
    
    Throws:
    
    ComponentNotFoundException - none of the components on the BasicForm have the specified name.
  - setLabel
```
public void setLabel(java.lang.String name,
                     java.lang.String label)
              throws ComponentNotFoundException
```
    Changes the text of a label of a component. If the component was created without a label, no effect will occur.
    
    Parameters:
    
    name - the name of the component
    
    label - the text to put into the label
    
    Throws:
    
    ComponentNotFoundException - none of the components on the BasicForm have the specified name.
  - placePicture
```
public void placePicture(java.lang.String name,
                         Picture p)
                  throws IllegalOperationException,
                         ComponentNotFoundException
```
    Places a picture onto a canvas.
    
    Parameters:
    
    name - the name of the canvas component
    
    p - a picture to be placed onto the canvas
    
    Throws:
    
    ComponentNotFoundException - none of the components on the BasicForm have the specified name.
    
    IllegalOperationException - the component with the specified name is not a canvas.
  - setSound
```
public void setSound(java.lang.String name,
                     Sound s)
```
    Deprecated. use placeSound instead
    
    Places a sound into a sound player on the form
    
    Parameters:
    
    name - the name of the sound player component
    
    s - the sound to be placed into the sound player
    
    Throws:
    
    ComponentNotFoundException - none of the components on the BasicForm have the specified name.
    
    IllegalOperationException - the component with the specified name is not a sound player.
  - setTurtle
```
public void setTurtle(java.lang.String name,
                      Turtle t)
               throws IllegalOperationException
```
    Deprecated. use placeTurtle instead
    
    Places a turtle onto a canvas.
    
    Parameters:
    
    name - the name of the canvas component
    
    t - the turtle to be put onto the canvas
    
    Throws:
    
    ComponentNotFoundException - none of the components on the BasicForm have the specified name.
    
    IllegalOperationException - the component with the specified name is not a canvas.
  - placeSound
```
public void placeSound(java.lang.String name,
                       Sound s)
```
    Places a sound into a sound player on the form
    
    Parameters:
    
    name - the name of the sound player component
    
    s - the sound to be placed into the sound player
    
    Throws:
    
    ComponentNotFoundException - none of the components on the BasicForm have the specified name.
    
    IllegalOperationException - the component with the specified name is not a sound player.
  - placeTurtle
```
public void placeTurtle(java.lang.String name,
                        Turtle t)
                 throws IllegalOperationException
```
    Places a turtle onto a canvas.
    
    Parameters:
    
    name - the name of the canvas component
    
    t - the turtle to be put onto the canvas
    
    Throws:
    
    ComponentNotFoundException - none of the components on the BasicForm have the specified name.
    
    IllegalOperationException - the component with the specified name is not a canvas.
  - getPicture
```
public Picture getPicture(java.lang.String name)
                   throws IllegalOperationException
```
    Gets a picture from a canvas.
    
    Parameters:
    
    name - the name of the canvas component
    
    Returns:
    
    the picture on the canvas
    
    Throws:
    
    IllegalOperationException - the component with the specified name is not a canvas.
  - getSound
```
public Sound getSound(java.lang.String name)
               throws IllegalOperationException
```
    Gets a sound from a sound player.
    
    Parameters:
    
    name - the name of the sound player component
    
    Returns:
    
    the sound in the sound player
    
    Throws:
    
    IllegalOperationException - the component with the specified name is not a sound player.
  - getTurtle
```
public Turtle getTurtle(java.lang.String name)
                 throws IllegalOperationException
```
    Gets a turtle from a canvas.
    
    Parameters:
    
    name - the name of the canvas component
    
    Returns:
    
    the trutle on the canvas
    
    Throws:
    
    IllegalOperationException - the component with the specified name is not a canvas.
  - show
```
public void show()
```
    Makes the form visible on the screen, putting the form into the Visible state. The components on the form are not editiable by a user until the accept() method is called.
  - hide
```
public void hide()
```
    Makes the form invisible on the screen, putting the form into the Invisible state. The form still exists when hidden and can be accessed via program control.
  - accept
```
public int accept()
```
    The form is made visible with the default buttons and the program is suspended, putting the form into User has Control state. The user may interact with the form ending the interaction (dismissing the form) by pressing a button. An int value is returned based on which button is pressed. The first button will return a value of 0, the 2nd a value of 1. The nth button will return a value of n-1.
    
    Returns:
    
    the int value of the button pressed
  - accept
```
public int accept(java.lang.String... buttons)
```
    The form is made visible with the specified buttons and the program is suspended, putting the form into User has Control state. The user may interact with the form ending the interaction (dismissing the form) by pressing a button. An int value is returned based on which button is pressed. The first button will return a value of 0, the 2nd a value of 1. The nth button will return a value of n-1.
    
    Parameters:
    
    buttons - buttons that will be displayed
    
    Returns:
    
    the int value of the button pressed
  - setEditable
```
public void setEditable(java.lang.String name,
                        boolean editable)
```
    Sets the edit state of the component. If editable is false, the component on the form can not be modified by the user when the form is in User has Control state. Otherwise the user will be able to modify the value in the component. The default edit state is editable (true).
    
    Parameters:
    
    name - the name of the component
    
    editable - the component is editable
    
    Throws:
    
    ComponentNotFoundException - none of the components on the BasicForm have the specified name.
  - isEditable
```
public boolean isEditable(java.lang.String name)
```
    Returns true if the component is set to editable, false otherwise.
    
    Parameters:
    
    name - the name of the component
    
    Returns:
    
    boolean the component is currently editable
    
    Throws:
    
    ComponentNotFoundException - none of the components on the BasicForm have the specified name.
  - addLabel
```
public void addLabel(java.lang.String name,
                     java.lang.String label,
                     int x,
                     int y)
              throws NameAlreadyExistsException
```
    Adds a label with the specified name, text and x,y co-ordinate to the form. If a string for the label is not provided, an empty label of 20 characters will be created. Otherwise the size of the label will be the size of the String "label". Leaving out the other paramters will result in them having their default values. (see default values above) All of the parameters are optional, and possible combinations of them can be seen below.
    
    Parameters:
    
    name - the name of the label component.
    
    label - the text the label displays.
    
    x - The x co-ordinate of the top left corner of the label.
    
    y - The y co-ordinate of the top left corner of the label.
    
    Throws:
    
    NameAlreadyExistsException - the name has already been used for another component.
  - addLabel
```
public void addLabel()
```
  - addLabel
```
public void addLabel(int x,
                     int y)
```
    See Also:
    
    ( String name, String label, int x, int y )
  - addLabel
```
public void addLabel(java.lang.String name)
```
    See Also:
    
    ( String name, String label, int x, int y )
  - addLabel
```
public void addLabel(java.lang.String name,
                     int x,
                     int y)
```
    See Also:
    
    ( String name, String label, int x, int y )
  - addLabel
```
public void addLabel(java.lang.String name,
                     java.lang.String label)
```
    See Also:
    
    ( String name, String label, int x, int y )
  - addTextField
```
public void addTextField(java.lang.String name,
                         java.lang.String label,
                         java.text.Format f,
                         int size,
                         int x,
                         int y)
                  throws NameAlreadyExistsException
```
    Adds a text field with the specified name, label, default format, size and x,y co-ordinate to the form. Leaving the name blank will prevent the text field from being accessed other than by iterating through all components on the form. Leaving out the label will create a text field without a a label. Leaving out the other paramters will result in them having their default values. (see default values above) All of the parameters are optional, and possible combinations of them can be seen below.
    
    Parameters:
    
    name - the name of the text field component.
    
    label - the text to be displayed in the label.
    
    f - the default format for the text field.
    
    size - the size of the text field in characters.
    
    x - the x co-ordinate of the top left corner of the label/text field
    
    y - the y co-ordinate of the top left corner of the label/text field
    
    Throws:
    
    NameAlreadyExistsException - the name has already been used for another component.
  - addTextField
```
public void addTextField(java.lang.String name,
                         java.lang.String label,
                         java.text.Format f,
                         int size)
```
    See Also:
    
    addTextField(String name, String label, Format f, int size, int x, int y)
  - addTextField
```
public void addTextField(java.lang.String name,
                         java.lang.String label,
                         java.text.Format f)
```
    See Also:
    
    addTextField(String name, String label, Format f, int size, int x, int y)
  - addTextField
```
public void addTextField(java.lang.String name,
                         java.lang.String label)
```
    See Also:
    
    addTextField(String name, String label, Format f, int size, int x, int y)
  - addTextField
```
public void addTextField(java.lang.String name)
```
    See Also:
    
    addTextField(String name, String label, Format f, int size, int x, int y)
  - addTextField
```
public void addTextField(java.lang.String name,
                         java.text.Format f,
                         int size,
                         int x,
                         int y)
```
    See Also:
    
    addTextField(String name, String label, Format f, int size, int x, int y)
  - addTextField
```
public void addTextField(java.lang.String name,
                         java.text.Format f,
                         int size)
```
    See Also:
    
    addTextField(String name, String label, Format f, int size, int x, int y)
  - addTextField
```
public void addTextField(java.lang.String name,
                         java.text.Format f)
```
    See Also:
    
    addTextField(String name, String label, Format f, int size, int x, int y)
  - addTextField
```
public void addTextField(java.lang.String name,
                         java.lang.String label,
                         int size,
                         int x,
                         int y)
```
    See Also:
    
    addTextField(String name, String label, Format f, int size, int x, int y)
  - addTextField
```
public void addTextField(java.lang.String name,
                         java.lang.String label,
                         int size)
```
    See Also:
    
    addTextField(String name, String label, Format f, int size, int x, int y)
  - addTextField
```
public void addTextField(java.lang.String name,
                         int size,
                         int x,
                         int y)
```
    See Also:
    
    addTextField(String name, String label, Format f, int size, int x, int y)
  - addTextField
```
public void addTextField(java.lang.String name,
                         int size)
```
    See Also:
    
    addTextField(String name, String label, Format f, int size, int x, int y)
  - addTextField
```
public void addTextField(java.text.Format f,
                         int size,
                         int x,
                         int y)
```
    See Also:
    
    addTextField(String name, String label, Format f, int size, int x, int y)
  - addTextField
```
public void addTextField(java.text.Format f,
                         int size)
```
    See Also:
    
    addTextField(String name, String label, Format f, int size, int x, int y)
  - addTextField
```
public void addTextField(java.text.Format f)
```
    See Also:
    
    addTextField(String name, String label, Format f, int size, int x, int y)
  - addTextField
```
public void addTextField(int size,
                         int x,
                         int y)
```
    See Also:
    
    addTextField(String name, String label, Format f, int size, int x, int y)
  - addTextField
```
public void addTextField(int size)
```
    See Also:
    
    addTextField(String name, String label, Format f, int size, int x, int y)
  - addTextField
```
public void addTextField()
```
    See Also:
    
    addTextField(String name, String label, Format f, int size, int x, int y)
  - addTextArea
```
public void addTextArea(java.lang.String name,
                        java.lang.String label,
                        int nRow,
                        int nCol,
                        int x,
                        int y)
```
    Adds a text area, with the specified name, label, number of columns, number of rows and x,y co-ordinate to the form. Leaving the name blank will prevent the text area from being accessed other than through iterating through all components on the form. Leaving out the label, will created an unlabeled text area. Leaving out nRows and nCols will create a text area 12 rows by 50 columns. Leaving out the other paramters will result in them having their default values. (see default values above) All of the parameters are optional, and possible combinations of them can be seen below.
    
    Parameters:
    
    name - the name of the text area component.
    
    label - the text to be displayed in the label.
    
    nCol - the number of columns the text area will have (in lines)
    
    nRow - the number of rows the text area will have (in characters)
    
    x - The x co-ordinate of the top left corner of the label/text area
    
    y - The y co-ordinate of the top left corner of the label/text area
    
    Throws:
    
    NameAlreadyExistsException - the name has already been used for another component.
  - addTextArea
```
public void addTextArea(java.lang.String name,
                        java.lang.String label,
                        int nRow,
                        int nCol)
```
    See Also:
    
    addTextArea(String name, String label, int nRow, int nCol, int x, int y )
  - addTextArea
```
public void addTextArea(java.lang.String name,
                        java.lang.String label)
```
    See Also:
    
    addTextArea(String name, String label, int nRow, int nCol, int x, int y )
  - addTextArea
```
public void addTextArea(java.lang.String name)
```
    See Also:
    
    addTextArea(String name, String label, int nRow, int nCol, int x, int y )
  - addTextArea
```
public void addTextArea(java.lang.String name,
                        int nRow,
                        int nCol,
                        int x,
                        int y)
```
    See Also:
    
    addTextArea(String name, String label, int nRow, int nCol, int x, int y )
  - addTextArea
```
public void addTextArea(java.lang.String name,
                        int nRow,
                        int nCol)
```
    See Also:
    
    addTextArea(String name, String label, int nRow, int nCol, int x, int y )
  - addTextArea
```
public void addTextArea(int nRow,
                        int nCol,
                        int x,
                        int y)
```
    See Also:
    
    addTextArea(String name, String label, int nRow, int nCol, int x, int y )
  - addTextArea
```
public void addTextArea(int nRow,
                        int nCol)
```
    See Also:
    
    addTextArea(String name, String label, int nRow, int nCol, int x, int y )
  - addTextArea
```
public void addTextArea()
```
    See Also:
    
    addTextArea(String name, String label, int nRow, int nCol, int x, int y )
  - addCheckBox
```
public void addCheckBox(java.lang.String name,
                        java.lang.String label,
                        int x,
                        int y)
                 throws NameAlreadyExistsException
```
    Adds a checkbox with the specified name, label and x,y co-ordinate to the form. Leaving the name blank will prevent the checkbox from being accessed other than through iterating through all components on the form. Leaving out the other paramters will result in them having their default values. (see default values above) All of the parameters are optional, and possible combinations of them can be seen below.
    
    Parameters:
    
    name - the name of the checkbox component.
    
    label - the text to be displayed in the label.
    
    x - the x co-ordinate of the top left corner of the checkbox
    
    y - the y co-ordinate of the top left corner of the checkbox
    
    Throws:
    
    NameAlreadyExistsException - the name has already been used for another component.
  - addCheckBox
```
public void addCheckBox(java.lang.String name,
                        java.lang.String label)
```
    See Also:
    
    addCheckBox(String name, String label, int x, int y )
  - addCheckBox
```
public void addCheckBox(java.lang.String name)
```
    See Also:
    
    addCheckBox(String name, String label, int x, int y )
  - addCheckBox
```
public void addCheckBox(java.lang.String name,
                        int x,
                        int y)
```
    See Also:
    
    addCheckBox(String name, String label, int x, int y )
  - addCheckBox
```
public void addCheckBox(int x,
                        int y)
```
    See Also:
    
    addCheckBox(String name, String label, int x, int y )
  - addCheckBox
```
public void addCheckBox()
```
    See Also:
    
    addCheckBox(String name, String label, int x, int y )
  - addRadioButtons
```
public void addRadioButtons(java.lang.String name,
                            java.lang.String label,
                            boolean vertical,
                            int x,
                            int y,
                            java.lang.String... buttons)
                     throws NameAlreadyExistsException
```
    Adds a group of radio buttons with the specified name, label orientation and x,y co-ordinate to the form. The buttons are labeled by the Strings passed as a parameter. The number of buttons will be the number of Strings passed. The radio buttons are arranged either verticaly (true) or horizontally (false) depending on the parameter vertical. If the paramter vertical is omitted the buttons are arranged vertically. Leaving out the name means the radio buttons can only be accessed via iterating through the elements on the form. Leaving out the other paramters will result in them having their default values. (see default values above) All of the parameters are optional, and possible combinations of them can be seen below.
    
    Parameters:
    
    name - the name radio button group component.
    
    label - the text to be displayed in the label.
    
    vertical - the radio buttons will be laid out in a vertical fashion, false for a horizontal layout
    
    x - the x co-ordinate of the top left corner of the radio button group
    
    y - the y co-ordinate of the top left corner of the radio button group
    
    buttons - the labels for the buttons in the radio button group
    
    Throws:
    
    NameAlreadyExistsException - the name has already been used for another component.
  - addRadioButtons
```
public void addRadioButtons(java.lang.String name,
                            java.lang.String label,
                            boolean vertical,
                            java.lang.String... buttons)
```
    See Also:
    
    addRadioButtons(String name, String label, boolean vertical, int x, int y, String... buttons)
  - addRadioButtons
```
public void addRadioButtons(java.lang.String name,
                            boolean vertical,
                            int x,
                            int y,
                            java.lang.String... buttons)
```
    See Also:
    
    addRadioButtons(String name, String label, boolean vertical, int x, int y, String... buttons)
  - addRadioButtons
```
public void addRadioButtons(java.lang.String name,
                            boolean vertical,
                            java.lang.String... buttons)
```
    See Also:
    
    addRadioButtons(String name, String label, boolean vertical, int x, int y, String... buttons)
  - addRadioButtons
```
public void addRadioButtons(boolean vertical,
                            int x,
                            int y,
                            java.lang.String... buttons)
```
    See Also:
    
    addRadioButtons(String name, String label, boolean vertical, int x, int y, String... buttons)
  - addRadioButtons
```
public void addRadioButtons(boolean vertical,
                            java.lang.String... buttons)
```
    See Also:
    
    addRadioButtons(String name, String label, boolean vertical, int x, int y, String... buttons)
  - addRadioButtons
```
public void addRadioButtons(java.lang.String... buttons)
```
    See Also:
    
    addRadioButtons(String name, String label, boolean vertical, int x, int y, String... buttons)
  - addSlider
```
public void addSlider(java.lang.String name,
                      java.lang.String label,
                      int min,
                      int max,
                      int size,
                      int x,
                      int y)
               throws NameAlreadyExistsException
```
    Adds a slider with the specified name, label, range, size and x,y co-ordinate to the form. Leaving out the name means the slider can only be accessed via iterating through the elements on the form. The default range of the slider is 0-100 and the default size is 120 pixels. Leaving out the other paramters will result in them having their default values. (see default values above) All of the parameters are optional, and possible combinations of them can be seen below.
    
    Parameters:
    
    name - the name of the slider component.
    
    label - the text to be displayed in the label.
    
    min - the minimum value of the slider
    
    max - the maximum value of the slider
    
    size - the physical size of the slider (in pixels)
    
    x - The x co-ordinate of the top left corner of the slider
    
    y - The y co-ordinate of teh top left corner of the slider
    
    Throws:
    
    NameAlreadyExistsException - the name has already been used for another component.
  - addSlider
```
public void addSlider(java.lang.String name,
                      java.lang.String label,
                      int min,
                      int max,
                      int size)
```
    See Also:
    
    addSlider(String name, String label, int min, int max, int size, int x, int y )
  - addSlider
```
public void addSlider(java.lang.String name,
                      java.lang.String label,
                      int min,
                      int max)
```
    See Also:
    
    addSlider(String name, String label, int min, int max, int size, int x, int y )
  - addSlider
```
public void addSlider(java.lang.String name,
                      java.lang.String label)
```
    See Also:
    
    addSlider(String name, String label, int min, int max, int size, int x, int y )
  - addSlider
```
public void addSlider(java.lang.String name)
```
    See Also:
    
    addSlider(String name, String label, int min, int max, int size, int x, int y )
  - addSlider
```
public void addSlider(java.lang.String name,
                      int min,
                      int max,
                      int size,
                      int x,
                      int y)
```
    See Also:
    
    addSlider(String name, String label, int min, int max, int size, int x, int y )
  - addSlider
```
public void addSlider(java.lang.String name,
                      int min,
                      int max,
                      int size)
```
    See Also:
    
    addSlider(String name, String label, int min, int max, int size, int x, int y )
  - addSlider
```
public void addSlider(java.lang.String name,
                      int min,
                      int max)
```
    See Also:
    
    addSlider(String name, String label, int min, int max, int size, int x, int y )
  - addSlider
```
public void addSlider(int min,
                      int max,
                      int size,
                      int x,
                      int y)
```
    See Also:
    
    addSlider(String name, String label, int min, int max, int size, int x, int y )
  - addSlider
```
public void addSlider(int min,
                      int max,
                      int size)
```
    See Also:
    
    addSlider(String name, String label, int min, int max, int size, int x, int y )
  - addSlider
```
public void addSlider(int min,
                      int max)
```
    See Also:
    
    addSlider(String name, String label, int min, int max, int size, int x, int y )
  - addSlider
```
public void addSlider()
```
    See Also:
    
    addSlider(String name, String label, int min, int max, int size, int x, int y )
  - addSound
```
public void addSound(java.lang.String name,
                     java.lang.String label,
                     Sound s,
                     int x,
                     int y)
```
    Adds a sound player (a button that when pressed will play the sound associated with the player) with specified name, label, sound and x,y co-ordinate to the form. Leaving out the name means the sound player can only be accessed via iterating through the elements on the form. Leaving out the sound means that there is no sound to be played until one is placed on the player (placeSound). Leaving out the other paramters will result in them having their default values. (see default values above) All of the parameters are optional, and possible combinations of them can be seen below.
    
    Parameters:
    
    name - the name of the sound player component
    
    label - the label for the sound player
    
    s - a sound file associated with the sound player
    
    x - the x co-ordinate of the top left corner of the sound player
    
    y - the y co-ordinate of the top left corner of the sound player
    
    Throws:
    
    NameAlreadyExistsException - the name has already been used for another component.
  - addSound
```
public void addSound()
```
    See Also:
    
    addSound(String name, String label, Sound s, int x, int y)
  - addSound
```
public void addSound(Sound s)
```
    See Also:
    
    addSound(String name, String label, Sound s, int x, int y)
  - addSound
```
public void addSound(java.lang.String name)
```
    See Also:
    
    addSound(String name, String label, Sound s, int x, int y)
  - addSound
```
public void addSound(java.lang.String name,
                     Sound s)
```
    See Also:
    
    addSound(String name, String label, Sound s, int x, int y)
  - addSound
```
public void addSound(int x,
                     int y)
```
    See Also:
    
    addSound(String name, String label, Sound s, int x, int y)
  - addSound
```
public void addSound(Sound s,
                     int x,
                     int y)
```
    See Also:
    
    addSound(String name, String label, Sound s, int x, int y)
  - addSound
```
public void addSound(java.lang.String name,
                     int x,
                     int y)
```
    See Also:
    
    addSound(String name, String label, Sound s, int x, int y)
  - addSound
```
public void addSound(java.lang.String name,
                     java.lang.String label)
```
    See Also:
    
    addSound(String name, String label, Sound s, int x, int y)
  - addSound
```
public void addSound(java.lang.String name,
                     java.lang.String label,
                     Sound s)
```
    See Also:
    
    addSound(String name, String label, Sound s, int x, int y)
  - addSound
```
public void addSound(java.lang.String name,
                     java.lang.String label,
                     int x,
                     int y)
```
    See Also:
    
    addSound(String name, String label, Sound s, int x, int y)
  - addCanvas
```
public void addCanvas(java.lang.String name,
                      java.lang.String label,
                      int width,
                      int height,
                      int x,
                      int y)
               throws NameAlreadyExistsException
```
    Adds a canvas with specified name, label, size, and x,y co-ordinates to the form. This canvas can have pictures and turtles placed on it and is used to display the image of a turtle drawing or of a picture. Leaving out the name means the canvas can only be accessed via iterating through the elements on the form. If width and height are not specified the default size is 200x200. Leaving out the other paramters will result in them having their default values. (see default values above) All of the parameters are optional, and possible combinations of them can be seen below.
    
    Parameters:
    
    name - the name of the canvas
    
    label - a label to be associated with the canvas
    
    width - the width of the canvas
    
    height - the height of the canvas
    
    x - the x co-ordinate of the top left corner of the canvas
    
    y - the y co-ordinate of the top left corner of the canvas
    
    Throws:
    
    NameAlreadyExistsException - the name has already been used for another component.
  - addCanvas
```
public void addCanvas(java.lang.String name,
                      java.lang.String label,
                      int width,
                      int height)
```
    See Also:
    
    addCanvas(String name, String label, int width, int height, int x, int y)
  - addCanvas
```
public void addCanvas(java.lang.String name,
                      java.lang.String label)
```
    See Also:
    
    addCanvas(String name, String label, int width, int height, int x, int y)
  - addCanvas
```
public void addCanvas(java.lang.String name)
```
    See Also:
    
    addCanvas(String name, String label, int width, int height, int x, int y)
  - addCanvas
```
public void addCanvas(java.lang.String name,
                      int width,
                      int height,
                      int x,
                      int y)
```
    See Also:
    
    addCanvas(String name, String label, int width, int height, int x, int y)
  - addCanvas
```
public void addCanvas(java.lang.String name,
                      int width,
                      int height)
```
    See Also:
    
    addCanvas(String name, String label, int width, int height, int x, int y)
  - addCanvas
```
public void addCanvas(int width,
                      int height,
                      int x,
                      int y)
```
    See Also:
    
    addCanvas(String name, String label, int width, int height, int x, int y)
  - addCanvas
```
public void addCanvas(int width,
                      int height)
```
    See Also:
    
    addCanvas(String name, String label, int width, int height, int x, int y)
  - addCanvas
```
public void addCanvas()
```
    See Also:
    
    addCanvas(String name, String label, int width, int height, int x, int y)
  - skipToEOL
```
public void skipToEOL()
```
    Deprecated. Use nextLine() instead.
    
    See Also:
    
    nextLine(String)
  - nextLine
```
public void nextLine()
```
    See Also:
    
    nextLine(String)
  - skipToEOL
```
public void skipToEOL(java.lang.String name)
```
    Deprecated. use nextLine(name) instead.
    
    The next read from the specified component on the form will start at the first character of the next line. If no name is specified the nextline will occur on the next component. Otherwise the nextline will be occur on the specified component.
    
    Parameters:
    
    name - name of the component
  - nextLine
```
public void nextLine(java.lang.String name)
```
    The next read from the specified component on the form will start at the first character of the next line. If no name is specified the nextline will occur on the next component. Otherwise the nextline will be occur on the specified component.
    
    Parameters:
    
    name - name of the component
  - readBoolean
```
public boolean readBoolean()
```
    See Also:
    
    readBoolean(String)
  - readBoolean
```
public boolean readBoolean(java.lang.String name)
```
    Reads a boolean from the specified component on the form. If no name is specified the boolean value will be read from the next component.
    
    Parameters:
    
    name - the name of component
  - readByte
```
public byte readByte()
```
    See Also:
    
    readByte(String,Format)
  - readByte
```
public byte readByte(java.lang.String name)
```
    See Also:
    
    readByte(String,Format)
  - readByte
```
public byte readByte(java.text.Format f)
```
    See Also:
    
    readByte(String,Format)
  - readByte
```
public byte readByte(java.lang.String name,
                     java.text.Format f)
```
    Reads a byte from the specified component on the form. If no name is specified the byte value will be read from the next component. If a format is specified it will be used to format when reading the byte otherwise the default format will be used.
    
    Parameters:
    
    name - the name of component
    
    f - the format for reading
  - readC
```
public char readC()
```
    See Also:
    
    readC(String)
  - readC
```
public char readC(java.lang.String name)
```
    Reads a char from the specified component on the form. If no name is specified the char value will be read from the next component.
    
    Parameters:
    
    name - the name of component
  - readChar
```
public char readChar()
```
    See Also:
    
    readChar(String)
  - readChar
```
public char readChar(java.lang.String name)
```
    Reads a char from the specified component on the form. If no name is specified the char value will be read from the next component.
    
    Parameters:
    
    name - the name of component
  - readDouble
```
public double readDouble()
```
    See Also:
    
    readDouble(String,Format)
  - readDouble
```
public double readDouble(java.lang.String name)
```
    See Also:
    
    readDouble(String,Format)
  - readDouble
```
public double readDouble(java.text.Format f)
```
    See Also:
    
    readDouble(String,Format)
  - readDouble
```
public double readDouble(java.lang.String name,
                         java.text.Format f)
```
    Reads a double from the specified component on the form. If no name is specified the double value will be read from the next component. If a format is specified it will be used to format when reading the double otherwise the default format will be used.
    
    Parameters:
    
    name - the name of component
    
    f - the format for reading
  - readFloat
```
public float readFloat()
```
    See Also:
    
    readFloat(String,Format)
  - readFloat
```
public float readFloat(java.lang.String name)
```
    See Also:
    
    readFloat(String,Format)
  - readFloat
```
public float readFloat(java.text.Format f)
```
    See Also:
    
    readFloat(String,Format)
  - readFloat
```
public float readFloat(java.lang.String name,
                       java.text.Format f)
```
    Reads a float from the specified component on the form. If no name is specified the float value will be read from the next component. If a format is specified it will be used to format when reading the float otherwise the default format will be used.
    
    Parameters:
    
    name - the name of component
    
    f - the format for reading
  - readInt
```
public int readInt()
```
    See Also:
    
    readInt(String,Format)
  - readInt
```
public int readInt(java.lang.String name)
```
    See Also:
    
    readInt(String,Format)
  - readInt
```
public int readInt(java.text.Format f)
```
    See Also:
    
    readInt(String,Format)
  - readInt
```
public int readInt(java.lang.String name,
                   java.text.Format f)
```
    Reads an int from the specified component on the form. If no name is specified the int value will be read from the next component. If a format is specified it will be used to format when reading the int otherwise the default format will be used.
    
    Parameters:
    
    name - the name of component
    
    f - the format for reading
  - readLine
```
public java.lang.String readLine()
```
    See Also:
    
    readLine(String)
  - readLine
```
public java.lang.String readLine(java.lang.String name)
```
    Reads a line of text as a String from the specified component on the form. If no name is specified the line will be read from the next component.
    
    Parameters:
    
    name - the name of component
  - readLong
```
public long readLong()
```
    See Also:
    
    readLong(String,Format)
  - readLong
```
public long readLong(java.lang.String name)
```
    See Also:
    
    readLong(String,Format)
  - readLong
```
public long readLong(java.text.Format f)
```
    See Also:
    
    readLong(String,Format)
  - readLong
```
public long readLong(java.lang.String name,
                     java.text.Format f)
```
    Reads a long from the specified component on the form. If no name is specified the long value will be read from the next component. If a format is specified it will be used to format when reading the long otherwise the default format will be used.
    
    Parameters:
    
    name - the name of component
    
    f - the format for reading
  - readShort
```
public short readShort()
```
    See Also:
    
    readShort(String,Format)
  - readShort
```
public short readShort(java.lang.String name)
```
    See Also:
    
    readShort(String,Format)
  - readShort
```
public short readShort(java.text.Format f)
```
    See Also:
    
    readShort(String,Format)
  - readShort
```
public short readShort(java.lang.String name,
                       java.text.Format f)
```
    Reads a short from the specified component on the form. If no name is specified the short value will be read from the next component. If a format is specified it will be used to format when reading the short otherwise the default format will be used.
    
    Parameters:
    
    name - the name of component
    
    f - the format for reading
  - readString
```
public java.lang.String readString()
```
    See Also:
    
    readString(String)
  - readString
```
public java.lang.String readString(java.lang.String name)
```
    Reads a String from the specified component on the form. If no name is specified the String will be read from the next component.
    
    Parameters:
    
    name - the name of component
  - writeEOL
```
public void writeEOL()
```
    Deprecated. use newLine() instead
    
    See Also:
    
    writeEOL(String)
  - writeEOL
```
public void writeEOL(java.lang.String name)
```
    Deprecated. Use newLine() instead.
    
    Writes a newline character to the specified component on the form. The next write to the component will begin on the next line. If no name is specified the newline will occur on the next component.
    
    Parameters:
    
    name - the name of the component
  - newLine
```
public void newLine(java.lang.String name)
```
    Writes a newline character to the specified component on the form. The next write to the component will begin on the next line. If no name is specified the newline will occur on the next component.
    
    Parameters:
    
    name - the name of the component
  - newLine
```
public void newLine()
```
    See Also:
    
    newLine(String)
  - writeBoolean
```
public void writeBoolean(boolean b)
```
  - writeBoolean
```
public void writeBoolean(java.lang.String name,
                         boolean b)
```
    Writes a boolean value to the specified component on the form. If no name is specified the byte value will be written to the next component.
    
    Parameters:
    
    name - the field to write to
    
    b - the boolean value to write
  - writeByte
```
public void writeByte(byte b)
```
    See Also:
    
    writeByte(String,byte,Format,int)
  - writeByte
```
public void writeByte(java.lang.String name,
                      byte b)
```
    See Also:
    
    writeByte(String,byte,Format,int)
  - writeByte
```
public void writeByte(byte b,
                      java.text.Format f)
```
    See Also:
    
    writeByte(String,byte,Format,int)
  - writeByte
```
public void writeByte(java.lang.String name,
                      byte b,
                      java.text.Format f)
```
    See Also:
    
    writeByte(String,byte,Format,int)
  - writeByte
```
public void writeByte(java.lang.String name,
                      byte b,
                      java.text.Format f,
                      int size)
```
    Writes a byte value to the specified component on the form. If no name is specified the byte value will be written to the next component. If a format is specified it will be used to format when writing the byte value otherwise the default format will be used. The display string will be truncated/padded to the specified size or will be the minimum size to represent the formatted value if no size is specified.
    
    Parameters:
    
    name - the name of the component
    
    b - the byte value to write
    
    f - the format for the write
    
    size - display size in characters
  - writeByte
```
public void writeByte(java.lang.String name,
                      byte b,
                      int size)
```
    See Also:
    
    writeByte(String,byte,Format,int)
  - writeByte
```
public void writeByte(byte b,
                      java.text.Format f,
                      int size)
```
    See Also:
    
    writeByte(String,byte,Format,int)
  - writeByte
```
public void writeByte(byte b,
                      int size)
```
    See Also:
    
    writeByte(String,byte,Format,int)
  - writeC
```
public void writeC(char c)
```
    See Also:
    
    writeC(String name,char c)
  - writeC
```
public void writeC(java.lang.String name,
                   char c)
```
    Writes a char value to the specified component on the form. If no name is specified the char value will be written to the next component.
    
    Parameters:
    
    name - the field to write to
    
    c - the char value to write
  - writeChar
```
public void writeChar(char c)
```
    See Also:
    
    writeChar(String name,char c)
  - writeChar
```
public void writeChar(java.lang.String name,
                      char c)
```
    Writes a char value to the specified component on the form. If no name is specified the char value will be written to the next component.
    
    Parameters:
    
    name - the field to write to
    
    c - the char value to write
  - writeDouble
```
public void writeDouble(double d)
```
    See Also:
    
    writeDouble(String name, double d, Format f, int size)
  - writeDouble
```
public void writeDouble(java.lang.String name,
                        double d)
```
    See Also:
    
    writeDouble(String name, double d, Format f, int size)
  - writeDouble
```
public void writeDouble(double d,
                        java.text.Format f)
```
    See Also:
    
    writeDouble(String name, double d, Format f, int size)
  - writeDouble
```
public void writeDouble(java.lang.String name,
                        double d,
                        java.text.Format f)
```
    See Also:
    
    writeDouble(String name, double d, Format f, int size)
  - writeDouble
```
public void writeDouble(java.lang.String name,
                        double d,
                        java.text.Format f,
                        int size)
```
    Writes a double value to the specified component on the form. If no name is specified the double value will be written to the next component. If a format is specified it will be used to format when writing the double value otherwise the default format will be used. The display string will be truncated/padded to the specified size or will be the minimum size to represent the formatted value if no size is specified.
    
    Parameters:
    
    name - the name of the component
    
    d - the double value to write
    
    f - the format for the write
    
    size - display size in characters
  - writeDouble
```
public void writeDouble(java.lang.String name,
                        double d,
                        int size)
```
    See Also:
    
    writeDouble(String name, double d, Format f, int size)
  - writeDouble
```
public void writeDouble(double d,
                        java.text.Format f,
                        int size)
```
    See Also:
    
    writeDouble(String name, double d, Format f, int size)
  - writeDouble
```
public void writeDouble(double d,
                        int size)
```
    See Also:
    
    writeDouble(String name, double d, Format f, int size)
  - writeFloat
```
public void writeFloat(float f)
```
    See Also:
    
    writeFloat(String name, float f, Format format, int size)
  - writeFloat
```
public void writeFloat(float f,
                       java.text.Format format)
```
    See Also:
    
    writeFloat(String name, float f, Format format, int size)
  - writeFloat
```
public void writeFloat(java.lang.String name,
                       float f)
```
    See Also:
    
    writeFloat(String name, float f, Format format, int size)
  - writeFloat
```
public void writeFloat(java.lang.String name,
                       float f,
                       java.text.Format format)
```
    See Also:
    
    writeFloat(String name, float f, Format format, int size)
  - writeFloat
```
public void writeFloat(java.lang.String name,
                       float f,
                       java.text.Format fmt,
                       int size)
```
    Writes a float value to the specified component on the form. If no name is specified the float value will be written to the next component. If a format is specified it will be used to format when writing the float value otherwise the default format will be used. The display string will be truncated/padded to the specified size or will be the minimum size to represent the formatted value if no size is specified.
    
    Parameters:
    
    name - the name of the component
    
    f - the float value to write
    
    fmt - the format for the write
    
    size - display size in characters
  - writeFloat
```
public void writeFloat(java.lang.String name,
                       float f,
                       int size)
```
    See Also:
    
    writeFloat(String name, float f, Format format, int size)
  - writeFloat
```
public void writeFloat(float f,
                       java.text.Format fmt,
                       int size)
```
    See Also:
    
    writeFloat(String name, float f, Format format, int size)
  - writeFloat
```
public void writeFloat(float f,
                       int size)
```
    See Also:
    
    writeFloat(String name, float f, Format format, int size)
  - writeInt
```
public void writeInt(int i)
```
    See Also:
    
    writeInt(String name, int i, Format f, int size)
  - writeInt
```
public void writeInt(int i,
                     java.text.Format f)
```
    See Also:
    
    writeInt(String name, int i, Format f, int size)
  - writeInt
```
public void writeInt(java.lang.String name,
                     int i)
```
    See Also:
    
    writeInt(String name, int i, Format f, int size)
  - writeInt
```
public void writeInt(java.lang.String name,
                     int i,
                     java.text.Format f)
```
    See Also:
    
    writeInt(String name, int i, Format f, int size)
  - writeInt
```
public void writeInt(java.lang.String name,
                     int i,
                     java.text.Format f,
                     int size)
```
    Writes an int value to the specified component on the form. If no name is specified the int value will be written to the next component. If a format is specified it will be used to format when writing the int value otherwise the default format will be used. The display string will be truncated/padded to the specified size or will be the minimum size to represent the formatted value if no size is specified.
    
    Parameters:
    
    name - the name of the component
    
    i - the int value to write
    
    f - the format for the write
    
    size - display size in characters
  - writeInt
```
public void writeInt(java.lang.String name,
                     int i,
                     int size)
```
    See Also:
    
    writeInt(String name, int i, Format f, int size)
  - writeInt
```
public void writeInt(int i,
                     java.text.Format f,
                     int size)
```
    See Also:
    
    writeInt(String name, int i, Format f, int size)
  - writeInt
```
public void writeInt(int i,
                     int size)
```
    See Also:
    
    writeInt(String name, int i, Format f, int size)
  - writeLine
```
public void writeLine(java.lang.String s)
```
    See Also:
    
    writeLine(String name, String s)
  - writeLine
```
public void writeLine(java.lang.String name,
                      java.lang.String s)
```
    Writes a string as a line to the specified component on the form. The next write to the component will begin on the next line. If no name is specified the string will be written to the next component.
    
    Parameters:
    
    name - the name of the component
    
    s - the String value to write
  - writeLong
```
public void writeLong(long l)
```
    See Also:
    
    writeLong(String name, long l, Format f, int size)
  - writeLong
```
public void writeLong(long l,
                      java.text.Format f)
```
    See Also:
    
    writeLong(String name, long l, Format f, int size)
  - writeLong
```
public void writeLong(java.lang.String name,
                      long l)
```
    See Also:
    
    writeLong(String name, long l, Format f, int size)
  - writeLong
```
public void writeLong(java.lang.String name,
                      long l,
                      java.text.Format f)
```
    See Also:
    
    writeLong(String name, long l, Format f, int size)
  - writeLong
```
public void writeLong(java.lang.String name,
                      long l,
                      java.text.Format f,
                      int size)
```
    Writes a long value to the specified component on the form. If no name is specified the long value will be written to the next component. If a format is specified it will be used to format when writing the long value otherwise the default format will be used. The display string will be truncated/padded to the specified size or will be the minimum size to represent the formatted value if no size is specified.
    
    Parameters:
    
    name - the name of the component
    
    l - the long value to write
    
    f - the format for the write
    
    size - display size in characters
  - writeLong
```
public void writeLong(java.lang.String name,
                      long l,
                      int size)
```
    See Also:
    
    writeLong(String name, long l, Format f, int size)
  - writeLong
```
public void writeLong(long l,
                      java.text.Format f,
                      int size)
```
    See Also:
    
    writeLong(String name, long l, Format f, int size)
  - writeLong
```
public void writeLong(long l,
                      int size)
```
    See Also:
    
    writeLong(String name, long l, Format f, int size)
  - writeShort
```
public void writeShort(short s)
```
    See Also:
    
    writeShort(String name, short s, Format f, int size)
  - writeShort
```
public void writeShort(short s,
                       java.text.Format f)
```
    See Also:
    
    writeShort(String name, short s, Format f, int size)
  - writeShort
```
public void writeShort(java.lang.String name,
                       short s)
```
    See Also:
    
    writeShort(String name, short s, Format f, int size)
  - writeShort
```
public void writeShort(java.lang.String name,
                       short s,
                       java.text.Format f)
```
    See Also:
    
    writeShort(String name, short s, Format f, int size)
  - writeShort
```
public void writeShort(java.lang.String name,
                       short s,
                       java.text.Format f,
                       int size)
```
    Writes a short value to the specified component on the form. If no name is specified the short value will be written to the next component. If a format is specified it will be used to format when writing the short value otherwise the default format will be used. The display string will be truncated/padded to the specified size or will be the minimum size to represent the formatted value if no size is specified.
    
    Parameters:
    
    name - the name of the component
    
    s - the short value to write
    
    f - the format for the write
    
    size - display size in characters
  - writeShort
```
public void writeShort(java.lang.String name,
                       short s,
                       int size)
```
    See Also:
    
    writeShort(String name, short s, Format f, int size)
  - writeShort
```
public void writeShort(short s,
                       java.text.Format f,
                       int size)
```
    See Also:
    
    writeShort(String name, short s, Format f, int size)
  - writeShort
```
public void writeShort(short s,
                       int size)
```
    See Also:
    
    writeShort(String name, short s, Format f, int size)
  - writeString
```
public void writeString(java.lang.String s)
```
    See Also:
    
    writeString(String name, String s, Format f, int size)
  - writeString
```
public void writeString(java.lang.String s,
                        java.text.Format f)
```
    See Also:
    
    writeString(String name, String s, Format f, int size)
  - writeString
```
public void writeString(java.lang.String name,
                        java.lang.String s)
```
    See Also:
    
    writeString(String name, String s, Format f, int size)
  - writeString
```
public void writeString(java.lang.String name,
                        java.lang.String s,
                        java.text.Format f)
```
    See Also:
    
    writeString(String name, String s, Format f, int size)
  - writeString
```
public void writeString(java.lang.String s,
                        int size)
```
    See Also:
    
    writeString(String name, String s, Format f, int size)
  - writeString
```
public void writeString(java.lang.String s,
                        java.text.Format f,
                        int size)
```
    See Also:
    
    writeString(String name, String s, Format f, int size)
  - writeString
```
public void writeString(java.lang.String name,
                        java.lang.String s,
                        int size)
```
    See Also:
    
    writeString(String name, String s, Format f, int size)
  - writeString
```
public void writeString(java.lang.String name,
                        java.lang.String s,
                        java.text.Format f,
                        int size)
```
    Writes a String value to the specified component on the form. If no name is specified the String value will be written to the next component. If a format is specified it will be used to format when writing the String value otherwise the default format will be used. If size is specified, the string will be left justified in a field of size characters.
    
    Parameters:
    
    name - the field to write to
    
    s - the String value to write
    
    f - the format for the write
    
    size - the size of the field to write
  - clear
```
public void clear()
```
    See Also:
    
    clear(String name)
  - clear
```
public void clear(java.lang.String name)
```
    Clears the value displayed in the specified component on the form. If no name is specified, the next component is cleared.
    
    Parameters:
    
    name - the name of the component
  - clearAll
```
public void clearAll()
```
    Clears the values displayed in all components of the form.
  - close
```
public void close()
```
    Closes the form and frees resources. The form should not be used thereafter.
  - addCustomComponent
```
public void addCustomComponent(javax.swing.JComponent c)
```
    Adds any JComponent to the form.

Class BasicForm

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BasicForm

BasicForm

Method Detail

successful

isEOF

isFormatException

isDataError

setTitle

getX

getY

getWidth

getHeight

setLabel

placePicture

setSound

setTurtle

placeSound

placeTurtle

getPicture

getSound

getTurtle

show

hide

accept

accept

setEditable

isEditable

addLabel

addLabel

addLabel

addLabel

addLabel

addLabel

addTextField

addTextField

addTextField

addTextField

addTextField

addTextField

addTextField

addTextField

addTextField

addTextField

addTextField

addTextField

addTextField

addTextField

addTextField

addTextField

addTextField

addTextField

addTextArea

addTextArea

addTextArea

addTextArea

addTextArea

addTextArea

addTextArea

addTextArea

addTextArea

addCheckBox

addCheckBox

addCheckBox

addCheckBox

addCheckBox

addCheckBox

addRadioButtons

addRadioButtons

addRadioButtons

addRadioButtons

addRadioButtons

addRadioButtons

addRadioButtons

addSlider

addSlider