ch.aplu.util

Class GConsole

java.lang.Object

ch.aplu.util.GConsole

All Implemented Interfaces:

java.awt.print.Printable, java.lang.Runnable

public class GConsole
extends java.lang.Object
implements java.lang.Runnable, java.awt.print.Printable

Console window for line oriented input and output.

Once the console window is instantiated all output to stdout and stderr is redirected to this window. (Non-static version of Console.java.) Only 7-bit-ASCII characters are supported.

All Swing GUI methods are invoked from the Event Dispatch Thread (EDT) if it's not done by the caller.

Default properties of the console window can be changed from the library defaults by using a Java properties file aplu_util.properties. For more details, consult aplu_util.properties found in the distribution.

When the close button of the console window title bar is hit, System.exit(0) is executed that terminates the JVM, but you can modifiy this behavior by registering your own implementation of the ExitListener interface or by using the key ConsoleClosingMode in aplu_util.properties.

Part of code from Rjhm van den Bergh (rvdb@comweb.nl) with thanks for the permission to use and distribute

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GConsole.ClosingMode

Field Summary

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Constructor Summary

Constructors

Constructor and Description
GConsole() Construct a Console with default attributes.
GConsole(java.awt.Font font) Construct a Console with given font and default position and size.
GConsole(Position position, Size size) Construct a Console with given position, size and default font.
GConsole(Position position, Size size, java.awt.Font font) Construct a Console with given attributes.

Method Summary

Methods

Modifier and Type	Method and Description
void	addExitListener(ExitListener exitListener) Register an ExitListener to get a notification when the close button is clicked.
void	checkDisposed()
void	clear() Erase all text in console window
void	delay(int time) Delay execution for the given amount of time ( in ms ).
void	deleteLastChar() Deletes the last character and adjusts the cursor.
void	dispose() Disposes the console frame.
void	end() Hide the console window and releases resources.
GConsole.ClosingMode	getClosingMode(ch.aplu.util.MyProperties props)
java.lang.Double	getDouble() Same as readDouble() but returns a Double object.
javax.swing.JFrame	getFrame() Return a reference to the JFrame instance used by the console
java.lang.Integer	getInt() Same as readInt() but returns an Integer object.
char	getKey() Return the unicode character associated with last key pressed and flush the one-charactor buffer.
char	getKey(boolean keep) Return the unicode character associated with last key pressed and keep the one-charactor buffer if keep = true.
int	getKeyCode() Return the keycode associated with last key pressed and flush the one-character buffer.
int	getKeyCodeWait() Wait until a key is typed and return the keycode associated with last key pressed.
int	getKeyInt() Return the 8-bit ASCII code associated with last key pressed and flush the one-charactor buffer.
char	getKeyWait() Wait until a key is typed and return the unicode character associated with last key pressed.
int	getKeyWaitInt() Return the 8-bit ASCII code associated with last key pressed and flush the one-charactor buffer.
char	getLastKey() Return the key character associated with last key pressed.
int	getLastKeyCode() Return the key code associated with last key pressed.
java.lang.String	getLastLine() Returns the last line of the text area.
int	getLastModifiers() Return the modifiers associated with last key pressed.
java.lang.String	getLastModifiersText() Return the modifiers text associated with last key pressed.
javax.swing.JTextArea	getTextArea() Return a reference to the JTextArea of the console window
void	hide() Hide the console window.
boolean	isDisposed() Return true, if the Console windows was disposed or released.
boolean	kbhit() Return true if a key was hit since the last time the one-character buffer was read with getKey() oder getKeyWait().
java.lang.String	pad(java.lang.String num, int fieldWidth) Right justify the given number in a field with the given field width (pad the field with leading spaces).
java.lang.String	pad(java.lang.String num, int fieldWidth, int decimalWidth) Pad given number with trailing spaces to optain decimal width and right justify in a field with the given width (pad the the field with leading spaces).
Position	position(int ulx, int uly) Return a Position reference with specified upperleft x and y coordinates.
void	print(boolean b) Print a boolean value.
void	print(char c) Print a character.
void	print(char[] s) Print an array of characters.
void	print(double d) Print a double-precision floating-point number.
void	print(float f) Print a floating-point number.
int	print(java.awt.Graphics g, java.awt.print.PageFormat pf, int pageIndex) For internal use only.
void	print(int i) Print an integer.
void	print(long l) Print a long integer.
void	print(java.lang.Object obj) Print an object.
void	print(java.lang.String s) Print a string.
void	printf(java.util.Locale l, java.lang.String format, java.lang.Object... args) Print a formatted string using the specified format string and varargs and applying given locale during formatting.
void	printf(java.lang.String format, java.lang.Object... args) Print a formatted string using the specified format string and varargs.
void	println() Terminate the current line by writing the line separator string.
void	println(boolean b) Print a boolean and then terminate the line.
void	println(char c) Print a character and then terminate the line.
void	println(char[] s) Print an array of characters and then terminate the line.
void	println(double d) Print a double and then terminate the line.
void	println(float f) Print a float and then terminate the line.
void	println(int i) Print an integer and then terminate the line.
void	println(long l) Print a long and then terminate the line.
void	println(java.lang.Object obj) Print an Object and then terminate the line.
void	println(java.lang.String s) Print a String and then terminate the line.
boolean	printScreen() Same as printScreen(scale) with scale = 1
boolean	printScreen(double scale) Print the current text area to an attached printer with the given magnification scale factor.
char	readChar() Wait until a key is typed and return the unicode character associated it.
double	readDouble() Wait until a sequence of numbers with trailing newline is typed.
int	readInt() Wait until a sequence of numbers with trailing newline is typed.
java.lang.String	readLine() Wait until a sequence of characters with trailing newline is typed.
void	run() For internal use only.
void	setAutowrap(boolean enable) Enable/disable autowrapping.
void	setCaretPosition(int pos)
void	setClosingMode(GConsole.ClosingMode mode) Determines what happens when the title bar close button is hit.
void	setTitle(java.lang.String title) Set another title in the console's title bar.
void	show() Show the console window.
void	showFonts() Show all available fonts.
void	showHorizontalScrollBar(boolean b) Insert/remove a horizonal scroll bar.
void	showVerticalScrollBar(boolean b) Insert/remove a vertical scroll bar.
Size	size(int width, int height) Return a Size reference with specified width and height.
void	terminate() Terminate application.

