Java Eyes Problem Set Javadocs

cs101.awt
Class DefaultGameFrame

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjava.awt.Window
              extended byjava.awt.Frame
                  extended bycs101.awt.DefaultGameFrame
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class DefaultGameFrame
extends java.awt.Frame

Simple top level Frame that deals with one component and sizing.

Copyright (c) 1999 Massachusetts Institute of Technology

Version:
$Id: DefaultGameFrame.java
Author:
Paul K. Njoroge, pnjoroge@mit.edu, Lynn Andrea Stein, las@ai.mit.edu
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class java.awt.Frame
java.awt.Frame.AccessibleAWTFrame
 
Nested classes inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
protected  java.awt.Component c
          The Component (view) to display.
protected  GameControllable gc
          The controls for this component.
 
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
 
Fields inherited from class java.awt.Component
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
DefaultGameFrame(GameControllable gc)
          Creates a new frame relying on the supplied GameControllable to provide its behavior.
DefaultGameFrame(GameControllable gc, java.awt.Component c)
          Creates a new frame surrounding the supplied component and relying on the GameControllable to provide its behavior.
DefaultGameFrame(GameControllable gc, java.awt.Component c, java.awt.Dimension d)
          Creates a new frame of the specified size surrounding the supplied component and relying on the GameControllable to provide its behavior.
DefaultGameFrame(GameControllable gc, java.awt.Component c, int x, int y)
          Creates a new frame of the specified size surrounding the supplied component and relying on the GameControllable to provide its behavior.
 
Method Summary
 java.awt.Dimension getPreferredSize()
          This method overrides Frame's default getPreferredSize() in case component doesn't specify its own preferences.
 void init()
          Make the frame appear
protected  void shutdown()
          Helper method for what to do when this window goes away....
 
Methods inherited from class java.awt.Frame
addNotify, finalize, getAccessibleContext, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, paramString, remove, removeNotify, setCursor, setExtendedState, setIconImage, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, show, toBack, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, remove, removeAll, removeContainerListener, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, setLayout, transferFocusBackward, 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, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
 

Field Detail

c

protected java.awt.Component c
The Component (view) to display.


gc

protected GameControllable gc
The controls for this component.

Constructor Detail

DefaultGameFrame

public DefaultGameFrame(GameControllable gc)
Creates a new frame relying on the supplied GameControllable to provide its behavior. If GameControllable is also a java.awt.Component, displays that component in this Frame. Note: This method does not show the frame. To show the frame, you must also call init().

Parameters:
gc - GameControllable to use; may also be Component to show.
See Also:
init(), DefaultGameFrame( GameControllable, Component, Dimension )

DefaultGameFrame

public DefaultGameFrame(GameControllable gc,
                        java.awt.Component c)
Creates a new frame surrounding the supplied component and relying on the GameControllable to provide its behavior. Does not show the frame. To show the frame, use init(). If no size is supplied, this is where the default dimensions of this Frame are provided.

Parameters:
gc - GameControllable that supplies its behavior.
c - Component to display.
See Also:
init(), DefaultGameFrame( GameControllable, Component, Dimension )

DefaultGameFrame

public DefaultGameFrame(GameControllable gc,
                        java.awt.Component c,
                        int x,
                        int y)
Creates a new frame of the specified size surrounding the supplied component and relying on the GameControllable to provide its behavior. Does not show the frame. To show the frame, use init().

Parameters:
gc - GameControllable that supplies its behavior.
c - Component to display.
x - preferred horizontal dimension of the Frame (in pixels)
y - preferred vertical dimension of the Frame (in pixels)
See Also:
init(), DefaultGameFrame( GameControllable, Component, Dimension )

DefaultGameFrame

public DefaultGameFrame(GameControllable gc,
                        java.awt.Component c,
                        java.awt.Dimension d)
Creates a new frame of the specified size surrounding the supplied component and relying on the GameControllable to provide its behavior. Does not show the frame. To show the frame, use init().

Parameters:
gc - GameControllable that supplies its behavior.
c - Component to display.
d - preferred Dimension of the Frame (in pixels)
See Also:
init()
Method Detail

shutdown

protected void shutdown()
Helper method for what to do when this window goes away....


init

public void init()
Make the frame appear


getPreferredSize

public java.awt.Dimension getPreferredSize()
This method overrides Frame's default getPreferredSize() in case component doesn't specify its own preferences. Without this method, the DefaultFrame has a disconcerting tendency to paint itself into a tiny little corner....

Returns:
the default dimension supplied to (or by) the constructor
See Also:
Container.getPreferredSize()

Java Eyes Problem Set Javadocs