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

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

An event that is sent between applications through the sharedEvents dispatcher that exists between two application SWFs. The event describes a request for the listener in the other SWF to perform some action on objects in its SWF and potentially return some data back to the dispatching SWF. Unlike typical events, SWFBridgeRequests are an exception to the event model because properties of the event are modified in order to return data back to the dispatching SWF.

See also

flash.display.LoaderInfo.sharedEvents

Public Properties

| Property | Defined By
--- | --- | ---
|  | data : Object Data related to the event. | SWFBridgeRequest
|  | requestor : IEventDispatcher The bridge that sent the message. | SWFBridgeRequest

Public Methods

| Method | Defined By
--- | --- | ---
|  | SWFBridgeRequest(type:String, bubbles:Boolean = false, cancelable:Boolean = false, requestor:IEventDispatcher = null, data:Object = null) Constructor. | SWFBridgeRequest
|  | marshal(event:Event):SWFBridgeRequest [static] Marshals a SWFBridgeRequest from a remote ApplicationDomain into the current ApplicationDomain. | SWFBridgeRequest

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_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_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

data | property

`public var data:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Data related to the event. For information on how this object is used, see each event type.

requestor | property |

`public var requestor:IEventDispatcher`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The bridge that sent the message. This in used by the receiving SWF to track which SWFLoader holds the requesting SWF

Constructor Detail

SWFBridgeRequest | () | Constructor

`public function SWFBridgeRequest(type:String, bubbles:Boolean = false, cancelable:Boolean = false, requestor:IEventDispatcher = null, data:Object = null)`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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.
| `requestor:IEventDispatcher` (default = `null`)`` — The bridge that sent the message.
| `data:Object` (default = `null`)`` — Data related to the event.

Method Detail

marshal | () | method

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Marshals a SWFBridgeRequest from a remote ApplicationDomain into the current ApplicationDomain.

Parameters

| `event:Event` — A SWFBridgeRequest which may have been created in a different ApplicationDomain.

Returns

| `SWFBridgeRequest` — A SWFBridgeRequest created in the caller's ApplicationDomain.

Constant Detail

ACTIVATE_FOCUS_REQUEST | Constant

`public static const ACTIVATE_FOCUS_REQUEST:String = activateFocusRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Sent from the top-level focus manager to a subordinate focus managers so all the focus managers participating in a tab loop get activated.

ACTIVATE_POP_UP_REQUEST | Constant |

`public static const ACTIVATE_POP_UP_REQUEST:String = activatePopUpRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Requests that a child application's pop up be activated. This request is sent from a top-level SystemManager to a child SystemManager through the bridge. The `data` property contains an identifier for the pop up. It is not always an actual reference to the pop up. No data is returned.

ADD_POP_UP_PLACE_HOLDER_REQUEST | Constant |

`public static const ADD_POP_UP_PLACE_HOLDER_REQUEST:String = addPopUpPlaceHolderRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Adds a placeholder for a pop up window hosted by a child SystemManager. The pop up window is untrusted so it must remain hosted by a child that trusts it. A placeholder is sent to the top-level root SystemManager so activation and deactivation of all the pop ups can be managed there.

ADD_POP_UP_REQUEST | Constant |

`public static const ADD_POP_UP_REQUEST:String = addPopUpRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Adds a popup on the targeted application. The request is not honored by the targeted application unless there is mutual trust between the dispatching and receiving applications.

CAN_ACTIVATE_POP_UP_REQUEST | Constant |

`public static const CAN_ACTIVATE_POP_UP_REQUEST:String = canActivateRequestPopUpRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Tests if a given pop up can be activated. If a pop up is not visible or is not enabled, then it cannot be activated. This message is always sent from the top-level SystemManager through the bridge to the SystemManager that owns the pop up. The `data` property is an identifier for the pop up. It is not always an actual reference to the pop up. The receiving SystemManager sets the request's `data` property to `true` if the pop up can be activated.

CREATE_MODAL_WINDOW_REQUEST | Constant |

`public static const CREATE_MODAL_WINDOW_REQUEST:String = createModalWindowRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Creates a modal window. The `show` property can be used to show the modal window after creating it. A value of `true` shows the modal window. A value of `false` lets the modal window remain hidden until a `ModalWindowRequest.SHOW` request is dispatched. The `data` property might have a Rectangle that describes the area to exclude from the modal window. The coordinates of the Rectangle are in global coordinates. The parameter will only be present when the requestor trusts the recipient of the request.

DEACTIVATE_FOCUS_REQUEST | Constant |

`public static const DEACTIVATE_FOCUS_REQUEST:String = deactivateFocusRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Sent from the top-level focus manager to a subordinate focus managers so all the focus managers participating in a tab loop get deactivated.

DEACTIVATE_POP_UP_REQUEST | Constant |

