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.

In AIR 3, and above, you can listen for proximity events on supported Android devices that have an active stylus. On such devices,
proximityMove and touchMove event objects provide a byte array containing path and pressure
samples taken since the previous move event. You can use these samples to construct the path of the stylus between touch events.
(Note that hit-testing for interaction of the stylus input with the display list only occurs at the end of a path segment.)

isRelatedObjectInaccessible

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.

Implementation public function get isRelatedObjectInaccessible():Boolean public function set isRelatedObjectInaccessible(value:Boolean):void

relatedObject

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.

timestamp

The times reported are relative to the time the application started execution.
For events that return a sequence of points in the samples buffer, this timestamp
reflects the elapsed time of the last sample in the buffer.

Implementation public function get timestamp():Number public function set timestamp(value:Number):void

touchIntent

Reports whether the touch was generated by the primary or the eraser end of a stylus.

If a touch event is generated by a finger or other non-stylus input method,
or a stylus for which high-frequency motion tracking is not supported, this property reports
the value: TouchEventIntent.UNKNOWN.

The TouchEventIntent class defines constants for the possible values of this property,
which include:

TouchEventIntent.ERASER

TouchEventIntent.PEN

TouchEventIntent.UNKNOWN

Implementation public function get touchIntent():String public function set touchIntent(value:String):void

The following example establishes a variable touchMoveID to test for the correct touchPointID
value before responding to a touch move event. Otherwise, other touch input triggers the event handler, too. Notice the listeners for
the move and end phases are on the stage, not the display object. The stage listens for the move or end phases in case the user's touch
moves beyond the display object boundaries.

pressure:Number (default = NaN) — 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.

relatedObject:InteractiveObject (default = null) — 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:Boolean (default = false) — 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.

samples:ByteArray (default = null) — (AIR only) A ByteArray object containing position and pressure readings for each intermediate sample
recorded since the last touch or proximity event in a sequence.

isTouchPointCanceled:Boolean (default = false) — (AIR only) true if the touch event is canceled because of a rejected touch type.

getSamples

Updates the specified ByteArray object with the high-frequency data points for a multi-point touch event.

The ByteArray object referenced by the buffer parameter is updated with values for
the intermediate data points between this and the previous touch event. Three floating point
values are added for each sample: an x coordinate, a y coordinate, and a pressure value.
The position values reported in stage coordinates. The pressure is reported as a value between
0 and 1. Samples are recorded at regular time intervals. The exact frequency depends on the device
hardware and hardware drivers. Typical sample frequencies are around 133 Hz. Note that touch
events are not dispatched at exact intervals. Thus, the buffer for similar events can contain
a different number of samples. The last sample in the buffer has the same data as the
stageX, stageY, and pressure properties of this touch
event object.

A sample buffer is included in the event objects dispatched for proximityMove
and touchMove events.

append:Boolean (default = false) — when true, the samples are added to the buffer
byte array starting at the array's current position property.
When false, the default, existing data in the buffer object is discarded before the samples are added.

Returns

uint — uint the number of samples added to the buffer. Each sample consists of three floating point Numbers.

PROXIMITY_BEGIN

Defines the value of the type property of a PROXIMITY_BEGIN
touch event object.

The dispatched TouchEvent object has the following properties:

Property

Value

altKey

true if the Alt key is active (Windows or Linux).

bubbles

true

cancelable

false; there is no default behavior to cancel.

commandKey

true on the Mac if the Command key is active; false if it is inactive. Always false on Windows.

controlKey

true if the Ctrl or Control key is active; false if it is inactive.

ctrlKey

true on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.

currentTarget

The object that is actively processing the Event
object with an event listener.

eventPhase

The current phase in the event flow.

isRelatedObjectInaccessible

true if the relatedObject property is set to null because of security sandbox rules.

localX

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

localY

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

pressure

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.

relatedObject

A reference to a display list object related to the event.

shiftKey

true if the Shift key is active; false if it is inactive.

sizeX

Width of the contact area.

sizeY

Height of the contact area.

stageX

The horizontal coordinate at which the event occurred in global stage coordinates.

stageY

The vertical coordinate at which the event occurred in global stage coordinates.

target

The InteractiveObject instance under the touching device.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.

touchPointID

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

timestamp

(AIR only) The timestamp of the event in milliseconds relative to the start of the application.

touchIntent

(AIR only) A value from the TouchEventIntent class.

isTouchPointCanceled

(AIR only) true if the touch event is canceled because of the device's touch-rejection logic.

