Scribble Problem Set Javadocs

scribble
Class ScribbleCanvas

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Canvas
          extended byscribble.SmartCanvas
              extended byscribble.ScribbleCanvas
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class ScribbleCanvas
extends SmartCanvas

An extended SmartCanvas that echos user's mouse strokes as lines.

Handles mouse events (by creating lines to put in the repository), can be given a Color in which to draw, can be cleared.

Copyright 1996 Massachusetts Institute of Technology

Version:
$Id: ScribbleCanvas.java,v 1.1.1.1 2002/06/05 21:56:35 root Exp $
Author:
Todd C. Parnell, tparnell@ai.mit.edu, Maciej Stachowiak, maciej@ai.mit.edu, Lynn Andrea Stein, las@ai.mit.edu
See Also:
SmartCanvas, Serialized Form

Nested Class Summary
 
Nested classes inherited from class java.awt.Canvas
java.awt.Canvas.AccessibleAWTCanvas
 
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.Color currColor
          The current color to draw lines in.
protected  int currX
           
protected  int currY
           
 
Fields inherited from class scribble.SmartCanvas
repository
 
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
ScribbleCanvas()
          Creates a new ScribbleCanvas.
ScribbleCanvas(ScribbleData sd)
          Creates a new ScribbleCanvas with associated ScribbleData.
 
Method Summary
 void clearLines()
          Removes all lines from the data repository.
protected  void lineTo(int endX, int endY)
          Adds a line (from the saved start point to the point passed) to the data repository.
protected  void resetCoords()
          Gives the x and y coords impossible values to signal that new coords are expected.
 void setColor(java.awt.Color c)
          Changes the drawing color.
protected  void setCoords(int x, int y)
          Saves the starting point for drawing a line in currX, currY
 
Methods inherited from class scribble.SmartCanvas
paint
 
Methods inherited from class java.awt.Canvas
addNotify, createBufferStrategy, createBufferStrategy, getAccessibleContext, getBufferStrategy, update
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

currX

protected int currX

currY

protected int currY

currColor

protected java.awt.Color currColor
The current color to draw lines in.

Constructor Detail

ScribbleCanvas

public ScribbleCanvas()
Creates a new ScribbleCanvas.


ScribbleCanvas

public ScribbleCanvas(ScribbleData sd)
Creates a new ScribbleCanvas with associated ScribbleData.

Method Detail

clearLines

public void clearLines()
Removes all lines from the data repository. Then forces a call to the paint method.


setColor

public void setColor(java.awt.Color c)
Changes the drawing color.

Parameters:
c - the new drawing color.

resetCoords

protected void resetCoords()
Gives the x and y coords impossible values to signal that new coords are expected.


setCoords

protected void setCoords(int x,
                         int y)
Saves the starting point for drawing a line in currX, currY

Parameters:
x - the x coord of the starting point
y - the y coord of the starting point

lineTo

protected void lineTo(int endX,
                      int endY)
Adds a line (from the saved start point to the point passed) to the data repository.

Parameters:
endX - the x coord of the line's endpoint
endY - the y coord of the line's endpoint

Scribble Problem Set Javadocs