com.datalogic.softspot

Class SoftSpot

java.lang.Object

com.datalogic.softspot.SoftSpot

public class SoftSpot
extends java.lang.Object

API to configure SoftSpot. All X/Y coordinates are based at the top-left of the screen. The left of the screen is where X is 0, and the top of the screen is where Y is 0.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoftSpot.Point X/Y screen coordinates.
static class	SoftSpot.WorkingArea Constraints defining the frame to restrict SoftSpot's movement.

Field Summary

Fields

Modifier and Type	Field and Description
static long	TIMEOUT_MILLIS API will return the last known value if SoftSpot does not respond before the timeout.

Constructor Summary

Constructors

Constructor and Description
SoftSpot(android.content.Context ctx) Create an object to communicate with SoftSpot.

Method Summary

Modifier and Type	Method and Description
void	clearCustomImage(ImageEnum imageEnum) Delete the custom image for the given ImageEnum. It's icon will be changed back to the default number icons.
void	clearWorkingArea() Reset the working area to the whole screen.
ImageEnum	getImage(ActionType actionType, ImageState imageState) Get the image in use for the given ActionType and ImageState values.
boolean	getLockState() Get current lock state (can I move it around the screen on finger drag?)
SoftSpot.Point	getPosition() Current X/Y position
SoftSpot.Point	getPositionMax() Maximum X/Y position Changing scale will change this value.
SoftSpot.Point	getPositionMin() Minimum X/Y position Changing scale will change this value.
float	getScale() Current scale multiplier
float	getScaleMax() Maximum scale multiplier
float	getScaleMin() Minimum scale multiplier
boolean	getVibrator() Is vibration enabled when using SoftSpot?
SoftSpot.WorkingArea	getWorkingArea() Get Area that SoftSpot can move within
void	hide() Hide SoftSpot.
boolean	isEnabled() When SoftSpot is enabled then it will either be currently showing, or a notification is available to show.
void	lock(boolean lockVal) Set lock state of SoftSpot, it impacts SoftSpot motion ability on finger dragging events.
void	setCustomImage(ImageEnum imageEnum, byte[] data) Copy the image in the byte array, then assigns the custom imageEnum to use that image.<
void	setCustomImage(ImageEnum imageEnum, java.io.File imageFile) Copy the image located at the given filepath, then assigns the custom imageEnum to use that image.<
void	setDecodedDuration(DecodedDuration decodedDuration) Set the duration for how long the decoded image should be displayed on screen after a good read before switching back to the ImageState.NORMAL image.
void	setEnabled(boolean enable) Set the current enabled state of SoftSpot.
void	setImage(ActionType actionType, ImageState imageState, ImageEnum imageEnum) Set the image to use when SoftSpot has the given ActionType and ImageState values.
void	setPosition(SoftSpot.Point point) Move SoftSpot
void	setScale(float scalar) Set the scale multiplier used for SoftSpot size.
void	setVibrator(boolean enable) Toggle the vibrator on or off when SoftSpot is pressed or moved.
void	setWorkingArea(SoftSpot.WorkingArea area) Restrict SoftSpot to a square region on the screen
void	show() Show SoftSpot.

Methods inherited from class java.lang.Object

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

Field Detail

TIMEOUT_MILLIS

public static final long TIMEOUT_MILLIS

API will return the last known value if SoftSpot does not respond before the timeout.

See Also:

Constant Field Values

Constructor Detail

SoftSpot

public SoftSpot(android.content.Context ctx)

Create an object to communicate with SoftSpot.

Parameters:

ctx - Required for broadcasting to SoftSpot.

Method Detail

getPositionMin

public SoftSpot.Point getPositionMin()

Minimum X/Y position
Changing scale will change this value.

Returns:

Minimum X/Y coordinates to set as position.

getPositionMax

public SoftSpot.Point getPositionMax()

Maximum X/Y position
Changing scale will change this value.

Returns:

Maximum X/Y coordinates to set as position.

getWorkingArea

public SoftSpot.WorkingArea getWorkingArea()

Get Area that SoftSpot can move within

Returns:

WorkingArea specifying the area that SoftSpot can move within.

setWorkingArea

public void setWorkingArea(SoftSpot.WorkingArea area)

Restrict SoftSpot to a square region on the screen

Parameters:

area - WorkingArea describing how to restrict SoftSpot.

clearWorkingArea

public void clearWorkingArea()

