Touch

This interface defines an individual point of contact for a touch event.

Supported Platform(s)

- BlackBerry OS 6.0+
- BlackBerry PlayBook

View Supported Platform Table

APIOS 5.0OS 6.0OS 7.0PlayBookRipple
clientX   Y Y Y 
clientY   Y Y Y 
force   Y Y Y 
identifier   Y Y Y 
pageX   Y Y Y 
pageY   Y Y Y 
radiusX   Y Y Y 
radiusY   Y Y Y 
rotationAngle   Y Y Y 
screenX   Y Y Y 
screenY   Y Y Y 

Configuration Document Settings

To use all of the API described for this object, you must ensure the following settings are in your configuration document:

This API does not require a <feature> element to be declared in the configuration document of your BlackBerry WebWorks Application.

Permission Elements (PlayBook Only)
This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application.

Properties:

Property Type Description Supported Platform(s)
clientX Number
readonly 		x-coordinate of point relative to the viewport, excluding any scroll offset
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook
clientY Number
readonly 		y-coordinate of point relative to the viewport, excluding any scroll offset
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook
force Number
readonly 		a relative value of pressure applied, in the range 0 to 1, where 0 is no pressure, and 1 is the highest level of pressure the touch device is capable of sensing; 0 if no value is known. In environments where force is known, the absolute pressure represented by the force attribute, and the sensitivity in levels of pressure, may vary.
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook
identifier Number
readonly 		An identification number for each touch point, unique to that touch point per session. The algorithm for determining the identifier value is as follows:

  1. if there are no other active touch event sessions, the value of identifier must be 0
  2. if there is at least one active touch event session, the value of identifier must be the lowest integer not currently used by any active Touch object in any active touch event session

  - BlackBerry OS 6.0+
 - BlackBerry PlayBook
pageX Number
readonly 		x-coordinate of point relative to the viewport, including any scroll offset
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook
pageY Number
readonly 		y-coordinate of point relative to the viewport, including any scroll offset
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook
radiusX Number
readonly 		the radius of the ellipse which most closely circumscribes the touching area (e.g. finger, stylus) along the x-axis, in pixels of the same scale as screenX; 1 if no value is known. The value must be positive.
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook
radiusY Number
readonly 		the radius of the ellipse which most closely circumscribes the touching area (e.g. finger, stylus) along the y-axis, in pixels of the same scale as screenY; 1 if no value is known. The value must be positive.
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook
rotationAngle Number
readonly 		the angle (in degrees) that the ellipse described by radiusX and radiusY is rotated clockwise about its center; 0 if no value is known. The value must be greater than or equal to 0 and less than 90.

If the ellipse described by radiusX and radiusY is circular, then rotationAngle has no effect. The user agent may use 0 as the value in this case, or it may use any other value in the allowed range. (For example, the user agent may use the rotationAngle value from the previous touch event, to avoid sudden changes.)
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook
screenX Number
readonly 		x-coordinate of point relative to the screen
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook
screenY Number
readonly 		y-coordinate of point relative to the screen
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook
Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 13:31:20 GMT-0500 (EST)