PROXIMITY_END

Defines the value of the type property of a PROXIMITY_END
touch event object.

The dispatched TouchEvent object has the following properties:

Property

Value

altKey

true if the Alt key is active (Windows or Linux).

bubbles

true

cancelable

false; there is no default behavior to cancel.

commandKey

true on the Mac if the Command key is active; false if it is inactive. Always false on Windows.

controlKey

true if the Ctrl or Control key is active; false if it is inactive.

ctrlKey

true on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.

currentTarget

The object that is actively processing the Event
object with an event listener.

eventPhase

The current phase in the event flow.

isRelatedObjectInaccessible

true if the relatedObject property is set to null because of security sandbox rules.

localX

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

localY

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

pressure

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.

relatedObject

A reference to a display list object related to the event.

shiftKey

true if the Shift key is active; false if it is inactive.

sizeX

Width of the contact area.

sizeY

Height of the contact area.

stageX

The horizontal coordinate at which the event occurred in global stage coordinates.

stageY

The vertical coordinate at which the event occurred in global stage coordinates.

target

The InteractiveObject instance under the touching device.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.

touchPointID

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

timestamp

(AIR only) The timestamp of the event in milliseconds relative to the start of the application.

touchIntent

(AIR only) A value from the TouchEventIntent class.

isTouchPointCanceled

(AIR only) true if the touch event is canceled because of the device's touch-rejection logic.

PROXIMITY_MOVE

Defines the value of the type property of a PROXIMITY_MOVE
touch event object.

The dispatched TouchEvent object has the following properties:

Property

Value

altKey

true if the Alt key is active (Windows or Linux).

bubbles

true

cancelable

false; there is no default behavior to cancel.

commandKey

true on the Mac if the Command key is active; false if it is inactive. Always false on Windows.

controlKey

true if the Ctrl or Control key is active; false if it is inactive.

ctrlKey

true on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.

currentTarget

The object that is actively processing the Event
object with an event listener.

eventPhase

The current phase in the event flow.

isRelatedObjectInaccessible

true if the relatedObject property is set to null because of security sandbox rules.

localX

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

localY

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

pressure

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.

relatedObject

A reference to a display list object related to the event.

shiftKey

true if the Shift key is active; false if it is inactive.

sizeX

Width of the contact area.

sizeY

Height of the contact area.

stageX

The horizontal coordinate at which the event occurred in global stage coordinates.

stageY

The vertical coordinate at which the event occurred in global stage coordinates.

target

The InteractiveObject instance under the touching device.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.

touchPointID

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

timestamp

(AIR only) The timestamp of the event in milliseconds relative to the start of the application.

touchIntent

(AIR only) A value from the TouchEventIntent class.

isTouchPointCanceled

(AIR only) true if the touch event is canceled because of the device's touch-rejection logic.

PROXIMITY_OUT

Defines the value of the type property of a PROXIMITY_OUT
touch event object.

The dispatched TouchEvent object has the following properties:

Property

Value

altKey

true if the Alt key is active (Windows or Linux).

bubbles

true

cancelable

false; there is no default behavior to cancel.

commandKey

true on the Mac if the Command key is active; false if it is inactive. Always false on Windows.

controlKey

true if the Ctrl or Control key is active; false if it is inactive.

ctrlKey

true on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.

currentTarget

The object that is actively processing the Event
object with an event listener.

eventPhase

The current phase in the event flow.

isRelatedObjectInaccessible

true if the relatedObject property is set to null because of security sandbox rules.

localX

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

localY

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

pressure

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.

relatedObject

A reference to a display list object related to the event.

shiftKey

true if the Shift key is active; false if it is inactive.

sizeX

Width of the contact area.

sizeY

Height of the contact area.

stageX

The horizontal coordinate at which the event occurred in global stage coordinates.

stageY

The vertical coordinate at which the event occurred in global stage coordinates.

target

The InteractiveObject instance under the touching device.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.

touchPointID

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

timestamp

(AIR only) The timestamp of the event in milliseconds relative to the start of the application.

touchIntent

(AIR only) A value from the TouchEventIntent class.

isTouchPointCanceled

(AIR only) true if the touch event is canceled because of the device's touch-rejection logic.

PROXIMITY_OVER

Defines the value of the type property of a PROXIMITY_OVER
touch event object.

The dispatched TouchEvent object has the following properties:

Property

Value

altKey

true if the Alt key is active (Windows or Linux).

bubbles

true

