Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
EventListenerRequest

Package | mx.events
Class | public class EventListenerRequest
Inheritance | EventListenerRequest SWFBridgeRequest flash.events.Event

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Request sent from one SystemManager to a SystemManager in another application through their bridge to add or remove a listener to a specified event on your behalf. The `data` property is not used. Only certain events can be requested. When the event is triggered in the other application, that event is re-dispatched through the bridge where the requesting SystemManager picks up the event and redispatches it from itself. In general, this request is generated because some other code called the `addEventListener()` method for one of the approved events on its SystemManager. This request is also dispatched by SystemManager to allow the marshal implementation to handle adding or removing listeners differently. When dispatched by the SystemManager, the listener property is non-null;

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | data : Object Data related to the event. | SWFBridgeRequest
|  | eventType : String [read-only] The type of the event to listen to. | EventListenerRequest
|  | listener : Function [read-only] The method or function to call | EventListenerRequest
|  | priority : int [read-only] The priority parameter to addEventListener(). | EventListenerRequest
|  | requestor : IEventDispatcher The bridge that sent the message. | SWFBridgeRequest
|  | useCapture : Boolean [read-only] The useCapture parameter to addEventListener(). | EventListenerRequest
|  | useWeakReference : Boolean [read-only] The useWeakReference parameter to addEventListener(). | EventListenerRequest

Public Methods

| Method | Defined By
--- | --- | ---
|  | EventListenerRequest(type:String, bubbles:Boolean = false, cancelable:Boolean = true, eventType:String = null, listener:Function = null, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false) Creates a new request to add or remove an event listener. | EventListenerRequest
|  | marshal(event:Event):EventListenerRequest [static] Marshals an event by copying the relevant parameters from the event into a new event. | EventListenerRequest

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | ACTIVATE_FOCUS_REQUEST : String = activateFocusRequest [static] Sent from the top-level focus manager to a subordinate focus managers so all the focus managers participating in a tab loop get activated. | SWFBridgeRequest
|  | ACTIVATE_POP_UP_REQUEST : String = activatePopUpRequest [static] Requests that a child application's pop up be activated. | SWFBridgeRequest
|  | ADD_EVENT_LISTENER_REQUEST : String = addEventListenerRequest [static] Request to add an event listener. | EventListenerRequest
|  | ADD_POP_UP_PLACE_HOLDER_REQUEST : String = addPopUpPlaceHolderRequest [static] Adds a placeholder for a pop up window hosted by a child SystemManager. | SWFBridgeRequest
|  | ADD_POP_UP_REQUEST : String = addPopUpRequest [static] Adds a popup on the targeted application. | SWFBridgeRequest
|  | CAN_ACTIVATE_POP_UP_REQUEST : String = canActivateRequestPopUpRequest [static] Tests if a given pop up can be activated. | SWFBridgeRequest
|  | CREATE_MODAL_WINDOW_REQUEST : String = createModalWindowRequest [static] Creates a modal window. | SWFBridgeRequest
|  | DEACTIVATE_FOCUS_REQUEST : String = deactivateFocusRequest [static] Sent from the top-level focus manager to a subordinate focus managers so all the focus managers participating in a tab loop get deactivated. | SWFBridgeRequest
|  | DEACTIVATE_POP_UP_REQUEST : String = deactivatePopUpRequest [static] Requests that a child application's pop up be deactivated. | SWFBridgeRequest
|  | GET_SIZE_REQUEST : String = getSizeRequest [static] Gets the size of the child SystemManager. | SWFBridgeRequest
|  | GET_VISIBLE_RECT_REQUEST : String = getVisibleRectRequest [static] Requests that the parent SystemManager calculate the visible portion of the requesting SWF based on any DisplayObjects that might be clipping the requesting SWF. | SWFBridgeRequest
|  | HIDE_MODAL_WINDOW_REQUEST : String = hideModalWindowRequest [static] Hides a modal window. | SWFBridgeRequest
|  | HIDE_MOUSE_CURSOR_REQUEST : String = hideMouseCursorRequest [static] Requests that the mouse cursor should be hidden when over this application. | SWFBridgeRequest
|  | INVALIDATE_REQUEST : String = invalidateRequest [static] Requests that the loader of the current application invalidate its properties, size, or display list. | SWFBridgeRequest
|  | IS_BRIDGE_CHILD_REQUEST : String = isBridgeChildRequest [static] Tests if a given DisplayObject is a child of a SWF or one of its child SWFs. | SWFBridgeRequest
|  | MOVE_FOCUS_REQUEST : String = moveFocusRequest [static] Request to move control over focus to another FocusManager.and have that FocusManager give focus to a control under its management based on the direction property in the event. | SWFBridgeRequest
|  | REMOVE_EVENT_LISTENER_REQUEST : String = removeEventListenerRequest [static] Request to remove an event listener. | EventListenerRequest
|  | REMOVE_POP_UP_PLACE_HOLDER_REQUEST : String = removePopUpPlaceHolderRequest [static] Removes a placeholder. | SWFBridgeRequest
|  | REMOVE_POP_UP_REQUEST : String = removePopUpRequest [static] Removes a popup from the sandboxRoot's SystemManager. | SWFBridgeRequest
|  | RESET_MOUSE_CURSOR_REQUEST : String = resetMouseCursorRequest [static] Requests that the show/hide mouse cursor logic be reset for a new mouse event so that the various applications can request whether the mouse cursor should be shown or hidden. | SWFBridgeRequest
|  | SET_ACTUAL_SIZE_REQUEST : String = setActualSizeRequest [static] Sets the size of the child.systemManager. | SWFBridgeRequest
|  | SET_SHOW_FOCUS_INDICATOR_REQUEST : String = setShowFocusIndicatorRequest [static] Set the value of the showFocusIndicator property in every application's FocusManager. | SWFBridgeRequest
|  | SHOW_MODAL_WINDOW_REQUEST : String = showModalWindowRequest [static] Shows a modal window. | SWFBridgeRequest
|  | SHOW_MOUSE_CURSOR_REQUEST : String = showMouseCursorRequest [static] Asks the top-level root if the mouse cursor should be hidden given its current location. | SWFBridgeRequest

