Project: Adobe Flex SDK

Revision: 3102

Author: mhorn@adobe.com

Date: 04 Sep 2008 15:29:25

• /flex/sdk/branches/3.0.x/frameworks/projects/framework/src/mx/events/SWFBridgeRequest.as

  ......	@@ -16,8 +16,8 @@
  16	16	import flash.events.IEventDispatcher;
  17	17
  18	18	/**
  19		* This is an event sent between SWFs via the sharedEvents
  20		* dispatcher that exists between two SWFs
  	19	* An event that is sent between applications through the sharedEvents
  	20	* dispatcher that exists between two application SWFs.
  21	21	* The event describes a request for the listener in the other SWF
  22	22	* to perform some action on objects in its SWF and potentially
  23	23	* return some data back to the dispatching SWF.
  ......	@@ -38,30 +38,32 @@
  38	38	//--------------------------------------------------------------------------
  39	39
  40	40	/**
  41		* Request sent from a child systemManager to the top-level systemManager
  42		* via the bridge to request that a child application's pop up be activated.
  43		* The data property contains an identifier for the pop up. It is not
  44		* always an actual reference to the pop up. No data is
  	41	* Requests that a child application's pop up be activated.
  	42	* This request is sent from a child SystemManager to the top-level SystemManager
  	43	* through the bridge.
  	44	* The <code>data</code> property contains an identifier for the pop up. It is not
  	45	* always an actual reference to the pop up. No data is
  45	46	* returned.
  46	47	*/
  47	48	public static const ACTIVATE_POP_UP_REQUEST:String = "activatePopUpRequest";
  48	49
  49	50	/**
  50		* Test if a given pop up can be activated.
  	51	* Tests if a given pop up can be activated.
  51	52	* If a pop up is not visible or is not enabled,
  52	53	* then it cannot be activated.
  53		* This message is always sent from the top-level system manager via the bridge to
  54		* the systemManager that owns the pop up. The data property
  55		* is an identifier for the pop up. It is not
  56		* always an actual reference to the pop up. The receiving
  57		* systemManager sets the request's data property to true if
  	54	* This message is always sent from the top-level SystemManager through the bridge to
  	55	* the SystemManager that owns the pop up. The <code>data</code> property
  	56	* is an identifier for the pop up. It is not
  	57	* always an actual reference to the pop up. The receiving
  	58	* SystemManager sets the request's <code>data</code> property to <code>true</code> if
  58	59	* the pop up can be activated.
  59	60	*/
  60	61	public static const CAN_ACTIVATE_POP_UP_REQUEST:String = "canActivateRequestPopUpRequest";
  61	62
  62	63	/**
  63		* Request sent from a child systemManager to the top-level systemManager
  64		* via the bridge to request that a child application's pop up be deactivated.
  	64	* Requests that a child application's pop up be deactivated.
  	65	* This request is sent from a child SystemManager to the top-level SystemManager
  	66	* through the bridge.
  65	67	* The data property contains an identifier for the pop up. It is not
  66	68	* always an actual reference to the pop up. No data is
  67	69	* returned.
  ......	@@ -69,109 +71,109 @@
  69	71	public static const DEACTIVATE_POP_UP_REQUEST:String = "deactivatePopUpRequest";
  70	72
  71	73	/**
  72		* Request sent to a parent systemManager via the bridge
  73		* to calculate the visible portion
  74		* of the requesting SWF based on any display objects that
  75		* may be clipping the requesting SWF. The results are returned
  76		* in the <code>data</code> property which is a <code>Rectangle</code>
  	74	* Requests that the parent SystemManager calculate the visible portion
  	75	* of the requesting SWF based on any DisplayObjects that
  	76	* might be clipping the requesting SWF.
  	77	* The requests is sent to a parent SystemManager through the bridge.
  	78	* The results are returned
  	79	* in the <code>data</code> property which is a Rectangle
  77	80	* in global coordinates.
  78	81	*
  79	82	*/
  80	83	public static const GET_VISIBLE_RECT_REQUEST:String = "getVisibleRectRequest";
  81	84
  82	85	/**
  83		* Test if a given display object is a child of a SWF
  84		* or one of its child SWFs. This request is sent from a systemManager
  85		* to one or more of its children's systemManagers via their bridges.
  86		* The data property
  87		* is a reference to the display object. The receiving
  88		* systemManager sets the request's data property to true if
  89		* the display object is a child of the SWF or one of its child SWFs.
  	86	* Tests if a given DisplayObject is a child of a SWF
  	87	* or one of its child SWFs. This request is sent from a SystemManager
  	88	* to one or more of its children's SystemManagers through their bridges.
  	89	* The <code>data</code> property
  	90	* is a reference to the DisplayObject. The receiving
  	91	* SystemManager sets the request's <code>data</code> property to <code>true</code> if
  	92	* the DisplayObject is a child of the SWF or one of its child SWFs.
  90	93	*/
  91	94	public static const IS_BRIDGE_CHILD_REQUEST:String = "isBridgeChildRequest";
  92	95
  93	96	/**
  94		* Request the loader of the current application to invalidate its
  95		* properties, size, or display list. This request is sent from
  96		* a systemManager to its parent systemManager. The data property
  97		* is a combination of InvalidationRequestData flags. No data is
  	97	* Requests that the loader of the current application invalidate its
  	98	* properties, size, or display list. This request is sent from
  	99	* a SystemManager to its parent SystemManager. The <code>data</code> property
  	100	* is a combination of InvalidationRequestData flags. No data is
  98	101	* returned.
  99	102	*/
  100	103	public static const INVALIDATE_REQUEST:String = "invalidateRequest";
  101	104
  102	105	/**
  103		* Request that the mouse cursor should be hidden
  104		* when over this application. Sent to the bridge shared with
  	106	* Requests that the mouse cursor should be hidden
  	107	* when over this application. This request is sent to the bridge that is shared with
  105	108	* the parent application and propagated up to the top-level root.
  106		* The data property is not used
  	109	* The <code>data</code> property is not used
  107	110	*/
  108	111	public static const HIDE_MOUSE_CURSOR_REQUEST:String = "hideMouseCursorRequest";
  109	112
  110	113	/**
  111		* Ask the top-level root if the mouse cursor should be hidden given its
  112		* current location. Sent to the bridge shared with
  	114	* Asks the top-level root if the mouse cursor should be hidden given its
  	115	* current location. Sent to the bridge shared with
  113	116	* the parent application and propagated up to the top-level root.
  114	117	* The data is set to true if the mouse cursor should be shown at this location
  115	118	*/
  116	119	public static const SHOW_MOUSE_CURSOR_REQUEST:String = "showMouseCursorRequest";
  117	120
  118	121	/**
  119		* Request that the show/hide mouse cursor logic be reset for a new mouse
  120		* event so the various applications can request whether the mouse cursor
  121		* should be shown or hidden. Sent to the bridge shared with
  	122	* Requests that the show/hide mouse cursor logic be reset for a new mouse
  	123	* event so that the various applications can request whether the mouse cursor
  	124	* should be shown or hidden. This request is sent to the bridge shared with
  122	125	* the parent application and propagated up to the top-level root.
  123	126	* The data property is not used
  124	127	*/
  125	128	public static const RESET_MOUSE_CURSOR_REQUEST:String = "resetMouseCursorRequest";
  126	129
  127	130	/**
  128		* Sent from the top-level focus manager to a subordinate focus managers
  129		* so all the focus managers participating in a tab loop get activated
  	131	* Sent from the top-level focus manager to a subordinate focus managers
  	132	* so all the focus managers participating in a tab loop get activated.
  130	133	*/
  131	134	public static const ACTIVATE_FOCUS_REQUEST:String = "activateFocusRequest";
  132	135
  133	136	/**
  134		* Sent from the top-level focus manager to a subordinate focus managers
  135		* so all the focus managers participating in a tab loop get deactivated
  	137	* Sent from the top-level focus manager to a subordinate focus managers
  	138	* so all the focus managers participating in a tab loop get deactivated.
  136	139	*/
  137	140	public static const DEACTIVATE_FOCUS_REQUEST:String = "deactivateFocusRequest";
  138	141
  139	142	/**
  140	143	* Request to move control over focus to another FocusManager.and have
  141	144	* that FocusManager give focus to a control under its management based
  142		* on the direction propert in the event.
  	145	* on the <code>direction</code> property in the event.
  143	146	*
  144		* When focus is moved back to the parent SWFs FocusManager, the direction
  145		* property is set to FocusDirection.FORWARD or FocusDirection.BACKWARD.
  146		* When focus is moved to a child SWFs FocusManager, the direction
  147		* property is set to FocusDirection.TOP or FocusDirection.BOTTOM.
  	147	* When focus is moved back to the parent SWFs FocusManager, the <code>direction</code>
  	148	* property is set to <code>FocusDirection.FORWARD</code> or <code>FocusDirection.BACKWARD</code>.
  	149	* When focus is moved to a child SWFs FocusManager, the <code>direction</code>
  	150	* property is set to <code>FocusDirection.TOP</code> or <code>FocusDirection.BOTTOM</code>.
  148	151	*/
  149	152	public static const MOVE_FOCUS_REQUEST:String = "moveFocusRequest";
  150	153
  151	154	/**
  152		* Create a modal window.
  	155	* Creates a modal window.
  153	156	*
  154	157	* The <code>show</code> property can be used to show the modal window
  155	158	* after creating it. A value of <code>true</code> shows the modal window.
  156		* A value of <code>false</code> allows the modal window to remain hidden
  	159	* A value of <code>false</code> lets the modal window remain hidden
  157	160	* until a <code>ModalWindowRequest.SHOW</code> request is dispatched.
  158	161	*
  159		* The <code>data</code> property may have a <code>Rectangle</code> that
  	162	* The <code>data</code> property might have a Rectangle that
  160	163	* describes the area to exclude from the modal window. The coordinates
  161		* of the rectangle are in global coordinates. The parameter will only be present when
  	164	* of the Rectangle are in global coordinates. The parameter will only be present when
  162	165	* the requestor trusts the recipient of the request.
  163	166	*/
  164	167	public static const CREATE_MODAL_WINDOW_REQUEST:String = "createModalWindowRequest";
  165	168
  166	169	/**
  167		* Show a modal window.
  	170	* Shows a modal window.
  168	171	*
  169	172	* The <code>skip</code> property is used with this request. A value of <code>true</code>
  170	173	* indicates that the recipient should just forward the request up the parent chain
  171		* without processing the
  172		* request.
  	174	* without processing the request.
  173	175	*
  174		* The <code>data</code> property may have a <code>Rectangle</code> that
  	176	* The <code>data</code> property might have a Rectangle that
  175	177	* describes the area to exclude based on the current parent. The coordinates
  176	178	* are in screen coordinates. The parameter will only be present when
  177	179	* the requestor trusts the recipient of the message.
  ......	@@ -179,57 +181,57 @@
  179	181	public static const SHOW_MODAL_WINDOW_REQUEST:String = "showModalWindowRequest";
  180	182
  181	183	/**
  182		* Hide a modal window.
  	184	* Hides a modal window.
  183	185	*
  184	186	* The <code>remove</code> property determines if the modal window is
  185	187	* removed from the display lists as well as hidden. A value of <code>true</code>
  186		* removes the modals window. A value of <code>false</code> only hides the
  	188	* removes the modal window. A value of <code>false</code> hides only the
  187	189	* modal window.
  188	190	*/
  189	191	public static const HIDE_MODAL_WINDOW_REQUEST:String = "hideModalWindowRequest";
  190	192
  191	193	/**
  192		* Add a popup on the targeted application.
  193		* The request is not honored by the targeted application unless there
  194		* is mutual trust between the dispatching and receiving applications.
  	194	* Adds a popup on the targeted application.
  	195	* The request is not honored by the targeted application unless there
  	196	* is mutual trust between the dispatching and receiving applications.
  195	197	*
  196	198	*/
  197	199	public static const ADD_POP_UP_REQUEST:String = "addPopUpRequest";
  198	200
  199	201	/**
  200		* Remove a popup from the sandboxRoot's system manager.
  	202	* Removes a popup from the sandboxRoot's SystemManager.
  201	203	*/
  202	204	public static const REMOVE_POP_UP_REQUEST:String = "removePopUpRequest";
  203	205
  204	206	/**
  205		* Add a placeholder for a pop up window hosted by a child SystemManager.
  206		* The pop up window is untrusted so must remain hosted
  207		* by a child that trusts it.
  	207	* Adds a placeholder for a pop up window hosted by a child SystemManager.
  	208	* The pop up window is untrusted so it must remain hosted
  	209	* by a child that trusts it.
  208	210	* A placeholder is sent to the top-level root SystemManager
  209		* so activation and deactivation of all the pop ups can be managed there.
  	211	* so activation and deactivation of all the pop ups can be managed there.
  210	212	*/
  211	213	public static const ADD_POP_UP_PLACE_HOLDER_REQUEST:String =
  212	214	"addPopUpPlaceHolderRequest";
  213	215
  214	216	/**
  215		* Remove a placeholder.
  	217	* Removes a placeholder.
  216	218	*/
  217	219	public static const REMOVE_POP_UP_PLACE_HOLDER_REQUEST:String =
  218	220	"removePopUpPlaceHolderRequest";
  219	221
  220	222	/**
  221		* Get the size of the child systemManager.
  222		* Dispatched by SWFLoader to the child systemManager
  223		* to get the size of its content. The child systemManager
  224		* updates the width and height properties in the event object
  	223	* Gets the size of the child SystemManager.
  	224	* Dispatched by the SWFLoader control to the child SystemManager
  	225	* to get the size of its content. The child SystemManager
  	226	* updates the <code>width</code> and <code>height</code> properties in the event object
  225	227	*/
  226	228	public static const GET_SIZE_REQUEST:String = "getSizeRequest";
  227	229
  228	230	/**
  229		* Set the size of the child.systemManager
  230		* Dispatched by SWFLoader to the child systemManager. The child
  231		* systemManager should update the size of its children accordingly
  232		* based on the width and height properties in the event object
  	231	* Sets the size of the <code>child.systemManager</code>.
  	232	* Dispatched by the SWFLoader control to the child SystemManager. The child
  	233	* SystemManager should update the size of its children
  	234	* based on the <code>width</code> and <code>height</code> properties in the event object
  233	235	*/
  234	236	public static const SET_ACTUAL_SIZE_REQUEST:String = "setActualSizeRequest";
  235	237
  ......	@@ -250,7 +252,7 @@
  250	252	//--------------------------------------------------------------------------
  251	253
  252	254	/**
  253		* Marshal a SWFBridgeRequest from a remote ApplicationDomain into the current
  	255	* Marshals a SWFBridgeRequest from a remote ApplicationDomain into the current
  254	256	* ApplicationDomain.
  255	257	*
  256	258	* @param event A SWFBridgeRequest which may have been created in a different ApplicationDomain.
  ......	@@ -275,6 +277,16 @@
  275	277
  276	278	/**
  277	279	* Constructor.
  	280	*
  	281	* @param type The event type; indicates the action that caused the event.
  	282	*
  	283	* @param bubbles Specifies whether the event can bubble up the display list hierarchy.
  	284	*
  	285	* @param cancelable Specifies whether the behavior associated with the event can be prevented.
  	286	*
  	287	* @param requestor The bridge that sent the message.
  	288	*
  	289	* @param data Data related to the event.
  278	290	*/
  279	291	public function SWFBridgeRequest(type:String, bubbles:Boolean = false,
  280	292	cancelable:Boolean = false,
  ......	@@ -298,8 +310,7 @@
  298	310	//----------------------------------
  299	311
  300	312	/**
  301		* Related data. See each event type documentation for how this property
  302		* is used.
  	313	* Data related to the event. For information on how this object is used, see each event type.
  303	314	*/
  304	315	public var data:Object;
  305	316
  ......	@@ -308,8 +319,8 @@
  308	319	//----------------------------------
  309	320
  310	321	/**
  311		* Bridge that sent the message.
  312		* This in used by the receiving SWF to track which SWFLoader
  	322	* The bridge that sent the message.
  	323	* This in used by the receiving SWF to track which SWFLoader
  313	324	* holds the requesting SWF
  314	325	*/
  315	326	public var requestor:IEventDispatcher;

• /flex/sdk/branches/3.0.x/frameworks/projects/framework/src/mx/managers/SystemManager.as

  ......	@@ -1257,7 +1257,7 @@
  1257	1257	//--------------------------------------------------------------------------
  1258	1258
  1259	1259	/**
  1260		* @inheritdoc
  	1260	* @inheritDoc
  1261	1261	*/
  1262	1262	public function get swfBridge():IEventDispatcher
  1263	1263	{
  ......	@@ -1268,7 +1268,7 @@
  1268	1268	}
  1269	1269
  1270	1270	/**
  1271		* @inheritdoc
  	1271	* @inheritDoc
  1272	1272	*/
  1273	1273	public function get childAllowsParent():Boolean
  1274	1274	{
  ......	@@ -1285,7 +1285,7 @@
  1285	1285	}
  1286	1286
  1287	1287	/**
  1288		* @inheritdoc
  	1288	* @inheritDoc
  1289	1289	*/
  1290	1290	public function get parentAllowsChild():Boolean
  1291	1291	{
  ......	@@ -2711,7 +2711,7 @@
  2711	2711	}
  2712	2712
  2713	2713	/**
  2714		* @inheritdoc
  	2714	* @inheritDoc
  2715	2715	*/
  2716	2716	public function isTopLevelRoot():Boolean
  2717	2717	{
  ......	@@ -4660,8 +4660,8 @@
  4660	4660	/**
  4661	4661	* Add a bridge to talk to the child owned by <code>owner</code>.
  4662	4662	*
  4663		* @param bridge the bridge used to talk to the parent.
  4664		* @param owner the display object that owns the bridge.
  	4663	* @param bridge The bridge used to talk to the parent.
  	4664	* @param owner The display object that owns the bridge.
  4665	4665	*/
  4666	4666	public function addChildBridge(bridge:IEventDispatcher, owner:DisplayObject):void
  4667	4667	{
  ......	@@ -4684,7 +4684,7 @@
  4684	4684	}
  4685	4685
  4686	4686	/**
  4687		* @inheritdoc
  	4687	* @inheritDoc
  4688	4688	*/
  4689	4689	public function useSWFBridge():Boolean
  4690	4690	{
  ......	@@ -4819,7 +4819,7 @@
  4819	4819	}
  4820	4820
  4821	4821	/**
  4822		* @inheritdoc
  	4822	* @inheritDoc
  4823	4823	*/
  4824	4824	public function getVisibleApplicationRect(bounds:Rectangle = null):Rectangle
  4825	4825	{
  ......	@@ -4852,7 +4852,7 @@
  4852	4852	}
  4853	4853
  4854	4854	/**
  4855		* @inheritdoc
  	4855	* @inheritDoc
  4856	4856	*/
  4857	4857	public function deployMouseShields(deploy:Boolean):void
  4858	4858	{