Touch

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


Supported Platform(s)

- BlackBerry OS 6.0+
- BlackBerry PlayBook 1.0+
- BlackBerry 10
View Supported Platform Table
APIBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
clientX   Y Y Y Y Y 
clientY   Y Y Y Y Y 
force   Y Y Y Y Y 
identifier   Y Y Y Y Y 
pageX   Y Y Y Y Y 
pageY   Y Y Y Y Y 
radiusX   Y Y Y Y Y 
radiusY   Y Y Y Y Y 
rotationAngle   Y Y Y Y Y 
screenX   Y Y Y Y Y 
screenY   Y Y 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 and BlackBerry 10+)
This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application.

Properties

Number clientX
Number clientY
Number force
Number identifier
Number pageX
Number pageY
Number radiusX
Number radiusY
Number rotationAngle
Number screenX
Number screenY

Properties

readonly Number clientX


x-coordinate of point relative to the viewport, excluding any scroll offset


Supported Platforms
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10

readonly Number clientY


y-coordinate of point relative to the viewport, excluding any scroll offset


Supported Platforms
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10

readonly Number force


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.


Supported Platforms
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10

readonly Number identifier


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


Supported Platforms
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10

readonly Number pageX


x-coordinate of point relative to the viewport, including any scroll offset


Supported Platforms
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10

readonly Number pageY


y-coordinate of point relative to the viewport, including any scroll offset


Supported Platforms
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10

readonly Number radiusX


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.


Supported Platforms
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10

readonly Number radiusY


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.


Supported Platforms
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10

readonly Number rotationAngle


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.)


Supported Platforms
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10

readonly Number screenX


x-coordinate of point relative to the screen


Supported Platforms
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10

readonly Number screenY


y-coordinate of point relative to the screen


Supported Platforms
 - BlackBerry OS 6.0+
 - BlackBerry PlayBook 1.0+
 - BlackBerry 10

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Feb 11 2013 14:51:11 GMT-0500 (EST)