cancelable

false; there is no default behavior to cancel.

commandKey

true on the Mac if the Command key is active; false if it is inactive. Always false on Windows.

controlKey

true if the Ctrl or Control key is active; false if it is inactive.

ctrlKey

true on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.

currentTarget

The object that is actively processing the Event
object with an event listener.

eventPhase

The current phase in the event flow.

isRelatedObjectInaccessible

true if the relatedObject property is set to null because of security sandbox rules.

localX

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

localY

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

pressure

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.

relatedObject

A reference to a display list object related to the event.

shiftKey

true if the Shift key is active; false if it is inactive.

sizeX

Width of the contact area.

sizeY

Height of the contact area.

stageX

The horizontal coordinate at which the event occurred in global stage coordinates.

stageY

The vertical coordinate at which the event occurred in global stage coordinates.

target

The InteractiveObject instance under the touching device.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.

touchPointID

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

timestamp

(AIR only) The timestamp of the event in milliseconds relative to the start of the application.

touchIntent

(AIR only) A value from the TouchEventIntent class.

isTouchPointCanceled

(AIR only) true if the touch event is canceled because of the device's touch-rejection logic.

PROXIMITY_ROLL_OUT

Defines the value of the type property of a PROXIMITY_ROLL_OUT
touch event object.

The dispatched TouchEvent object has the following properties:

Property

Value

altKey

true if the Alt key is active (Windows or Linux).

bubbles

true

cancelable

false; there is no default behavior to cancel.

commandKey

true on the Mac if the Command key is active; false if it is inactive. Always false on Windows.

controlKey

true if the Ctrl or Control key is active; false if it is inactive.

ctrlKey

true on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.

currentTarget

The object that is actively processing the Event
object with an event listener.

eventPhase

The current phase in the event flow.

isRelatedObjectInaccessible

true if the relatedObject property is set to null because of security sandbox rules.

localX

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

localY

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

pressure

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.

relatedObject

A reference to a display list object related to the event.

shiftKey

true if the Shift key is active; false if it is inactive.

sizeX

Width of the contact area.

sizeY

Height of the contact area.

stageX

The horizontal coordinate at which the event occurred in global stage coordinates.

stageY

The vertical coordinate at which the event occurred in global stage coordinates.

target

The InteractiveObject instance under the touching device.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.

touchPointID

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

timestamp

(AIR only) The timestamp of the event in milliseconds relative to the start of the application.

touchIntent

(AIR only) A value from the TouchEventIntent class.

isTouchPointCanceled

(AIR only) true if the touch event is canceled because of the device's touch-rejection logic.

PROXIMITY_ROLL_OVER

Defines the value of the type property of a PROXIMITY_ROLL_OVER
touch event object.

The dispatched TouchEvent object has the following properties:

Property

Value

altKey

true if the Alt key is active (Windows or Linux).

bubbles

true

cancelable

false; there is no default behavior to cancel.

commandKey

true on the Mac if the Command key is active; false if it is inactive. Always false on Windows.

controlKey

true if the Ctrl or Control key is active; false if it is inactive.

ctrlKey

true on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.

currentTarget

The object that is actively processing the Event
object with an event listener.

eventPhase

The current phase in the event flow.

isRelatedObjectInaccessible

true if the relatedObject property is set to null because of security sandbox rules.

localX

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

localY

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

pressure

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.

relatedObject

A reference to a display list object related to the event.

shiftKey

true if the Shift key is active; false if it is inactive.

sizeX

Width of the contact area.

sizeY

Height of the contact area.

stageX

The horizontal coordinate at which the event occurred in global stage coordinates.

stageY

The vertical coordinate at which the event occurred in global stage coordinates.

target

The InteractiveObject instance under the touching device.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.

touchPointID

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

timestamp

(AIR only) The timestamp of the event in milliseconds relative to the start of the application.

touchIntent

(AIR only) A value from the TouchEventIntent class.

isTouchPointCanceled

(AIR only) true if the touch event is canceled because of the device's touch-rejection logic.

TOUCH_BEGIN

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

The dispatched TouchEvent object has the following properties:

Property

Value

altKey

true if the Alt key is active (Windows or Linux).

bubbles

true

cancelable

false; there is no default behavior to cancel.

commandKey

true on the Mac if the Command key is active; false if it is inactive. Always false on Windows.

controlKey

true if the Ctrl or Control key is active; false if it is inactive.

ctrlKey

true on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.

currentTarget

The object that is actively processing the Event
object with an event listener.