Reset the working area to the whole screen.

getPosition

public SoftSpot.Point getPosition()

Current X/Y position

Returns:

Current X/Y position of SoftSpot. This is the central point of SoftSpot.

setPosition

public void setPosition(SoftSpot.Point point)

Move SoftSpot

Parameters:

point - X and Y coordinates to set as the center of SoftSpot.

getScaleMin

public float getScaleMin()

Minimum scale multiplier

Returns:

The minimum scale multiplier used for SoftSpot size.

getScaleMax

public float getScaleMax()

Maximum scale multiplier

Returns:

The maximum scale multiplier used for SoftSpot size.

getScale

public float getScale()

Current scale multiplier

Returns:

The current scale multiplier used for SoftSpot size.

setScale

public void setScale(float scalar)

Set the scale multiplier used for SoftSpot size.

Parameters:

scalar - Scale multiplier to set SoftSpot size. A value that is not between the minimum and maximum will be ignored.

getLockState

public boolean getLockState()

Get current lock state (can I move it around the screen on finger drag?)

Returns:

Current lock state of SoftSpot

lock

public void lock(boolean lockVal)

Set lock state of SoftSpot, it impacts SoftSpot motion ability on finger dragging events.

Parameters:

lockVal - Pass in 'true' to keep SoftSpot locked to its current position. Pass in 'false' to allow SoftSpot to be moved around the screen.

hide

public void hide()

Hide SoftSpot. A notification will be available to show again. If SoftSpot is not enabled, this will have no effect.

show

public void show()

Show SoftSpot. If SoftSpot is not enabled, this will have no effect.

isEnabled

public boolean isEnabled()

When SoftSpot is enabled then it will either be currently showing, or a notification is available to show.

Returns:

True if SoftSpot is currently enabled. Otherwise SoftSpot is disabled.

setEnabled

public void setEnabled(boolean enable)

Set the current enabled state of SoftSpot.

Parameters:

enable - True to enable SoftSpot, false to disable SoftSpot.

getImage

public ImageEnum getImage(ActionType actionType,
                          ImageState imageState)

Get the image in use for the given ActionType and ImageState values.

Parameters:

actionType - The type of action to retreive an image for.

imageState - The state of the image to retrieve the image for.

setImage

public void setImage(ActionType actionType,
                     ImageState imageState,
                     ImageEnum imageEnum)

Set the image to use when SoftSpot has the given ActionType and ImageState values.

Parameters:

actionType - The type of action to set an image for.

imageState - The state of the image for which the image should be set.

imageEnum - The image to set as active.

setCustomImage

public void setCustomImage(ImageEnum imageEnum,
                           java.io.File imageFile)
                    throws java.io.FileNotFoundException

Copy the image located at the given filepath, then assigns the custom imageEnum to use that image.< Image will be downsampled if too large.

Parameters:

imageEnum - The ImageEnum to set the new image to. Must be a custom slot.

imageFile - Image in external storage to be copied.

Throws:

java.io.FileNotFoundException

setCustomImage

public void setCustomImage(ImageEnum imageEnum,
                           byte[] data)
                    throws java.lang.NullPointerException

Copy the image in the byte array, then assigns the custom imageEnum to use that image.< Image will be downsampled if too large.

Parameters:

imageEnum - The ImageEnum to set the new image to. Must be a custom slot.

data - Byte array containing the image to be copied.

Throws:

java.lang.NullPointerException

clearCustomImage

public void clearCustomImage(ImageEnum imageEnum)

Delete the custom image for the given ImageEnum.
It's icon will be changed back to the default number icons.

Parameters:

imageEnum - The slot for the custom image to be deleted. Must be a custom slot.

setDecodedDuration

public void setDecodedDuration(DecodedDuration decodedDuration)

Set the duration for how long the decoded image should be displayed on screen after a good read before switching back to the ImageState.NORMAL image.

Parameters:

decodedDuration - Enum value representing the number of seconds to display the 'decoded' image for.

setVibrator

public void setVibrator(boolean enable)

Toggle the vibrator on or off when SoftSpot is pressed or moved. Also, vibrate when SoftSpot is used to launch an application.

Parameters:

enable - set to true to enable vibrator. set to false to disable vibrator.

getVibrator

public boolean getVibrator()

Is vibration enabled when using SoftSpot?

Returns:

True if SoftSpot vibration effects are enabled.