ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.events 

TouchInteractionEvent  - AS3 Flex

Packagemx.events
Classpublic class TouchInteractionEvent
InheritanceTouchInteractionEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.5

TouchInteractionEvents are used to coordinate touch intraction and response among different components.

More examples

Learn more



Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  reason : String
The reason for this gesture capture event.
TouchInteractionEvent
  relatedObject : Object
The object attempting to capture this touch interaction.
TouchInteractionEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
TouchInteractionEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)
Constructor.
TouchInteractionEvent
 Inherited
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  TOUCH_INTERACTION_END : String = "touchInteractionEnd"
[static] The TouchInteractionEvent.TOUCH_INTERACTION_END constant defines the value of the type property of the event object for a touchInteractionEnd event.
TouchInteractionEvent
  TOUCH_INTERACTION_START : String = "touchInteractionStart"
[static] The TouchInteractionEvent.TOUCH_INTERACTION_START constant defines the value of the type property of the event object for a touchInteractionStart event.
TouchInteractionEvent
  TOUCH_INTERACTION_STARTING : String = "touchInteractionStarting"
[static] The TouchInteractionEvent.TOUCH_INTERACTION_STARTING constant defines the value of the type property of the event object for a touchInteractionStarting event.
TouchInteractionEvent
Property Detail

reason

property
public var reason:String

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.5

The reason for this gesture capture event.

Related API Elements

relatedObject

property 
public var relatedObject:Object

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.5

The object attempting to capture this touch interaction.

Constructor Detail

TouchInteractionEvent

()Constructor
public function TouchInteractionEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.5

Constructor.

Parameters
type:String — The event type; indicates the action that caused the event.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Specifies whether the behavior associated with the event can be prevented.
Constant Detail

TOUCH_INTERACTION_END

Constant
public static const TOUCH_INTERACTION_END:String = "touchInteractionEnd"

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.5

The TouchInteractionEvent.TOUCH_INTERACTION_END constant defines the value of the type property of the event object for a touchInteractionEnd event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
reasonThe reason for the touch interaction event. See mx.events.TouchInteractionReason.
relatedObjectThe object associated with this touch interaction event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

Related API Elements

TOUCH_INTERACTION_START

Constant 
public static const TOUCH_INTERACTION_START:String = "touchInteractionStart"

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.5

The TouchInteractionEvent.TOUCH_INTERACTION_START constant defines the value of the type property of the event object for a touchInteractionStart event.

The properties of the event object have the following values:

PropertyValue
bubblestrue
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
reasonThe reason for the touch interaction event. See mx.events.TouchInteractionReason.
relatedObjectThe object associated with this touch interaction event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

Related API Elements

TOUCH_INTERACTION_STARTING

Constant 
public static const TOUCH_INTERACTION_STARTING:String = "touchInteractionStarting"

Language Version: ActionScript 3.0
Product Version: Flex 4.5
Runtime Versions: Flash Player 10, AIR 2.5

The TouchInteractionEvent.TOUCH_INTERACTION_STARTING constant defines the value of the type property of the event object for a touchInteractionStarting event.

The properties of the event object have the following values:

PropertyValue
bubblestrue
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
reasonThe reason for the touch interaction event. See mx.events.TouchInteractionReason.
relatedObjectThe object associated with this touch interaction event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

Related API Elements