eventPhase

The current phase in the event flow.

isRelatedObjectInaccessible

true if the relatedObject property is set to null because of security sandbox rules.

localX

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

localY

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

pressure

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.

relatedObject

A reference to a display list object related to the event.

shiftKey

true if the Shift key is active; false if it is inactive.

sizeX

Width of the contact area.

sizeY

Height of the contact area.

stageX

The horizontal coordinate at which the event occurred in global stage coordinates.

stageY

The vertical coordinate at which the event occurred in global stage coordinates.

target

The InteractiveObject instance under the touching device.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.

touchPointID

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

TOUCH_END

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

The dispatched TouchEvent object has the following properties:

Property

Value

altKey

true if the Alt key is active (Windows or Linux).

bubbles

true

cancelable

false; there is no default behavior to cancel.

commandKey

true on the Mac if the Command key is active; false if it is inactive. Always false on Windows.

controlKey

true if the Ctrl or Control key is active; false if it is inactive.

ctrlKey

true on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.

currentTarget

The object that is actively processing the Event
object with an event listener.

eventPhase

The current phase in the event flow.

isRelatedObjectInaccessible

true if the relatedObject property is set to null because of security sandbox rules.

localX

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

localY

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

pressure

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.

relatedObject

A reference to a display list object related to the event.

shiftKey

true if the Shift key is active; false if it is inactive.

sizeX

Width of the contact area.

sizeY

Height of the contact area.

stageX

The horizontal coordinate at which the event occurred in global stage coordinates.

stageY

The vertical coordinate at which the event occurred in global stage coordinates.

target

The InteractiveObject instance under the touching device.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.

touchPointID

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

TOUCH_MOVE

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

The dispatched TouchEvent object has the following properties:

Property

Value

altKey

true if the Alt key is active (Windows or Linux).

bubbles

true

cancelable

false; there is no default behavior to cancel.

commandKey

true on the Mac if the Command key is active; false if it is inactive. Always false on Windows.

controlKey

true if the Ctrl or Control key is active; false if it is inactive.

ctrlKey

true on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.

currentTarget

The object that is actively processing the Event
object with an event listener.

eventPhase

The current phase in the event flow.

isRelatedObjectInaccessible

true if the relatedObject property is set to null because of security sandbox rules.

localX

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

localY

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

pressure

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.

relatedObject

A reference to a display list object related to the event.

shiftKey

true if the Shift key is active; false if it is inactive.

sizeX

Width of the contact area.

sizeY

Height of the contact area.

stageX

The horizontal coordinate at which the event occurred in global stage coordinates.

stageY

The vertical coordinate at which the event occurred in global stage coordinates.

target

The InteractiveObject instance under the touching device.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.

touchPointID

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

TOUCH_OUT

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

The dispatched TouchEvent object has the following properties:

Property

Value

altKey

true if the Alt key is active (Windows or Linux).

bubbles

true

cancelable

false; there is no default behavior to cancel.

commandKey

true on the Mac if the Command key is active; false if it is inactive. Always false on Windows.

controlKey

true if the Ctrl or Control key is active; false if it is inactive.

ctrlKey

true on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.

currentTarget

The object that is actively processing the Event
object with an event listener.

eventPhase

The current phase in the event flow.

isRelatedObjectInaccessible

true if the relatedObject property is set to null because of security sandbox rules.

localX

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

localY

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

pressure

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.

relatedObject

A reference to a display list object related to the event.

shiftKey

true if the Shift key is active; false if it is inactive.

sizeX

Width of the contact area.

sizeY

Height of the contact area.

stageX

The horizontal coordinate at which the event occurred in global stage coordinates.

stageY

The vertical coordinate at which the event occurred in global stage coordinates.

target

The InteractiveObject instance under the touching device.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.

touchPointID

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

TOUCH_OVER

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

The dispatched TouchEvent object has the following properties:

Property

Value

altKey

true if the Alt key is active (Windows or Linux).

bubbles

true

cancelable

false; there is no default behavior to cancel.

commandKey

true on the Mac if the Command key is active; false if it is inactive. Always false on Windows.

controlKey

true if the Ctrl or Control key is active; false if it is inactive.

ctrlKey

true on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.

currentTarget

The object that is actively processing the Event
object with an event listener.

eventPhase

The current phase in the event flow.

isRelatedObjectInaccessible

true if the relatedObject property is set to null because of security sandbox rules.

localX

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

localY

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

pressure

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.

