org.gannacademy.cdf.turtlelogo

Class Terrarium

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.gannacademy.cdf.turtlelogo.Terrarium

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class Terrarium
extends JPanel

A Turtle lives (and draws) inside a Terrarium.

A terrarium can be resized using the setSize(int, int) method and repositioned on the screen using the setPosition(int, int). The terrarium can also have a custom background color (set via the JComponent.setBackground(Color) method — it defaults to white.

Initially, there is only a single terrarium, into which all new turtles are added. However, it is possible to instantiate additional terraria, and to direct Turtles to them using the Turtle.setTerrarium(Terrarium) method. From a technical standpoint, the initial terrarium is a quasi-singleton, and will continue to be treated as a singleton by any new turtles as they are instantiated. The singleton terrarium instance can be accessed statically via the getInstance() method. When additional terraria have been instantiated, they may also be accessed statically via their index (in instantiation order) using the getInstance(int) method.

Author:

Seth Battis

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Terrarium.UnderTheSurface The parts of the terrarium that are "under the surface" are not meant to be used by students.

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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	DEFAULT_BACKGROUND Color.WHITE
static int	DEFAULT_HEIGHT 400 pixels
static int	DEFAULT_WIDTH 600 pixels
protected static Terrarium.UnderTheSurface	UNDER_THE_SURFACE

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

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
Terrarium() Construct a new terrarium of default dimensions, centered on the screen in its own window

Method Summary

Modifier and Type	Method and Description
void	add(Track track, Turtle.UnderTheShell key) Adds a new turtle track to the terrarium
void	add(Turtle turtle, Turtle.UnderTheShell key) Adds a new turtle to the terrarium
void	clear() Clear all turtle tracks from the terrarium
protected void	draw(Graphics2D context) For synchronous drawing requests (e.g.
static Terrarium	getInstance() Get the default terrarium instance (instantiating it, if necessary)
static Terrarium	getInstance(int index) Get a particular Terrarium instance
void	paintComponent(Graphics context) Repaint the contents of the terrarium (tracks and turtles) as-needed
void	remove(Turtle turtle, Turtle.UnderTheShell key) Remove a turtle from the terrarium
void	setPosition(int x, int y) Adjust the location of the terrarium window.
void	setSize(int width, int height) Adjust the dimensions of the terrarium view

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, 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

UNDER_THE_SURFACE

protected static final Terrarium.UnderTheSurface UNDER_THE_SURFACE

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

600 pixels

See Also:

Constant Field Values

DEFAULT_HEIGHT

public static final int DEFAULT_HEIGHT

400 pixels

See Also:

Constant Field Values

DEFAULT_BACKGROUND

public static final Color DEFAULT_BACKGROUND

Color.WHITE

Constructor Detail

Terrarium

public Terrarium()

Construct a new terrarium of default dimensions, centered on the screen in its own window

Method Detail

getInstance

public static Terrarium getInstance()

Get the default terrarium instance (instantiating it, if necessary)

Returns:

The default terrarium

getInstance

public static Terrarium getInstance(int index)

Get a particular Terrarium instance

Parameters:

index - [0..n) if there are n terraria, sequenced by instantiation order

Returns:

The terrarium at this index

add

public void add(Track track,
                Turtle.UnderTheShell key)

Adds a new turtle track to the terrarium

May only be called by Turtle and its subclasses, enforced via Turtle.UnderTheShell.

Parameters:

track - to be added

key - to authenticate "Turtleness"

clear

public void clear()

Clear all turtle tracks from the terrarium

add

public void add(Turtle turtle,
                Turtle.UnderTheShell key)

Adds a new turtle to the terrarium

May only be called by Turtle and its subclasses, enforced via Turtle.UnderTheShell.

Parameters:

turtle - to be added

key - to authenticate "Turtleness"

remove

public void remove(Turtle turtle,
                   Turtle.UnderTheShell key)

Remove a turtle from the terrarium

May only be called by Turtle and its subclasses, enforced via Turtle.UnderTheShell.

Parameters:

turtle - to be removed

key - to authenticate "Turtleness"

setSize

public void setSize(int width,
                    int height)

Adjust the dimensions of the terrarium view

Overrides:

setSize in class Component

Parameters:

width - in pixels

height - in pixels

setPosition

public void setPosition(int x,
                        int y)

Adjust the location of the terrarium window. Note that the screen origin is in the top, left corner of the display and that, while the X-axis increases from left to right, the Y-axis increases from top to bottom. The coordinates given are for the origin of the window (the top, left corner)

Parameters:

x - coordinate

y - coordinate

paintComponent

public void paintComponent(Graphics context)

Repaint the contents of the terrarium (tracks and turtles) as-needed

This method is called automatically by the enclosing JFrame to repaint the terrarium as-needed. It is not meant to be called at will. If the terrarium needs to be updated, a Component.repaint() request will schedule the update.

Overrides:

paintComponent in class JComponent

Parameters:

context - for drawing commands

draw

protected void draw(Graphics2D context)

For synchronous drawing requests (e.g. saving images)

Parameters:

context - for drawing commands