flash.events

# PressAndTapGestureEvent - AS3

Package | flash.events
Class | public class PressAndTapGestureEvent
Inheritance | PressAndTapGestureEvent GestureEvent Event Object

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10.1, AIR 2, Flash Lite 4

The PressAndTapGestureEvent class lets you handle press-and-tap gesture on touch-enabled devices. Objects that inherit properties from the InteractiveObject class capture the primary touch point (press) and a secondary point (tap) in the dispatched event object. The press-and-tap gesture is typically used to raise a context-sensitive popup menu.

View the examples

Related API Elements

flash.ui.Multitouch
flash.display.InteractiveObject
flash.events.TouchEvent
flash.events.GestureEvent
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
|  | 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
|  | tapLocalX : Number The horizontal coordinate at which the event occurred relative to the containing interactive object. | PressAndTapGestureEvent
|  | tapLocalY : Number The vertical coordinate at which the event occurred relative to the containing interactive object. | PressAndTapGestureEvent
|  | tapStageX : Number [read-only] The horizontal coordinate at which the tap touch occurred in global Stage coordinates. | PressAndTapGestureEvent
|  | tapStageY : Number [read-only] The vertical coordinate at which the tap touch occurred in global Stage coordinates. | PressAndTapGestureEvent
|  | target : Object [read-only] The event target. | Event
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | PressAndTapGestureEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, phase:String = null, localX:Number = 0, localY:Number = 0, tapLocalX:Number = 0, tapLocalY: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 complex multi-touch events, such as a user raising a context-sensitive popup menu.
PressAndTapGestureEvent
|  | clone():Event [override] Creates a copy of the PressAndTapGestureEvent object and sets the value of each property to match that of the original. | PressAndTapGestureEvent
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event. | Event
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String [override] Returns a string that contains all the properties of the PressAndTapGestureEvent object. | PressAndTapGestureEvent
|  | updateAfterEvent():void Refreshes the Flash runtime display after processing the gesture event, in case the display list has been modified by the event handler. | GestureEvent
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | GESTURE_PRESS_AND_TAP : String = "gesturePressAndTap" [static] Defines the value of the type property of a GESTURE_PRESS_AND_TAP touch event object. | PressAndTapGestureEvent

Property Detail

### tapLocalX

property

`tapLocalX:Number`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10.1, AIR 2, Flash Lite 4

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

Implementation
`public function get tapLocalX():Number`
`public function set tapLocalX(value:Number):void`

### tapLocalY

property

`tapLocalY:Number`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10.1, AIR 2, Flash Lite 4

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

Implementation
`public function get tapLocalY():Number`
`public function set tapLocalY(value:Number):void`

### tapStageX

property

`tapStageX: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 tap touch occurred in global Stage coordinates. This property is calculated when the `tapLocalX` property is set.

Implementation
`public function get tapStageX():Number`

### tapStageY

property

`tapStageY: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 tap touch occurred in global Stage coordinates. This property is calculated when the `tapLocalX` property is set.

Implementation
`public function get tapStageY():Number`
Constructor Detail

### PressAndTapGestureEvent

()
Constructor

`public function PressAndTapGestureEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, phase:String = null, localX:Number = 0, localY:Number = 0, tapLocalX:Number = 0, tapLocalY: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 complex multi-touch events, such as a user raising a context-sensitive popup menu. Event objects are passed as parameters to event listeners.

Parameters

| `type:String` — The type of the event: `PressAndTapGestureEvent.GESTURE_PRESS_AND_TAP`.
| `bubbles:Boolean` (default = `true`)`` — Determines whether the Event object participates in the bubbling phase of the event flow.
| `cancelable:Boolean` (default = `false`)`` — Determines whether the Event object can be canceled.
| `phase:String` (default = `null`)`` — This values tracks the beginning, progress, and end of a touch gesture. Possible values are: `GesturePhase.BEGIN`, `GesturePhase.END`, `GesturePhase.UPDATE`, or `GesturePhase.ALL`.
| `localX:Number` (default = `0`)`` — The horizontal coordinate at which the event occurred relative to the containing display object.
| `localY:Number` (default = `0`)`` — The vertical coordinate at which the event occurred relative to the containing display object.
| `tapLocalX:Number` (default = `0`)`` — The horizontal coordinate at which the event occurred relative to the containing interactive object.
| `tapLocalY:Number` (default = `0`)`` — The vertical coordinate at which the event occurred relative to the containing interactive object.
| `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.
| `altKey:Boolean` (default = `false`)`` — Indicates whether the Alt key is activated (Windows or Linux only).
| `shiftKey:Boolean` (default = `false`)`` — Indicates whether the Shift key is activated.
| `commandKey:Boolean` (default = `false`)`` — (AIR only) Indicates whether the Command key is activated (Mac only). This parameter is for Adobe AIR only; do not set it for Flash Player content.
| `controlKey:Boolean` (default = `false`)`` — (AIR only) Indicates whether the Control or Ctrl key is activated. This parameter is for Adobe AIR only; do not set it for Flash Player content.