Methods inherited from class java.lang.Object

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

Constructor Detail

GConsole

public GConsole(Position position,
        Size size,
        java.awt.Font font)

Construct a Console with given attributes.

Parameters:

position - a reference to a Position object

size - a reference to a Size object

font - a reference to a Font object

GConsole

public GConsole()

Construct a Console with default attributes.

GConsole

public GConsole(Position position,
        Size size)

Construct a Console with given position, size and default font.

Parameters:

position - a reference to a Position object

size - a reference to a Size object

GConsole

public GConsole(java.awt.Font font)

Construct a Console with given font and default position and size.

Parameters:

font - a reference to a Font object

Method Detail

end

public void end()

Hide the console window and releases resources. Redirect System.out to stdout. (The Console reference should not be used any more.)

clear

public void clear()

Erase all text in console window

position

public Position position(int ulx,
                int uly)

Return a Position reference with specified upperleft x and y coordinates. May be used in init() to avoid the keyword new

size

public Size size(int width,
        int height)

Return a Size reference with specified width and height. May be used in init() to avoid the keyword new

addExitListener

public void addExitListener(ExitListener exitListener)

Register an ExitListener to get a notification when the close button is clicked. After registering the automatic termination of the application is disabled. To close the Console window without termination, Console.end() should be called. To terminate the application, System.exit() should be called.

run

public void run()

For internal use only.

Specified by:

run in interface java.lang.Runnable

setCaretPosition

public void setCaretPosition(int pos)

show

public void show()

Show the console window.

hide

public void hide()

Hide the console window.

kbhit

public boolean kbhit()

Return true if a key was hit since the last time the one-character buffer was read with getKey() oder getKeyWait(). The one-character buffer is not modified. (Put the current thread to sleep for 1 ms to reduce CPU time when used in an iteration loop.)

getKey

public char getKey()

Return the unicode character associated with last key pressed and flush the one-charactor buffer. Return KeyEvent.CHAR_UNDEFINED if the one-character buffer is empty. (No echo in the console window.)

