UC Berkeley Group for User Interface Research
Updated November 17, 2000

edu.berkeley.guir.lib.satin
Interface SatinConstants

All Known Subinterfaces:
Command, GestureCommandCallback, GetType, GraphicalObject, GraphicalObjectCollection, GraphicalObjectGroup, Interpreter, MultiInterpreter, MultiView, Patch, ProgressiveStrokeRecognizer, Recognizer, SemanticZoomView, SingleStrokeRecognizer, View
All Known Implementing Classes:
Sheet, Clipboard, CommandSubsystem, StrokeEvent, SatinImageLib, ViewHandler, TimedStroke, GraphicalObjectLib, InteractionHandler, Style, StrokeAssembler, StrokeLib, JSatinComponent, SerializationLib

public interface SatinConstants

Satin constants.

This software is distributed under the Berkeley Software License.

 Revisions:  - SATIN-v1.0-1.0.0, Mar 16 1999, JH
               Created 
             - 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 Class Summary
static class SatinConstants.ObjectPoolAffineTransform
          Object pool of AffineTransform objects.
static class SatinConstants.ObjectPoolPoint2D
          Object pool of Point2D objects.
static class SatinConstants.ObjectPoolPolygon2D
          Object pool of Polygon2D objects.
static class SatinConstants.ObjectPoolRectangle2D
          Object pool of Rectangle2D objects.
static class SatinConstants.ObjectPoolStringBuffer
          Object pool of StringBuffer objects.
static class SatinConstants.UniqueAffineTransform
          Designed to overcome a limitation with hashing, namely objects that return the same hashvalue can overwrite each other.
static class SatinConstants.UniquePoint2D
          Designed to overcome a limitation with hashing, namely objects that return the same hashvalue can overwrite each other.
static class SatinConstants.UniquePolygon2D
          Designed to overcome a limitation with hashing, namely objects that return the same hashvalue can overwrite each other.
static class SatinConstants.UniqueRectangle2D
          Designed to overcome a limitation with hashing, namely objects that return the same hashvalue can overwrite each other.
 
Field Summary
static int ABOVE
          Get GraphicalObjects above the specified Point.
static int ALL
          Get all GraphicalObjects that fit the parameters.
static String BAR
          For separating text when printing.
static int BELOW
          Get GraphicalObjects below the specified Point.
static Clipboard clipboard
          Globally shared clipboard.
static ClassProperties clprops
          Class default properties for graphical objects and command objects.
static CommandQueue cmdqueue
          Global command queue.
static CommandSubsystem cmdsubsys
          Globally shared command subsystem.
static int CONTAINEDBY
          Get GraphicalObjects contained entirely by the Shape or Point.
static int CONTAINS
          Get GraphicalObjects containing the Shape or Point (within threshold halo).
static int COORD_ABS
          Absolute (screen) coordinate system constant.
static int COORD_LOCAL
          Local (self) coordinate system constant.
static int COORD_REL
          Relative (parent) coordinate system constant.
static int DAMAGE_LATER
          Damage the region and repaint lazily
static int DAMAGE_NOW
          Damage the region and repaint immediately
static int DEBUG_GRAPHICS_OFFSET
          Number of pixels used for spacing for drawing height and width bars.
static String DEBUG_STYLE_FILE
          The name of the file containing the default debug properties.
static String DEBUG_STYLE_GPROPERTY
          Global property for debugging style.
static int DEEP
          Get Graphical Objects deeply
static int DEFAULT_POINT2D_POOL_SIZE
           
static int DEFAULT_POLYGON2D_POOL_SIZE
           
static int DEFAULT_RECTANGLE_POOL_SIZE
           
static int DEFAULT_REPAINT_THRESHOLD
          Satin damages and repaints in rectangular regions.
static int DEFAULT_SELECT_THRESHOLD
          Default threshold for distances when selecting Graphical Objects in terms of absolute coordinates (screen pixels).
static int DEFAULT_STRINGBUFFER_POOL_SIZE
           
static int DEFAULT_TRANSFORM_POOL_SIZE
           
