class flash.events.TouchEvent extends Event

Available on all platforms

The TouchEvent class lets you handle events on devices that detect user * contact with the device(such as a finger on a touch screen). When a user * interacts with a device such as a mobile phone or tablet with a touch * screen, the user typically touches the screen with his or her fingers or a * pointing device. You can develop applications that respond to basic touch * events(such as a single finger tap) with the TouchEvent class. Create * event listeners using the event types defined in this class. For user * interaction with multiple points of contact(such as several fingers moving * across a touch screen at the same time) use the related GestureEvent, * PressAndTapGestureEvent, and TransformGestureEvent classes. And, use the * properties and methods of these classes to construct event handlers that * respond to the user touching the device. *

Use the Multitouch class to determine the current environment's support * for touch interaction, and to manage the support of touch interaction if * the current environment supports it.

*

Note: When objects are nested on the display list, touch events * target the deepest possible nested object that is visible in the display * list. This object is called the target node. To have a target node's * ancestor(an object containing the target node in the display list) receive * notification of a touch event, use * EventDispatcher.addEventListener() on the ancestor node with * the type parameter set to the specific touch event you want to detect.

Class Fields

static var TOUCH_BEGIN:String

Defines the value of the type property of a * TOUCH_BEGIN touch event object. * *

The dispatched TouchEvent object has the following properties:

static var TOUCH_END:String

Defines the value of the type property of a * TOUCH_END touch event object. * *

The dispatched TouchEvent object has the following properties:

static var TOUCH_MOVE:String

Defines the value of the type property of a * TOUCH_MOVE touch event object. * *

The dispatched TouchEvent object has the following properties:

static var TOUCH_OUT:String

Defines the value of the type property of a * TOUCH_OUT touch event object. * *

The dispatched TouchEvent object has the following properties:

static var TOUCH_OVER:String

Defines the value of the type property of a * TOUCH_OVER touch event object. * *

The dispatched TouchEvent object has the following properties:

static var TOUCH_ROLL_OUT:String

Defines the value of the type property of a * TOUCHROLLOUT touch event object. * *

The dispatched TouchEvent object has the following properties:

static var TOUCH_ROLL_OVER:String

Defines the value of the type property of a * TOUCHROLLOVER touch event object. * *

The dispatched TouchEvent object has the following properties:

static var TOUCH_TAP:String

Defines the value of the type property of a * TOUCH_TAP touch event object. * *

The dispatched TouchEvent object has the following properties:

Instance Fields

var altKey:Bool

Indicates whether the Alt key is active(true) or inactive * (false). Supported for Windows and Linux operating systems * only.

var ctrlKey:Bool

On Windows or Linux, indicates whether the Ctrl key is active * (true) or inactive(false). On Macintosh, * indicates whether either the Control key or the Command key is activated.

var isPrimaryTouchPoint:Bool

Indicates whether the first point of contact is mapped to mouse events.

var isRelatedObjectInaccessible:Bool

If true, the relatedObject property is set to * null for reasons related to security sandboxes. If the * nominal value of relatedObject is a reference to a * DisplayObject in another sandbox, relatedObject is set to * null unless there is permission in both directions across * this sandbox boundary. Permission is established by calling * Security.allowDomain() from a SWF file, or by providing a * policy file from the server of an image file, and setting the * LoaderContext.checkPolicyFile property when loading the * image.

var localX:Float

The horizontal coordinate at which the event occurred relative to the * containing sprite.

var localY:Float

The vertical coordinate at which the event occurred relative to the * containing sprite.

var pressure:Float

A value between 0.0 and 1.0 indicating force of * the contact with the device. If the device does not support detecting the * pressure, the value is 1.0.

var relatedObject:InteractiveObject

A reference to a display list object that is related to the event. For * example, when a touchOut event occurs, * relatedObject represents the display list object to which the * pointing device now points. This property applies to the * touchOut, touchOver, touchRollOut, * and touchRollOver events. * *

The value of this property can be null in two * circumstances: if there is no related object, or there is a related * object, but it is in a security sandbox to which you don't have access. * Use the isRelatedObjectInaccessible() property to determine * which of these reasons applies.

var shiftKey:Bool

Indicates whether the Shift key is active(true) or inactive * (false).

var sizeX:Float

Width of the contact area. * Only supported on Android(C++ target), in the range of 0-1.

var sizeY:Float

Height of the contact area. * Only supported on Android(C++ target), in the range of 0-1.

var stageX:Float

The horizontal coordinate at which the event occurred in global Stage * coordinates. This property is calculated when the localX * property is set.

var stageY:Float

The vertical coordinate at which the event occurred in global Stage * coordinates. This property is calculated when the localY * property is set.

var touchPointID:Int

A unique identification number(as an int) assigned to the touch point.

function new(type:String, ?bubbles:Bool, ?cancelable:Bool, ?touchPointID:Int, ?isPrimaryTouchPoint:Bool, ?localX:Float, ?localY:Float, ?sizeX:Float, ?sizeY:Float, ?pressure:Float, ?relatedObject:InteractiveObject, ?ctrlKey:Bool, ?altKey:Bool, ?shiftKey:Bool):Void

Creates an Event object that contains information about touch events. * Event objects are passed as parameters to event listeners. * *

type

The type of the event. Possible values are: * TouchEvent.TOUCHBEGIN, * TouchEvent.TOUCHEND, * TouchEvent.TOUCHMOVE, * TouchEvent.TOUCHOUT, * TouchEvent.TOUCHOVER, * TouchEvent.TOUCHROLLOUT, * TouchEvent.TOUCHROLLOVER, and * TouchEvent.TOUCHTAP. *

bubbles

Determines whether the Event object * participates in the bubbling phase of the event * flow. *

cancelable

Determines whether the Event object can be * canceled. *

touchPointID

A unique identification number(as an int) * assigned to the touch point. *

isPrimaryTouchPoint

Indicates whether the first point of contact is mapped to mouse events.

relatedObject

The complementary InteractiveObject instance * that is affected by the event. For example, * when a touchOut event occurs, * relatedObject represents the * display list object to which the pointing * device now points. *

ctrlKey

On Windows or Linux, indicates whether the Ctrl * key is activated. On Mac, indicates whether * either the Ctrl key or the Command key is * activated. *

altKey

Indicates whether the Alt key is activated * (Windows or Linux only). *

shiftKey

Indicates whether the Shift key is activated.

function updateAfterEvent():Void

Instructs Flash Player or Adobe AIR to render after processing of this * event completes, if the display list has been modified.