getKey

public char getKey(boolean keep)

Return the unicode character associated with last key pressed and keep the one-charactor buffer if keep = true. Return KeyEvent.CHAR_UNDEFINED if the one-character buffer is empty. (No echo in the console window.)

getKeyInt

public int getKeyInt()

Return the 8-bit ASCII code associated with last key pressed and flush the one-charactor buffer. Return KeyEvent.CHAR_UNDEFINED if the one-character buffer is empty. (No echo in the console window.)

getKeyWaitInt

public int getKeyWaitInt()

Return the 8-bit ASCII code associated with last key pressed and flush the one-charactor buffer. Return KeyEvent.CHAR_UNDEFINED if the one-character buffer is empty. (No echo in the console window.)

getKeyCode

public int getKeyCode()

Return the keycode associated with last key pressed and flush the one-character buffer. Return KeyEvent.CHAR_UNDEFINED if the one-character buffer is empty. (No echo in the console window.)

getKeyWait

public char getKeyWait()

Wait until a key is typed and return the unicode character associated with last key pressed. Flush the one-character buffer. (No echo in the console window.)

getKeyCodeWait

public int getKeyCodeWait()

Wait until a key is typed and return the keycode associated with last key pressed. Flush the one-character buffer. (No echo in the console window.)

readChar

public char readChar()

Wait until a key is typed and return the unicode character associated it. (Echo the character in the console window.)

readLine

public java.lang.String readLine()

Wait until a sequence of characters with trailing newline is typed. Return the string (without the trailing newline) (Echo the characters in the console wiindow.)

getLastKey

public char getLastKey()

Return the key character associated with last key pressed. Do not flush the one-charater buffer. Return KeyEvent.CHAR_UNDEFINED, if no key was pressed.

getLastKeyCode

public int getLastKeyCode()

Return the key code associated with last key pressed. Do not flush the one-character buffer. Return 0, if no key was pressed.

getLastModifiers

public int getLastModifiers()

Return the modifiers associated with last key pressed. Do not flush the one-character buffer. Return 0, if no key was pressed.

getLastModifiersText

public java.lang.String getLastModifiersText()

Return the modifiers text associated with last key pressed. Do not flush the one-character buffer. Return 0, if no key was pressed. Return empty string, if no key was pressed.

readInt

public int readInt()

Wait until a sequence of numbers with trailing newline is typed. Return the converted integer (if possible) (Echo the character in the console window.)

getInt

public java.lang.Integer getInt()

Same as readInt() but returns an Integer object. Return null, if entered character sequence cannot converted to an integer.

readDouble

public double readDouble()

Wait until a sequence of numbers with trailing newline is typed. Return the converted double (if possible) (Echo the character in the console window.)

getDouble

public java.lang.Double getDouble()

Same as readDouble() but returns a Double object. Return null, if entered character sequence cannot converted to a double.

terminate

public void terminate()

Terminate application.

showFonts

public void showFonts()

Show all available fonts.

delay

public void delay(int time)

Delay execution for the given amount of time ( in ms ).

pad

public java.lang.String pad(java.lang.String num,
                   int fieldWidth)

Right justify the given number in a field with the given field width (pad the field with leading spaces). Return the padded string (if possible)

pad

public java.lang.String pad(java.lang.String num,
                   int fieldWidth,
                   int decimalWidth)

Pad given number with trailing spaces to optain decimal width and right justify in a field with the given width (pad the the field with leading spaces). Return the padded string (if possible)

getTextArea

public javax.swing.JTextArea getTextArea()

Return a reference to the JTextArea of the console window

print

public void print(boolean b)

Print a boolean value. Return a reference to Console to concatenate print methods.

print

public void print(char c)

Print a character. Return a reference to Console to concatenate print methods.

print

public void print(char[] s)

Print an array of characters. Return a reference to Console to concatenate print methods.

print

public void print(double d)

Print a double-precision floating-point number. Return a reference to Console to concatenate print methods.

print

public void print(float f)

Print a floating-point number. Return a reference to Console to concatenate print methods.

print

public void print(int i)

Print an integer. Return a reference to Console to concatenate print methods.

print

public void print(long l)