relatedObject

A reference to a display list object related to the event.

shiftKey

true if the Shift key is active; false if it is inactive.

sizeX

Width of the contact area.

sizeY

Height of the contact area.

stageX

The horizontal coordinate at which the event occurred in global stage coordinates.

stageY

The vertical coordinate at which the event occurred in global stage coordinates.

target

The InteractiveObject instance under the touching device.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.

touchPointID

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

TOUCH_ROLL_OUT

Defines the value of the type property of a TOUCH_ROLL_OUT touch event object.

The dispatched TouchEvent object has the following properties:

Property

Value

altKey

true if the Alt key is active (Windows or Linux).

bubbles

true

cancelable

false; there is no default behavior to cancel.

commandKey

true on the Mac if the Command key is active; false if it is inactive. Always false on Windows.

controlKey

true if the Ctrl or Control key is active; false if it is inactive.

ctrlKey

true on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.

currentTarget

The object that is actively processing the Event
object with an event listener.

eventPhase

The current phase in the event flow.

isRelatedObjectInaccessible

true if the relatedObject property is set to null because of security sandbox rules.

localX

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

localY

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

pressure

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.

relatedObject

A reference to a display list object related to the event.

shiftKey

true if the Shift key is active; false if it is inactive.

sizeX

Width of the contact area.

sizeY

Height of the contact area.

stageX

The horizontal coordinate at which the event occurred in global stage coordinates.

stageY

The vertical coordinate at which the event occurred in global stage coordinates.

target

The InteractiveObject instance under the touching device.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.

touchPointID

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

TOUCH_ROLL_OVER

Defines the value of the type property of a TOUCH_ROLL_OVER touch event object.

The dispatched TouchEvent object has the following properties:

Property

Value

altKey

true if the Alt key is active (Windows or Linux).

bubbles

true

cancelable

false; there is no default behavior to cancel.

commandKey

true on the Mac if the Command key is active; false if it is inactive. Always false on Windows.

controlKey

true if the Ctrl or Control key is active; false if it is inactive.

ctrlKey

true on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.

currentTarget

The object that is actively processing the Event
object with an event listener.

eventPhase

The current phase in the event flow.

isRelatedObjectInaccessible

true if the relatedObject property is set to null because of security sandbox rules.

localX

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

localY

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

pressure

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.

relatedObject

A reference to a display list object related to the event.

shiftKey

true if the Shift key is active; false if it is inactive.

sizeX

Width of the contact area.

sizeY

Height of the contact area.

stageX

The horizontal coordinate at which the event occurred in global stage coordinates.

stageY

The vertical coordinate at which the event occurred in global stage coordinates.

target

The InteractiveObject instance under the touching device.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.

touchPointID

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

TOUCH_TAP

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

The dispatched TouchEvent object has the following properties:

Property

Value

altKey

true if the Alt key is active (Windows or Linux).

bubbles

true

cancelable

false; there is no default behavior to cancel.

commandKey

true on the Mac if the Command key is active; false if it is inactive. Always false on Windows.

controlKey

true if the Ctrl or Control key is active; false if it is inactive.

ctrlKey

true on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.

currentTarget

The object that is actively processing the Event
object with an event listener.

eventPhase

The current phase in the event flow.

isRelatedObjectInaccessible

true if the relatedObject property is set to null because of security sandbox rules.

localX

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

localY

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

pressure

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.

relatedObject

A reference to a display list object related to the event.

shiftKey

true if the Shift key is active; false if it is inactive.

sizeX

Width of the contact area.

sizeY

Height of the contact area.

stageX

The horizontal coordinate at which the event occurred in global stage coordinates.

stageY

The vertical coordinate at which the event occurred in global stage coordinates.

target

The InteractiveObject instance under the touching device.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event.

touchPointID

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

The following example shows event handling for the TOUCH_BEGIN, TOUCH_MOVE, and TOUCH_END events.
While the point of contact moves across the screen (onTouchMove), the x-coordinate relative to the stage is traced to output.
For the Sprite.startTouchDrag parameters in the onTouchBegin function, the value for touchPointID is the value assigned to the event object.
The bounds parameter is the rectangle defining the boundaries of
the parent display object (bg is a display object containing MySprite).

The following example shows how to handle touch events and touch event phases, as well as the Multitouch.maxTouchPoints and the
touch event object's touchPointID properties.
This example comes from Christian Cantrell, and is explained in more detail in his quickstart:
Multi-touch and gesture support on the Flash Platform.