com.datalogic.softspot

Class SoftSpot.WorkingArea

java.lang.Object

com.datalogic.softspot.SoftSpot.WorkingArea

Enclosing class:

SoftSpot

public static class SoftSpot.WorkingArea
extends java.lang.Object

Constraints defining the frame to restrict SoftSpot's movement. Constraints can be specified using pixel values or as proportions of the screen. For the latter, 0.0 refers to the far left/top, while 1.0 refers to the very bottom/right.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoftSpot.WorkingArea.RotationBehavior RotationBehavior is an enumeration defining constants for different ways the WorkingArea can behave when rotating the device.

Field Summary

Fields

Modifier and Type	Field and Description
float	bottom Lower bound, proportional to the screen.
int	bottomPixels Lower bound, in pixels.
float	left Left bound, proportional to the screen.
int	leftPixels Left bound, in pixels.
float	right Right bound, proportional to the screen.
int	rightPixels Right bound, in pixels.
SoftSpot.WorkingArea.RotationBehavior	rotationBehavior Determines how the working area reacts to screen rotations.
float	top Upper bound, proportional to the screen.
int	topPixels Upper bound, in pixels

Constructor Summary

Constructors

Constructor and Description
WorkingArea(float left, float top, float right, float bottom) Create a WorkingArea specifying proportions on the screen.
WorkingArea(int leftPixels, int topPixels, int rightPixels, int bottomPixels) Create a WorkingArea specifying pixels values.
WorkingArea(int leftPixels, int topPixels, int rightPixels, int bottomPixels, float left, float top, float right, float bottom, SoftSpot.WorkingArea.RotationBehavior rotationBehavior)

Method Summary

Modifier and Type	Method and Description
float	height() Height of the WorkingArea.
float	heightPixels() Height of the WorkingArea.
float	width() Width of the WorkingArea.
float	widthPixels() Width of the WorkingArea.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

leftPixels

public int leftPixels

Left bound, in pixels.

topPixels

public int topPixels

Upper bound, in pixels

rightPixels

public int rightPixels

Right bound, in pixels. Must be >= leftPixels.

bottomPixels

public int bottomPixels

Lower bound, in pixels. Must be >= topPixels.

left

public float left

Left bound, proportional to the screen. 0 = far left, 1 = far right.

top

public float top

Upper bound, proportional to the screen. 0 = far top, 1 = far bottom.

right

public float right

Right bound, proportional to the screen. 0 = far left, 1 = far right. Must be >= left.

bottom

public float bottom

Lower bound, proportional to the screen. 0 = far top, 1 = far bottom. Must be >= top.

rotationBehavior

public SoftSpot.WorkingArea.RotationBehavior rotationBehavior

Determines how the working area reacts to screen rotations.

Constructor Detail

WorkingArea

public WorkingArea(int leftPixels,
                   int topPixels,
                   int rightPixels,
                   int bottomPixels)

Create a WorkingArea specifying pixels values.

Parameters:

leftPixels - Left bound, in pixels.

topPixels - Upper bound, in pixels.

rightPixels - Right bound, in pixels. Must be >= leftPixels.

bottomPixels - Lower bound, in pixels. Must be >= topPixels.

WorkingArea

public WorkingArea(float left,
                   float top,
                   float right,
                   float bottom)

Create a WorkingArea specifying proportions on the screen.

Parameters:

left - Left bound, proportional to the screen. 0 = far left, 1 = far right.

top - Upper bound, proportional to the screen. 0 = far top, 1 = far bottom.

right - Right bound, proportional to the screen. 0 = far left, 1 = far right. Must be >= left.

bottom - Lower bound, proportional to the screen. 0 = far top, 1 = far bottom. Must be >= top.

WorkingArea

public WorkingArea(int leftPixels,
                   int topPixels,
                   int rightPixels,
                   int bottomPixels,
                   float left,
                   float top,
                   float right,
                   float bottom,
                   SoftSpot.WorkingArea.RotationBehavior rotationBehavior)

Method Detail

widthPixels

public float widthPixels()

Width of the WorkingArea.

Returns:

The width of the WorkingArea, in pixels.

heightPixels

public float heightPixels()

Height of the WorkingArea.

Returns:

The height of the WorkingArea, in pixels.

width

public float width()

Width of the WorkingArea.

Returns:

The width of the WorkingArea, relative to the screen.

height

public float height()

Height of the WorkingArea.

Returns:

The height of the WorkingArea, relative to the screen.