mx.events.EventListenerRequest - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.events
Class	public class EventListenerRequest
Inheritance	EventListenerRequest SWFBridgeRequest Event Object

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
		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
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener.	Event
		data : Object Data related to the event.	SWFBridgeRequest
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		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
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		requestor : IEventDispatcher The bridge that sent the message.	SWFBridgeRequest
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event
		useCapture : Boolean [read-only] The useCapture parameter to addEventListener().	EventListenerRequest
		useWeakReference : Boolean [read-only] The useWeakReference parameter to addEventListener().	EventListenerRequest

Public Methods

Hide Inherited Public Methods

Show Inherited 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
		clone():Event Duplicates an instance of an Event subclass.	Event
		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
		marshal(event:Event):EventListenerRequest [static] Marshals an event by copying the relevant parameters from the event into a new event.	EventListenerRequest
		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 Returns a string containing all the properties of the Event object.	Event
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

Hide Inherited Public Constants

Show Inherited 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
		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
		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
		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
		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 efines 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
		COPY : String = "copy" [static] Defines the value of the type property of a copy event object.	Event
		CREATE_MODAL_WINDOW_REQUEST : String = "createModalWindowRequest" [static] Creates a modal window.	SWFBridgeRequest
		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
		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
		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
		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
		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
		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
		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
		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
		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
		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
		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
		RENDER : String = "render" [static] The Event.RENDER constant defines the value of the type property of a render event object.	Event
		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
		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
		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
		SOUND_COMPLETE : String = "soundComplete" [static] The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete 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
		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

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

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

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

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

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`)

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.