static int DIR_CENTER
           o o o o x o o o o
static int DIR_DOWN
           o o o o o o o x o
static int DIR_DOWN_LEFT
           o o o o o o x o o
static int DIR_DOWN_RIGHT
           o o o o o o o o x
static int DIR_LEFT
           o o o x o o o o o
static int DIR_RIGHT
           o o o o o x o o o
static int DIR_UP
           o x o o o o o o o
static int DIR_UP_LEFT
           x o o o o o o o o
static int DIR_UP_RIGHT
           o o x o o o o o o
static int FILTER_THRESHOLD
          Throw out pixels closer together than the square root of this distance (in pixels).
static int FIRST
          Get the first GraphicalObjects that fit the parameters.
static double FLOATING_PT_TOLERANCE
          Tolerance range for floating point.
static FlexProperties glprops
          Global system properties.
static int INTERSECTS
          Get GraphicalObjects intersecting the Shape or Point.
static String KEY_STYLE_DASHARRAY
           
static String KEY_STYLE_DASHPHASE
           
static String KEY_STYLE_DRAWCOLOR
           
static String KEY_STYLE_DRAWFONT
           
static String KEY_STYLE_DRAWTRANSPARENCY
           
static String KEY_STYLE_ENDCAP
           
static String KEY_STYLE_FILLCOLOR
           
static String KEY_STYLE_FILLTRANSPARENCY
           
static String KEY_STYLE_LINEJOIN
           
static String KEY_STYLE_LINEWIDTH
           
static String KEY_STYLE_MITERLIMIT
           
static int NEAR
          An alias for CONTAINS.
static String NOTIFY_BOUNDS
          Notification of a change in the bounding points.
static String NOTIFY_LAYER
          Notification of a change in the layer.
static String NOTIFY_LOCATION
          Notification of a change in the location of the top-left corner.
static String NOTIFY_STYLE
          Notification of a change in the style.
static String NOTIFY_TRANSFORM
          Notification of move, rotate, scale, or translate.
static ObjectPool poolPoints
          Object pool of Point2D.
static ObjectPool poolPolys
          Object pool of Polygon2D.
static ObjectPool poolRects
          Object pool of Rectangle2D.
static ObjectPool poolStrbuf
          Object pool of StringBuffers.
static ObjectPool poolTx
          Object pool of AffineTransforms.
static Random rand
          Random.
static String SATIN_DATA_DIRECTORY_DEFAULT
           
static String SATIN_DATA_DIRECTORY_GPROPERTY
          The location of all of the data and properties files.
static String SATIN_PROPERTIES_FILENAME
          The name of Satin's properties file.
static int SHALLOW
          Get Graphical Objects shallowly
 

Field Detail

SATIN_PROPERTIES_FILENAME

public static final String SATIN_PROPERTIES_FILENAME
The name of Satin's properties file. Assumed to be in the current directory, from which Satin is started (via the java interpreter).

SATIN_DATA_DIRECTORY_GPROPERTY

public static final String SATIN_DATA_DIRECTORY_GPROPERTY
The location of all of the data and properties files.

SATIN_DATA_DIRECTORY_DEFAULT

public static final String SATIN_DATA_DIRECTORY_DEFAULT

DEBUG_STYLE_FILE

public static final String DEBUG_STYLE_FILE
The name of the file containing the default debug properties.

DEBUG_STYLE_GPROPERTY

public static final String DEBUG_STYLE_GPROPERTY
Global property for debugging style.
See Also:
glprops

DEFAULT_TRANSFORM_POOL_SIZE

public static final int DEFAULT_TRANSFORM_POOL_SIZE

DEFAULT_RECTANGLE_POOL_SIZE

public static final int DEFAULT_RECTANGLE_POOL_SIZE

DEFAULT_STRINGBUFFER_POOL_SIZE

public static final int DEFAULT_STRINGBUFFER_POOL_SIZE

DEFAULT_POLYGON2D_POOL_SIZE

public static final int DEFAULT_POLYGON2D_POOL_SIZE

