acm.program

Class CommandLineProgram

java.lang.Object

acm.program.CommandLineProgram

All Implemented Interfaces:

acm.io.IOModel, ProgramInterface, ActionListener, KeyListener, MouseListener, MouseMotionListener, EventListener

public class CommandLineProgram
extends Object
implements ProgramInterface, acm.io.IOModel, MouseListener, MouseMotionListener, KeyListener, ActionListener

This class simulates the functionality of a ConsoleProgram in an environment that lacks a graphics context. As of JDK 1.4, it is illegal even to instantiate an applet in a non-graphics environment (called "headless" in the Java terminology), which means that the program can no longer extend Applet or JApplet. This class creates a stripped-down program class that duplicates the operation of a ConsoleProgram using the standard I/O streams.

Field Summary

Fields inherited from interface acm.program.ProgramInterface

CENTER, EAST, NORTH, SOUTH, WEST

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CommandLineProgram() This code initializes the program data structures.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e) Called when a component (typically a button) is activated.
void	add(Component comp, String region, Object constraints) Adds the component to the specified border region with the indicated constraints object.
void	addActionListeners() Adds the program as an ActionListener to every button in the structure that does not have a listener already.
void	addActionListeners(ActionListener listener) Adds the specified listener to every button in the structure that does not have a listener already.
void	addExitHook(Object obj) Requests that the program call the exit method in the specified object before exiting.
protected void	addImpl(Component comp, Object constraints, int index) Adds the specified component to the content pane using the specified constraints and index.
static void	checkIfHeadless(String className) Checks to see if the program is running in a headless environment and, if so, runs it in that form.
protected IOConsole	createConsole() Creates the console used by the ConsoleProgram.
protected acm.io.IODialog	createDialogIO() Creates the dialog used for interaction (primarily by the DialogProgram class).
protected static HashMap<String,String>	createParameterTable(String[] args) Creates a hash table containing the parameters specified in the argument list.
void	destroy() Called when the program has been told to destroy itself.
protected void	endHook() Performs class-specific cleanup for the program just after it finishes.
void	exit() Exits from the program.
protected AppletStub	getAppletStub() Retrieves the applet stub.
protected String[]	getArgumentArray() Retrieves the array of arguments passed in from the command line, or null if no arguments are available.
protected Component	getBorder(String side) Returns the component installed as a border on the specified side, which must be one of the constants from BorderLayout (NORTH, SOUTH, EAST, WEST).
IOConsole	getConsole() Returns the console associated with this program.
acm.io.IODialog	getDialog() Returns the dialog used for user interaction.
int	getHeight() Returns the height of the central region.
acm.io.IOModel	getInputModel() Returns the IOModel used for program input, which will typically be either the default IOConsole or IODialog object.
LayoutManager	getLayout() Gets the layout manager for the central region of the content pane.
protected boolean	getMacMenuBarFlag() Retrieves the setting of the Mac menu bar flag.
acm.io.IOModel	getOutputModel() Returns the IOModel used for program output, which will typically be either the default IOConsole or IODialog object.
String	getParameter(String name) Returns the parameter associated with name.
protected HashMap<String,String>	getParameterTable() Retrieves the parameter table.
Dimension	getPreferredSize() Returns the preferred size of the content pane.
BufferedReader	getReader() Returns a BufferedReader whose input comes from the console.
JPanel	getRegionPanel(String region) Gets the JPanel for the specified region.
String	getTitle() Gets the title of this program.
int	getWidth() Returns the width of the central region.
PrintWriter	getWriter() Returns a PrintWriter whose output is directed to the console.
void	init() The init method is called at startup time before the run method is called.
boolean	isAppletMode() Returns true if this program is running as an applet in a browser.
static boolean	isHeadless() Returns true if the program is running in non-graphical "headless" mode.
protected boolean	isStarted() Checks to see whether this program has started, usually by checking to see whether some pane exists.
void	keyPressed(KeyEvent e) Called when a key is pressed.
void	keyReleased(KeyEvent e) Called when a key is released.
void	keyTyped(KeyEvent e) Called when a key is typed (i.e., pressed and released).
static void	main(String[] args) Every application must either contain a "Main-Class" entry in its manifest file or include a main method that looks like this, where MyClass is the name of the program class:
void	menuAction(String cmd) Called whenever an action event is detected in the menu bar.
void	mouseClicked(MouseEvent e) Called when the mouse is clicked.
void	mouseDragged(MouseEvent e) Called when the mouse is dragged with the button down.
void	mouseEntered(MouseEvent e) Called when the mouse enters the source (which may be either a component or a GObject).
void	mouseExited(MouseEvent e) Called when the mouse exits the source (which may be either a component or a GObject).
void	mouseMoved(MouseEvent e) Called when the mouse is moved.
void	mousePressed(MouseEvent e) Called when the mouse button is pressed.
void	mouseReleased(MouseEvent e) Called when the mouse button is released.
void	pause(double milliseconds) Causes the program to delay for the given number of milliseconds.
void	print(boolean x) Makes sure that print can display a boolean.
void	print(char x) Makes sure that print can display a char.
void	print(double x) Makes sure that print can display a double.
void	print(float x) Makes sure that print can display a float.
void	print(int x) Makes sure that print can display an int.
void	print(long x) Makes sure that print can display a long.
void	print(Object x) Makes sure that print can display an Object.
void	print(String value) Displays the argument value on the console, leaving the cursor at the end of the output.
void	printf(String format, Object... args) Writes a formatted string to this output stream using the specified format string and arguments.
void	println() Advances the console cursor to the beginning of the next line.
void	println(boolean x) Makes sure that println can display a boolean.
void	println(char x) Makes sure that println can display a char.
void	println(double x) Makes sure that println can display a double.
void	println(float x) Makes sure that println can display a float.
void	println(int x) Makes sure that println can display an int.
void	println(long x) Makes sure that println can display a long.
void	println(Object x) Makes sure that println can display an Object.
void	println(String value) Displays the argument value on the console and then advances the cursor to the beginning of the next line.
boolean	readBoolean() Reads and returns a boolean value (true or false).
boolean	readBoolean(String prompt) Prompts the user to enter a boolean value, which is returned as the value of this method.
boolean	readBoolean(String prompt, String trueLabel, String falseLabel) Prompts the user to enter a boolean value, which is matched against the labels provided.
double	readDouble() Reads and returns a double-precision value from the user.
double	readDouble(double low, double high) Reads and returns a double-precision value from the user, which is constrained to be within the specified inclusive range.
double	readDouble(String prompt) Prompts the user to enter an double-precision number, which is then returned as the value of this method.
double	readDouble(String prompt, double low, double high) Prompts the user to enter an double-precision number, which is then returned as the value of this method.
int	readInt() Reads and returns an integer value from the user.
int	readInt(int low, int high) Reads and returns an integer value from the user, which is constrained to be within the specified inclusive range.
int	readInt(String prompt) Prompts the user to enter an integer, which is then returned as the value of this method.
int	readInt(String prompt, int low, int high) Prompts the user to enter an integer, which is then returned as the value of this method.
String	readLine() Reads and returns a line of input from the console.
String	readLine(String prompt) Prompts the user for a line of input.
void	remove(Component comp) Removes the specified component from the central region.
void	remove(int index) Removes the component at the specified index from the central region.
void	removeAll() Removes all components from the central region.
void	repaint() Forwards repaint to the content pane.
void	run() Contains the code to be executed for each specific program subclass.
protected void	setAppletStub(AppletStub stub) Sets the applet stub for this program in a way that makes it possible for clients to retrieve it.
void	setBackground(Color color) Sets the background for the central region of the content pane.
void	setConsole(IOConsole console) Sets the console associated with this program.
void	setLayout(LayoutManager layout) Sets the layout manager for the central region of the content pane.
protected void	setMacMenuBarFlag(boolean flag) Sets a flag indicating whether applications running on the Macintosh should use standard Mac menus.
protected void	setParameterTable(HashMap<String,String> ht) Sets the parameter table for this program.
void	setParameterTable(Map<String,String> table)
void	setStartupObject(Object obj)
void	setTitle(String title) Sets the title of this program.
void	showErrorMessage(String msg) Displays the error message in the standard output model.
void	start()
void	start(String[] args) Starts the program using the specified argument list.
protected void	startHook() Performs class-specific initialization for the program just before it starts.
void	validate() Forwards validate to the content pane.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLineProgram

protected CommandLineProgram()

This code initializes the program data structures.

Method Detail

isHeadless

public static boolean isHeadless()

Returns true if the program is running in non-graphical "headless" mode.

checkIfHeadless

public static void checkIfHeadless(String className)

Checks to see if the program is running in a headless environment and, if so, runs it in that form. If the environment is indeed headless, this call never returns.

Parameters:

className - The name of the main class

Usage:

CommandLineProgram.checkIfHeadless(className);

run

public void run()

Contains the code to be executed for each specific program subclass. If you are defining your own program, you need to override the definition of run so that it contains the code for your application.

Specified by:

run in interface ProgramInterface

init

public void init()

The init method is called at startup time before the run method is called. Subclasses can override this method to perform any initialization code that would ordinarily be included in an applet init method. This method is used only for certain styles of application development that have their roots in the applet world; other styles will not ordinarily use or override this method.

Specified by:

init in interface ProgramInterface

Usage:

program.init();

pause

public void pause(double milliseconds)

Causes the program to delay for the given number of milliseconds.

Specified by:

pause in interface ProgramInterface

print

public void print(String value)

Displays the argument value on the console, leaving the cursor at the end of the output. The print method is overloaded so that value can be of any type.

Specified by:

print in interface acm.io.IOModel

Specified by:

