acm.program

Class AbstractConsoleProgram

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Panel

java.applet.Applet

javax.swing.JApplet

acm.program.Program

acm.program.AbstractConsoleProgram

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:

ConsoleProgram

public abstract class AbstractConsoleProgram
extends Program

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	PROGRAM_COMPLETED_TITLE_SUFFIX

Fields inherited from class acm.program.Program

CONFIG_FILE_NAME, 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

Constructor Summary

Constructors

Constructor and Description
AbstractConsoleProgram()

Method Summary

Modifier and Type	Method and Description
protected void	checkCompilerFlags()
void	clearConsole() Erases any text from the main console.
protected void	compareOutput() Pops up a file chooser to compare output to some expected output.
protected void	endHook() Called as the program is shutting down.
void	fontEnlarge() Makes the console's font larger by 2pt.
void	fontShrink() Makes the console's font smaller by 2pt.
void	fontToggleBold() Makes the console's font toggle between bold and non-bold.
String	getAllOutput() Returns all text that has been displayed on this console so far.
Font	getFont() Returns the font currently used in the console.
void	historyDown() Retrieves the next command in the console input history.
void	historyUp() Retrieves the previous command in the console input history.
protected void	loadConfiguration(Properties props) Reads the console's configuration settings, if present.
protected void	loadInputScript() Pops up a file chooser to compare output to some expected output.
boolean	menuAction(ActionEvent event) Responds to menu clicks.
void	mouseWheelMoved(MouseWheelEvent e) Implementation of MouseWheelListener interface.
String	promptUserForFile(String prompt) Asks the user to type a file name, re-prompting until the user types a file that exists in the current directory.
String	promptUserForFile(String prompt, String directory) Asks the user to type a file name, re-prompting until the user types a file that exists in the given directory.
String	promptUserForFile(String prompt, String directory, String reprompt) Asks the user to type a file name, re-prompting until the user types a file that exists in the given directory.
protected void	saveConfiguration(Properties props) Writes the console's configuration settings to disk.
void	scrollLineDown() Tells the console's output area to scroll itself downward by one line.
void	scrollLineUp() Tells the console's output area to scroll itself upward by one line.
void	scrollPageDown() Tells the console's output area to scroll itself downward by one page.
void	scrollPageUp() Tells the console's output area to scroll itself upward by one page.
void	scrollToBottom() Tells the console's output area to scroll itself to the bottom of the output.
void	scrollToTop() Tells the console's output area to scroll itself to the top of the output.
void	setClearConsoleEnabled(boolean enabled) Turns on/off the ability to clear the console using clearConsole(); (default true)
protected void	setColorFromChooser(boolean background) Pops up a JColorChooser to let the user pick a color for the console.
void	setFont(Font font) Sets the font for the console.
void	setFont(String str) Sets the font used for the console as specified by the string str, which is interpreted in the style of Font.decode.
protected void	setFontFromChooser() Pops up a JFontChooser to let the user pick a font for the console.

Methods inherited from class acm.program.Program

actionPerformed, add, addActionListeners, addActionListeners, addActionListenersToButtonsOnly, addAllActionListeners, addExitHook, addImpl, adjustmentValueChanged, alert, alert, animation, center, changedUpdate, checkKill, checkStartupSettings, componentAdded, componentHidden, componentMoved, componentRemoved, componentResized, componentShown, confirm, contentsChanged, createConsole, createDialogIO, createMenuBar, createParameterTable, createProgramFrame, destroy, error, error, error, exit, fileExists, fileExists, fileExistsInsideJAR, fileExistsInsideJAR, fileExistsOnDisk, fileExistsOnDisk, fileSize, fileSize, focusGained, focusLost, getAnimationDelay, getAppletStub, getArgumentArray, getBoolean, getBoolean, getBoolean, getBorder, getBottomY, getCenterLocation, getCenterX, getCenterY, getCentralRegionSize, getConsole, getDialog, getDouble, getDouble, getDouble, getDouble, getHeight, getInputModel, getInteger, getInteger, getInteger, getInteger, getJFrame, getLayout, getLine, getLine, getMainThread, getMenuBar, getOutputColor, getOutputModel, getParameter, getParameterTable, getPreferredSize, getReader, getReal, getReal, getReal, getReal, getRegionPanel, getRightX, getScreenHeight, getScreenSize, getScreenWidth, getStartupObject, getTitle, getWidth, getWindow, getWriter, getYesOrNo, hasConfiguration, init, insertUpdate, intervalAdded, intervalRemoved, isAnimated, isApplet, isAppletMode, isExitOnClose, isInitialized, isStarted, itemStateChanged, keyPressed, keyReleased, keyTyped, killMe, loadConfiguration, main, menuCanceled, menuDeselected, menuSelected, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, openFile, openFile, openFileFromDisk, openFileFromDisk, openFileFromJAR, openFileFromJAR, pack, pause, pauseTick, popupMenuCanceled, popupMenuWillBecomeInvisible, popupMenuWillBecomeVisible, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, print, printf, println, println, println, println, println, println, println, println, println, println, println, println, println, println, println, println, println, prompt, readBoolean, readBoolean, readBoolean, readDouble, readDouble, readDouble, readDouble, readInt, readInt, readInt, readInt, readLine, readLine, remove, remove, removeAll, removeFromRegion, removeMenuBar, removeUpdate, repaint, run, runHook, saveConfiguration, setAnimated, setAnimationDelay, setAppletStub, setBackground, setBottomY, setCenterLocation, setCenterX, setCenterY, setConsole, setDialog, setExitOnClose, setFramesPerSecond, setHeight, setInputModel, setInvisible, setJFrame, setJMenuBar, setLayout, setLocation, setLocation, setOutputColor, setOutputModel, setParameter, setParameterTable, setPauseScaleFactor, setResizable, setRightX, setShowPixelGrid, setShowPixelInfo, setSize, setStartupObject, setTitle, setWidth, setX, setY, showErrorMessage, start, start, startAnimation, startHook, startRun, stateChanged, stopAnimation, textValueChanged, validate, valueChanged, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowGainedFocus, windowIconified, windowLostFocus, windowOpened, windowStateChanged

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, 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, 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

