Program

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - java.awt.Panel
    - - java.applet.Applet
      - javax.swing.JApplet
        
        acm.program.Program

All Implemented Interfaces:

acm.io.IOModel, ProgramInterface, ActionListener, AdjustmentListener, ComponentListener, ContainerListener, FocusListener, ItemListener, KeyListener, MouseListener, MouseMotionListener, MouseWheelListener, TextListener, WindowFocusListener, WindowListener, WindowStateListener, ImageObserver, MenuContainer, Serializable, Runnable, EventListener, Accessible, ChangeListener, DocumentListener, ListDataListener, ListSelectionListener, MouseInputListener, PopupMenuListener, RootPaneContainer

Direct Known Subclasses:

AbstractConsoleProgram, DialogProgram, GraphicsProgram, Karel, KarelProgram
```
public abstract class Program
extends JApplet
implements ActionListener, AdjustmentListener, ChangeListener, ComponentListener, ContainerListener, DocumentListener, FocusListener, acm.io.IOModel, ItemListener, KeyListener, ListDataListener, ListSelectionListener, MouseListener, MouseInputListener, MouseMotionListener, MouseWheelListener, PopupMenuListener, ProgramInterface, Runnable, TextListener, WindowFocusListener, WindowListener, WindowStateListener
```
This class is the superclass for all executable programs in the acm.program package. Its principal role is to unify the concepts of applets and applications in a single class, although it also provides applications with many other useful facilities not traditionally available in applications.
In many programming environments, objects that are specific instances of a Program subclass will run automatically without any special action on your part. For maximum portability, you might want to define a static main method as described in the comments for the standard implementation of main.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JApplet
  JApplet.AccessibleJApplet
- Nested classes/interfaces inherited from class java.applet.Applet
  Applet.AccessibleApplet
- Nested classes/interfaces inherited from class java.awt.Panel
  Panel.AccessibleAWTPanel
- Nested classes/interfaces inherited from class java.awt.Container
  Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class java.awt.Component
  Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields
Modifier and Type Field and Description

protected static String CONFIG_FILE_NAME

protected Set<GObject> invisibleObjects
- Fields inherited from class javax.swing.JApplet
  accessibleContext, rootPane, rootPaneCheckingEnabled
- Fields inherited from class java.awt.Component
  BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
- Fields inherited from interface acm.program.ProgramInterface
  CENTER, EAST, NORTH, SOUTH, WEST
- Fields inherited from interface java.awt.image.ImageObserver
  ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields
Modifier and Type	Field and Description
`protected static String`	`CONFIG_FILE_NAME`
`protected Set<GObject>`	`invisibleObjects`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Program()
This code initializes the program data structures.