print in interface ProgramInterface

Parameters:

value - The value to be displayed

Usage:

program.print(value);

print

public final void print(boolean x)

Makes sure that print can display a boolean.

Specified by:

print in interface acm.io.IOModel

Noshow:

print

public final void print(char x)

Makes sure that print can display a char.

Specified by:

print in interface acm.io.IOModel

Noshow:

print

public final void print(double x)

Makes sure that print can display a double.

Specified by:

print in interface acm.io.IOModel

Noshow:

print

public final void print(float x)

Makes sure that print can display a float.

Specified by:

print in interface acm.io.IOModel

Noshow:

print

public final void print(int x)

Makes sure that print can display an int.

Specified by:

print in interface acm.io.IOModel

Noshow:

print

public final void print(long x)

Makes sure that print can display a long.

Specified by:

print in interface acm.io.IOModel

Noshow:

print

public final void print(Object x)

Makes sure that print can display an Object.

Specified by:

print in interface acm.io.IOModel

Specified by:

print in interface ProgramInterface

Noshow:

printf

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

Writes a formatted string to this output stream using the specified format string and arguments.

Specified by:

printf in interface ProgramInterface

Parameters:

format - A format string as described in Java's Format string syntax.

args - Arguments referenced by the format specifiers in the format string. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero. The maximum number of arguments is limited by the maximum dimension of a Java array as defined by The Java™ Virtual Machine Specification. The behavior on a null argument depends on the conversion.

Throws:

IllegalFormatException - If a format string contains an illegal syntax, a format specifier that is incompatible with the given arguments, insufficient arguments given the format string, or other illegal conditions.

NullPointerException - If the format is null

println

public void println()

Advances the console cursor to the beginning of the next line.

Specified by:

println in interface acm.io.IOModel

Specified by:

println in interface ProgramInterface

Usage:

program.println();

println

public void println(String value)

Displays the argument value on the console and then advances the cursor to the beginning of the next line. The println method is overloaded so that value can be of any type.

Specified by:

println in interface acm.io.IOModel

Specified by:

println in interface ProgramInterface

Parameters:

value - The value to be displayed

Usage:

program.println(value);

println

public final void println(boolean x)

Makes sure that println can display a boolean.

Specified by:

println in interface acm.io.IOModel

Noshow:

println

public final void println(char x)

Makes sure that println can display a char.

Specified by:

println in interface acm.io.IOModel

Noshow:

println

public final void println(double x)

Makes sure that println can display a double.

Specified by:

println in interface acm.io.IOModel

Noshow:

println

public final void println(float x)

Makes sure that println can display a float.

Specified by:

println in interface acm.io.IOModel

Noshow:

println

public final void println(int x)

Makes sure that println can display an int.

Specified by:

println in interface acm.io.IOModel

Noshow:

println

public final void println(long x)

Makes sure that println can display a long.

Specified by:

println in interface acm.io.IOModel

Noshow:

println

public final void println(Object x)

Makes sure that println can display an Object.

Specified by:

println in interface acm.io.IOModel

Specified by:

println in interface ProgramInterface

Noshow:

showErrorMessage

public void showErrorMessage(String msg)

Displays the error message in the standard output model.

Specified by:

showErrorMessage in interface acm.io.IOModel

Parameters:

msg - The error msg to be displayed

Usage:

showErrorMessage(msg);

readLine

public final String readLine()

Reads and returns a line of input from the console. The end-of-line characters that terminate the input are not included in the returned string.