DEFAULT_POINT2D_POOL_SIZE

public static final int DEFAULT_POINT2D_POOL_SIZE

rand

public static final Random rand
Random.

poolPoints

public static final ObjectPool poolPoints
Object pool of Point2D.

poolRects

public static final ObjectPool poolRects
Object pool of Rectangle2D.

poolTx

public static final ObjectPool poolTx
Object pool of AffineTransforms.

poolPolys

public static final ObjectPool poolPolys
Object pool of Polygon2D.

poolStrbuf

public static final ObjectPool poolStrbuf
Object pool of StringBuffers.

glprops

public static final FlexProperties glprops
Global system properties.

clprops

public static final ClassProperties clprops
Class default properties for graphical objects and command objects.

cmdsubsys

public static final CommandSubsystem cmdsubsys
Globally shared command subsystem.

clipboard

public static final Clipboard clipboard
Globally shared clipboard.

cmdqueue

public static final CommandQueue cmdqueue
Global command queue.

BAR

public static final String BAR
For separating text when printing.

DIR_CENTER

public static final int DIR_CENTER
 o o o
 o x o
 o o o
 

DIR_UP_LEFT

public static final int DIR_UP_LEFT
 x o o
 o o o
 o o o
 

DIR_UP

public static final int DIR_UP
 o x o
 o o o
 o o o
 

DIR_UP_RIGHT

public static final int DIR_UP_RIGHT
 o o x
 o o o
 o o o
 

DIR_RIGHT

public static final int DIR_RIGHT
 o o o
 o o x
 o o o
 

DIR_DOWN_RIGHT

public static final int DIR_DOWN_RIGHT
 o o o
 o o o
 o o x
 

DIR_DOWN

public static final int DIR_DOWN
 o o o
 o o o
 o x o
 

DIR_DOWN_LEFT

public static final int DIR_DOWN_LEFT
 o o o
 o o o
 x o o
 

DIR_LEFT

public static final int DIR_LEFT
 o o o
 x o o
 o o o
 

COORD_LOCAL

public static final int COORD_LOCAL
Local (self) coordinate system constant.

COORD_REL

public static final int COORD_REL
Relative (parent) coordinate system constant.

COORD_ABS

public static final int COORD_ABS
Absolute (screen) coordinate system constant.

DAMAGE_NOW

public static final int DAMAGE_NOW
Damage the region and repaint immediately
See Also:
GraphicalObject.damage(int)

DAMAGE_LATER

public static final int DAMAGE_LATER
Damage the region and repaint lazily
See Also:
GraphicalObject.damage(int)

ALL

public static final int ALL
Get all GraphicalObjects that fit the parameters.
See Also:
GraphicalObjectGroup.getGraphicalObjects(int, Point2D, int, int, int, double, GraphicalObjectCollection)

FIRST

public static final int FIRST
Get the first GraphicalObjects that fit the parameters.
See Also:
GraphicalObjectGroup.getGraphicalObjects(int, Point2D, int, int, int, double, GraphicalObjectCollection)

SHALLOW

public static final int SHALLOW
Get Graphical Objects shallowly
See Also:
GraphicalObjectGroup.getGraphicalObjects(int, Point2D, int, int, int, double, GraphicalObjectCollection)

DEEP

public static final int DEEP
Get Graphical Objects deeply
See Also:
GraphicalObjectGroup.getGraphicalObjects(int, Point2D, int, int, int, double, GraphicalObjectCollection)

INTERSECTS

public static final int INTERSECTS
Get GraphicalObjects intersecting the Shape or Point.
See Also:
GraphicalObjectGroup.getGraphicalObjects(int, Point2D, int, int, int, double, GraphicalObjectCollection)

CONTAINEDBY

public static final int CONTAINEDBY
Get GraphicalObjects contained entirely by the Shape or Point.
See Also:
GraphicalObjectGroup.getGraphicalObjects(int, Point2D, int, int, int, double, GraphicalObjectCollection)

CONTAINS