PROGRAM_COMPLETED_TITLE_SUFFIX

protected static final String PROGRAM_COMPLETED_TITLE_SUFFIX

See Also:

Constant Field Values

Constructor Detail

AbstractConsoleProgram

public AbstractConsoleProgram()

Method Detail

checkCompilerFlags

protected void checkCompilerFlags()

Overrides:

checkCompilerFlags in class Program

clearConsole

public void clearConsole()

Erases any text from the main console.

compareOutput

protected void compareOutput()

Pops up a file chooser to compare output to some expected output.

endHook

protected void endHook()

Called as the program is shutting down. Puts [terminated] on the console window title.

Overrides:

endHook in class Program

loadInputScript

protected void loadInputScript()

Pops up a file chooser to compare output to some expected output.

fontEnlarge

public void fontEnlarge()

Makes the console's font larger by 2pt.

fontShrink

public void fontShrink()

Makes the console's font smaller by 2pt.

fontToggleBold

public void fontToggleBold()

Makes the console's font toggle between bold and non-bold.

getAllOutput

public String getAllOutput()

Returns all text that has been displayed on this console so far.

getFont

public Font getFont()

Returns the font currently used in the console.

Specified by:

getFont in interface MenuContainer

Overrides:

getFont in class Component

historyDown

public void historyDown()

Retrieves the next command in the console input history.

historyUp

public void historyUp()

Retrieves the previous command in the console input history.

loadConfiguration

protected void loadConfiguration(Properties props)

Reads the console's configuration settings, if present.

Overrides:

loadConfiguration in class Program

Parameters:

props - properties to load from

menuAction

public boolean menuAction(ActionEvent event)

Responds to menu clicks.

Overrides:

menuAction in class Program

mouseWheelMoved

public void mouseWheelMoved(MouseWheelEvent e)

Implementation of MouseWheelListener interface. When you Ctrl-wheel or Command-wheel, the font will grow or shrink.

Specified by:

mouseWheelMoved in interface MouseWheelListener

Overrides:

mouseWheelMoved in class Program

promptUserForFile

public String promptUserForFile(String prompt)

Asks the user to type a file name, re-prompting until the user types a file that exists in the current directory. The message "Unable to open that file. Try again." is shown every time a reprompt is necessary. The file's full path is returned as a string.

Parameters:

prompt - the text to display to the user

directory - the working directory in which to look for files (e.g. "res/")

Returns:

the file name typed by the user, including any directory prefix, such as "res/input.txt" or "foo.dat"

promptUserForFile

public String promptUserForFile(String prompt,
                                String directory)

Asks the user to type a file name, re-prompting until the user types a file that exists in the given directory. The message "Unable to open that file. Try again." is shown every time a reprompt is necessary. The file's full path is returned as a string.

Parameters:

prompt - the text to display to the user

directory - the working directory in which to look for files (e.g. "res/")

Returns:

the file name typed by the user, including any directory prefix, such as "res/input.txt" or "foo.dat"

promptUserForFile

public String promptUserForFile(String prompt,
                                String directory,
                                String reprompt)

Asks the user to type a file name, re-prompting until the user types a file that exists in the given directory. The given reprompt message is shown every time a reprompt is necessary. The file's full path is returned as a string.

Parameters:

prompt - the text to display to the user

directory - the working directory in which to look for files (e.g. "res/")

Returns:

the file name typed by the user, including any directory prefix, such as "res/input.txt" or "foo.dat"

setClearConsoleEnabled

public void setClearConsoleEnabled(boolean enabled)

Turns on/off the ability to clear the console using clearConsole(); (default true)

Parameters:

enabled - Whether to enable clearConsole();

saveConfiguration

protected void saveConfiguration(Properties props)

Writes the console's configuration settings to disk.

Overrides:

saveConfiguration in class Program

scrollLineDown

public void scrollLineDown()

Tells the console's output area to scroll itself downward by one line.

scrollLineUp

public void scrollLineUp()

Tells the console's output area to scroll itself upward by one line.

scrollPageDown

public void scrollPageDown()

Tells the console's output area to scroll itself downward by one page.

scrollPageUp

public void scrollPageUp()

Tells the console's output area to scroll itself upward by one page.

scrollToTop

public void scrollToTop()

Tells the console's output area to scroll itself to the top of the output.

scrollToBottom

public void scrollToBottom()

Tells the console's output area to scroll itself to the bottom of the output.

setColorFromChooser

protected void setColorFromChooser(boolean background)

Pops up a JColorChooser to let the user pick a color for the console.

setFont

public void setFont(Font font)

Sets the font for the console.

Overrides:

setFont in class Container

Parameters:

font - The new font

Usage:

program.setFont(font);

setFont

public void setFont(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

Usage:

program.setFont(str);

setFontFromChooser

protected void setFontFromChooser()

Pops up a JFontChooser to let the user pick a font for the console.