Print a long integer. Return a reference to Console to concatenate print methods.

print

public void print(java.lang.Object obj)

Print an object. Return a reference to Console to concatenate print methods.

print

public void print(java.lang.String s)

Print a string. Return a reference to Console to concatenate print methods.

println

public void println()

Terminate the current line by writing the line separator string. Return a reference to Console to concatenate print methods.

println

public void println(boolean b)

Print a boolean and then terminate the line. Return a reference to Console to concatenate print methods.

println

public void println(char c)

Print a character and then terminate the line. Return a reference to Console to concatenate print methods.

println

public void println(char[] s)

Print an array of characters and then terminate the line. Return a reference to Console to concatenate print methods.

println

public void println(double d)

Print a double and then terminate the line. Return a reference to Console to concatenate print methods.

println

public void println(float f)

Print a float and then terminate the line. Return a reference to Console to concatenate print methods.

println

public void println(int i)

Print an integer and then terminate the line. Return a reference to Console to concatenate print methods.

println

public void println(long l)

Print a long and then terminate the line. Return a reference to Console to concatenate print methods.

println

public void println(java.lang.Object obj)

Print an Object and then terminate the line. Return a reference to Console to concatenate print methods.

println

public void println(java.lang.String s)

Print a String and then terminate the line. Return a reference to Console to concatenate print methods.

printf

public void printf(java.lang.String format,
          java.lang.Object... args)

Print a formatted string using the specified format string and varargs. (See PrintStream.printf() for more information) Return a reference to Console to concatenate print methods.

printf

public void printf(java.util.Locale l,
          java.lang.String format,
          java.lang.Object... args)

Print a formatted string using the specified format string and varargs and applying given locale during formatting. (See PrintStream.printf() for more information) Return a reference to Console to concatenate print methods.

print

public int print(java.awt.Graphics g,
        java.awt.print.PageFormat pf,
        int pageIndex)

For internal use only. Implements Printable.print().

Specified by:

print in interface java.awt.print.Printable

printScreen

public boolean printScreen(double scale)

Print the current text area to an attached printer with the given magnification scale factor. A standard printer dialog is shown before printing is started.
Return false, if printing is canceled in this dialog, return true, when print data is sent to the printer spooler.
Only the text thats fits on one page is printed.

printScreen

public boolean printScreen()

Same as printScreen(scale) with scale = 1

getFrame

public javax.swing.JFrame getFrame()

Return a reference to the JFrame instance used by the console

showVerticalScrollBar

public void showVerticalScrollBar(boolean b)

Insert/remove a vertical scroll bar. Default scroll bar policy: scroll bar added as needed

showHorizontalScrollBar

public void showHorizontalScrollBar(boolean b)

Insert/remove a horizonal scroll bar. Default scroll bar policy: scroll bar added as needed

setTitle

public void setTitle(java.lang.String title)

Set another title in the console's title bar.

setAutowrap

public void setAutowrap(boolean enable)

Enable/disable autowrapping. If enabled the lines will be wrapped at word boundaries (whitespace) if they are too long to fit within the current line width.

getClosingMode

public GConsole.ClosingMode getClosingMode(ch.aplu.util.MyProperties props)

checkDisposed

public void checkDisposed()

isDisposed

public boolean isDisposed()

Return true, if the Console windows was disposed or released.

setClosingMode

public void setClosingMode(GConsole.ClosingMode mode)

Determines what happens when the title bar close button is hit. Values: On of the enums in ClosingMode:
TerminateOnClose -> Terminating and shutting down JRE by System.exit(0)
HideOnClose -> Hides the console window, use show() to make it visible
ClearOnClose -> Clears the graphics content
AskOnClose -> Shows confirmation dialog asking for termination
DisposeOnClose -> Closes the consle window, but does not shutdown JRE
ReleaseOnClose -> Like DisposeOnClose, but throws runtime exception when graphics methods are called
NothingOnClose -> Does nothing
Default value: TerminateOnClose or value read from aplu_utils.properties

deleteLastChar

public void deleteLastChar()

Deletes the last character and adjusts the cursor.

getLastLine

public java.lang.String getLastLine()

Returns the last line of the text area.

dispose

public void dispose()

Disposes the console frame.