Constructors
Modifier	Constructor and Description
`protected`	`Program()` This code initializes the program data structures.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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`	`addActionListenersToButtonsOnly()` Adds the program as an `ActionListener` to every button in the structure that does not have a listener already.
`void`	`addAllActionListeners()` Adds the program as an `ActionListener` to every button or component 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.
`void`	`adjustmentValueChanged(AdjustmentEvent e)` Required empty method of AdjustmentListener interface.
`void`	`alert(Object value)` Pops up a dialog box displaying a string representation of the given message.
`void`	`alert(String message)` Pops up a dialog box displaying the given message.
`void`	`animation()` Override this method to indicate what to do on every frame advance in an animated program after setAnimated(true) is called.
`void`	`center()` Moves this program's window to the center of the screen.
`void`	`changedUpdate(DocumentEvent e)` Required method of DocumentListener interface.
`protected void`	`checkCompilerFlags()`
`void`	`checkKill()` Checks whether the program has been stopped via the killMe method.
`protected void`	`checkStartupSettings()`
`void`	`componentAdded(ContainerEvent e)` Required method of ContainerListener interface.
`void`	`componentHidden(ComponentEvent e)` Required method of ComponentListener interface.
`void`	`componentMoved(ComponentEvent e)` Required method of ComponentListener interface.
`void`	`componentRemoved(ContainerEvent e)` Required method of ContainerListener interface.
`void`	`componentResized(ComponentEvent e)` Required method of ComponentListener interface.
`void`	`componentShown(ComponentEvent e)` Required method of ComponentListener interface.
`boolean`	`confirm(String question)` Pops up a dialog box displaying the given message and asking the user to choose Yes or No.
`void`	`contentsChanged(ListDataEvent e)` Required method of ListDataListener interface.
`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 ProgramMenuBar`	`createMenuBar()` Creates a menu bar for use with the program.
`protected static Map<String,String>`	`createParameterTable(String[] args)` Creates a hash table containing the parameters specified in the argument list.
`protected JFrame`	`createProgramFrame()` Creates the frame containing the program.
`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`	`error(Exception ex)` Generates an ErrorException with the given exception as its cause.
`void`	`error(Exception ex, String text)` Generates an ErrorException with the given exception and text.
`void`	`error(String text)` Generates an ErrorException with the given text as its error message.
`void`	`exit()` Exits from the program.
`protected boolean`	`fileExists(String filename)` Returns true if the given file exists within the current working directory.
`protected boolean`	`fileExists(String directory, String filename)` Returns true if the given file exists within the given directory.
`protected boolean`	`fileExistsInsideJAR(String filename)` Returns true if the given file exists inside the app's JAR archive within the current working directory.
`protected boolean`	`fileExistsInsideJAR(String directory, String filename)` Returns true if the given file exists inside the app's JAR archive within the given directory.
`protected boolean`	`fileExistsOnDisk(String filename)` Returns true if the given file exists in the current working directory.
`protected boolean`	`fileExistsOnDisk(String directory, String filename)` Returns true if the given file exists in the given directory.
`protected int`	`fileSize(String filename)` Returns the size of the given file in bytes in the current working directory.
`protected int`	`fileSize(String directory, String filename)` Returns the size of the given file in bytes.
`void`	`focusGained(FocusEvent e)` Required empty method of FocusListener interface; does nothing.
`void`	`focusLost(FocusEvent e)` Required empty method of FocusListener interface; does nothing.
`int`	`getAnimationDelay()` Returns the delay between frames of animation in milliseconds (default 20).
`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.
`boolean`	`getBoolean()` Reads and returns a boolean value (`true` or `false`).
`boolean`	`getBoolean(String prompt)` Prompts the user to enter a boolean value, which is returned as the value of this method.
`boolean`	`getBoolean(String prompt, String trueLabel, String falseLabel)` Prompts the user to enter a boolean value, which is matched against the labels provided.
`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`).
`int`	`getBottomY()` Returns the y-coordinate of the bottom of this program's window.
`acm.graphics.GDimension`	`getCenterLocation()` Returns the x/y-coordinates of the center of this program's window.
`int`	`getCenterX()` Returns the x-coordinate of the center of this program's window.
`int`	`getCenterY()` Returns the y-coordinate of the center of this program's window.
`Dimension`	`getCentralRegionSize()` Returns the size of the central region.
`IOConsole`	`getConsole()` Returns the console associated with this program.
`acm.io.IODialog`	`getDialog()` Returns the dialog used for user interaction.
`double`	`getDouble()` Reads and returns a double-precision value from the user.
`double`	`getDouble(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`	`getDouble(String prompt)` Prompts the user to enter an double-precision number, which is then returned as the value of this method.
`double`	`getDouble(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`	`getHeight()` Returns the height of the central region.
`acm.io.IOModel`	`getInputModel()` Returns the `IOModel` used for program input, which will ordinarily be the console.
`int`	`getInteger()` Reads and returns an integer value from the user.
`int`	`getInteger(int low, int high)` Reads and returns an integer value from the user, which is constrained to be within the specified inclusive range.
`int`	`getInteger(String prompt)` Prompts the user to enter an integer, which is then returned as the value of this method.
`int`	`getInteger(String prompt, int low, int high)` Prompts the user to enter an integer, which is then returned as the value of this method.
`JFrame`	`getJFrame()` Returns the Java Swing window frame that encloses this program.
`LayoutManager`	`getLayout()` Gets the layout manager for the central region of the content pane.
`String`	`getLine()` Reads and returns a line of input from the console.
`String`	`getLine(String prompt)` Prompts the user for a line of input.
`Thread`	`getMainThread()` Returns the thread that is running the main program.
`ProgramMenuBar`	`getMenuBar()` Returns the menu bar associated with this program.
`Color`	`getOutputColor()` Returns the current output color used to display output on the console.
`acm.io.IOModel`	`getOutputModel()` Returns the `IOModel` used for program output, which will ordinarily be the console.
`String`	`getParameter(String name)` Returns the parameter associated with name.
`protected Map<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.
`double`	`getReal()` Reads and returns a double-precision value from the user.
`double`	`getReal(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`	`getReal(String prompt)` Prompts the user to enter an double-precision number, which is then returned as the value of this method.
`double`	`getReal(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.
`JPanel`	`getRegionPanel(String region)` Gets the `JPanel` for the specified region.
`int`	`getRightX()` Returns the x-coordinate of the right edge of this program's window.
`int`	`getScreenHeight()` Returns the height of the screen in pixels.
`acm.graphics.GDimension`	`getScreenSize()` Returns the width x height of the screen in pixels.
`int`	`getScreenWidth()` Returns the width of the screen in pixels.
`protected Object`	`getStartupObject()` Retrieves the object that was created when this program was started if that object is something other than a `Program`.
`String`	`getTitle()` Gets the title of this program.
`int`	`getWidth()` Returns the width of the central region.
`Window`	`getWindow()` Returns the Java Swing window that encloses this program.
`PrintWriter`	`getWriter()` Returns a `PrintWriter` whose output is directed to the console.
`boolean`	`getYesOrNo(String prompt)` Prompts the user to answer a yes/no question and returns true if the user typed 'yes' (or anything that starts with a 'y', case-insensitively), false if the user types anything that starts with 'n', or re-prompts if the user doesn't type a 'y' or 'n' word.
`boolean`	`hasConfiguration()` Returns true if this program has any saved configuration stored on disk.
`void`	`init()` Specifies the code to be executed as startup time before the `run` method is called.
`void`	`insertUpdate(DocumentEvent e)` Required method of DocumentListener interface.
`void`	`intervalAdded(ListDataEvent e)` Required method of ListDataListener interface.
`void`	`intervalRemoved(ListDataEvent e)` Required method of ListDataListener interface.
`boolean`	`isAnimated()` Returns true if the program is currently in animated mode.
`protected boolean`	`isApplet()` Returns `true` if this program is running as an applet in a browser.
`boolean`	`isAppletMode()` Returns `true` if this program is running as an applet in a browser.
`boolean`	`isExitOnClose()` Returns whether the program will exit when its window is closed (default true).
`boolean`	`isInitialized()` Returns true if this program's init() method has been called.
`protected boolean`	`isStarted()` Checks to see whether this program has started, usually by checking to see whether some pane exists.
`void`	`itemStateChanged(ItemEvent e)` Required empty method of ItemListener interface.
`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).
`void`	`killMe()` Instructs the program to stop/kill itself.
`void`	`loadConfiguration()` Loads any saved configuration of this program from disk.
`protected void`	`loadConfiguration(Properties props)` Loads any saved configuration of this program from disk.
`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:
`boolean`	`menuAction(ActionEvent event)` Called whenever a program action is detected in the menu bar.
`void`	`menuCanceled(MenuEvent e)` Required method of MenuListener interface.
`void`	`menuDeselected(MenuEvent e)` Required method of MenuListener interface.
`void`	`menuSelected(MenuEvent e)` Required method of MenuListener interface.
`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`	`mouseWheelMoved(MouseWheelEvent e)` Implementation of MouseWheelListener interface.
`protected InputStream`	`openFile(String filename)` Opens the given file for reading.
`protected InputStream`	`openFile(String directory, String filename)` Opens the given file from within the given directory.
`protected InputStream`	`openFileFromDisk(String filename)` Opens the given file from within the current working directory.
`protected InputStream`	`openFileFromDisk(String directory, String filename)` Opens the given file from within the given directory.
`protected InputStream`	`openFileFromJAR(String filename)` Opens the given file from inside the app's JAR archive.
`protected InputStream`	`openFileFromJAR(String directory, String filename)` Opens the given file from within the app's JAR archive in the given directory.
`void`	`pack()` Resizes this program to exactly fit the preferred size of its contents.
`void`	`pause(double milliseconds)` Delays the calling thread for the specified time, which is expressed in milliseconds.
`void`	`pauseTick()` Sets a 'pause tick' flag.
`void`	`popupMenuCanceled(PopupMenuEvent e)` Required method of PopupMenuListener interface.
`void`	`popupMenuWillBecomeInvisible(PopupMenuEvent e)` Required method of PopupMenuListener interface.
`void`	`popupMenuWillBecomeVisible(PopupMenuEvent e)` Required method of PopupMenuListener interface.
`void`	`print(boolean x)` Makes sure that `print` can display a `boolean`.
`void`	`print(boolean value, Color color)` Prints the given value in the given color.
`void`	`print(char x)` Makes sure that `print` can display a `char`.
`void`	`print(char value, Color color)` Prints the given value in the given color.
`void`	`print(double x)` Makes sure that `print` can display a `double`.
`void`	`print(double value, Color color)` Prints the given value in the given color.
`void`	`print(float x)` Makes sure that `print` can display a `float`.
`void`	`print(float value, Color color)` Prints the given value in the given color.
`void`	`print(int x)` Makes sure that `print` can display an `int`.
`void`	`print(int value, Color color)` Prints the given value in the given color.
`void`	`print(long x)` Makes sure that `print` can display a `long`.
`void`	`print(long value, Color color)` Prints the given value in the given color.
`void`	`print(Object x)` Makes sure that `print` can display an `Object`.
`void`	`print(Object value, Color color)` Prints the given value in the given color.
`void`	`print(String value)` Displays the argument value on the console, leaving the cursor at the end of the output.
`void`	`print(String value, Color color)` Prints the given string in the given color.
`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(boolean value, Color color)` Prints the given value in the given color and then advances the cursor to the beginning of the next line.
`void`	`println(char x)` Makes sure that `println` can display a `char`.
`void`	`println(char value, Color color)` Prints the given value in the given color and then advances the cursor to the beginning of the next line.
`void`	`println(double x)` Makes sure that `println` can display a `double`.
`void`	`println(double value, Color color)` Prints the given value in the given color and then advances the cursor to the beginning of the next line.
`void`	`println(float x)` Makes sure that `println` can display a `float`.
`void`	`println(float value, Color color)` Prints the given value in the given color and then advances the cursor to the beginning of the next line.
`void`	`println(int x)` Makes sure that `println` can display an `int`.
`void`	`println(int value, Color color)` Prints the given value in the given color and then advances the cursor to the beginning of the next line.
`void`	`println(long x)` Makes sure that `println` can display a `long`.
`void`	`println(long value, Color color)` Prints the given value in the given color and then advances the cursor to the beginning of the next line.
`void`	`println(Object x)` Makes sure that `println` can display an `Object`.
`void`	`println(Object value, Color color)` Prints the given value in the given color and then advances the cursor to the beginning of the next line.
`void`	`println(String value)` Displays the argument value on the console and then advances the cursor to the beginning of the next line.
`void`	`println(String value, Color color)` Prints the given string in the given color and then advances the cursor to the beginning of the next line.
`String`	`prompt(String prompt)` Pops up a dialog box displaying the given message and asking the user to type a response.
`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`	`removeFromRegion(Component comp, String region)` Removes the specified component from the specified region of this program window.
`void`	`removeMenuBar()` Removes the JMenuBar at the top of the program window.
`void`	`removeUpdate(DocumentEvent e)` Required method of DocumentListener interface.
`void`	`repaint()` Forwards repaint to the content pane.
`void`	`run()` Specifies the code to be executed as the program runs.
`protected void`	`runHook()` Calls the run method in the program.
`void`	`saveConfiguration()` Saves configuration of this program to disk.
`protected void`	`saveConfiguration(Properties props)` Saves configuration of this program to disk in the given properties collection.
`void`	`setAnimated(boolean value)` Sets the program to be in animated (true) or non-animated (false) mode.
`void`	`setAnimationDelay(int delayMS)` Sets the number of milliseconds to delay between frames of animation.
`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`	`setBottomY(double y)` Sets the y location of the bottom of this program.
`void`	`setCenterLocation(double x, double y)` Sets the y location of the horizontal and vertical center of this program.
`void`	`setCenterX(double x)` Sets the x location of the horizontal center of this program.
`void`	`setCenterY(double y)` Sets the y location of the vertical center of this program.
`void`	`setConsole(IOConsole console)` Sets the console associated with this program.
`void`	`setDialog(acm.io.IODialog dialog)` Sets the dialog associated with this program.
`void`	`setExitOnClose(boolean exitOnClose)` Sets whether the program will exit when its window is closed (default true).
`void`	`setFramesPerSecond(int fps)` Sets the animation delay properly to produce the given number of frames per second of animation.
`void`	`setHeight(double height)` Sets the height of this program without changing its width.
`void`	`setInputModel(acm.io.IOModel io)` Sets the input model associated with this program.
`void`	`setInvisible(GObject obj, boolean invisible)` Marks the given GObject as being 'invisible'.
`void`	`setJFrame(JFrame jframe)` Sets the Java Swing window frame that encloses this program.
`void`	`setJMenuBar(JMenuBar bar)` Sets the JMenuBar at the top of the program window to be the given menu bar.
`void`	`setLayout(LayoutManager layout)` Sets the layout manager for the central region of the content pane.
`void`	`setLocation(double x, double y)` Sets the (x, y) location of the top-left corner of this program.
`void`	`setLocation(GPoint point)` Sets the (x, y) location of the top-left corner of this program.
`void`	`setOutputColor(Color color)` Sets the current output color used to display output on the console.
`void`	`setOutputModel(acm.io.IOModel io)` Sets the output model associated with this program.
`void`	`setParameter(String name, String value)` Sets a new value for the named parameter.
`void`	`setParameterTable(Map<String,String> ht)` Sets the parameter table for this program.
`void`	`setPauseScaleFactor(double factor)` Applies a scaling factor to the duration of pause() calls.
`void`	`setResizable(boolean resizable)` Sets the title of this program.
`void`	`setRightX(double x)` Sets the x location of the right edge of this program.
`void`	`setShowPixelGrid(boolean show)` Sets whether to display a grid of horizontal and vertical lines on this canvas for debugging, if this program contains a graphical canvas.
`void`	`setShowPixelInfo(boolean show)` Sets whether to display information on this canvas about the current pixel where the mouse pointer is resting in this program's graphical canvas, if this program contains a graphical canvas.
`void`	`setSize(double width, double height)` Sets the width and height of this program.
`void`	`setStartupObject(Object obj)` Sets the object that is created when the program is started so that it can be retrieved later by `getStartupObject`.
`void`	`setTitle(String title)` Sets the title of this program.
`void`	`setWidth(double width)` Sets the width of this program without changing its height.
`void`	`setX(double x)` Sets the x location of the top-left corner of this program.
`void`	`setY(double y)` Sets the y location of the top-left corner of this program.
`void`	`showErrorMessage(String msg)` Displays the error message in the standard output model.
`void`	`start()` Starts the program when it is running in application mode.
`void`	`start(String[] args)` Starts the program using the specified argument list.
`void`	`startAnimation()` Sets the program into animated mode.
`protected void`	`startHook()` Performs class-specific initialization for the program just before it starts.
`protected void`	`startRun()` Initializes and runs the run method.
`void`	`stateChanged(ChangeEvent event)` Required method of ChangeListener interface.
`void`	`stopAnimation()` Sets the program into non-animated (default) mode.
`void`	`textValueChanged(TextEvent e)` Required method of TextListener interface.
`void`	`validate()` Forwards validate to the content pane.
`void`	`valueChanged(ListSelectionEvent e)` Required method of ListSelectionListener interface.
`void`	`windowActivated(WindowEvent event)` Required empty method of WindowListener interface.
`void`	`windowClosed(WindowEvent event)` Required empty method of WindowListener interface.
`void`	`windowClosing(WindowEvent event)` Required empty method of WindowListener interface.
`void`	`windowDeactivated(WindowEvent event)` Required empty method of WindowListener interface.
`void`	`windowDeiconified(WindowEvent event)` Required empty method of WindowListener interface.
`void`	`windowGainedFocus(WindowEvent e)` Required empty method of WindowFocusListener interface.
`void`	`windowIconified(WindowEvent event)` Required empty method of WindowListener interface.
`void`	`windowLostFocus(WindowEvent e)` Required empty method of WindowFocusListener interface.
`void`	`windowOpened(WindowEvent event)` Required empty method of WindowListener interface.
`void`	`windowStateChanged(WindowEvent e)` Required empty method of WindowStateListener interface.

Methods inherited from class javax.swing.JApplet
createRootPane, getAccessibleContext, getContentPane, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isRootPaneCheckingEnabled, paramString, repaint, setContentPane, setGlassPane, setLayeredPane, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.applet.Applet
getAppletContext, getAppletInfo, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameterInfo, isActive, isValidateRoot, newAudioClip, play, play, resize, resize, setStub, showStatus, stop

Methods inherited from class java.awt.Panel
addNotify

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getListeners, getMaximumSize, getMinimumSize, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validateTree

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, revalidate, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

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

- Field Detail
  - CONFIG_FILE_NAME
```
protected static final String CONFIG_FILE_NAME
```
    See Also:
    
    Constant Field Values
  - invisibleObjects
```
protected Set<GObject> invisibleObjects
```
- Constructor Detail
  - Program
```
protected Program()
```
    This code initializes the program data structures.
- Method Detail
  - contentsChanged
```
public void contentsChanged(ListDataEvent e)
```
    Required method of ListDataListener interface.
    
    Specified by:
    
    contentsChanged in interface ListDataListener
  - intervalAdded
```
public void intervalAdded(ListDataEvent e)
```
    Required method of ListDataListener interface.
    
    Specified by:
    
    intervalAdded in interface ListDataListener
  - intervalRemoved
```
public void intervalRemoved(ListDataEvent e)
```
    Required method of ListDataListener interface.
    
    Specified by:
    
    intervalRemoved in interface ListDataListener
  - menuCanceled
```
public void menuCanceled(MenuEvent e)
```
    Required method of MenuListener interface.
  - menuDeselected
```
public void menuDeselected(MenuEvent e)
```
    Required method of MenuListener interface.
  - menuSelected
```
public void menuSelected(MenuEvent e)
```
    Required method of MenuListener interface.
  - popupMenuCanceled
```
public void popupMenuCanceled(PopupMenuEvent e)
```
    Required method of PopupMenuListener interface.
    
    Specified by:
    
    popupMenuCanceled in interface PopupMenuListener
  - popupMenuWillBecomeInvisible
```
public void popupMenuWillBecomeInvisible(PopupMenuEvent e)
```
    Required method of PopupMenuListener interface.
    
    Specified by:
    
    popupMenuWillBecomeInvisible in interface PopupMenuListener
  - popupMenuWillBecomeVisible
```
public void popupMenuWillBecomeVisible(PopupMenuEvent e)
```
    Required method of PopupMenuListener interface.
    
    Specified by:
    
    popupMenuWillBecomeVisible in interface PopupMenuListener
  - valueChanged
```
public void valueChanged(ListSelectionEvent e)
```
    Required method of ListSelectionListener interface.
    
    Specified by:
    
    valueChanged in interface ListSelectionListener
  - actionPerformed
```
public void actionPerformed(ActionEvent e)
```
    Called when a component (typically a button) is activated.
    
    Specified by:
    
    actionPerformed in interface ActionListener
  - 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);
  - addActionListenersToButtonsOnly
```
public void addActionListenersToButtonsOnly()
```
    Adds the program as an ActionListener to every button in the structure that does not have a listener already. Also adds action listeners to other components that have action commands.
    
    Usage:
    
    addActionListeners();
  - addAllActionListeners
```
public void addAllActionListeners()
```
    Adds the program as an ActionListener to every button or component in the structure that does not have a listener already. Also adds action listeners to other components that have action commands.
    
    Usage:
    
    addAllActionListeners();
  - addExitHook
```
public void addExitHook(Object obj)
```
    Requests that the program call the exit method in the specified object before exiting.
    
    Usage:
    
    program.addExitHook(obj);
  - addImpl
```
protected void addImpl(Component comp,
                       Object constraints,
                       int index)
```
    Adds the specified component to the content pane using the specified constraints and index.
    
    Overrides:
    
    addImpl in class JApplet
  - adjustmentValueChanged
```
public void adjustmentValueChanged(AdjustmentEvent e)
```
    Required empty method of AdjustmentListener interface.
    
    Specified by:
    
    adjustmentValueChanged in interface AdjustmentListener
  - alert
```
public void alert(Object value)
```
    Pops up a dialog box displaying a string representation of the given message.
    
    Parameters:
    
    value - the value to display (its toString() method is implicitly called)
  - alert
```
public void alert(String message)
```
    Pops up a dialog box displaying the given message.
    
    Parameters:
    
    value - the value to display
  - animation
```
public void animation()
```
    Override this method to indicate what to do on every frame advance in an animated program after setAnimated(true) is called.
  - center
```
public void center()
```
    Moves this program's window to the center of the screen.
  - changedUpdate
```
public void changedUpdate(DocumentEvent e)
```
    Required method of DocumentListener interface.
    
    Specified by:
    
    changedUpdate in interface DocumentListener
  - checkCompilerFlags
```
protected void checkCompilerFlags()
```
  - checkKill
```
public void checkKill()
```
    Checks whether the program has been stopped via the killMe method. Not to be called by students.
  - checkStartupSettings
```
protected void checkStartupSettings()
```
  - componentAdded
```
public void componentAdded(ContainerEvent e)
```
    Required method of ContainerListener interface. Does nothing.
    
    Specified by:
    
    componentAdded in interface ContainerListener
  - componentHidden
```
public void componentHidden(ComponentEvent e)
```
    Required method of ComponentListener interface. Does nothing.
    
    Specified by:
    
    componentHidden in interface ComponentListener
  - componentMoved
```
public void componentMoved(ComponentEvent e)
```
    Required method of ComponentListener interface. Does nothing.
    
    Specified by:
    
    componentMoved in interface ComponentListener
  - componentRemoved
```
public void componentRemoved(ContainerEvent e)
```
    Required method of ContainerListener interface. Does nothing.
    
    Specified by:
    
    componentRemoved in interface ContainerListener
  - componentResized
```
public void componentResized(ComponentEvent e)
```
    Required method of ComponentListener interface. Does nothing.
    
    Specified by:
    
    componentResized in interface ComponentListener
  - componentShown
```
public void componentShown(ComponentEvent e)
```
    Required method of ComponentListener interface. Does nothing.
    
    Specified by:
    
    componentShown in interface ComponentListener
  - confirm
```
public boolean confirm(String question)
```
    Pops up a dialog box displaying the given message and asking the user to choose Yes or No.
    
    Parameters:
    
    value - the value to display
    
    Returns:
    
    true if user chose Yes, false if they chose No
  - 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();
  - createMenuBar
```
protected ProgramMenuBar createMenuBar()
```
    Creates a menu bar for use with the program.
    
    Returns:
    
    A menu bar for use with this Program
    
    Usage:
    
    ProgramMenuBar menuBar = createMenuBar();
    
    Noshow:
  - createParameterTable
```
protected static Map<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);
  - createProgramFrame
```
protected JFrame createProgramFrame()
```
    Creates the frame containing the program.
    
    Returns:
    
    The newly allocated Frame object
    
    Usage:
    
    Frame frame = program.createProgramFrame();
  - destroy
```
public void destroy()
```
    Called when the program has been told to destroy itself. The code here stops the main thread and any animators that have been initiated by this applet.
    
    Overrides:
    
    destroy in class Applet
    
    Usage:
    
    program.destroy();
    
    Noshow:
  - endHook
```
protected void endHook()
```
    Performs class-specific cleanup for the program just after it finishes.
    
    Noshow:
  - error
```
public void error(Exception ex)
```
    Generates an ErrorException with the given exception as its cause.
  - error
```
public void error(Exception ex,
                  String text)
```
    Generates an ErrorException with the given exception and text.
  - error
```
public void error(String text)
```
    Generates an ErrorException with the given text as its error message.
  - 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();
  - fileExists
```
protected boolean fileExists(String filename)
```
    Returns true if the given file exists within the current working directory.
    
    Parameters:
    
    filename - name of the file.
    
    Returns:
    
    true if file exists, false if not
  - fileExists
```
protected boolean fileExists(String directory,
                             String filename)
```
    Returns true if the given file exists within the given directory.
    
    Parameters:
    
    directory - directory to search for the file.
    
    filename - name of the file.
    
    Returns:
    
    true if file exists, false if not
  - fileExistsInsideJAR
```
protected boolean fileExistsInsideJAR(String filename)
```
    Returns true if the given file exists inside the app's JAR archive within the current working directory.
    
    Parameters:
    
    directory - directory to search for the file.
    
    filename - name of the file.
    
    Returns:
    
    true if file exists, false if not
  - fileExistsInsideJAR
```
protected boolean fileExistsInsideJAR(String directory,
                                      String filename)
```
    Returns true if the given file exists inside the app's JAR archive within the given directory.
    
    Parameters:
    
    directory - directory to search for the file.
    
    filename - name of the file.
    
    Returns:
    
    true if file exists, false if not
  - fileExistsOnDisk
```
protected boolean fileExistsOnDisk(String filename)
```
    Returns true if the given file exists in the current working directory.
    
    Parameters:
    
    filename - name of the file.
    
    Returns:
    
    true if file exists, false if not
  - fileExistsOnDisk
```
protected boolean fileExistsOnDisk(String directory,
                                   String filename)
```
    Returns true if the given file exists in the given directory.
    
    Parameters:
    
    directory - directory to search for the file.
    
    filename - name of the file.
    
    Returns:
    
    true if file exists, false if not
  - fileSize
```
protected int fileSize(String filename)
```
    Returns the size of the given file in bytes in the current working directory.
    
    Parameters:
    
    filename - name of the file.
    
    Returns:
    
    file size in bytes
    
    Throws:
    
    IORuntimeException - if file is not found or cannot be read
  - fileSize
```
protected int fileSize(String directory,
                       String filename)
```
    Returns the size of the given file in bytes.
    
    Parameters:
    
    directory - directory to search for the file.
    
    filename - name of the file.
    
    Returns:
    
    file size in bytes
    
    Throws:
    
    IORuntimeException - if file is not found or cannot be read
  - focusGained
```
public void focusGained(FocusEvent e)
```
    Required empty method of FocusListener interface; does nothing. Invoked when a component gains the keyboard focus.
    
    Specified by:
    
    focusGained in interface FocusListener
  - focusLost
```
public void focusLost(FocusEvent e)
```
    Required empty method of FocusListener interface; does nothing. Invoked when a component loses the keyboard focus.
    
    Specified by:
    
    focusLost in interface FocusListener
  - getAnimationDelay
```
public int getAnimationDelay()
```
    Returns the delay between frames of animation in milliseconds (default 20).
  - getAppletStub
```
protected AppletStub getAppletStub()
```
    Retrieves the applet stub.
    
    Returns:
    
    The applet stub
    
    Usage:
    
    AppletStub stub = getAppletStub();
  - 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:
  - getBoolean
```
public final boolean getBoolean()
```
    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.
    
    Returns:
    
    The value of the input interpreted as a boolean value
    
    Usage:
    
    boolean flag = program.getBoolean();
  - getBoolean
```
public boolean getBoolean(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.
    
    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);
  - getBoolean
```
public boolean getBoolean(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.
    
    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.getBoolean(prompt, trueLabel, falseLabel);
  - 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:
  - getBottomY
```
public int getBottomY()
```
    Returns the y-coordinate of the bottom of this program's window.
  - getCenterLocation
```
public acm.graphics.GDimension getCenterLocation()
```
    Returns the x/y-coordinates of the center of this program's window.
  - getCenterX
```
public int getCenterX()
```
    Returns the x-coordinate of the center of this program's window.
  - getCenterY
```
public int getCenterY()
```
    Returns the y-coordinate of the center of this program's window.
  - getCentralRegionSize
```
public Dimension getCentralRegionSize()
```
    Returns the size of the central region. If the content pane has not been validated, this method computes its preferred size by subtracting the sizes required for the side panels from the size of the entire frame.
    
    Returns:
    
    The size of the central region
  - 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();
  - getDouble
```
public double getDouble()
```
    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.
    
    Returns:
    
    The value of the input interpreted as a double
    
    Usage:
    
    double d = program.getDouble();
  - getDouble
```
public double getDouble(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.
    
    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.getDouble(low, high);
  - getDouble
```
public final double getDouble(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.
    
    Parameters:
    
    prompt - The prompt string to display to the user
    
    Returns:
    
    The value of the input interpreted as a double
    
    Usage:
    
    double d = program.getDouble(prompt);
  - getDouble
```
public double getDouble(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.
    
    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.getDouble(prompt, low, high);
  - getHeight
```
public int getHeight()
```
    Returns the height of the central region.
    
    Overrides:
    
    getHeight in class Component
    
    Returns:
    
    The height of the central region
    
    Usage:
    
    int height = getHeight();
    
    Noshow:
  - getInputModel
```
public acm.io.IOModel getInputModel()
```
    Returns the IOModel used for program input, which will ordinarily be the console.
    
    Returns:
    
    The IOModel used for program input
    
    Usage:
    
    IOModel io = program.getInputModel();
  - getInteger
```
public int getInteger()
```
    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.
    
    Returns:
    
    The value of the input interpreted as a decimal integer
    
    Usage:
    
    int n = program.getInteger();
  - getInteger
```
public int getInteger(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.
    
    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.getInteger(low, high);
  - getInteger
```
public final int getInteger(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.
    
    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.getInteger(prompt);
  - getInteger
```
public int getInteger(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.
    
    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.getInteger(prompt, low, high);
  - getJFrame
```
public JFrame getJFrame()
```
    Returns the Java Swing window frame that encloses this program. Will be null until start() has been called on the program.
    
    Returns:
    
    the window frame
  - getLayout
```
public LayoutManager getLayout()
```
    Gets the layout manager for the central region of the content pane.
    
    Overrides:
    
    getLayout in class Container
    
    Returns:
    
    The active layout manager
    
    Usage:
    
    LayoutManager layout = setLayout();
    
    Noshow:
  - getLine
```
public String getLine()
```
    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.
    
    Returns:
    
    The next line of input as a String
    
    Usage:
    
    String str = program.getLine();
  - getLine
```
public String getLine(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.
    
    Parameters:
    
    prompt - The prompt string to display to the user
    
    Returns:
    
    The next line of input as a String
    
    Usage:
    
    String str = program.getLine(prompt);
  - getMainThread
```
public Thread getMainThread()
```
    Returns the thread that is running the main program.
    
    Returns:
    
    The thread that is running the main program, if any
    
    Usage:
    
    Thread mainThread = getMainThread();
    
    Noshow:
  - getMenuBar
```
public ProgramMenuBar getMenuBar()
```
    Returns the menu bar associated with this program. Note that this menu bar cannot be set by clients, although it can be changed initially by overriding the createMenuBar factory method.
    
    Returns:
    
    The menu bar in use for this program
    
    Usage:
    
    ProgramMenuBar mbar = getMenuBar();
  - getOutputColor
```
public Color getOutputColor()
```
    Returns the current output color used to display output on the console. If it has never been explicitly set, returns a default of Color.BLACK.
  - getOutputModel
```
public acm.io.IOModel getOutputModel()
```
    Returns the IOModel used for program output, which will ordinarily be the console.
    
    Returns:
    
    The IOModel used for program output
    
    Usage:
    
    IOModel io = program.getOutputModel();
  - getParameter
```
public String getParameter(String name)
```
    Returns the parameter associated with name.
    
    Overrides:
    
    getParameter in class Applet
    
    Parameters:
    
    name - The name of the parameter
    
    Returns:
    
    The value associated with the parameter, or null if none
    
    Usage:
    
    String value = getParameter(name);
    
    Noshow:
  - getParameterTable
```
protected Map<String,String> getParameterTable()
```
    Retrieves the parameter table.
    
    Returns:
    
    The parameter table
    
    Usage:
    
    ParameterTable ht = getParameterTable();
  - getPreferredSize
```
public Dimension getPreferredSize()
```
    Returns the preferred size of the content pane.
    
    Overrides:
    
    getPreferredSize in class Container
    
    Returns:
    
    The preferred size of the content pane
    
    Usage:
    
    Dimension size = getPreferredSize();
    
    Noshow:
  - 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();
  - getReal
```
public double getReal()
```
    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.
    
    Returns:
    
    The value of the input interpreted as a double
    
    Usage:
    
    double d = program.getReal();
  - getReal
```
public double getReal(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.
    
    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.getReal(low, high);
  - getReal
```
public final double getReal(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.
    
    Parameters:
    
    prompt - The prompt string to display to the user
    
    Returns:
    
    The value of the input interpreted as a double
    
    Usage:
    
    double d = program.getReal(prompt);
  - getReal
```
public double getReal(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.
    
    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.getReal(prompt, low, high);
  - 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:
  - getRightX
```
public int getRightX()
```
    Returns the x-coordinate of the right edge of this program's window.
  - getScreenHeight
```
public int getScreenHeight()
```
    Returns the height of the screen in pixels.
  - getScreenSize
```
public acm.graphics.GDimension getScreenSize()
```
    Returns the width x height of the screen in pixels.
  - getScreenWidth
```
public int getScreenWidth()
```
    Returns the width of the screen in pixels.
  - getStartupObject
```
protected Object getStartupObject()
```
    Retrieves the object that was created when this program was started if that object is something other than a Program. In the normal case of running a Program object, this method will return null.
    
    Returns:
    
    The startup object
    
    Usage:
    
    Object obj = getStartupObject();
  - 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();
  - getWidth
```
public int getWidth()
```
    Returns the width of the central region.
    
    Overrides:
    
    getWidth in class Component
    
    Returns:
    
    The width of the central region
    
    Usage:
    
    int width = getWidth();
    
    Noshow:
  - getWindow
```
public Window getWindow()
```
    Returns the Java Swing window that encloses this program.
    
    Returns:
    
    the window frame
  - 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();
  - getYesOrNo
```
public boolean getYesOrNo(String prompt)
```
    Prompts the user to answer a yes/no question and returns true if the user typed 'yes' (or anything that starts with a 'y', case-insensitively), false if the user types anything that starts with 'n', or re-prompts if the user doesn't type a 'y' or 'n' word.
    
    Returns:
    
    true if user types a 'y' word; false if user types an 'n' word
  - hasConfiguration
```
public final boolean hasConfiguration()
```
    Returns true if this program has any saved configuration stored on disk.
  - init
```
public void init()
```
    Specifies the code to be executed as 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. In general, subclasses will override init in GUI-based programs where the program simply sets up an initial state and then waits for events from the user. The run method is required for applications in which there needs to be some control thread while the program runs, as in a typical animation.
    
    Specified by:
    
    init in interface ProgramInterface
    
    Overrides:
    
    init in class Applet
    
    Usage:
    
    program.init();
  - insertUpdate
```
public void insertUpdate(DocumentEvent e)
```
    Required method of DocumentListener interface.
    
    Specified by:
    
    insertUpdate in interface DocumentListener
  - isAnimated
```
public boolean isAnimated()
```
    Returns true if the program is currently in animated mode.
  - isApplet
```
protected boolean isApplet()
```
    Returns true if this program is running as an applet in a browser.
  - 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:
  - isExitOnClose
```
public boolean isExitOnClose()
```
    Returns whether the program will exit when its window is closed (default true).
  - isInitialized
```
public boolean isInitialized()
```
    Returns true if this program's init() method has been called.
  - 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:
  - itemStateChanged
```
public void itemStateChanged(ItemEvent e)
```
    Required empty method of ItemListener interface.
    
    Specified by:
    
    itemStateChanged in interface ItemListener
  - 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
  - keyTyped
```
public void keyTyped(KeyEvent e)
```
    Called when a key is typed (i.e., pressed and released).
    
    Specified by:
    
    keyTyped in interface KeyListener
  - killMe
```
public void killMe()
```
    Instructs the program to stop/kill itself. Not to be called by students.
  - loadConfiguration
```
public final void loadConfiguration()
```
    Loads any saved configuration of this program from disk.
  - loadConfiguration
```
protected void loadConfiguration(Properties props)
```
    Loads any saved configuration of this program from disk.
    
    Parameters:
    
    props - properties to load from
  - menuAction
```
public boolean menuAction(ActionEvent event)
```
    Called whenever a program action is detected in the menu bar. Subclasses can override this method to extend the set of menu commands recognized even in the absence of a component with keyboard focus.
  - 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
  - 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
  - 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
  - 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
  - mouseWheelMoved
```
public void mouseWheelMoved(MouseWheelEvent e)
```
    Implementation of MouseWheelListener interface. This method does nothing but can be overridden.
    
    Specified by:
    
    mouseWheelMoved in interface MouseWheelListener
  - openFile
```
protected InputStream openFile(String filename)
```
    Opens the given file for reading.
    
    Parameters:
    
    filename - name of the file.
    
    Returns:
    
    stream to read file
    
    Throws:
    
    IORuntimeException - if file is not found
  - openFile
```
protected InputStream openFile(String directory,
                               String filename)
```
    Opens the given file from within the given directory.
    
    Parameters:
    
    filename - name of the file.
    
    Returns:
    
    stream to read file
    
    Throws:
    
    IORuntimeException - if file is not found
  - openFileFromDisk
```
protected InputStream openFileFromDisk(String filename)
```
    Opens the given file from within the current working directory.
    
    Parameters:
    
    filename - name of the file.
    
    Returns:
    
    stream to read file
    
    Throws:
    
    IORuntimeException - if file is not found
  - openFileFromDisk
```
protected InputStream openFileFromDisk(String directory,
                                       String filename)
```
    Opens the given file from within the given directory.
    
    Parameters:
    
    directory - directory to search for the file.
    
    filename - name of the file.
    
    Returns:
    
    stream to read file
    
    Throws:
    
    IORuntimeException - if file is not found
  - openFileFromJAR
```
protected InputStream openFileFromJAR(String filename)
```
    Opens the given file from inside the app's JAR archive.
    
    Parameters:
    
    filename - name of the file.
    
    Returns:
    
    stream to read file
    
    Throws:
    
    IORuntimeException - if file is not found
  - openFileFromJAR
```
protected InputStream openFileFromJAR(String directory,
                                      String filename)
```
    Opens the given file from within the app's JAR archive in the given directory.
    
    Parameters:
    
    directory - directory to search for the file.
    
    filename - name of the file.
    
    Returns:
    
    stream to read file
    
    Throws:
    
    IORuntimeException - if file is not found
  - pack
```
public void pack()
```
    Resizes this program to exactly fit the preferred size of its contents.
  - pause
```
public void pause(double milliseconds)
```
    Delays the calling thread for the specified time, which is expressed in milliseconds. Unlike Thread.sleep, this method never throws an exception.
    
    Specified by:
    
    pause in interface ProgramInterface
    
    Parameters:
    
    milliseconds - The sleep time in milliseconds
    
    Usage:
    
    program.pause(milliseconds);
  - pauseTick
```
public void pauseTick()
```
    Sets a 'pause tick' flag. Not to be called by students.
  - 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 void print(boolean value,
                  Color color)
```
    Prints the given value in the given color.
    
    Parameters:
    
    value - The value to print.
    
    color - The color in which to draw the value. If null, draws in black.
  - 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 void print(char value,
                  Color color)
```
    Prints the given value in the given color.
    
    Parameters:
    
    value - The value to print.
    
    color - The color in which to draw the value. If null, draws in black.
  - 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 void print(double value,
                  Color color)
```
    Prints the given value in the given color.
    
    Parameters:
    
    value - The value to print.
    
    color - The color in which to draw the value. If null, draws in black.
  - 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 void print(float value,
                  Color color)
```
    Prints the given value in the given color.
    
    Parameters:
    
    value - The value to print.
    
    color - The color in which to draw the value. If null, draws in black.
  - 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 void print(int value,
                  Color color)
```
    Prints the given value in the given color.
    
    Parameters:
    
    value - The value to print.
    
    color - The color in which to draw the value. If null, draws in black.
  - 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 void print(long value,
                  Color color)
```
    Prints the given value in the given color.
    
    Parameters:
    
    value - The value to print.
    
    color - The color in which to draw the value. If null, draws in black.
  - 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:
  - print
```
public void print(Object value,
                  Color color)
```
    Prints the given value in the given color.
    
    Parameters:
    
    value - The value to print.
    
    color - The color in which to draw the value. If null, draws in black.
  - 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 void print(String value,
                  Color color)
```
    Prints the given string in the given color.
    
    Parameters:
    
    value - The string to print.
    
    color - The color in which to draw the text. If null, draws in black.
  - 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 final void println(boolean x)
```
    Makes sure that println can display a boolean.
    
    Specified by:
    
    println in interface acm.io.IOModel
    
    Noshow:
  - println
```
public void println(boolean value,
                    Color color)
```
    Prints the given value in the given color and then advances the cursor to the beginning of the next line.
    
    Parameters:
    
    value - The value to print.
    
    color - The color in which to draw the value. If null, draws in black.
  - 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 void println(char value,
                    Color color)
```
    Prints the given value in the given color and then advances the cursor to the beginning of the next line.
    
    Parameters:
    
    value - The value to print.
    
    color - The color in which to draw the value. If null, draws in black.
  - 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 void println(double value,
                    Color color)
```
    Prints the given value in the given color and then advances the cursor to the beginning of the next line.
    
    Parameters:
    
    value - The value to print.
    
    color - The color in which to draw the value. If null, draws in black.
  - 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 void println(float value,
                    Color color)
```
    Prints the given value in the given color and then advances the cursor to the beginning of the next line.
    
    Parameters:
    
    value - The value to print.
    
    color - The color in which to draw the value. If null, draws in black.
  - 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 void println(int value,
                    Color color)
```
    Prints the given value in the given color and then advances the cursor to the beginning of the next line.
    
    Parameters:
    
    value - The value to print.
    
    color - The color in which to draw the value. If null, draws in black.
  - 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 void println(long value,
                    Color color)
```
    Prints the given value in the given color and then advances the cursor to the beginning of the next line.
    
    Parameters:
    
    value - The value to print.
    
    color - The color in which to draw the value. If null, draws in black.
  - 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:
  - println
```
public void println(Object value,
                    Color color)
```
    Prints the given value in the given color and then advances the cursor to the beginning of the next line.
    
    Parameters:
    
    value - The value to print.
    
    color - The color in which to draw the value. If null, draws in black.
  - 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 void println(String value,
                    Color color)
```
    Prints the given string in the given color and then advances the cursor to the beginning of the next line.
    
    Parameters:
    
    value - The string to print.
    
    color - The color in which to draw the text. If null, draws in black.
  - prompt
```
public String prompt(String prompt)
```
    Pops up a dialog box displaying the given message and asking the user to type a response.
    
    Parameters:
    
    value - the value to display
    
    Returns:
    
    the text that the user typed, or null if the user presses Cancel
  - 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, trueLabel, falseLabel);
  - 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);
  - 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);
  - 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);
  - remove
```
public void remove(int index)
```
    Removes the component at the specified index from the central region.
    
    Overrides:
    
    remove in class Container
    
    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.
    
    Overrides:
    
    remove in class JApplet
    
    Parameters:
    
    comp - The component to remove
    
    Usage:
    
    remove(comp);
    
    Noshow:
  - removeAll
```
public void removeAll()
```
    Removes all components from the central region.
    
    Overrides:
    
    removeAll in class Container
    
    Usage:
    
    removeAll();
    
    Noshow:
  - removeFromRegion
```
public void removeFromRegion(Component comp,
                             String region)
```
    Removes the specified component from the specified region of this program window.
  - removeMenuBar
```
public void removeMenuBar()
```
    Removes the JMenuBar at the top of the program window.
  - removeUpdate
```
public void removeUpdate(DocumentEvent e)
```
    Required method of DocumentListener interface.
    
    Specified by:
    
    removeUpdate in interface DocumentListener
  - repaint
```
public void repaint()
```
    Forwards repaint to the content pane.
    
    Overrides:
    
    repaint in class Component
    
    Usage:
    
    repaint();
    
    Noshow:
  - run
```
public void run()
```
    Specifies the code to be executed as the program runs. The run method is required for applications that have a thread of control that runs even in the absence of user actions, such as a program that uses console interation or that involves animation. GUI-based programs that operate by setting up an initial configuration and then wait for user events usually do not specify a run method and supply a new definition for init instead.
    
    Specified by:
    
    run in interface ProgramInterface
    
    Specified by:
    
    run in interface Runnable
  - runHook
```
protected void runHook()
```
    Calls the run method in the program. Subclasses can override this method to transfer control somewhere else.
  - saveConfiguration
```
public final void saveConfiguration()
```
    Saves configuration of this program to disk.
  - saveConfiguration
```
protected void saveConfiguration(Properties props)
```
    Saves configuration of this program to disk in the given properties collection.
  - setAnimated
```
public void setAnimated(boolean value)
```
    Sets the program to be in animated (true) or non-animated (false) mode.
  - setAnimationDelay
```
public void setAnimationDelay(int delayMS)
```
    Sets the number of milliseconds to delay between frames of animation. If animation is already in progress, the delay change will take effect immediately.
    
    Parameters:
    
    delayMS - delay in milliseconds (must be a positive integer)
  - 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);
  - setBackground
```
public void setBackground(Color color)
```
    Sets the background for the central region of the content pane.
    
    Overrides:
    
    setBackground in class Component
    
    Parameters:
    
    color - The new background color
    
    Usage:
    
    setBackground(color);
    
    Noshow:
  - setBottomY
```
public void setBottomY(double y)
```
    Sets the y location of the bottom of this program.
    
    Parameters:
    
    y - the y location as a pixel offset (will be rounded down to nearest integer)
  - setCenterX
```
public void setCenterX(double x)
```
    Sets the x location of the horizontal center of this program.
    
    Parameters:
    
    x - the x location as a pixel offset (will be rounded down to nearest integer)
  - setCenterY
```
public void setCenterY(double y)
```
    Sets the y location of the vertical center of this program.
    
    Parameters:
    
    y - the y location as a pixel offset (will be rounded down to nearest integer)
  - setCenterLocation
```
public void setCenterLocation(double x,
                              double y)
```
    Sets the y location of the horizontal and vertical center of this program.
    
    Parameters:
    
    x - the x location as a pixel offset (will be rounded down to nearest integer)
    
    y - the y location as a pixel offset (will be rounded down to nearest integer)
  - 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);
  - setDialog
```
public void setDialog(acm.io.IODialog dialog)
```
    Sets the dialog associated with this program.
    
    Parameters:
    
    dialog - The IODialog object used for this program
    
    Usage:
    
    program.setDialog(dialog);
  - setExitOnClose
```
public void setExitOnClose(boolean exitOnClose)
```
    Sets whether the program will exit when its window is closed (default true).
  - setFramesPerSecond
```
public void setFramesPerSecond(int fps)
```
    Sets the animation delay properly to produce the given number of frames per second of animation. Equivalent to calling setAnimationDelay(1000 / fps). Special case: If 0 fps is passed, stops the animation. Note that calling this method does not start the animation running. If animation is already in progress, the FPS change will take effect immediately.
    
    Parameters:
    
    fps - frames per second (must be a non-negative integer)
  - setHeight
```
public void setHeight(double height)
```
    Sets the height of this program without changing its width.
    
    Parameters:
    
    height - the new height, in pixels (will be rounded down to nearest integer)
  - setInputModel
```
public void setInputModel(acm.io.IOModel io)
```
    Sets the input model associated with this program.
    
    Parameters:
    
    io - The input model used for this program
    
    Usage:
    
    program.setInputModel(io);
  - setInvisible
```
public void setInvisible(GObject obj,
                         boolean invisible)
```
    Marks the given GObject as being 'invisible'. Not to be called by students.
  - setJFrame
```
public void setJFrame(JFrame jframe)
```
    Sets the Java Swing window frame that encloses this program.
    
    Parameters:
    
    jframe -
  - setJMenuBar
```
public void setJMenuBar(JMenuBar bar)
```
    Sets the JMenuBar at the top of the program window to be the given menu bar. If the menu bar passed is null, removes the menu bar.
    
    Overrides:
    
    setJMenuBar in class JApplet
  - setLayout
```
public void setLayout(LayoutManager layout)
```
    Sets the layout manager for the central region of the content pane.
    
    Overrides:
    
    setLayout in class JApplet
    
    Parameters:
    
    layout - The layout manager to use
    
    Usage:
    
    setLayout(layout);
    
    Noshow:
  - setLocation
```
public void setLocation(double x,
                        double y)
```
    Sets the (x, y) location of the top-left corner of this program.
    
    Parameters:
    
    x - the x location as a pixel offset (will be rounded down to nearest integer)
    
    y - the y location as a pixel offset (will be rounded down to nearest integer)
  - setLocation
```
public void setLocation(GPoint point)
```
    Sets the (x, y) location of the top-left corner of this program.
    
    Parameters:
    
    x - the x location as a pixel offset (will be rounded down to nearest integer)
    
    y - the y location as a pixel offset (will be rounded down to nearest integer)
  - setOutputColor
```
public void setOutputColor(Color color)
```
    Sets the current output color used to display output on the console. If null is passed, uses a default of Color.BLACK.
  - setOutputModel
```
public void setOutputModel(acm.io.IOModel io)
```
    Sets the output model associated with this program.
    
    Parameters:
    
    io - The IOModel object used as the output model
    
    Usage:
    
    program.setOutputModel(io);
  - setParameter
```
public void setParameter(String name,
                         String value)
```
    Sets a new value for the named parameter.
    
    Parameters:
    
    name - The name of the parameter
    
    value - The new value
    
    Usage:
    
    setParameter(name, value);
    
    Noshow:
  - setParameterTable
```
public void setParameterTable(Map<String,String> ht)
```
    Sets the parameter table for this program.
    
    Specified by:
    
    setParameterTable in interface ProgramInterface
    
    Parameters:
    
    ht - The parameter table
    
    Usage:
    
    setParameterTable(ht);
  - setPauseScaleFactor
```
public void setPauseScaleFactor(double factor)
```
    Applies a scaling factor to the duration of pause() calls. Not to be called by students.
  - setResizable
```
public void setResizable(boolean resizable)
```
    Sets the title of this program. The title appears in the title bar when the program is running as an application.
    
    Parameters:
    
    title - The title for this program
    
    Usage:
    
    setTitle(title);
  - setRightX
```
public void setRightX(double x)
```
    Sets the x location of the right edge of this program.
    
    Parameters:
    
    x - the x location as a pixel offset (will be rounded down to nearest integer)
  - setShowPixelGrid
```
public void setShowPixelGrid(boolean show)
```
    Sets whether to display a grid of horizontal and vertical lines on this canvas for debugging, if this program contains a graphical canvas.
  - setShowPixelInfo
```
public void setShowPixelInfo(boolean show)
```
    Sets whether to display information on this canvas about the current pixel where the mouse pointer is resting in this program's graphical canvas, if this program contains a graphical canvas. Displays the current pixel's (x, y) coordinate and color.
  - setSize
```
public void setSize(double width,
                    double height)
```
    Sets the width and height of this program.
    
    Parameters:
    
    width - the new width, in pixels (will be rounded down to nearest integer)
    
    height - the new height, in pixels (will be rounded down to nearest integer)
  - setStartupObject
```
public void setStartupObject(Object obj)
```
    Sets the object that is created when the program is started so that it can be retrieved later by getStartupObject.
    
    Specified by:
    
    setStartupObject in interface ProgramInterface
    
    Parameters:
    
    obj - The startup object
    
    Usage:
    
    setStartupObject(obj);
  - 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);
  - setWidth
```
public void setWidth(double width)
```
    Sets the width of this program without changing its height.
    
    Parameters:
    
    width - the new width, in pixels (will be rounded down to nearest integer)
  - setX
```
public void setX(double x)
```
    Sets the x location of the top-left corner of this program.
    
    Parameters:
    
    x - the x location as a pixel offset (will be rounded down to nearest integer)
    
    y - the y location as a pixel offset (will be rounded down to nearest integer)
  - setY
```
public void setY(double y)
```
    Sets the y location of the top-left corner of this program.
    
    Parameters:
    
    y - the y location as a pixel offset (will be rounded down to nearest integer)
  - 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);
  - start
```
public final void start()
```
    Starts the program when it is running in application mode. Note that this overloads the start method in Applet and therefore will be called as part of applet startup.
    
    Specified by:
    
    start in interface ProgramInterface
    
    Overrides:
    
    start in class Applet
    
    Usage:
    
    program.start();
    
    Noshow:
  - start
```
public void start(String[] args)
```
    Starts the program using the specified argument list. Note: Java back-end C++ lib programs do not call start(), so any mandatory initialization code that affects the back-end and C++ probably should not go here. Java back-end C++ programs instead use the JavaBackEnd class's main() / run() methods to construct and initialize Program objects.
    
    Specified by:
    
    start in interface ProgramInterface
    
    Parameters:
    
    args - An array of strings passed to the program
    
    Usage:
    
    program.start(args);
  - startAnimation
```
public void startAnimation()
```
    Sets the program into animated mode. The animation() method will be called repeatedly in the background.
  - startHook
```
protected void startHook()
```
    Performs class-specific initialization for the program just before it starts.
    
    Noshow:
  - startRun
```
protected void startRun()
```
    Initializes and runs the run method.
  - stateChanged
```
public void stateChanged(ChangeEvent event)
```
    Required method of ChangeListener interface.
    
    Specified by:
    
    stateChanged in interface ChangeListener
  - stopAnimation
```
public void stopAnimation()
```
    Sets the program into non-animated (default) mode. The animation() method will no longer be called repeatedly in the background.
  - textValueChanged
```
public void textValueChanged(TextEvent e)
```
    Required method of TextListener interface. Invoked when the value of the text has changed.
    
    Specified by:
    
    textValueChanged in interface TextListener
  - validate
```
public void validate()
```
    Forwards validate to the content pane.
    
    Overrides:
    
    validate in class Container
    
    Usage:
    
    validate();
    
    Noshow:
  - windowActivated
```
public void windowActivated(WindowEvent event)
```
    Required empty method of WindowListener interface.
    
    Specified by:
    
    windowActivated in interface WindowListener
  - windowClosed
```
public void windowClosed(WindowEvent event)
```
    Required empty method of WindowListener interface.
    
    Specified by:
    
    windowClosed in interface WindowListener
  - windowClosing
```
public void windowClosing(WindowEvent event)
```
    Required empty method of WindowListener interface.
    
    Specified by:
    
    windowClosing in interface WindowListener
  - windowDeactivated
```
public void windowDeactivated(WindowEvent event)
```
    Required empty method of WindowListener interface.
    
    Specified by:
    
    windowDeactivated in interface WindowListener
  - windowDeiconified
```
public void windowDeiconified(WindowEvent event)
```
    Required empty method of WindowListener interface.
    
    Specified by:
    
    windowDeiconified in interface WindowListener
  - windowGainedFocus
```
public void windowGainedFocus(WindowEvent e)
```
    Required empty method of WindowFocusListener interface. Invoked when the Window is set to be the focused Window, which means that the Window, or one of its subcomponents, will receive keyboard events.
    
    Specified by:
    
    windowGainedFocus in interface WindowFocusListener
  - windowIconified
```
public void windowIconified(WindowEvent event)
```
    Required empty method of WindowListener interface.
    
    Specified by:
    
    windowIconified in interface WindowListener
  - windowLostFocus
```
public void windowLostFocus(WindowEvent e)
```
    Required empty method of WindowFocusListener interface. Invoked when the Window is no longer the focused Window, which means that keyboard events will no longer be delivered to the Window or any of its subcomponents.
    
    Specified by:
    
    windowLostFocus in interface WindowFocusListener
  - windowOpened
```
public void windowOpened(WindowEvent event)
```
    Required empty method of WindowListener interface.
    
    Specified by:
    
    windowOpened in interface WindowListener
  - windowStateChanged
```
public void windowStateChanged(WindowEvent e)
```
    Required empty method of WindowStateListener interface. Invoked when window state is changed.
    
    Specified by:
    
    windowStateChanged in interface WindowStateListener
  - 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

Class Program

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JApplet

Nested classes/interfaces inherited from class java.applet.Applet

Nested classes/interfaces inherited from class java.awt.Panel

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JApplet

Fields inherited from class java.awt.Component

Fields inherited from interface acm.program.ProgramInterface

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JApplet

Methods inherited from class java.applet.Applet

Methods inherited from class java.awt.Panel

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

CONFIG_FILE_NAME

invisibleObjects

Constructor Detail

Program

Method Detail

contentsChanged

intervalAdded

intervalRemoved

menuCanceled

menuDeselected

menuSelected

popupMenuCanceled

popupMenuWillBecomeInvisible

popupMenuWillBecomeVisible

valueChanged

actionPerformed

add

addActionListeners

addActionListeners

addActionListenersToButtonsOnly

addAllActionListeners

addExitHook

addImpl

adjustmentValueChanged

alert

alert

animation

center

changedUpdate

checkCompilerFlags

checkKill

checkStartupSettings

componentAdded

componentHidden

componentMoved

componentRemoved

componentResized

componentShown

confirm

createConsole

createDialogIO

createMenuBar

createParameterTable

createProgramFrame

destroy

endHook

error

error

error

exit

fileExists

fileExists

fileExistsInsideJAR

fileExistsInsideJAR

fileExistsOnDisk

fileExistsOnDisk

fileSize

fileSize

focusGained