stanford.karel

Class KarelProgram

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Panel

java.applet.Applet

javax.swing.JApplet

acm.program.Program

stanford.karel.KarelProgram

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

public class KarelProgram
extends Program

This class is a subclass of Program that runs a Karel program.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KarelProgram.State

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
static Color	BLACK
static Color	BLUE
static Color	CYAN
static Color	DARK_GRAY
static int	EAST
static int	FANCY
static Color	GRAY
static Color	GREEN
static int	INFINITE
static Color	LIGHT_GRAY
static Color	MAGENTA
static int	NORTH
static Color	ORANGE
static Color	PINK
static Color	RED
static int	SIMPLE
static int	SOUTH
Event<KarelProgram.State>	StateEvent
static int	WEST
static Color	WHITE
static String	WORLD_EXTENSION File extension for Karel worlds.
static String	WORLDS_DIRECTORY Directory where *.w Karel world files are found.
static Color	YELLOW

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

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
KarelProgram() Creates a new Karel program.

Method Summary

Modifier and Type	Method and Description
void	add(Karel karel)
void	add(KarelInterface karel, int x, int y, int dir, int nBeepers)
protected KarelWorld	createWorld() Creates the KarelWorld in which Karel lives.
protected Karel	getKarel()
KarelWorld	getWorld() Returns the KarelWorld object in which Karel lives.
static String	getWorldDirectory() Returns the default directory in which Karel's worlds live.
protected boolean	isStarted() Checks to see whether this program has started.
protected void	loadConfiguration(Properties props) Loads any saved configuration of this program from disk.
void	loadInitialWorld()
void	main() Contains the code to be executed for each specific program subclass.
boolean	menuAction(ActionEvent event) Called whenever a program action is detected in the menu bar.
protected void	saveConfiguration(Properties props) Saves configuration of this program to disk in the given properties collection.
void	setStatus(String status)
protected void	setWorld(KarelWorld world)
protected void	startRun() Initializes and runs the run method.

Methods inherited from class acm.program.Program

actionPerformed, add, addActionListeners, addActionListeners, addActionListenersToButtonsOnly, addAllActionListeners, addExitHook, addImpl, adjustmentValueChanged, alert, alert, animation, center, changedUpdate, checkCompilerFlags, checkKill, checkStartupSettings, componentAdded, componentHidden, componentMoved, componentRemoved, componentResized, componentShown, confirm, contentsChanged, createConsole, createDialogIO, createMenuBar, createParameterTable, createProgramFrame, destroy, endHook, 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, itemStateChanged, keyPressed, keyReleased, keyTyped, killMe, loadConfiguration, main, menuCanceled, menuDeselected, menuSelected, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, 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, 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, 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

WORLDS_DIRECTORY

public static final String WORLDS_DIRECTORY

Directory where *.w Karel world files are found.

See Also:

Constant Field Values

WORLD_EXTENSION

public static final String WORLD_EXTENSION

File extension for Karel worlds.

See Also:

Constant Field Values

NORTH

public static final int NORTH

See Also:

Constant Field Values

EAST

public static final int EAST

See Also:

Constant Field Values

SOUTH

public static final int SOUTH

See Also:

Constant Field Values

WEST

public static final int WEST

See Also:

Constant Field Values

INFINITE

public static final int INFINITE

See Also:

Constant Field Values

SIMPLE

public static final int SIMPLE

See Also:

Constant Field Values

FANCY

public static final int FANCY

See Also:

Constant Field Values

BLACK

public static final Color BLACK

BLUE

public static final Color BLUE

CYAN

public static final Color CYAN

DARK_GRAY

public static final Color DARK_GRAY

GRAY

public static final Color GRAY

GREEN

public static final Color GREEN

LIGHT_GRAY

public static final Color LIGHT_GRAY

MAGENTA

public static final Color MAGENTA

ORANGE

public static final Color ORANGE

PINK

public static final Color PINK

RED

public static final Color RED

WHITE

public static final Color WHITE

YELLOW

public static final Color YELLOW

StateEvent

public Event<KarelProgram.State> StateEvent

Constructor Detail

KarelProgram

public KarelProgram()

Creates a new Karel program.

Method Detail

main

public void main()

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

setStatus

public void setStatus(String status)

getWorld

public KarelWorld getWorld()

Returns the KarelWorld object in which Karel lives.

Returns:

The KarelWorld object in which Karel lives

setWorld

protected void setWorld(KarelWorld world)

getWorldDirectory

public static String getWorldDirectory()

Returns the default directory in which Karel's worlds live.

Returns:

The directory in which Karel's worlds lives

createWorld

protected KarelWorld createWorld()

Creates the KarelWorld in which Karel lives. Subclasses can override this method to create their own KarelWorld types.

Returns:

The World object in which Karel lives

Noshow:

student

isStarted

protected boolean isStarted()

Checks to see whether this program has started.

Overrides:

isStarted in class Program

Noshow:

student

getKarel

protected Karel getKarel()

add

public void add(Karel karel)

add

public void add(KarelInterface karel,
                int x,
                int y,
                int dir,
                int nBeepers)

menuAction

public boolean menuAction(ActionEvent event)

Description copied from class: Program

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.

Overrides:

menuAction in class Program

loadConfiguration

protected void loadConfiguration(Properties props)

Description copied from class: Program

Loads any saved configuration of this program from disk.

Overrides:

loadConfiguration in class Program

Parameters:

props - properties to load from

saveConfiguration

protected void saveConfiguration(Properties props)

Description copied from class: Program

Saves configuration of this program to disk in the given properties collection.

Overrides:

saveConfiguration in class Program

loadInitialWorld

public void loadInitialWorld()

startRun

protected void startRun()

Description copied from class: Program

Initializes and runs the run method.

Overrides:

startRun in class Program