Specified by:

readLine in interface acm.io.IOModel

Returns:

The next line of input as a String

Usage:

String str = program.readLine();

readLine

public String readLine(String prompt)

Prompts the user for a line of input. The end-of-line characters that terminate the input are not included in the returned string.

Specified by:

readLine in interface acm.io.IOModel

Parameters:

prompt - The prompt string to display to the user

Returns:

The next line of input as a String

Usage:

String str = program.readLine(prompt);

readInt

public final int readInt()

Reads and returns an integer value from the user. If the user types a value that is not a legal integer, the method ordinarily offers the user a chance to reenter the data, although this behavior can be changed using the setExceptionOnError method.

Specified by:

readInt in interface acm.io.IOModel

Returns:

The value of the input interpreted as a decimal integer

Usage:

int n = program.readInt();

readInt

public final int readInt(int low,
                         int high)

Reads and returns an integer value from the user, which is constrained to be within the specified inclusive range. If the user types a value that is not a legal integer, the method ordinarily offers the user a chance to reenter the data, although this behavior can be changed using the setExceptionOnError method.

Specified by:

readInt in interface acm.io.IOModel

Parameters:

low - The lowest value in the permitted range

high - The highest value in the permitted range

Returns:

The value of the input interpreted as a decimal integer

Usage:

int n = program.readInt(low, high);

readInt

public final int readInt(String prompt)

Prompts the user to enter an integer, which is then returned as the value of this method. If the user types a value that is not a legal integer, the method ordinarily offers the user a chance to reenter the data, although this behavior can be changed using the setExceptionOnError method.

Specified by:

readInt in interface acm.io.IOModel

Parameters:

prompt - The prompt string to display to the user

Returns:

The value of the input interpreted as a decimal integer

Usage:

int n = program.readInt(prompt);

readInt

public int readInt(String prompt,
                   int low,
                   int high)

Prompts the user to enter an integer, which is then returned as the value of this method. The value must be within the inclusive range between low and high. If the user types a value that is not a legal integer or is outside the specified range, the method ordinarily offers the user a chance to reenter the data, although this behavior can be changed using the setExceptionOnError method.

Specified by:

readInt in interface acm.io.IOModel

Parameters:

prompt - The prompt string to display to the user

low - The lowest value in the permitted range

high - The highest value in the permitted range

Returns:

The value of the input interpreted as a decimal integer

Usage:

int n = console.readInt(prompt, low, high);

readDouble

public final double readDouble()

Reads and returns a double-precision value from the user. If the user types a value that is not a legal number, the method ordinarily offers the user a chance to reenter the data, although this behavior can be changed using the setExceptionOnError method.

Specified by:

readDouble in interface acm.io.IOModel

Returns:

The value of the input interpreted as a double

Usage:

double d = program.readDouble();

readDouble

public final double readDouble(double low,
                               double high)

Reads and returns a double-precision value from the user, which is constrained to be within the specified inclusive range. If the user types a value that is not a legal number, the method ordinarily offers the user a chance to reenter the data, although this behavior can be changed using the setExceptionOnError method.

Specified by:

readDouble in interface acm.io.IOModel

Parameters:

low - The lowest value in the permitted range

high - The highest value in the permitted range

Returns:

The value of the input interpreted as a double

Usage:

double d = program.readDouble(low, high);

readDouble

public final double readDouble(String prompt)

Prompts the user to enter an double-precision number, which is then returned as the value of this method. If the user types a value that is not a legal number, the method ordinarily offers the user a chance to reenter the data, although this behavior can be changed using the setExceptionOnError method.

Specified by:

readDouble in interface acm.io.IOModel

Parameters:

prompt - The prompt string to display to the user

Returns:

The value of the input interpreted as a double

Usage:

double d = program.readDouble(prompt);

readDouble

public double readDouble(String prompt,
                         double low,
                         double high)

Prompts the user to enter an double-precision number, which is then returned as the value of this method. The value must be within the inclusive range between low and high. If the user types a value that is not a legal number, the method ordinarily offers the user a chance to reenter the data, although this behavior can be changed using the setExceptionOnError method.

Specified by:

readDouble in interface acm.io.IOModel

Parameters:

prompt - The prompt string to display to the user

low - The lowest value in the permitted range

high - The highest value in the permitted range

Returns:

The value of the input interpreted as a double

Usage:

d = program.readDouble(prompt, low, high);