Property Detail

eventType | property

`eventType:String` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The type of the event to listen to.

Implementation
`public function get eventType():String`

See also

flash.events.Event.type

listener | property |

`listener:Function` [read-only]

The method or function to call

Implementation
`public function get listener():Function`

See also

flash.events.IEventDispatcher.addEventListener

priority | property |

`priority:int` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The `priority` parameter to `addEventListener()`.

Implementation
`public function get priority():int`

See also

flash.events.IEventDispatcher.addEventListener

useCapture | property |

`useCapture:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The `useCapture` parameter to `addEventListener()`.

Implementation
`public function get useCapture():Boolean`

See also

flash.events.IEventDispatcher.addEventListener

useWeakReference | property |

`useWeakReference:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The `useWeakReference` parameter to `addEventListener()`.

Implementation
`public function get useWeakReference():Boolean`

See also

flash.events.IEventDispatcher.addEventListener
Constructor Detail

EventListenerRequest | () | Constructor

`public function EventListenerRequest(type:String, bubbles:Boolean = false, cancelable:Boolean = true, eventType:String = null, listener:Function = null, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false)`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Creates a new request to add or remove an event listener.

Parameters

| `type:String` — The event type; indicates the action that caused the event. Either `EventListenerRequest.ADD` or `EventListenerRequest.REMOVE`.
| `bubbles:Boolean` (default = `false`)`` — Specifies whether the event can bubble up the display list hierarchy.
| `cancelable:Boolean` (default = `true`)`` — Specifies whether the behavior associated with the event can be prevented.
| `eventType:String` (default = `null`)`` — The type of message you would normally pass to the `addEventListener()` method.
| `listener:Function` (default = `null`)`` — Determines whether the listener works in the capture phase or the target and bubbling phases.
| `useCapture:Boolean` (default = `false`)`` — The priority level of the event listener. Priorities are designated by a 32-bit integer.
| `priority:int` (default = `0`)`` — Determines whether the reference to the listener is strong or weak.
| `useWeakReference:Boolean` (default = `false`)``

See also

flash.events.IEventDispatcher.addEventListener
Method Detail

marshal | () | method

`public static function marshal(event:Event):EventListenerRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Marshals an event by copying the relevant parameters from the event into a new event.

Parameters

| `event:Event` — The event to marshal.

Returns

| `EventListenerRequest` — An EventListenerRequest that defines the new event.

Constant Detail

ADD_EVENT_LISTENER_REQUEST | Constant

`public static const ADD_EVENT_LISTENER_REQUEST:String = addEventListenerRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Request to add an event listener.

REMOVE_EVENT_LISTENER_REQUEST | Constant |

`public static const REMOVE_EVENT_LISTENER_REQUEST:String = removeEventListenerRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Request to remove an event listener.

Sun Mar 5 2017, 03:42 PM +11:00