canvas
Class ViewFrame

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Frame
                          |
                          +--javax.swing.JFrame
                                |
                                +--canvas.ViewFrame
All Implemented Interfaces:
Accessible, ImageObserver, MenuContainer, RootPaneContainer, Serializable, WindowConstants

public class ViewFrame
extends JFrame

Represents a window with a title and a border. Contains a DrawingPane so that Components can be easily displayed.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JFrame
JFrame.AccessibleJFrame
 
Nested classes inherited from class java.awt.Frame
Frame.AccessibleAWTFrame
 
Nested classes inherited from class java.awt.Window
Window.AccessibleAWTWindow
 
Nested classes inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class javax.swing.JFrame
accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled
 
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 javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
ViewFrame()
          Creates a ViewFrame that contains a DrawingPane with a white background that is initially 640 pixels wide and 480 pixels high.
ViewFrame(String title)
          Creates a ViewFrame that contains a DrawingPane with a white background that is initially 640 pixels wide and 480 pixels high.
ViewFrame(String title, Color background, int width, int height)
          Creates a ViewFrame with the given title that contains a DrawingPane with the given background color, and size.
ViewFrame(String title, canvas.DrawingPane viewPane)
          Constructs a ViewFrame that contains the given viewPane
 
Method Summary
 Component add(Component c)
          adds the Component to the main DrawingPane of this ViewFrame
 Component add(Component c, int x, int y)
          Puts the given Component on the main DrawingPane using the Component's preferred size at the given x,y location.
 void addKeyboardListener()
          Adds a Keyboard Listener to the ViewFrame Note: Only works if a listener is set for the ViewFrame
 void addMouseListener()
          Adds a Mouse Listener to the ViewFrame Note: Only works if a listener is set for the ViewFrame
 canvas.DrawingPane getDrawingPane()
          Returns the main DrawingPane that this ViewFrame holds
 int getVFHeight()
           
 int getVFWidth()
           
 void moveToBack(Component c)
          Moves the given Component behind of all other Components.
 void moveToFront(Component c)
          Moves the given Component on top of all other Components.
 void remove(Component c)
          Takes the given Component off the main DrawingPane.
 void removeKeyboardListener()
          Removes the Keyboard Listener to the ViewFrame Note: Only works if a listener is set for the ViewFrame
 void removeMouseListener()
          Removes the Mouse Listener from the ViewFrame Note: Only works if a listener is set for the ViewFrame
 void setFeedbackText(String string)
          Sets the text on the Feedback Label at the bottom of the ViewFrame.
 void setListener(canvas.DefaultListener newListener)
          This sets a listener to listen for events on the ViewFrame itself
 void sleep(int milliseconds)
          Creates a time delay of approximately the given length.
 String toString()
           
 
Methods inherited from class javax.swing.JFrame
addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Frame
addNotify, finalize, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, 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, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, show, toBack, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, 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, 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, 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
 

Constructor Detail

ViewFrame

public ViewFrame()
Creates a ViewFrame that contains a DrawingPane with a white background that is initially 640 pixels wide and 480 pixels high.


ViewFrame

public ViewFrame(String title)
Creates a ViewFrame that contains a DrawingPane with a white background that is initially 640 pixels wide and 480 pixels high. It will have the given title.

Parameters:
title - String that Appears at the Top of the Frame

ViewFrame

public ViewFrame(String title,
                 Color background,
                 int width,
                 int height)
Creates a ViewFrame with the given title that contains a DrawingPane with the given background color, and size.

Parameters:
title - The title of the window
background - The background color of the frame
width - The width, in pixels
height - The height, in pixels

ViewFrame

public ViewFrame(String title,
                 canvas.DrawingPane viewPane)
Constructs a ViewFrame that contains the given viewPane

Method Detail

getVFWidth

public int getVFWidth()

getVFHeight

public int getVFHeight()

getDrawingPane

public canvas.DrawingPane getDrawingPane()
Returns the main DrawingPane that this ViewFrame holds


setFeedbackText

public void setFeedbackText(String string)
Sets the text on the Feedback Label at the bottom of the ViewFrame.


add

public Component add(Component c)
adds the Component to the main DrawingPane of this ViewFrame

Overrides:
add in class Container

add

public Component add(Component c,
                     int x,
                     int y)
Puts the given Component on the main DrawingPane using the Component's preferred size at the given x,y location.

Parameters:
c - the Component to be added
x - the x position for the upper left of the Component
y - the y position for the upper left of the Component
Returns:
the given Component is returned for convenience

remove

public void remove(Component c)
Takes the given Component off the main DrawingPane.

Overrides:
remove in class JFrame
Parameters:
c - the Component to be removed

moveToFront

public void moveToFront(Component c)
Moves the given Component on top of all other Components.

Parameters:
c - the Component to be moved to the front

setListener

public void setListener(canvas.DefaultListener newListener)
This sets a listener to listen for events on the ViewFrame itself

Parameters:
newListener - The listener class that will do the listening

addKeyboardListener

public void addKeyboardListener()
Adds a Keyboard Listener to the ViewFrame Note: Only works if a listener is set for the ViewFrame


removeKeyboardListener

public void removeKeyboardListener()
Removes the Keyboard Listener to the ViewFrame Note: Only works if a listener is set for the ViewFrame


addMouseListener

public void addMouseListener()
Adds a Mouse Listener to the ViewFrame Note: Only works if a listener is set for the ViewFrame


removeMouseListener

public void removeMouseListener()
Removes the Mouse Listener from the ViewFrame Note: Only works if a listener is set for the ViewFrame


moveToBack

public void moveToBack(Component c)
Moves the given Component behind of all other Components.

Parameters:
c - the Component to be moved to the back

sleep

public void sleep(int milliseconds)
Creates a time delay of approximately the given length.

Parameters:
milliseconds - the desired length of the delay, in milliseconds

toString

public String toString()
Overrides:
toString in class Component