edu.berkeley.guir.lib.satin.interpreter
Interface Interpreter

All Superinterfaces:

Cloneable, EventFilter, EventListener, SatinConstants, SatinEventFilter, Serializable, StrokeEventFilter, StrokeListener

All Known Subinterfaces:

MultiInterpreter

All Known Implementing Classes:

InterpreterImpl

public interface Interpreter

extends SatinConstants, StrokeListener, StrokeEventFilter, Cloneable, Serializable

Interpreters handle the interaction side of GraphicalObjects.

This software is distributed under the Berkeley Software License.

 Revisions:  - SATIN-v1.0-1.0.0, Apr 22 1999, JH
               Created class
             - SATIN-v2.1-1.0.0, Aug 11 2000, JH
               Touched for SATIN release
 

Since:

JDK 1.2

Version:

SATIN-v2.1-1.0.0, Aug 11 2000

Author:

Jason Hong ( jasonh@cs.berkeley.edu )

Inner classes inherited from class edu.berkeley.guir.lib.satin.SatinConstants

SatinConstants.ObjectPoolAffineTransform, SatinConstants.ObjectPoolPoint2D, SatinConstants.ObjectPoolPolygon2D, SatinConstants.ObjectPoolRectangle2D, SatinConstants.ObjectPoolStringBuffer, SatinConstants.UniqueAffineTransform, SatinConstants.UniquePoint2D, SatinConstants.UniquePolygon2D, SatinConstants.UniqueRectangle2D

Fields inherited from interface edu.berkeley.guir.lib.satin.SatinConstants

ABOVE, ALL, BAR, BELOW, clipboard, clprops, cmdqueue, cmdsubsys, CONTAINEDBY, CONTAINS, COORD_ABS, COORD_LOCAL, COORD_REL, DAMAGE_LATER, DAMAGE_NOW, DEBUG_GRAPHICS_OFFSET, DEBUG_STYLE_FILE, DEBUG_STYLE_GPROPERTY, DEEP, DEFAULT_POINT2D_POOL_SIZE, DEFAULT_POLYGON2D_POOL_SIZE, DEFAULT_RECTANGLE_POOL_SIZE, DEFAULT_REPAINT_THRESHOLD, DEFAULT_SELECT_THRESHOLD, DEFAULT_STRINGBUFFER_POOL_SIZE, DEFAULT_TRANSFORM_POOL_SIZE, DIR_CENTER, DIR_DOWN, DIR_DOWN_LEFT, DIR_DOWN_RIGHT, DIR_LEFT, DIR_RIGHT, DIR_UP, DIR_UP_LEFT, DIR_UP_RIGHT, FILTER_THRESHOLD, FIRST, FLOATING_PT_TOLERANCE, glprops, INTERSECTS, KEY_STYLE_DASHARRAY, KEY_STYLE_DASHPHASE, KEY_STYLE_DRAWCOLOR, KEY_STYLE_DRAWFONT, KEY_STYLE_DRAWTRANSPARENCY, KEY_STYLE_ENDCAP, KEY_STYLE_FILLCOLOR, KEY_STYLE_FILLTRANSPARENCY, KEY_STYLE_LINEJOIN, KEY_STYLE_LINEWIDTH, KEY_STYLE_MITERLIMIT, NEAR, NOTIFY_BOUNDS, NOTIFY_LAYER, NOTIFY_LOCATION, NOTIFY_STYLE, NOTIFY_TRANSFORM, poolPoints, poolPolys, poolRects, poolStrbuf, poolTx, rand, SATIN_DATA_DIRECTORY_DEFAULT, SATIN_DATA_DIRECTORY_GPROPERTY, SATIN_PROPERTIES_FILENAME, SHALLOW

Method Summary

Object	clone()
GraphicalObject	getAttachedGraphicalObject() Get the GraphicalObject this Interpreter is attached to.
String	getName() Get the name of this Interpreter.
boolean	isEnabled() See if this interpreter is enabled or not (ie can run or not).
GraphicalObject	setAttachedGraphicalObject(GraphicalObject newGob) Set the GraphicalObject this Interpreter is attached to.
void	setEnabled(boolean flag) Set whether or not this interpreter is enabled or not (ie can run or not).
String	setName(String strName) Set the name of this Interpreter.

Methods inherited from interface edu.berkeley.guir.lib.satin.event.StrokeListener

handleNewStroke, handleSingleStroke, handleUpdateStroke

Methods inherited from interface edu.berkeley.guir.lib.satin.event.StrokeEventFilter

isLeftButtonAccepted, isMiddleButtonAccepted, isRightButtonAccepted, setAcceptLeftButton, setAcceptMiddleButton, setAcceptRightButton

Methods inherited from interface edu.berkeley.guir.lib.satin.event.SatinEventFilter

isConsumedAccepted, setAcceptConsumed

Methods inherited from interface edu.berkeley.guir.lib.satin.event.EventFilter

isEventAccepted

Method Detail

getName

public String getName()

Get the name of this Interpreter.

Returns:

Some useful not-too-technical real-world name for this Interpreter.

isEnabled

public boolean isEnabled()

See if this interpreter is enabled or not (ie can run or not). This is used by the GraphicalObject and by MultiInterpreter before delegating any calls to the Interpreter.

If called by an MultiInterpreter, it just turns that MultiInterpreter off, but not any contained Interpreters.

setEnabled

public void setEnabled(boolean flag)

Set whether or not this interpreter is enabled or not (ie can run or not).

setName

public String setName(String strName)

Set the name of this Interpreter.

Parameters:

strName - is the new name of this interpreter.

Returns:

a reference to strName.

setAttachedGraphicalObject

public GraphicalObject setAttachedGraphicalObject(GraphicalObject newGob)

Set the GraphicalObject this Interpreter is attached to. This method should be called automatically when the Interpreter is added to the MultiInterpreter, via MultiInterpreter.add(Interpreter).

Parameters:

gob - is the GraphicalObject this Interpreter is to be attached to.

Returns:

a reference to gob.

getAttachedGraphicalObject

public GraphicalObject getAttachedGraphicalObject()

Get the GraphicalObject this Interpreter is attached to.

Returns:

a GraphicalObject.

clone

public Object clone()

Overrides:

clone in class Object