readBoolean

public final boolean readBoolean()

Reads and returns a boolean value (true or false). The input must match one of these strings, ignoring case. If the user types a value that is not one of these possibilities, the method ordinarily offers the user a chance to reenter the data, although this behavior can be changed using the setExceptionOnError method.

Specified by:

readBoolean in interface acm.io.IOModel

Returns:

The value of the input interpreted as a boolean value

Usage:

boolean flag = program.readBoolean();

readBoolean

public final boolean readBoolean(String prompt)

Prompts the user to enter a boolean value, which is returned as the value of this method. If the user types a value that is not a legal boolean value, the method ordinarily offers the user a chance to reenter the data, although this behavior can be changed using the setExceptionOnError method.

Specified by:

readBoolean in interface acm.io.IOModel

Parameters:

prompt - The prompt string to display to the user

Returns:

The value of the input interpreted as a boolean value

Usage:

boolean flag = program.readBoolean(prompt);

readBoolean

public boolean readBoolean(String prompt,
                           String trueLabel,
                           String falseLabel)

Prompts the user to enter a boolean value, which is matched against the labels provided. If the user enters a value that is not one of the two choices, readBoolean ordinarily offers the user a chance to reenter the data, although this behavior can be changed using the setExceptionOnError method.

Specified by:

readBoolean in interface acm.io.IOModel

Parameters:

prompt - The prompt string to display to the user

trueLabel - The string used to indicate true

falseLabel - The string used to indicate false

Returns:

The value of the input interpreted as a boolean value

Usage:

boolean flag = program.readBoolean(prompt);

isAppletMode

public boolean isAppletMode()

Returns true if this program is running as an applet in a browser.

Returns:

true if this program is running as an applet, false otherwise

Usage:

if (isAppletMode()) . . .

Noshow:

setConsole

public void setConsole(IOConsole console)

Sets the console associated with this program.

Parameters:

console - The IOConsole object used for this program

Usage:

program.setConsole(console);

getConsole

public IOConsole getConsole()

Returns the console associated with this program.

Returns:

The IOConsole object used for this program

Usage:

IOConsole console = program.getConsole();

getDialog

public acm.io.IODialog getDialog()

Returns the dialog used for user interaction.

Returns:

The IODialog object used for this program

Usage:

IODialog dialog = program.getDialog();

getInputModel

public acm.io.IOModel getInputModel()

Returns the IOModel used for program input, which will typically be either the default IOConsole or IODialog object.

Returns:

The IOModel used for program input

Usage:

IOModel io = program.getInputModel();

getOutputModel

public acm.io.IOModel getOutputModel()

Returns the IOModel used for program output, which will typically be either the default IOConsole or IODialog object.

Returns:

The IOModel used for program output

Usage:

IOModel io = program.getOutputModel();

getReader

public BufferedReader getReader()

Returns a BufferedReader whose input comes from the console.

Returns:

A Reader for use with this console

Usage:

BufferedReader rd = getReader();

getWriter

public PrintWriter getWriter()

Returns a PrintWriter whose output is directed to the console.

Returns:

A PrintWriter for use with this console

Usage:

PrintWriter wr = getWriter();

getRegionPanel

public JPanel getRegionPanel(String region)

Gets the JPanel for the specified region.

Parameters:

region - The region of the window (NORTH, SOUTH, EAST, WEST, or CENTER)

Returns:

The JPanel for that subregion

Usage:

JPanel panel = getRegionPanel(region);

Noshow:

add

public void add(Component comp,
                String region,
                Object constraints)

Adds the component to the specified border region with the indicated constraints object.

Parameters:

comp - The component to be added

region - The region of the window (NORTH, SOUTH, EAST, WEST, or CENTER)

constraints - The constraints object

Usage:

add(comp, region, constraints);

Noshow:

addActionListeners

public void addActionListeners()

Adds the program as an ActionListener to every button in the structure that does not have a listener already.

Usage:

addActionListeners();

addActionListeners

public void addActionListeners(ActionListener listener)

Adds the specified listener to every button in the structure that does not have a listener already.

Parameters:

listener - The ActionListener to be added

Usage:

addActionListeners(listener);

setTitle

public void setTitle(String title)

Sets the title of this program. The title appears in the title bar when the program is running as an application.

Specified by:

setTitle in interface ProgramInterface

Parameters:

title - The title for this program

Usage:

setTitle(title);

getTitle