Related API Elements

flash.ui.Multitouch
flash.events.TouchEvent
flash.events.GestureEvent
flash.events.GesturePhase
flash.events.MouseEvent
flash.events.EventDispatcher.addEventListener()
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 PressAndTapGestureEvent object and sets the value of each property to match that of the original.

Returns

| `Event` — A new PressAndTapGestureEvent 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 PressAndTapGestureEvent object. The string is in the following format:

`[PressAndTapGestureEvent type=value bubbles=value cancelable=value ... ]`

Returns

| `String` — A string that contains all the properties of the PressAndTapGestureEvent object.

Constant Detail

### GESTURE_PRESS_AND_TAP

Constant

`public static const GESTURE_PRESS_AND_TAP:String = "gesturePressAndTap"`

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_PRESS_AND_TAP` touch event object.

The dispatched PressAndTapGestureEvent 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 as the event passes through the object hierarchy; a numeric value indicating the event is captured (1), at the target (2), or bubbling (3).
`localX` | The horizontal coordinate at which the event occurred relative to the containing display object.
`localY` | The vertical coordinate at which the event occurred relative to the containing display object.
`phase` | The current phase in the event flow; a value from the GesturePhase class.Possible values are: `GesturePhase.BEGIN`, `GesturePhase.UPDATE`, `GesturePhase.END`, or `GesturePhase.ALL`. A press-and-tap gesture either generates a `GesturePhase.BEGIN`, `GesturePhase.UPDATE`, `GesturePhase.END` sequence or the gesture generates a single `GesturePhase.ALL` phase.
`shiftKey` | `true` if the Shift key is active; `false` if it is inactive.
`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.
`tapLocalX` | The horizontal coordinate at which the event occurred relative to the containing interactive object.
`tapLocalY` | The vertical coordinate at which the event occurred relative to the containing interactive object.
`tapStageX` | The horizontal coordinate at which the tap touch occurred in global Stage coordinates.
`tapStageY` | The vertical coordinate at which the tap touch 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.

Related API Elements

flash.display.InteractiveObject.gesturePressAndTap
flash.events.GesturePhase
Examples How to use this example
GesturePressAndTap.as
The following example shows event handling for the `GESTURE_PRESS_AND_TAP` event. While the user performs a press-and-tap gesture, mySprite rotates and myTextField populates with the current phase.
Copy

    Multitouch.inputMode = MultitouchInputMode.GESTURE;

    var mySprite = new Sprite();
    mySprite.addEventListener(PressAndTapGestureEvent.GESTURE_PRESS_AND_TAP , onPressAndTap );
    mySprite.graphics.beginFill(0x336699);
    mySprite.graphics.drawRect(0, 0, 100, 80);
    var myTextField = new TextField();
    myTextField.y = 200;
    addChild(mySprite);
    addChild(myTextField);

    function onPressAndTap(evt:PressAndTapGestureEvent):void {

        evt.target.rotation -= 45;

        if (evt.phase==GesturePhase.BEGIN) {
            myTextField.text = "Begin";
        }
        if (evt.phase==GesturePhase.UPDATE) {
            myTextField.text = "Update";
        }
        if (evt.phase==GesturePhase.END) {
            myTextField.text = "End";
        }
    }

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00