IOConsole (acm 2.1 API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - acm.io.IOConsole

All Implemented Interfaces:: IOModel, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class IOConsole
extends java.awt.Container
implements IOModel

The IOConsole class makes it easier to interact with the user using text-based input and output in the style of a traditional console. Given a IOConsole object, you can write output to that console using the print and println methods, just as you would for the standard output stream. To request input from the user, the most common methods are

readInt
readDouble
readBoolean
readLine

A IOConsole object is a lightweight component and must be added to an installed Frame or JFrame before it becomes visible on the screen. The usual strategy for including a console in a frame is to use the ConsoleProgram mechanism in the acm.program package. The operation of the IOConsole class is illustrated by the following test method, which generates the session shown on the right. The user input appears in blue, just as it does in the console window.

 
      public void test(IOConsole console) {
         console.println("IOConsole class test");
         int n = console.readInt("Enter an integer: ");
         console.println("That integer was " + n);
         double d = console.readDouble("Enter a real number: ");
         console.println("That number was " + d);
         boolean b = console.readBoolean("Enter a boolean value: ");
         console.println("That value was " + b);
         String line = console.readLine("Enter a line: ");
         console.println("That line was \"" + line + "\"");
      }

See Also:: Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.awt.Container
  java.awt.Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class java.awt.Component
  java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.awt.Font`	`DEFAULT_FONT` The default font used by a new `IOConsole`.
`protected static java.lang.String`	`LINE_SEPARATOR` The end-of-line separator for this platform.
`protected static int`	`MINIMUM_CONSOLE_HEIGHT` The minimum height for a console.
`protected static int`	`MINIMUM_CONSOLE_WIDTH` The minimum width for a console.
`static IOConsole`	`SYSTEM_CONSOLE` This constant is an object that offers the functionality of the `IOConsole` class, but which does so using the standard I/O streams `System.in` and `System.out`.

Fields inherited from class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description

IOConsole()
Creates a new IOConsole object.

Constructors
Constructor and Description
`IOConsole()` Creates a new `IOConsole` object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears the console display.
`void`	`copy()` Implements the "Copy" menu operation.
`protected acm.io.ConsoleModel`	`createConsoleModel()` Creates the console model used by this console.
`void`	`cut()` Implements the "Cut" menu operation.
`java.awt.Color`	`getErrorColor()` Returns the color currently in use for console error messages.
`int`	`getErrorStyle()` Returns the current style parameters for console error messages.
`boolean`	`getExceptionOnError()` Returns the state of the error-handling flag.
`java.awt.Color`	`getInputColor()` Returns the color currently in use for console input.
`java.io.BufferedReader`	`getInputScript()` Retrieves the input script.
`int`	`getInputStyle()` Returns the current style parameters for console input.
`ProgramMenuBar`	`getMenuBar()` Returns the menu bar that controls this console.
`java.awt.Dimension`	`getMinimumSize()` Overrides the `getMinimumSize` method to ensure that an `IOConsole` is not too large.
`java.awt.Dimension`	`getPreferredSize()` Overrides the `getPreferredSize` method to ensure that an `IOConsole` is not too large.
`java.io.BufferedReader`	`getReader()` Returns a `BufferedReader` object that can be used to read from the console.
`java.io.PrintWriter`	`getWriter()` Returns a `PrintWriter` object that can be used to send output to the console.
`boolean`	`isConsoleMenuItem(javax.swing.JMenuItem item)` Returns `true` if the item is one that the console recognizes.
`boolean`	`menuAction(java.awt.event.ActionEvent e)` Called whenever a relevant action is detected in the menu bar.
`void`	`paste()` Implements the "Paste" menu operation.
`void`	`print(boolean x)` Makes sure that `print` can display a `boolean`.
`void`	`print(char x)` Makes sure that `print` can display a `char`.
`void`	`print(double x)` Makes sure that `print` can display a `double`.
`void`	`print(float x)` Makes sure that `print` can display a `float`.
`void`	`print(int x)` Makes sure that `print` can display an `int`.
`void`	`print(long x)` Makes sure that `print` can display a `long`.
`void`	`print(java.lang.Object x)` Makes sure that `print` can display an `Object`.
`void`	`print(java.lang.String value)` Displays the argument value on the console, leaving the cursor at the end of the output.
`void`	`printConsole()` Implements the "Print Console" menu operation.
`void`	`printConsole(java.awt.PrintJob pj)` Prints the console output using the specified `PrintJob` object.
`void`	`println()` Advances the console cursor to the beginning of the next line.
`void`	`println(boolean x)` Makes sure that `println` can display a `boolean`.
`void`	`println(char x)` Makes sure that `println` can display a `char`.
`void`	`println(double x)` Makes sure that `println` can display a `double`.
`void`	`println(float x)` Makes sure that `println` can display a `float`.
`void`	`println(int x)` Makes sure that `println` can display an `int`.
`void`	`println(long x)` Makes sure that `println` can display a `long`.
`void`	`println(java.lang.Object x)` Makes sure that `println` can display an `Object`.
`void`	`println(java.lang.String value)` Displays the argument value on the console and then advances the cursor to the beginning of the next line.
`boolean`	`readBoolean()` Reads and returns a boolean value from the user, which must match either `true` or `false`, ignoring case.
`boolean`	`readBoolean(java.lang.String prompt)` Prompts the user to enter a boolean value, which is then returned as the value of this method.
`boolean`	`readBoolean(java.lang.String prompt, java.lang.String trueLabel, java.lang.String falseLabel)` Prompts the user to enter a value, which is interpreted as a boolean value by matching it against the `trueLabel` and `falseLabel` parameters.
`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(java.lang.String prompt)` Prompts the user to enter an double-precision number, which is then returned as the value of this method.
`double`	`readDouble(java.lang.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(java.lang.String prompt)` Prompts the user to enter an integer, which is then returned as the value of this method.
`int`	`readInt(java.lang.String prompt, int low, int high)` Prompts the user to enter an integer, which is then returned as the value of this method.
`java.lang.String`	`readLine()` Reads and returns a line of input from the console, without including the end-of-line characters that terminate the input.
`java.lang.String`	`readLine(java.lang.String prompt)` Prompts the user to enter a line of text, which is then returned as the value of this method.
`void`	`requestFocus()` Overrides the `requestFocus` method so that it forwards to the console model.
`void`	`save()` Implements the "Save" menu operation.
`void`	`save(java.io.Writer wr)` Copies the console output to the specified writer.
`void`	`saveAs()` Implements the "Save As" menu operation.
`void`	`script()` Implements the "Script" menu operation.
`void`	`selectAll()` Implements the "Select All" menu operation.
`void`	`setBackground(java.awt.Color color)` Sets the background color used for the console.
`void`	`setErrorColor(java.awt.Color color)` Sets the color used for console error messages.
`void`	`setErrorStyle(int style)` Sets the style parameters for console error messages.
`void`	`setExceptionOnError(boolean flag)` Sets the error-handling mode of the console as specified by the `flag` parameter.
`void`	`setFont(java.awt.Font font)` Sets the font for the console.
`void`	`setFont(java.lang.String str)` Sets the font used for the console as specified by the string `str`, which is interpreted in the style of `Font.decode`.
`void`	`setForeground(java.awt.Color color)` Sets the foreground color used for the output text.
`void`	`setInputColor(java.awt.Color color)` Sets the color used for console input.
`void`	`setInputScript(java.io.BufferedReader rd)` Sets a new input script for the console, which will subsequently take input from the specified reader.
`void`	`setInputStyle(int style)` Sets the style parameters for console input.
`void`	`setMenuBar(ProgramMenuBar mbar)` Sets the menu bar that controls this console.
`void`	`showErrorMessage(java.lang.String msg)` Displays the error message on the console.
`void`	`updateMenuBar(ProgramMenuBar mbar)` Updates the menu bar to enable the appropriate menu items.

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, isValidateRoot, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, update, validate, 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, getAccessibleContext, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, 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, repaint, repaint, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, revalidate, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, 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
  - SYSTEM_CONSOLE
```
public static final IOConsole SYSTEM_CONSOLE
```
    This constant is an object that offers the functionality of the IOConsole class, but which does so using the standard I/O streams System.in and System.out.
  - DEFAULT_FONT
```
protected static final java.awt.Font DEFAULT_FONT
```
    The default font used by a new IOConsole.
  - LINE_SEPARATOR
```
protected static final java.lang.String LINE_SEPARATOR
```
    The end-of-line separator for this platform.
  - MINIMUM_CONSOLE_WIDTH
```
protected static final int MINIMUM_CONSOLE_WIDTH
```
    The minimum width for a console.
    
    See Also:
    
    Constant Field Values
  - MINIMUM_CONSOLE_HEIGHT
```
protected static final int MINIMUM_CONSOLE_HEIGHT
```
    The minimum height for a console.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IOConsole
```
public IOConsole()
```
    Creates a new IOConsole object.
- Method Detail
  - clear
```
public void clear()
```
    Clears the console display.
  - print
```
public void print(java.lang.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 IOModel
    
    Parameters:
    
    value - The value to be displayed
  - print
```
public final void print(boolean x)
```
    Makes sure that print can display a boolean.
    
    Specified by:
    
    print in interface IOModel
  - print
```
public final void print(char x)
```
    Makes sure that print can display a char.
    
    Specified by:
    
    print in interface IOModel
  - print
```
public final void print(double x)
```
    Makes sure that print can display a double.
    
    Specified by:
    
    print in interface IOModel
  - print
```
public final void print(float x)
```
    Makes sure that print can display a float.
    
    Specified by:
    
    print in interface IOModel
  - print
```
public final void print(int x)
```
    Makes sure that print can display an int.
    
    Specified by:
    
    print in interface IOModel
  - print
```
public final void print(long x)
```
    Makes sure that print can display a long.
    
    Specified by:
    
    print in interface IOModel
  - print
```
public final void print(java.lang.Object x)
```
    Makes sure that print can display an Object.
    
    Specified by:
    
    print in interface IOModel
  - println
```
public void println()
```
    Advances the console cursor to the beginning of the next line.
    
    Specified by:
    
    println in interface IOModel
  - println
```
public void println(java.lang.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 IOModel
    
    Parameters:
    
    value - The value to be displayed
  - println
```
public final void println(boolean x)
```
    Makes sure that println can display a boolean.
    
    Specified by:
    
    println in interface IOModel
  - println
```
public final void println(char x)
```
    Makes sure that println can display a char.
    
    Specified by:
    
    println in interface IOModel
  - println
```
public final void println(double x)
```
    Makes sure that println can display a double.
    
    Specified by:
    
    println in interface IOModel
  - println
```
public final void println(float x)
```
    Makes sure that println can display a float.
    
    Specified by:
    
    println in interface IOModel
  - println
```
public final void println(int x)
```
    Makes sure that println can display an int.
    
    Specified by:
    
    println in interface IOModel
  - println
```
public final void println(long x)
```
    Makes sure that println can display a long.
    
    Specified by:
    
    println in interface IOModel
  - println
```
public final void println(java.lang.Object x)
```
    Makes sure that println can display an Object.
    
    Specified by:
    
    println in interface IOModel
  - showErrorMessage
```
public void showErrorMessage(java.lang.String msg)
```
    Displays the error message on the console.
    
    Specified by:
    
    showErrorMessage in interface IOModel
    
    Parameters:
    
    msg - The error msg to be displayed
  - readLine
```
public final java.lang.String readLine()
```
    Reads and returns a line of input from the console, without including the end-of-line characters that terminate the input.
    
    Specified by:
    
    readLine in interface IOModel
    
    Returns:
    
    The next line of input as a String
  - readLine
```
public java.lang.String readLine(java.lang.String prompt)
```
    Prompts the user to enter a line of text, which is then returned as the value of this method. The end-of-line characters that terminate the input are not included in the returned string.
    
    Specified by:
    
    readLine in interface IOModel
    
    Parameters:
    
    prompt - The prompt string to display to the user
    
    Returns:
    
    The next line of input as a String
  - 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 IOModel
    
    Returns:
    
    The value of the input interpreted as a decimal integer
  - 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 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
  - readInt
```
public final int readInt(java.lang.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 IOModel
    
    Parameters:
    
    prompt - The prompt string to display to the user
    
    Returns:
    
    The value of the input interpreted as a decimal integer
  - readInt
```
public int readInt(java.lang.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 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
  - 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 IOModel
    
    Returns:
    
    The value of the input interpreted as a double
  - 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 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
  - readDouble
```
public final double readDouble(java.lang.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 IOModel
    
    Parameters:
    
    prompt - The prompt string to display to the user
    
    Returns:
    
    The value of the input interpreted as a double
  - readDouble
```
public double readDouble(java.lang.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 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
  - readBoolean
```
public final boolean readBoolean()
```
    Reads and returns a boolean value from the user, which must match either true or false, 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 IOModel
    
    Returns:
    
    The value of the input interpreted as a boolean value
  - readBoolean
```
public final boolean readBoolean(java.lang.String prompt)
```
    Prompts the user to enter a boolean value, which is then 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 IOModel
    
    Parameters:
    
    prompt - The prompt string to display to the user
    
    Returns:
    
    The value of the input interpreted as a boolean value
  - readBoolean
```
public boolean readBoolean(java.lang.String prompt,
                           java.lang.String trueLabel,
                           java.lang.String falseLabel)
```
    Prompts the user to enter a value, which is interpreted as a boolean value by matching it against the trueLabel and falseLabel parameters. If the user types 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 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
  - getReader
```
public java.io.BufferedReader getReader()
```
    Returns a BufferedReader object that can be used to read from the console.
    
    Returns:
    
    A BufferedReader that reads from this console
  - getWriter
```
public java.io.PrintWriter getWriter()
```
    Returns a PrintWriter object that can be used to send output to the console.
    
    Returns:
    
    A PrintWriter that writes to this console
  - setExceptionOnError
```
public void setExceptionOnError(boolean flag)
```
    Sets the error-handling mode of the console as specified by the flag parameter. If flag is false (which is the default), the input methods give the user a chance to retry after erroneous input. If this value is set to true, illegal input raises an ErrorException instead.
    
    Parameters:
    
    flag - false to retry on errors; true to raise an exception
  - getExceptionOnError
```
public boolean getExceptionOnError()
```
    Returns the state of the error-handling flag.
    
    Returns:
    
    The current setting of the error-handling mode (false to retry on errors; true to raise an exception)
  - setInputStyle
```
public void setInputStyle(int style)
```
    Sets the style parameters for console input. The style parameter is either Font.PLAIN or a sum of one or more of the attributes Font.BOLD and Font.ITALIC.
    
    Parameters:
    
    style - The style attributes to be used for console input
  - getInputStyle
```
public int getInputStyle()
```
    Returns the current style parameters for console input.
    
    Returns:
    
    The current input style
  - setInputColor
```
public void setInputColor(java.awt.Color color)
```
    Sets the color used for console input.
    
    Parameters:
    
    color - The color used for console input
  - getInputColor
```
public java.awt.Color getInputColor()
```
    Returns the color currently in use for console input.
    
    Returns:
    
    The current input color
  - setErrorStyle
```
public void setErrorStyle(int style)
```
    Sets the style parameters for console error messages. The style parameter is either Font.PLAIN or a sum of one or more of the attributes Font.BOLD and Font.ITALIC.
    
    Parameters:
    
    style - The style attributes to be used for console error messages
  - getErrorStyle
```
public int getErrorStyle()
```
    Returns the current style parameters for console error messages.
    
    Returns:
    
    The current error message style
  - setErrorColor
```
public void setErrorColor(java.awt.Color color)
```
    Sets the color used for console error messages.
    
    Parameters:
    
    color - The color used for console error messages
  - getErrorColor
```
public java.awt.Color getErrorColor()
```
    Returns the color currently in use for console error messages.
    
    Returns:
    
    The current error message color
  - setFont
```
public void setFont(java.lang.String str)
```
    Sets the font used for the console as specified by the string str, which is interpreted in the style of Font.decode. The usual format of the font string is
    family-style-size
    where both style and size are optional. If any of these parts are specified as an asterisk, the existing value is retained.
    
    Parameters:
    
    str - A String specifying the new font
  - setInputScript
```
public void setInputScript(java.io.BufferedReader rd)
```
    Sets a new input script for the console, which will subsequently take input from the specified reader. When the input from the reader has been exhausted, the console returns to its normal operation. This method is primarily useful for demonstrations and test suites, and is not ordinarily invoked by students.
    
    Parameters:
    
    rd - The reader from which console input is taken
  - getInputScript
```
public java.io.BufferedReader getInputScript()
```
    Retrieves the input script. After the end of the input script has been reached, this method will return null.
    
    Returns:
    
    The reader representing the current input script
  - cut
```
public void cut()
```
    Implements the "Cut" menu operation.
  - copy
```
public void copy()
```
    Implements the "Copy" menu operation.
  - paste
```
public void paste()
```
    Implements the "Paste" menu operation.
  - selectAll
```
public void selectAll()
```
    Implements the "Select All" menu operation.
  - save
```
public void save()
```
    Implements the "Save" menu operation.
  - saveAs
```
public void saveAs()
```
    Implements the "Save As" menu operation.
  - save
```
public void save(java.io.Writer wr)
```
    Copies the console output to the specified writer.
    
    Parameters:
    
    wr - A Writer to which the console output is sent
  - printConsole
```
public void printConsole()
```
    Implements the "Print Console" menu operation.
  - printConsole
```
public void printConsole(java.awt.PrintJob pj)
```
    Prints the console output using the specified PrintJob object. This method is usually invoked from the Print menu item in the ProgramMenuBar class and is not ordinarily called by clients.
    
    Parameters:
    
    pj - PrintJob object to which the output is sent
  - script
```
public void script()
```
    Implements the "Script" menu operation.
  - setMenuBar
```
public void setMenuBar(ProgramMenuBar mbar)
```
    Sets the menu bar that controls this console.
    
    Parameters:
    
    mbar - The menu bar
  - getMenuBar
```
public ProgramMenuBar getMenuBar()
```
    Returns the menu bar that controls this console.
    
    Returns:
    
    The menu bar
  - menuAction
```
public boolean menuAction(java.awt.event.ActionEvent e)
```
    Called whenever a relevant action is detected in the menu bar. Subclasses can override this method to extend the set of menu commands recognized by the console.
  - isConsoleMenuItem
```
public boolean isConsoleMenuItem(javax.swing.JMenuItem item)
```
    Returns true if the item is one that the console recognizes.
  - updateMenuBar
```
public void updateMenuBar(ProgramMenuBar mbar)
```
    Updates the menu bar to enable the appropriate menu items.
  - setBackground
```
public void setBackground(java.awt.Color color)
```
    Sets the background color used for the console.
    
    Overrides:
    
    setBackground in class java.awt.Component
    
    Parameters:
    
    color - The new background color
  - setForeground
```
public void setForeground(java.awt.Color color)
```
    Sets the foreground color used for the output text.
    
    Overrides:
    
    setForeground in class java.awt.Component
    
    Parameters:
    
    color - The color to use for the output text
  - setFont
```
public void setFont(java.awt.Font font)
```
    Sets the font for the console.
    
    Overrides:
    
    setFont in class java.awt.Container
    
    Parameters:
    
    font - The font to use for the console
  - requestFocus
```
public void requestFocus()
```
    Overrides the requestFocus method so that it forwards to the console model.
    
    Overrides:
    
    requestFocus in class java.awt.Component
  - getPreferredSize
```
public java.awt.Dimension getPreferredSize()
```
    Overrides the getPreferredSize method to ensure that an IOConsole is not too large.
    
    Overrides:
    
    getPreferredSize in class java.awt.Container
  - getMinimumSize
```
public java.awt.Dimension getMinimumSize()
```
    Overrides the getMinimumSize method to ensure that an IOConsole is not too large.
    
    Overrides:
    
    getMinimumSize in class java.awt.Container
  - createConsoleModel
```
protected acm.io.ConsoleModel createConsoleModel()
```
    Creates the console model used by this console.

Class IOConsole

Nested Class Summary

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

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

Field Summary

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

SYSTEM_CONSOLE

DEFAULT_FONT

LINE_SEPARATOR

MINIMUM_CONSOLE_WIDTH

MINIMUM_CONSOLE_HEIGHT

Constructor Detail

IOConsole

Method Detail

clear

print

print

print

print

print

print

print

print

println

println

println

println

println

println

println

println

println

showErrorMessage

readLine

readLine

readInt

readInt

readInt

readInt

readDouble

readDouble

readDouble

readDouble

readBoolean

readBoolean

readBoolean

getReader

getWriter

setExceptionOnError

getExceptionOnError

setInputStyle

getInputStyle

setInputColor

getInputColor

setErrorStyle

getErrorStyle

setErrorColor

getErrorColor

setFont

setInputScript

getInputScript

cut

copy

paste

selectAll

save

saveAs

save

printConsole

printConsole

script

setMenuBar

getMenuBar