public String getTitle()

Gets the title of this program.

Specified by:

getTitle in interface ProgramInterface

Returns:

The title in use for this program

Usage:

String title = getTitle();

setParameterTable

public void setParameterTable(Map<String,String> table)

Specified by:

setParameterTable in interface ProgramInterface

setStartupObject

public void setStartupObject(Object obj)

Specified by:

setStartupObject in interface ProgramInterface

start

public void start()

Specified by:

start in interface ProgramInterface

start

public void start(String[] args)

Starts the program using the specified argument list.

Specified by:

start in interface ProgramInterface

Parameters:

args - An array of strings passed to the program

Usage:

program.start(args);

exit

public void exit()

Exits from the program. Subclasses should override this method if they need to perform any actions before shutting down the program, such as asking the user to save any unsaved files. Any clients that do override this method should call super.exit() at the end of their processing.

Specified by:

exit in interface ProgramInterface

Usage:

program.exit();

addExitHook

public void addExitHook(Object obj)

Requests that the program call the exit method in the specified object before exiting.

Usage:

program.addExitHook(obj);

mouseClicked

public void mouseClicked(MouseEvent e)

Called when the mouse is clicked. A call to mouseClicked is always preceded by both a mousePressed and a mouseReleased event for the same source.

Specified by:

mouseClicked in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)

Called when the mouse button is pressed.

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

Called when the mouse button is released.

Specified by:

mouseReleased in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Called when the mouse enters the source (which may be either a component or a GObject).

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Called when the mouse exits the source (which may be either a component or a GObject).

Specified by:

mouseExited in interface MouseListener

mouseMoved

public void mouseMoved(MouseEvent e)

Called when the mouse is moved.

Specified by:

mouseMoved in interface MouseMotionListener

mouseDragged

public void mouseDragged(MouseEvent e)

Called when the mouse is dragged with the button down. Java makes several guarantees about dragging. First, a mouseDragged call is always preceded by a mousePressed call for the same source. If the mouse is pressed elsewhere and then enters a source with the button down, no drag event occurs. Moreover, once the mouse button goes down in a particular source, only that source will receive mouse events until the button goes up. Those events, moreover, are reported even in the mouse travels outside the domain of the object.

Specified by:

mouseDragged in interface MouseMotionListener

keyTyped

public void keyTyped(KeyEvent e)

Called when a key is typed (i.e., pressed and released).

Specified by:

keyTyped in interface KeyListener

keyPressed

public void keyPressed(KeyEvent e)

Called when a key is pressed.

Specified by:

keyPressed in interface KeyListener

keyReleased

public void keyReleased(KeyEvent e)

Called when a key is released.

Specified by:

keyReleased in interface KeyListener

actionPerformed

public void actionPerformed(ActionEvent e)

Called when a component (typically a button) is activated.

Specified by:

actionPerformed in interface ActionListener

createConsole

protected IOConsole createConsole()

Creates the console used by the ConsoleProgram. Subclasses can override this method to create their own console types.

Returns:

The console to be used by the program

Usage:

IOConsole console = program.createConsole();

createDialogIO

protected acm.io.IODialog createDialogIO()

Creates the dialog used for interaction (primarily by the DialogProgram class). Subclasses can override this method to create their own dialog types.

Returns:

The dialog to be used by the program

Usage:

IODialog dialog = program.createDialogIO();

getPreferredSize

public Dimension getPreferredSize()

Returns the preferred size of the content pane.

Returns:

The preferred size of the content pane

Usage:

Dimension size = getPreferredSize();

Noshow:

getWidth

public int getWidth()

Returns the width of the central region.

Returns:

The width of the central region

Usage:

int width = getWidth();

Noshow:

getHeight

public int getHeight()

Returns the height of the central region.

Returns:

The height of the central region

Usage:

int height = getHeight();

Noshow:

getParameter

public String getParameter(String name)

Returns the parameter associated with name.

Parameters:

name - The name of the parameter

Returns:

The value associated with the parameter, or null if none

Usage:

String value = getParameter(name);

Noshow:

setLayout

public void setLayout(LayoutManager layout)

Sets the layout manager for the central region of the content pane.

Parameters:

layout - The layout manager to use

Usage:

setLayout(layout);

Noshow:

getLayout

public LayoutManager getLayout()

Gets the layout manager for the central region of the content pane.

Returns:

The active layout manager

Usage:

LayoutManager layout = setLayout();