`public static const DEACTIVATE_POP_UP_REQUEST:String = deactivatePopUpRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Requests that a child application's pop up be deactivated. This request is sent from a child SystemManager to the top-level SystemManager through the bridge. The data property contains an identifier for the pop up. It is not always an actual reference to the pop up. No data is returned.

GET_SIZE_REQUEST | Constant |

`public static const GET_SIZE_REQUEST:String = getSizeRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Gets the size of the child SystemManager. Dispatched by the SWFLoader control to the child SystemManager to get the size of its content. The child SystemManager updates the `width` and `height` properties in the event object

GET_VISIBLE_RECT_REQUEST | Constant |

`public static const GET_VISIBLE_RECT_REQUEST:String = getVisibleRectRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Requests that the parent SystemManager calculate the visible portion of the requesting SWF based on any DisplayObjects that might be clipping the requesting SWF. The requests is sent to a parent SystemManager through the bridge. The results are returned in the `data` property which is a Rectangle in global coordinates.

HIDE_MODAL_WINDOW_REQUEST | Constant |

`public static const HIDE_MODAL_WINDOW_REQUEST:String = hideModalWindowRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Hides a modal window. The `remove` property determines if the modal window is removed from the display lists as well as hidden. A value of `true` removes the modal window. A value of `false` hides only the modal window.

HIDE_MOUSE_CURSOR_REQUEST | Constant |

`public static const HIDE_MOUSE_CURSOR_REQUEST:String = hideMouseCursorRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Requests that the mouse cursor should be hidden when over this application. This request is sent to the bridge that is shared with the parent application and propagated up to the top-level root. The `data` property is not used

INVALIDATE_REQUEST | Constant |

`public static const INVALIDATE_REQUEST:String = invalidateRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Requests that the loader of the current application invalidate its properties, size, or display list. This request is sent from a SystemManager to its parent SystemManager. The `data` property is a combination of InvalidationRequestData flags. No data is returned.

IS_BRIDGE_CHILD_REQUEST | Constant |

`public static const IS_BRIDGE_CHILD_REQUEST:String = isBridgeChildRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Tests if a given DisplayObject is a child of a SWF or one of its child SWFs. This request is sent from a SystemManager to one or more of its children's SystemManagers through their bridges. The `data` property is a reference to the DisplayObject. The receiving SystemManager sets the request's `data` property to `true` if the DisplayObject is a child of the SWF or one of its child SWFs.

MOVE_FOCUS_REQUEST | Constant |

`public static const MOVE_FOCUS_REQUEST:String = moveFocusRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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. When focus is moved back to the parent SWFs FocusManager, the `direction` property is set to `FocusDirection.FORWARD` or `FocusDirection.BACKWARD`. When focus is moved to a child SWFs FocusManager, the `direction` property is set to `FocusDirection.TOP` or `FocusDirection.BOTTOM`.

REMOVE_POP_UP_PLACE_HOLDER_REQUEST | Constant |

`public static const REMOVE_POP_UP_PLACE_HOLDER_REQUEST:String = removePopUpPlaceHolderRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Removes a placeholder.

REMOVE_POP_UP_REQUEST | Constant |

`public static const REMOVE_POP_UP_REQUEST:String = removePopUpRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Removes a popup from the sandboxRoot's SystemManager.

RESET_MOUSE_CURSOR_REQUEST | Constant |

`public static const RESET_MOUSE_CURSOR_REQUEST:String = resetMouseCursorRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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. This request is sent to the bridge shared with the parent application and propagated up to the top-level root. The data property is not used

SET_ACTUAL_SIZE_REQUEST | Constant |

`public static const SET_ACTUAL_SIZE_REQUEST:String = setActualSizeRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Sets the size of the `child.systemManager`. Dispatched by the SWFLoader control to the child SystemManager. The child SystemManager should update the size of its children based on the `width` and `height` properties in the event object

SET_SHOW_FOCUS_INDICATOR_REQUEST | Constant |

`public static const SET_SHOW_FOCUS_INDICATOR_REQUEST:String = setShowFocusIndicatorRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Set the value of the showFocusIndicator property in every application's FocusManager. The data property is a Boolean that contains the value showFocusIndicator property will be set to. This request is initially sent from the FocusManager that has its showFocusIndicator property set. From there the request is relayed to each FocusManager in the system.

SHOW_MODAL_WINDOW_REQUEST | Constant |

`public static const SHOW_MODAL_WINDOW_REQUEST:String = showModalWindowRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Shows a modal window. The `skip` property is used with this request. A value of `true` indicates that the recipient should just forward the request up the parent chain without processing the request. The `data` property might have a Rectangle that describes the area to exclude based on the current parent. The coordinates are in screen coordinates. The parameter will only be present when the requestor trusts the recipient of the message.

SHOW_MOUSE_CURSOR_REQUEST | Constant |

`public static const SHOW_MOUSE_CURSOR_REQUEST:String = showMouseCursorRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Asks the top-level root if the mouse cursor should be hidden given its current location. Sent to the bridge shared with the parent application and propagated up to the top-level root. The data is set to true if the mouse cursor should be shown at this location

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