public static final int CONTAINS
Get GraphicalObjects containing the Shape or Point (within threshold halo). You can also think of this as a NEAR operation.
See Also:
GraphicalObjectGroup.getGraphicalObjects(int, Point2D, int, int, int, double, GraphicalObjectCollection)

NEAR

public static final int NEAR
An alias for CONTAINS.
See Also:
GraphicalObjectGroup.getGraphicalObjects(int, Point2D, int, int, int, double, GraphicalObjectCollection)

ABOVE

public static final int ABOVE
Get GraphicalObjects above the specified Point.
See Also:
GraphicalObjectGroup.getGraphicalObjects(int, Point2D, int, int, int, double, GraphicalObjectCollection)

BELOW

public static final int BELOW
Get GraphicalObjects below the specified Point.
See Also:
GraphicalObjectGroup.getGraphicalObjects(int, Point2D, int, int, int, double, GraphicalObjectCollection)

FILTER_THRESHOLD

public static final int FILTER_THRESHOLD
Throw out pixels closer together than the square root of this distance (in pixels). Used when creating TimedStroke objects.

DEFAULT_SELECT_THRESHOLD

public static final int DEFAULT_SELECT_THRESHOLD
Default threshold for distances when selecting Graphical Objects in terms of absolute coordinates (screen pixels). That is, you have to be within this distance in order to be selected.

DEFAULT_REPAINT_THRESHOLD

public static final int DEFAULT_REPAINT_THRESHOLD
Satin damages and repaints in rectangular regions. This value is the amount to enlarge damaged rectangular regions, to make sure we get nearby objects correctly.

DEBUG_GRAPHICS_OFFSET

public static final int DEBUG_GRAPHICS_OFFSET
Number of pixels used for spacing for drawing height and width bars.

FLOATING_PT_TOLERANCE

public static final double FLOATING_PT_TOLERANCE
Tolerance range for floating point.

NOTIFY_TRANSFORM

public static final String NOTIFY_TRANSFORM
Notification of move, rotate, scale, or translate. The old value is a copy of the old transform (AffineTransform). The new value is a copy of the new transform (AffineTransform).

NOTIFY_STYLE

public static final String NOTIFY_STYLE
Notification of a change in the style. The old value is a copy of the old style (Style). The new value is a copy of the new style (Style).

NOTIFY_LAYER

public static final String NOTIFY_LAYER
Notification of a change in the layer. The old value is a copy of the old layer (String). The new value is a copy of the new layer (String).

NOTIFY_BOUNDS

public static final String NOTIFY_BOUNDS
Notification of a change in the bounding points. The old value is the old bounding box in absolute coordinates. The new value is the new bounding box in absolute coordinates.

NOTIFY_LOCATION

public static final String NOTIFY_LOCATION
Notification of a change in the location of the top-left corner. The old value is the old location in absolute coordinates. The new value is the new location in absolute coordinates.

KEY_STYLE_LINEWIDTH

public static final String KEY_STYLE_LINEWIDTH

KEY_STYLE_DRAWFONT

public static final String KEY_STYLE_DRAWFONT

KEY_STYLE_DRAWCOLOR

public static final String KEY_STYLE_DRAWCOLOR

KEY_STYLE_DRAWTRANSPARENCY

public static final String KEY_STYLE_DRAWTRANSPARENCY

KEY_STYLE_FILLCOLOR

public static final String KEY_STYLE_FILLCOLOR

KEY_STYLE_FILLTRANSPARENCY

public static final String KEY_STYLE_FILLTRANSPARENCY

KEY_STYLE_ENDCAP

public static final String KEY_STYLE_ENDCAP

KEY_STYLE_LINEJOIN

public static final String KEY_STYLE_LINEJOIN

KEY_STYLE_MITERLIMIT

public static final String KEY_STYLE_MITERLIMIT

KEY_STYLE_DASHARRAY

public static final String KEY_STYLE_DASHARRAY

KEY_STYLE_DASHPHASE

public static final String KEY_STYLE_DASHPHASE

Copyright Information