HTML5 Touch Event
This interface defines the touchstart, touchend, touchmove, touchenter, touchleave, and touchcancel event types.
Supported Platform(s)
- BlackBerry OS 6.0+
- BlackBerry PlayBook
| API | OS 5.0 | OS 6.0 | OS 7.0 | PlayBook | Ripple |
|---|---|---|---|---|---|
| initTouchEvent | Y | Y | Y | ||
| altKey | Y | Y | Y | ||
| changedTouches | Y | Y | Y | ||
| ctrlKey | Y | Y | Y | ||
| metaKey | Y | Y | Y | ||
| relatedTarget | Y | Y | Y | ||
| shiftKey | Y | Y | Y | ||
| targetTouches | Y | Y | Y | ||
| touches | 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. |
API Summary
Functions
initTouchEvent
| Boolean initTouchEvent(type : String, canBubble : Boolean, cancelable : Boolean, view : Window, detail : Number, ctrlKey : Boolean, altKey : Boolean, shiftKey : Boolean, metaKey : Boolean, touches : TouchList, targetTouches : TouchList, changedTouches : TouchList) |
Supported Platform(s)
- BlackBerry OS 6.0+- BlackBerry PlayBook
Description
initializes a TouchEvent created through the DocumentEvent interface.
| Parameter | Type | Description |
|---|---|---|
| type | String | |
| canBubble | Boolean | |
| cancelable | Boolean | |
| view | Window | |
| detail | Number | |
| ctrlKey | Boolean | |
| altKey | Boolean | |
| shiftKey | Boolean | |
| metaKey | Boolean | |
| touches | TouchList | |
| targetTouches | TouchList | |
| changedTouches | TouchList |
Properties:
| Property | Type | Description | Supported Platform(s) |
|---|---|---|---|
| altKey |
Boolean
readonly |
true if the alt (Alternate) key modifier is activated; otherwise false
|
- BlackBerry OS 6.0+
- BlackBerry PlayBook |
| changedTouches |
TouchList
readonly |
a list of Touches for every point of contact which contributed to the event
|
- BlackBerry OS 6.0+
- BlackBerry PlayBook |
| ctrlKey |
Boolean
readonly |
true if the ctrl (Control) key modifier is activated; otherwise false
|
- BlackBerry OS 6.0+
- BlackBerry PlayBook |
| metaKey |
Boolean
readonly |
if the meta (Meta) key modifier is activated; otherwise false. On some platforms
this attribute may map to a differently-named key
|
- BlackBerry OS 6.0+
- BlackBerry PlayBook |
| relatedTarget |
EventTarget
readonly |
identifies a secondary {EventTarget} related to a touch event. This attribute is
used with the touchenter event to indicate the {EventTarget} the touch point
exited, and with the touchleave event to indicate the {EventTarget} the touch point
entered. For other event types, this attribute must be null.
|
- BlackBerry OS 6.0+
- BlackBerry PlayBook |
| shiftKey |
Boolean
readonly |
true if the shift (Shift) key modifier is activated; otherwise false
|
- BlackBerry OS 6.0+
- BlackBerry PlayBook |
| targetTouches |
TouchList
readonly |
a list of Touches for every point of contact currently touching the surface, which started on the same target
|
- BlackBerry OS 6.0+
- BlackBerry PlayBook |
| touches |
TouchList
readonly |
a list of Touches for every point of contact currently touching the surface
|
- 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)