| Package | flash.events |
| Class | public class GestureEvent |
| Inheritance | GestureEvent  Event Object |
| Subclasses | PressAndTapGestureEvent, TransformGestureEvent |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.1, AIR 2, Flash Lite 4 |
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.
More examples
Related API Elements
flash.ui.Multitouch
flash.events.TouchEvent
flash.events.TransformGestureEvent
flash.events.PressAndTapGestureEvent
flash.events.MouseEvent
flash.events.EventDispatcher.addEventListener()
flash.events.TouchEvent
flash.events.TransformGestureEvent
flash.events.PressAndTapGestureEvent
flash.events.MouseEvent
flash.events.EventDispatcher.addEventListener()
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| altKey : Boolean
Indicates whether the Alt key is active (true) or inactive (false). | GestureEvent | ||
 | bubbles : Boolean [read-only]
Indicates whether an event is a bubbling event. | Event | |
| cancelable : Boolean [read-only]
Indicates whether the behavior associated with the event can be prevented. | Event | |
| commandKey : Boolean
Indicates whether the command key is activated (Mac only). | GestureEvent | ||
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| controlKey : Boolean
Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux. | GestureEvent | ||
| ctrlKey : Boolean
On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false). | GestureEvent | ||
| currentTarget : Object [read-only]
The object that is actively processing the Event object with an event listener. | Event | |
| eventPhase : uint [read-only]
The current phase in the event flow. | Event | |
| localX : Number
The horizontal coordinate at which the event occurred relative to the containing sprite. | GestureEvent | ||
| localY : Number
The vertical coordinate at which the event occurred relative to the containing sprite. | GestureEvent | ||
| phase : String
A value from the GesturePhase class indicating the progress of the touch gesture. | GestureEvent | ||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| shiftKey : Boolean
Indicates whether the Shift key is active (true) or inactive
(false). | GestureEvent | ||
| stageX : Number [read-only]
The horizontal coordinate at which the event occurred in global Stage coordinates. | GestureEvent | ||
| stageY : Number [read-only]
The vertical coordinate at which the event occurred in global Stage coordinates. | GestureEvent | ||
| target : Object [read-only]
The event target. | Event | |
| type : String [read-only]
The type of event. | Event | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
GestureEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, phase:String = null, localX:Number = 0, localY:Number = 0, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, commandKey:Boolean = false, controlKey:Boolean = false)
Creates an Event object that contains information about multi-touch events
(such as pressing two fingers on a touch screen at the same time). | GestureEvent | ||
[override]
Creates a copy of the GestureEvent object and sets the value of each property to match that of the original. | GestureEvent | ||
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
[override]
Returns a string that contains all the properties of the GestureEvent object. | GestureEvent | ||
Refreshes the Flash runtime display after processing the gesture event, in case the display list has been modified by the event handler. | GestureEvent | ||
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| ACTIVATE : String = "activate" [static]
The ACTIVATE constant defines the value of the type property of an activate event object. | Event | |
| ADDED : String = "added" [static]
The Event.ADDED constant defines the value of the type property of
an added event object. | Event | |
| ADDED_TO_STAGE : String = "addedToStage" [static]
The Event.ADDED_TO_STAGE constant defines the value of the type
property of an addedToStage event object. | Event | |
| CANCEL : String = "cancel" [static]
The Event.CANCEL constant defines the value of the type property of a cancel event object. | Event | |
| CHANGE : String = "change" [static]
The Event.CHANGE constant defines the value of the type property of a change event object. | Event | |
| CLEAR : String = "clear" [static]
The Event.CLEAR constant defines the value of the type property
of a clear event object. | Event | |
| CLOSE : String = "close" [static]
The Event.CLOSE constant defines the value of the type property of a close event object. | Event | |
| CLOSING : String = "closing" [static]
The Event.CLOSING constant defines the value of the
type property of a closing event object. | Event | |
| COMPLETE : String = "complete" [static]
The Event.COMPLETE constant defines the value of the type property of a complete event object. | Event | |
| CONNECT : String = "connect" [static]
The Event.CONNECT constant defines the value of the type property of a connect event object. | Event | |
| CONTEXT3D_CREATE : String = "context3DCreate" [static]
The Event.CONTEXT3D_CREATE constant defines the value of the type
property of a context3Dcreate event object. | Event | |
| COPY : String = "copy" [static]
Defines the value of the type property of a copy event object. | Event | |
| CUT : String = "cut" [static]
Defines the value of the type property of a cut event object. | Event | |
| DEACTIVATE : String = "deactivate" [static]
The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object. | Event | |
| DISPLAYING : String = "displaying" [static]
The Event.DISPLAYING constant defines the value of the type property of a displaying event object. | Event | |
| ENTER_FRAME : String = "enterFrame" [static]
The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object. | Event | |
| EXIT_FRAME : String = "exitFrame" [static]
The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object. | Event | |
| EXITING : String = "exiting" [static]
The Event.EXITING constant defines the value of the type property of an exiting event object. | Event | |
| FRAME_CONSTRUCTED : String = "frameConstructed" [static]
The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object. | Event | |
| FULLSCREEN : String = "fullScreen" [static]
The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object. | Event | |
| GESTURE_TWO_FINGER_TAP : String = "gestureTwoFingerTap" [static]
Defines the value of the type property of a GESTURE_TWO_FINGER_TAP gesture event object. | GestureEvent | ||
| HTML_BOUNDS_CHANGE : String = "htmlBoundsChange" [static]
The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object. | Event | |
| HTML_DOM_INITIALIZE : String = "htmlDOMInitialize" [static]
The Event.HTML_DOM_INITIALIZE constant defines the value of the type property
of an htmlDOMInitialize event object. | Event | |
| HTML_RENDER : String = "htmlRender" [static]
The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object. | Event | |
| ID3 : String = "id3" [static]
The Event.ID3 constant defines the value of the type property of an id3 event object. | Event | |
| INIT : String = "init" [static]
The Event.INIT constant defines the value of the type property of an init event object. | Event | |
| LOCATION_CHANGE : String = "locationChange" [static]
The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object. | Event | |
| MOUSE_LEAVE : String = "mouseLeave" [static]
The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object. | Event | |
| NETWORK_CHANGE : String = "networkChange" [static]
The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object. | Event | |
| OPEN : String = "open" [static]
The Event.OPEN constant defines the value of the type property of an open event object. | Event | |
| PASTE : String = "paste" [static]
The Event.PASTE constant defines the value of the type property of a paste event object. | Event | |
| PREPARING : String = "preparing" [static]
The Event.PREPARING constant defines the value of the type property of a preparing event object. | Event | |
| REMOVED : String = "removed" [static]
The Event.REMOVED constant defines the value of the type property of
a removed event object. | Event | |
| REMOVED_FROM_STAGE : String = "removedFromStage" [static]
The Event.REMOVED_FROM_STAGE constant defines the value of the type
property of a removedFromStage event object. | Event | |
| RENDER : String = "render" [static]
The Event.RENDER constant defines the value of the type property of a render event object. | Event | |
| RESIZE : String = "resize" [static]
The Event.RESIZE constant defines the value of the type property of a resize event object. | Event | |
| SCROLL : String = "scroll" [static]
The Event.SCROLL constant defines the value of the type property of a scroll event object. | Event | |
| SELECT : String = "select" [static]
The Event.SELECT constant defines the value of the type property of a select event object. | Event | |
| SELECT_ALL : String = "selectAll" [static]
The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object. | Event | |
| SOUND_COMPLETE : String = "soundComplete" [static]
The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object. | Event | |
| STANDARD_ERROR_CLOSE : String = "standardErrorClose" [static]
The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object. | Event | |
| STANDARD_INPUT_CLOSE : String = "standardInputClose" [static]
The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object. | Event | |
| STANDARD_OUTPUT_CLOSE : String = "standardOutputClose" [static]
The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object. | Event | |
| TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static]
The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object. | Event | |
| TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static]
The Event.TAB_ENABLED_CHANGE constant defines the value of the type
property of a tabEnabledChange event object. | Event | |
| TAB_INDEX_CHANGE : String = "tabIndexChange" [static]
The Event.TAB_INDEX_CHANGE constant defines the value of the
type property of a tabIndexChange event object. | Event | |
| TEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange" [static]
The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of an interaction mode event object. | Event | |
| UNLOAD : String = "unload" [static]
The Event.UNLOAD constant defines the value of the type property of an unload event object. | Event | |
| USER_IDLE : String = "userIdle" [static]
The Event.USER_IDLE constant defines the value of the type property of a userIdle event object. | Event | |
| USER_PRESENT : String = "userPresent" [static]
The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object. | Event | |
Property Detail
altKey | property |
altKey:Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.1, AIR 2 |
Indicates whether the Alt key is active (true) or inactive (false).
Supported for Windows and Linux operating systems only.
Implementation
public function get altKey():Boolean public function set altKey(value:Boolean):void commandKey | property |
commandKey:Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 2 |
Indicates whether the command key is activated (Mac only).
On a Mac OS, the value of the commandKey property
is the same value as the ctrlKey property.
This property is always false on Windows or Linux.
Implementation
public function get commandKey():Boolean public function set commandKey(value:Boolean):voidcontrolKey | property |
controlKey:Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.1, AIR 2 |
Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.
Implementation
public function get controlKey():Boolean public function set controlKey(value:Boolean):voidctrlKey | property |
ctrlKey:Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.1, AIR 2 |
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.
Implementation
public function get ctrlKey():Boolean public function set ctrlKey(value:Boolean):voidlocalX | property |
localY | property |
phase | property |
phase:String| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.1, AIR 2, Flash Lite 4 |
A value from the GesturePhase class indicating the progress of the touch gesture. For most gestures,
the value is begin, update, or end. For the swipe and two-finger tap gestures,
the phase value is always all once the event is dispatched.
Use this value to determine when an event handler responds to a complex user interaction, or responds in
different ways depending on the current phase of a multi-touch gesture (such as expanding, moving, and "dropping" as
a user touches and drags a visual object across a screen).
Implementation
public function get phase():String public function set phase(value:String):voidRelated API Elements
shiftKey | property |
stageX | property |
stageX:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.1, AIR 2, Flash Lite 4 |
The horizontal coordinate at which the event occurred in global Stage coordinates.
This property is calculated when the localX property is set.
Implementation
public function get stageX():NumberstageY | property |
stageY:Number [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.1, AIR 2, Flash Lite 4 |
The vertical coordinate at which the event occurred in global Stage coordinates.
This property is calculated when the localY property is set.
Implementation
public function get stageY():NumberConstructor Detail
GestureEvent | () | Constructor |
public function GestureEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, phase:String = null, localX:Number = 0, localY:Number = 0, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, commandKey:Boolean = false, controlKey:Boolean = false)| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.1, AIR 2, Flash Lite 4 |
Creates an Event object that contains information about multi-touch events (such as pressing two fingers on a touch screen at the same time). Event objects are passed as parameters to event listeners.
Parameterstype:String — The type of the event. The supported value is: GestureEvent.GESTURE_TWO_FINGER_TAP.
| |
bubbles:Boolean (default = true) | |
cancelable:Boolean (default = false) | |
phase:String (default = null) | |
localX:Number (default = 0) | |
localY:Number (default = 0) | |
ctrlKey:Boolean (default = false) | |
altKey:Boolean (default = false) | |
shiftKey:Boolean (default = false) | |
commandKey:Boolean (default = false) | |
controlKey:Boolean (default = false) |
Related API Elements
Method Detail
clone | () | method |
override public function clone():Event| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.1, AIR 2, Flash Lite 4 |
Creates a copy of the GestureEvent object and sets the value of each property to match that of the original.
ReturnsEvent — A new GestureEvent object with property values that match those of the original.
|
toString | () | method |
override public function toString():String| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.1, AIR 2, Flash Lite 4 |
Returns a string that contains all the properties of the GestureEvent object. The string is in the following format:
[GestureEvent type=value bubbles=value cancelable=value ... ]
String — A string that contains all the properties of the GestureEvent object.
|
updateAfterEvent | () | method |
public function updateAfterEvent():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.1, AIR 2, Flash Lite 4 |
Refreshes the Flash runtime display after processing the gesture event, in case the display list has been modified by the event handler.
Constant Detail
GESTURE_TWO_FINGER_TAP | Constant |
public static const GESTURE_TWO_FINGER_TAP:String = "gestureTwoFingerTap"| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10.1, AIR 2, Flash Lite 4 |
Defines the value of the type property of a GESTURE_TWO_FINGER_TAP gesture event object.
The dispatched GestureEvent 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 | (AIR only) 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. |
phase | The current phase in the event flow. For two-finger tap events,
this value is always all corresponding to the value GesturePhase.ALL once the event is dispatched. |
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. |
shiftKey | true if the Shift key is active; false if it is inactive. |
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. |
Related API Elements
Examples How to use this example
GestureTwoFingerTap.as
The following example shows event handling for the
GESTURE_TWO_FINGER_TAP event.
While the user performs a two-finger tap gesture, mySprite rotates and myTextField populates with the phase all,
which is the only phase for two-finger tap events. Other gestures from the TransformGestureEvent class support begin, update,
and end phases.
Multitouch.inputMode = MultitouchInputMode.GESTURE;
var mySprite = new Sprite();
mySprite.addEventListener(GestureEvent.GESTURE_TWO_FINGER_TAP , onTwoFingerTap );
mySprite.graphics.beginFill(0x336699);
mySprite.graphics.drawRect(0, 0, 100, 80);
var myTextField = new TextField();
myTextField.y = 200;
addChild(mySprite);
addChild(myTextField);
function onTwoFingerTap(evt:GestureEvent):void {
evt.target.rotation -= 45;
myTextField.text = evt.phase; //"all"
}
Mon Nov 28 2011, 06:48 AM -08:00