Noshow:

setBackground

public void setBackground(Color color)

Sets the background for the central region of the content pane.

Parameters:

color - The new background color

Usage:

setBackground(color);

Noshow:

addImpl

protected void addImpl(Component comp,
                       Object constraints,
                       int index)

Adds the specified component to the content pane using the specified constraints and index.

remove

public void remove(int index)

Removes the component at the specified index from the central region.

Parameters:

index - The index position of the component to remove

Usage:

remove(index);

Noshow:

remove

public void remove(Component comp)

Removes the specified component from the central region.

Parameters:

comp - The component to remove

Usage:

remove(comp);

Noshow:

removeAll

public void removeAll()

Removes all components from the central region.

Usage:

removeAll();

Noshow:

validate

public void validate()

Forwards validate to the content pane.

Usage:

validate();

Noshow:

repaint

public void repaint()

Forwards repaint to the content pane.

Usage:

repaint();

Noshow:

destroy

public void destroy()

Called when the program has been told to destroy itself.

Usage:

program.destroy();

Noshow:

main

public static void main(String[] args)

Every application must either contain a "Main-Class" entry in its manifest file or include a main method that looks like this, where MyClass is the name of the program class:

      public static void main(String[] args) {
         new MyClass().start();
      }
 

If the program needs the command line arguments, the args array can be passed to the start method and then retrieved using the getArgumentArray method.

Parameters:

args - An array of string arguments

menuAction

public void menuAction(String cmd)

Called whenever an action event is detected in the menu bar. Most of these actions are simply passed on to the appropriate console.

setMacMenuBarFlag

protected void setMacMenuBarFlag(boolean flag)

Sets a flag indicating whether applications running on the Macintosh should use standard Mac menus. The default is true. Setting this value to false means that Mac programs use the same in-window JMenuBar approach used on other platforms.

Parameters:

flag - true to use Mac menu style; false otherwise

Usage:

setMacMenuBarFlag(flag);

getMacMenuBarFlag

protected boolean getMacMenuBarFlag()

Retrieves the setting of the Mac menu bar flag.

Returns:

true if Mac menu style is supported; false otherwise

Usage:

boolean flag = getMacMenuBarFlag();

getBorder

protected Component getBorder(String side)

Returns the component installed as a border on the specified side, which must be one of the constants from BorderLayout (NORTH, SOUTH, EAST, WEST).

Parameters:

side - The side (NORTH, SOUTH, EAST, or WEST)

Returns:

The component used as a border on the specified side

Usage:

getBorder(side, comp);

Noshow:

getArgumentArray

protected String[] getArgumentArray()

Retrieves the array of arguments passed in from the command line, or null if no arguments are available.

Returns:

The array of command-line arguments

Usage:

String[] args = getArgumentArray();

Noshow:

isStarted

protected boolean isStarted()

Checks to see whether this program has started, usually by checking to see whether some pane exists. Subclasses can override this method to ensure that their structures are visible before proceeding.

Noshow:

startHook

protected void startHook()

Performs class-specific initialization for the program just before it starts.

Noshow:

endHook

protected void endHook()

Performs class-specific cleanup for the program just after it finishes.

Noshow:

setAppletStub

protected void setAppletStub(AppletStub stub)

Sets the applet stub for this program in a way that makes it possible for clients to retrieve it.

Parameters:

stub - The applet stub

Usage:

setAppletStub(stub);

getAppletStub

protected AppletStub getAppletStub()

Retrieves the applet stub.

Returns:

The applet stub

Usage:

AppletStub stub = getAppletStub();

setParameterTable

protected void setParameterTable(HashMap<String,String> ht)

Sets the parameter table for this program.

Parameters:

ht - The parameter table

Usage:

setParameterTable(ht);

getParameterTable

protected HashMap<String,String> getParameterTable()

Retrieves the parameter table.

Returns:

The parameter table

Usage:

ParameterTable ht = getParameterTable();

createParameterTable

protected static HashMap<String,String> createParameterTable(String[] args)

Creates a hash table containing the parameters specified in the argument list. Parameters are taken to be any argument that matches the template

name=value All other arguments are collected as a tab-separated string and placed in an entry under the key "ARGS". All named parameters are converted to lower case to preserve the case-insensitive semantics of getParameter.

Parameters:

args - The array of strings passed to the application

Returns:

A HashMap containing the parameter bindings

Usage:

HashMap ht = createParameterTable(args);