com.sun.glass.ui.monocle

Class TouchState

java.lang.Object

com.sun.glass.ui.monocle.TouchState

class TouchState
extends java.lang.Object

TouchState is a snapshot of touch points and their coordinates. TouchState is used both to store the current state of touch input and to describe changes to that state. A TouchState contains a number of Points. Each point has a unique ID, which is either assigned by a touch driver, or by JavaFX's input processing code. One touch point is defined as the primary touch point; it is this touch point's coordinates that are used to determine the coordinates of synthesized mouse events.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	TouchState.Point Describes a single touch point

Field Summary

Fields

Modifier and Type	Field and Description
private int	pointCount
private static java.util.Comparator<TouchState.Point>	pointIdComparator
private TouchState.Point[]	points
private int	primaryID
private MonocleWindow	window

Constructor Summary

Constructors

Constructor and Description
TouchState()

Method Summary

Modifier and Type	Method and Description
(package private) TouchState.Point	addPoint(TouchState.Point p) Adds a Point to this state object.
(package private) void	assignPrimaryID() Updates the primary point ID
(package private) boolean	canBeFoldedWith(TouchState ts, boolean ignoreIDs) Finds out whether two non-null states are identical in everything but their touch point coordinates
(package private) void	clear() Removes all touch points from this state.
(package private) void	clearWindow() Clears the cached window.
(package private) void	copyTo(TouchState target) Copies the contents of this state object to another.
(package private) boolean	equalsSorted(TouchState ts) Compare two non-null states whose points are sorted by ID
(package private) TouchState.Point	getPoint(int index) Returns the nth point in the toich point list, for index n
(package private) int	getPointCount() Returns the number of touch points pressed.
(package private) TouchState.Point	getPointForID(int id) Gets the Point matching the given ID.
(package private) int	getPrimaryID() Returns the touch point ID of the primary point.
(package private) MonocleWindow	getWindow(boolean recalculateCache, MonocleWindow fallback) Returns the Glass window on which this event state is located.
(package private) void	removePointForID(int id) Removes the point with the given ID
(package private) void	setPoint(int index, TouchState.Point p) Replaces the touch point data at the given index with the given touch point data
(package private) void	sortPointsByID() Modifies the ordering touch points in this state object so that the points are sorted in increasing order of ID.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

pointIdComparator

private static java.util.Comparator<TouchState.Point> pointIdComparator

points

private TouchState.Point[] points

pointCount

private int pointCount

primaryID

private int primaryID

window

private MonocleWindow window

Constructor Detail

TouchState

TouchState()

Method Detail

getWindow

MonocleWindow getWindow(boolean recalculateCache,
                        MonocleWindow fallback)

Returns the Glass window on which this event state is located. assignPrimaryID() should be called before this method.

Parameters:

recalculateCache - true if the cached value should be discarded and recomputed

fallback - the window to use if no primary ID is available

getPoint

TouchState.Point getPoint(int index)

Returns the nth point in the toich point list, for index n

Parameters:

index - The index of the point point to return. index should be less than the value returned by getPointCount().

Returns:

A touch point.

getPointForID

TouchState.Point getPointForID(int id)

Gets the Point matching the given ID. if available

Parameters:

id - The Point ID to match. A value of -1 matches any Point.

Returns:

a matching Point, or null if there is no point with that ID.

getPrimaryID

int getPrimaryID()

Returns the touch point ID of the primary point.

assignPrimaryID

void assignPrimaryID()

Updates the primary point ID

getPointCount

int getPointCount()

Returns the number of touch points pressed.

Returns:

the number of touch points

clear

void clear()

Removes all touch points from this state.

clearWindow

void clearWindow()

Clears the cached window.

addPoint

TouchState.Point addPoint(TouchState.Point p)

Adds a Point to this state object.

Parameters:

p - the Point describing the data to add, or null if no data is available yet for this point. p is not modified, but its contents are copied to the object describing the new Point.

Returns:

the Point with the data for the new touch point. The fields of this Point may be modified directly to change the data for the new touch point.

removePointForID

void removePointForID(int id)

Removes the point with the given ID

Parameters:

id - The ID of the touch point which is to be removed.

setPoint

void setPoint(int index,
              TouchState.Point p)

Replaces the touch point data at the given index with the given touch point data

Parameters:

index - the index at which to change the touch point data

p - the data to copy to the given index.

copyTo

void copyTo(TouchState target)

Copies the contents of this state object to another.

Parameters:

target - The TouchState to which to copy this state's data.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

sortPointsByID

void sortPointsByID()

Modifies the ordering touch points in this state object so that the points are sorted in increasing order of ID.

equalsSorted

boolean equalsSorted(TouchState ts)

Compare two non-null states whose points are sorted by ID

canBeFoldedWith

boolean canBeFoldedWith(TouchState ts,
                        boolean ignoreIDs)

Finds out whether two non-null states are identical in everything but their touch point coordinates

Parameters:

ts - the TouchState to compare to

ignoreIDs - if true, ignore IDs when comparing points