Class TouchEvent

The TouchEvent class encapsulates information about a touch event. The system continually sends TouchEvent objects to an application as fingers touch and move across a surface. A touch event provides a snapshot of all touches during a multi-touch sequence, most importantly the touches that are new or have changed for a particular target. A multi-touch sequence begins when a finger first touches the surface. Other fingers may subsequently touch the surface, and all fingers may move across the surface. The sequence ends when the last of these fingers is lifted from the surface. An application receives touch event objects during each phase of any touch.

Extends

UIEvent

Members Table

The following table lists the members exposed by the TouchEvent object.

Show inherited members (marked with *)

Show: Properties Methods

Attribute Description Property Type Readonly Description $pseudoTarget * HTMLElement false Keeps the reference to pseudo element where event originated. altKey Boolean true If true, the alt key is pressed; otherwise, it is not. bubbles * Boolean true Used to indicate whether or not an event is a bubbling event. cancelable * Boolean true Used to indicate whether or not an event can have its default action prevented. changedTouches TouchList true A collection of Touch objects representing all touches that changed in this event. clientX Number true The x-coordinate of the event’s location relative to the window’s viewport. clientY Number true The y-coordinate of the event’s location relative to the window’s viewport. ctrlKey Boolean true If true, the control key is pressed; otherwise, it is not. currentTarget * Node true Used to indicate the EventTarget whose EventListeners are currently being processed. This is particularly useful during capturing and bubbling. defaultPrevented * Boolean true Used to indicate whether preventDefault() has been called for this event. detail * Number false Specifies some detail information about the Event, depending on the type of event. eventPhase * Number true Used to indicate which phase of event flow is currently being evaluated. metaKey Boolean true If true, the meta key is pressed; otherwise, it is not. namespaceURI * String true The namespace URI associated with this event at initialization time, or null if it is unspecified. rotation Number true The delta rotation since the start of an event, in degrees, where clockwise is positive and counter-clockwise is negative. The initial value is 0.0. scale Number true The distance between two fingers since the start of an event, as a multiplier of the initial distance. The initial value is 1.0. If less than 1.0, the gesture is pinch close (to zoom out). If greater than 1.0, the gesture is pinch open (to zoom in). screenX Number true The x-coordinate of the event’s location in screen coordinates. screenY Number true The y-coordinate of the event’s location in screen coordinates. shiftKey Boolean true If true, the shift key is pressed; otherwise, it is not. target * Node true Used to indicate the EventTarget to which the event was originally dispatched. targetTouches TouchList true A collection of Touch objects representing all touches associated with this target. timeStamp * TimeStamp true Used to specify the time (in milliseconds relative to the epoch) at which the event was created. touches TouchList true A collection of Touch objects representing all touches associated with this event. type * String true The name of the event (case-insensitive). The name must be an XML name. view * Object false The view attribute identifies the AbstractView from which the event was generated. Method Returns Description initEvent * Void The initEvent method is used to initialize the value of an Event created through the DocumentEvent interface. Sytaxis: object.initEvent(type, canBubble, cancelable) Arguments: Name Type O/R Description type String Required Specifies the event type. canBubble Boolean Required Specifies whether or not the event can bubble. cancelable Boolean Required Specifies whether or not the event's default action can be prevented. initTouchEvent Void Initializes attributes of a TouchEvent object. Sytaxis: object.initTouchEvent(type, canBubble, cancelable, view, detail, screenX, screenY, clientX, clientY, ctrlKey, altKey, shiftKey, metaKey, touches, targetTouches, changedTouches, scale, rotation) Arguments: Name Type O/R Description type String Required The type of event that occurred. canBubble Boolean Required Indicates whether an event can bubble. If true, the event can bubble; otherwise, it cannot. cancelable Boolean Required Indicates whether an event can have its default action prevented. If true, the default action can be prevented; otherwise, it cannot. view Object Required The view (DOM window) in which the event occurred. detail Number Required Specifies some detail information about the event depending on the type of event. screenX Number Required The x-coordinate of the event’s location in screen coordinates. screenY Number Required The y-coordinate of the event’s location in screen coordinates. clientX Number Required The x-coordinate of the event’s location relative to the window’s viewport. clientY Number Required The y-coordinate of the event’s location relative to the window’s viewport. ctrlKey Boolean Required If true, the control key is pressed; otherwise, it is not. altKey Boolean Required If true, the alt key is pressed; otherwise, it is not. shiftKey Boolean Required If true, the shift key is pressed; otherwise, it is not. metaKey Boolean Required If true, the meta key is pressed; otherwise, it is not. touches TouchList Required A collection of Touch objects representing all touches associated with this event. targetTouches TouchList Required A collection of Touch objects representing all touches associated with this target. changedTouches TouchList Required A collection of Touch objects representing all touches that changed in this event. scale Number Required The distance between two fingers since the start of an event as a multiplier of the initial distance. The initial value is 1.0. If less than 1.0, the gesture is pinch close (to zoom out). If greater than 1.0, the gesture is pinch open (to zoom in). rotation Number Required The delta rotation since the start of an event, in degrees, where clockwise is positive and counter-clockwise is negative. The initial value is 0.0. initUIEvent * Void The initUIEvent method is used to initialize the value of a UIEvent object. Sytaxis: object.initUIEvent(type, canBubble, cancelable, view, detail) Arguments: Name Type O/R Description type String Required Specifies the event type. canBubble Boolean Required Specifies whether or not the event can bubble. cancelable Boolean Required Specifies whether or not the event's default action can be prevented. view Object Required Specifies view. This value may be null. detail Number Required Specifies detail. preventDefault * Void If an event is cancelable, the preventDefault method is used to signify that the event is to be canceled, meaning any default action normally taken by the implementation as a result of the event will not occur. Sytaxis: object.preventDefault() stopImmediatePropagation * Void Prevents other event listeners from being triggered and, unlike stopPropagation() its effect is immediate Sytaxis: object.stopImmediatePropagation() stopPropagation * Void The stopPropagation method is used prevent further propagation of an event during event flow. The event will complete dispatch to all listeners on the current EventTarget before event flow stops. This method may be used during any stage of event flow. Sytaxis: object.stopPropagation() Event B C Interface Description Pseudo-class Description Constant Value Description

Remarks

Events of that type:

• touchstart
• touchchange
• touchend
• touchcancel