BasicIO

Class ASCIIDisplayer

java.lang.Object

BasicIO.ASCIIDisplayer

public class ASCIIDisplayer
extends java.lang.Object

ASCIIDisplayer is used as a quick way to produce text output to the screen. It mimics writting to a file using ASCIIOutputFile, however instead of the data going to a text file, the data is displayed in a text area on a form on the screen.

Version:

1.0 July 2008

Author:

Andrew Cheesman

Constructor Summary

Constructors

Constructor and Description
ASCIIDisplayer() Constructs an ASCIIDisplayer as a form on the screen with a text area to which text may be written.
ASCIIDisplayer(int nRow, int nCol) Constructs an ASCIIDisplayer as a form on the screen with a text area of specified number of rows and columns, to which text may be written.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the ASCIIDisplayer and frees resources when the user presses Close.
void	hide() Makes the ASCIIDisplayer invisible, so that it can not be seen on the desktop.
void	newLine() Writes a newline character so that the next write starts at the beginning of the next line.
void	setLabel(java.lang.String label) Changes the text of the label on the text area of the ASCIIDisplayer.
void	show() Makes the ASCIIDisplayer visible, so that it can be seen on the desktop.
void	waitForUser() Waits for the user to finish using the ASCIIDisplayer and press OK.
void	writeBoolean(boolean b) Writes a boolean to the displayer.
void	writeByte(byte b) Writes a byte to the displayer.
void	writeByte(byte b, int length) Writes a byte to the displayer.
void	writeC(char c) Writes a char to the displayer.
void	writeChar(char c) Writes a char to the displayer.
void	writeDouble(double d) Writes a double to the displayer.
void	writeDouble(double d, int length, int decimals) Writes a double to the displayer.
void	writeEOL() Deprecated. Use newLine() instead.
void	writeFloat(float f) Writes a float to the displayer.
void	writeFloat(float f, int length, int decimals) Writes a float to the displayer.
void	writeInt(int i) Writes an int to the displayer.
void	writeInt(int i, int length) Writes an int to the displayer.
void	writeLine(java.lang.String s) Writes a String to the displayer with a newline character at the end of the String.
void	writeLong(long l) Writes a long to the displayer.
void	writeLong(long l, int length) Writes a long to the displayer.
void	writeObject(java.lang.Object o) Writes the String representation of an Object to the displayer.
void	writeShort(short s) Writes a short to the displayer.
void	writeShort(short s, int length) Writes a short to the displayer.
void	writeString(java.lang.String s) Writes a String to the displayer.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ASCIIDisplayer

public ASCIIDisplayer()

Constructs an ASCIIDisplayer as a form on the screen with a text area to which text may be written.

ASCIIDisplayer

public ASCIIDisplayer(int nRow,
                      int nCol)

Constructs an ASCIIDisplayer as a form on the screen with a text area of specified number of rows and columns, to which text may be written.

Parameters:

nRow - number of rows

nCol - number of columns

Method Detail

setLabel

public void setLabel(java.lang.String label)

Changes the text of the label on the text area of the ASCIIDisplayer.

Parameters:

label - The text to be displayed in the label

writeByte

public void writeByte(byte b)

Writes a byte to the displayer.

Parameters:

b - a byte to be displayed on the displayer

writeChar

public void writeChar(char c)

Writes a char to the displayer.

Parameters:

c - char to be displayed on the displayer

writeC

public void writeC(char c)

Writes a char to the displayer.

Parameters:

c - a char to be displayed on the displayer

writeDouble

public void writeDouble(double d)

Writes a double to the displayer.

Parameters:

d - a double to be displayed on the displayer

writeFloat

public void writeFloat(float f)

Writes a float to the displayer.

Parameters:

f - a float to be displayed on the displayer

writeInt

public void writeInt(int i)

Writes an int to the displayer.

Parameters:

i - an int to be displayed on the displayer

writeShort

public void writeShort(short s)

Writes a short to the displayer.

Parameters:

s - a short to be displayed on the displayer

writeLong

public void writeLong(long l)

Writes a long to the displayer.

Parameters:

l - a long to be displayed on the displayer

writeString

public void writeString(java.lang.String s)

Writes a String to the displayer.

Parameters:

s - a String to be displayed on the displayer

writeBoolean

public void writeBoolean(boolean b)

Writes a boolean to the displayer.

Parameters:

b - a boolean to be displayed on the displayer

writeLine

public void writeLine(java.lang.String s)

Writes a String to the displayer with a newline character at the end of the String.

Parameters:

s - a String to be displayed on the displayer

writeEOL

public void writeEOL()

Deprecated. Use newLine() instead.

Writes a newline character so that the next write starts at the beginning of the next line.

writeObject

public void writeObject(java.lang.Object o)

Writes the String representation of an Object to the displayer.

Parameters:

o - the object to be written.

newLine

public void newLine()

Writes a newline character so that the next write starts at the beginning of the next line.

writeByte

public void writeByte(byte b,
                      int length)

Writes a byte to the displayer. The data output will take up a number of characters specified by by the length provided. If the output would have been shorter spaces will be added. If the output would have been longer, then it will be truncated.

Parameters:

b - a byte to be displayed on the displayer

length - the number of characters that the output will be.

writeDouble

public void writeDouble(double d,
                        int length,
                        int decimals)

Writes a double to the displayer. The data output will take up a number of characters specified by by the length provided. If the output would have been shorter spaces will be added. If the output would have been longer, then it will be truncated. The paramter decimals will determine how many decimal places will be displayed.

Parameters:

d - a double to be displayed on the displayer

length - the number of characters that will be outputed.

decimals - the number of decimal characters that will be outputted.

writeFloat

public void writeFloat(float f,
                       int length,
                       int decimals)

Writes a float to the displayer. The data output will take up a number of characters specified by by the length provided. If the output would have been shorter spaces will be added. If the output would have been longer, then it will be truncated. The paramter decimals will determine how many decimal characters will be displayed.

Parameters:

f - a float to be displayed on the displayer

length - the number of characters that will be outputed.

decimals - the number of decimal characters that will be outputted.

writeInt

public void writeInt(int i,
                     int length)

Writes an int to the displayer. The data output will take up a number of characters specified by by the length provided. If the output would have been shorter spaces will be added. If the output would have been longer, then it will be truncated.

Parameters:

i - an int to be displayed on the displayer

length - the number of characters that the output will be.

writeShort

public void writeShort(short s,
                       int length)

Writes a short to the displayer. The data output will take up a number of characters specified by by the length provided. If the output would have been shorter spaces will be added. If the output would have been longer, then it will be truncated.

Parameters:

s - a short to be displayed on the displayer

length - the number of characters that the output will be.

writeLong

public void writeLong(long l,
                      int length)

Writes a long to the displayer. The data output will take up a number of characters specified by by the length provided. If the output would have been shorter spaces will be added. If the output would have been longer, then it will be truncated.

Parameters:

l - a long to be displayed on the displayer

length - the number of characters that the output will be.

waitForUser

public void waitForUser()

Waits for the user to finish using the ASCIIDisplayer and press OK.

show

public void show()

Makes the ASCIIDisplayer visible, so that it can be seen on the desktop.

hide

public void hide()

Makes the ASCIIDisplayer invisible, so that it can not be seen on the desktop.

close

public void close()

Closes the ASCIIDisplayer and frees resources when the user presses Close. The ASCIIDisplayer should not be used thereafter.