puremvc-as3 2.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/2.0.4/asdoc/all-classes.html +81 -0
- data/2.0.4/asdoc/all-index-A.html +59 -0
- data/2.0.4/asdoc/all-index-B.html +52 -0
- data/2.0.4/asdoc/all-index-C.html +92 -0
- data/2.0.4/asdoc/all-index-D.html +58 -0
- data/2.0.4/asdoc/all-index-E.html +89 -0
- data/2.0.4/asdoc/all-index-F.html +72 -0
- data/2.0.4/asdoc/all-index-G.html +190 -0
- data/2.0.4/asdoc/all-index-H.html +174 -0
- data/2.0.4/asdoc/all-index-I.html +202 -0
- data/2.0.4/asdoc/all-index-J.html +52 -0
- data/2.0.4/asdoc/all-index-K.html +52 -0
- data/2.0.4/asdoc/all-index-L.html +67 -0
- data/2.0.4/asdoc/all-index-M.html +112 -0
- data/2.0.4/asdoc/all-index-N.html +128 -0
- data/2.0.4/asdoc/all-index-O.html +178 -0
- data/2.0.4/asdoc/all-index-P.html +79 -0
- data/2.0.4/asdoc/all-index-Q.html +52 -0
- data/2.0.4/asdoc/all-index-R.html +308 -0
- data/2.0.4/asdoc/all-index-S.html +193 -0
- data/2.0.4/asdoc/all-index-T.html +67 -0
- data/2.0.4/asdoc/all-index-U.html +52 -0
- data/2.0.4/asdoc/all-index-V.html +84 -0
- data/2.0.4/asdoc/all-index-W.html +52 -0
- data/2.0.4/asdoc/all-index-X.html +52 -0
- data/2.0.4/asdoc/all-index-Y.html +52 -0
- data/2.0.4/asdoc/all-index-Z.html +52 -0
- data/2.0.4/asdoc/appendixes.html +47 -0
- data/2.0.4/asdoc/asdoc.js +273 -0
- data/2.0.4/asdoc/class-summary.html +174 -0
- data/2.0.4/asdoc/cookies.js +84 -0
- data/2.0.4/asdoc/images/collapsed.gif +0 -0
- data/2.0.4/asdoc/images/detailHeaderRule.jpg +0 -0
- data/2.0.4/asdoc/images/detailSectionHeader.jpg +0 -0
- data/2.0.4/asdoc/images/expanded.gif +0 -0
- data/2.0.4/asdoc/images/inherit-arrow.gif +0 -0
- data/2.0.4/asdoc/images/inheritedSummary.gif +0 -0
- data/2.0.4/asdoc/images/logo.jpg +0 -0
- data/2.0.4/asdoc/images/titleTableBottom.jpg +0 -0
- data/2.0.4/asdoc/images/titleTableMiddle.jpg +0 -0
- data/2.0.4/asdoc/images/titleTableTop.jpg +0 -0
- data/2.0.4/asdoc/index-list.html +121 -0
- data/2.0.4/asdoc/index.html +63 -0
- data/2.0.4/asdoc/mxml-tags.html +45 -0
- data/2.0.4/asdoc/org/puremvc/as3/core/Controller.html +433 -0
- data/2.0.4/asdoc/org/puremvc/as3/core/Model.html +405 -0
- data/2.0.4/asdoc/org/puremvc/as3/core/View.html +524 -0
- data/2.0.4/asdoc/org/puremvc/as3/core/class-list.html +30 -0
- data/2.0.4/asdoc/org/puremvc/as3/core/package-detail.html +65 -0
- data/2.0.4/asdoc/org/puremvc/as3/interfaces/ICommand.html +110 -0
- data/2.0.4/asdoc/org/puremvc/as3/interfaces/IController.html +226 -0
- data/2.0.4/asdoc/org/puremvc/as3/interfaces/IFacade.html +520 -0
- data/2.0.4/asdoc/org/puremvc/as3/interfaces/IMediator.html +345 -0
- data/2.0.4/asdoc/org/puremvc/as3/interfaces/IModel.html +226 -0
- data/2.0.4/asdoc/org/puremvc/as3/interfaces/INotification.html +269 -0
- data/2.0.4/asdoc/org/puremvc/as3/interfaces/INotifier.html +151 -0
- data/2.0.4/asdoc/org/puremvc/as3/interfaces/IObserver.html +234 -0
- data/2.0.4/asdoc/org/puremvc/as3/interfaces/IProxy.html +217 -0
- data/2.0.4/asdoc/org/puremvc/as3/interfaces/IView.html +350 -0
- data/2.0.4/asdoc/org/puremvc/as3/interfaces/class-list.html +54 -0
- data/2.0.4/asdoc/org/puremvc/as3/interfaces/package-detail.html +93 -0
- data/2.0.4/asdoc/org/puremvc/as3/patterns/command/MacroCommand.html +284 -0
- data/2.0.4/asdoc/org/puremvc/as3/patterns/command/SimpleCommand.html +164 -0
- data/2.0.4/asdoc/org/puremvc/as3/patterns/command/class-list.html +27 -0
- data/2.0.4/asdoc/org/puremvc/as3/patterns/command/package-detail.html +61 -0
- data/2.0.4/asdoc/org/puremvc/as3/patterns/facade/Facade.html +940 -0
- data/2.0.4/asdoc/org/puremvc/as3/patterns/facade/class-list.html +24 -0
- data/2.0.4/asdoc/org/puremvc/as3/patterns/facade/package-detail.html +57 -0
- data/2.0.4/asdoc/org/puremvc/as3/patterns/mediator/Mediator.html +402 -0
- data/2.0.4/asdoc/org/puremvc/as3/patterns/mediator/class-list.html +24 -0
- data/2.0.4/asdoc/org/puremvc/as3/patterns/mediator/package-detail.html +57 -0
- data/2.0.4/asdoc/org/puremvc/as3/patterns/observer/Notification.html +312 -0
- data/2.0.4/asdoc/org/puremvc/as3/patterns/observer/Notifier.html +180 -0
- data/2.0.4/asdoc/org/puremvc/as3/patterns/observer/Observer.html +253 -0
- data/2.0.4/asdoc/org/puremvc/as3/patterns/observer/class-list.html +30 -0
- data/2.0.4/asdoc/org/puremvc/as3/patterns/observer/package-detail.html +65 -0
- data/2.0.4/asdoc/org/puremvc/as3/patterns/proxy/Proxy.html +338 -0
- data/2.0.4/asdoc/org/puremvc/as3/patterns/proxy/class-list.html +24 -0
- data/2.0.4/asdoc/org/puremvc/as3/patterns/proxy/package-detail.html +57 -0
- data/2.0.4/asdoc/package-frame.html +36 -0
- data/2.0.4/asdoc/package-list.html +52 -0
- data/2.0.4/asdoc/package-summary.html +68 -0
- data/2.0.4/asdoc/print.css +110 -0
- data/2.0.4/asdoc/style.css +565 -0
- data/2.0.4/asdoc/title-bar.html +55 -0
- data/2.0.4/bin/PureMVC_AS3_2_0_4.swc +0 -0
- data/2.0.4/license.txt +61 -0
- data/2.0.4/src/org/puremvc/as3/core/Controller.as +183 -0
- data/2.0.4/src/org/puremvc/as3/core/Model.as +144 -0
- data/2.0.4/src/org/puremvc/as3/core/View.as +271 -0
- data/2.0.4/src/org/puremvc/as3/interfaces/ICommand.as +21 -0
- data/2.0.4/src/org/puremvc/as3/interfaces/IController.as +64 -0
- data/2.0.4/src/org/puremvc/as3/interfaces/IFacade.as +131 -0
- data/2.0.4/src/org/puremvc/as3/interfaces/IMediator.as +150 -0
- data/2.0.4/src/org/puremvc/as3/interfaces/IModel.as +57 -0
- data/2.0.4/src/org/puremvc/as3/interfaces/INotification.as +76 -0
- data/2.0.4/src/org/puremvc/as3/interfaces/INotifier.as +46 -0
- data/2.0.4/src/org/puremvc/as3/interfaces/IObserver.as +81 -0
- data/2.0.4/src/org/puremvc/as3/interfaces/IProxy.as +61 -0
- data/2.0.4/src/org/puremvc/as3/interfaces/IView.as +106 -0
- data/2.0.4/src/org/puremvc/as3/patterns/command/MacroCommand.as +121 -0
- data/2.0.4/src/org/puremvc/as3/patterns/command/SimpleCommand.as +42 -0
- data/2.0.4/src/org/puremvc/as3/patterns/facade/Facade.as +419 -0
- data/2.0.4/src/org/puremvc/as3/patterns/mediator/Mediator.as +115 -0
- data/2.0.4/src/org/puremvc/as3/patterns/observer/Notification.as +128 -0
- data/2.0.4/src/org/puremvc/as3/patterns/observer/Notifier.as +55 -0
- data/2.0.4/src/org/puremvc/as3/patterns/observer/Observer.as +114 -0
- data/2.0.4/src/org/puremvc/as3/patterns/proxy/Proxy.as +88 -0
- data/2.0.4/src/puremvc-manifest.xml +20 -0
- data/2.0.4/version.txt +117 -0
- data/Gemfile +4 -0
- data/README.textile +107 -0
- data/Rakefile +24 -0
- data/lib/puremvc-as3.rb +29 -0
- data/lib/rake/rename.rb +34 -0
- metadata +198 -0
|
@@ -0,0 +1,217 @@
|
|
|
1
|
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
5
|
+
<link rel="stylesheet" href="../../../../style.css" type="text/css" media="screen">
|
|
6
|
+
<link rel="stylesheet" href="../../../../print.css" type="text/css" media="print">
|
|
7
|
+
<meta content="IProxy,org.puremvc.as3.interfaces.IProxy,getData,getProxyName,onRegister,onRemove,setData" name="keywords">
|
|
8
|
+
<title>org.puremvc.as3.interfaces.IProxy</title>
|
|
9
|
+
</head>
|
|
10
|
+
<body>
|
|
11
|
+
<script type="text/javascript" language="javascript" src="../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../cookies.js"></script><script type="text/javascript" language="javascript">
|
|
12
|
+
<!--
|
|
13
|
+
asdocTitle = 'IProxy - API Documentation';
|
|
14
|
+
var baseRef = '../../../../';
|
|
15
|
+
window.onload = configPage;
|
|
16
|
+
--></script>
|
|
17
|
+
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
|
|
18
|
+
<tr>
|
|
19
|
+
<td align="left" class="titleTableTitle">PureMVC AS3 Framework - [Standard Version]</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../package-summary.html">All Packages</a> | <a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../class-summary.html">All Classes</a> | <a onclick="loadClassListFrame('../../../../index-list.html')" href="../../../../all-index-A.html">Index</a> | <a href="../../../../index.html?org/puremvc/as3/interfaces/IProxy.html&org/puremvc/as3/interfaces/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../images/logo.jpg"></td>
|
|
20
|
+
</tr>
|
|
21
|
+
<tr class="titleTableRow2">
|
|
22
|
+
<td align="left" id="subTitle" class="titleTableSubTitle">Interface IProxy</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a></td>
|
|
23
|
+
</tr>
|
|
24
|
+
<tr class="titleTableRow3">
|
|
25
|
+
<td colspan="2"> </td>
|
|
26
|
+
</tr>
|
|
27
|
+
</table>
|
|
28
|
+
<script type="text/javascript" language="javascript">
|
|
29
|
+
<!--
|
|
30
|
+
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Interface IProxy"); titleBar_setSubNav(false,false,false,false,false,false,true,false,false,false,false,false,false,false);}
|
|
31
|
+
--></script>
|
|
32
|
+
<div class="MainContent">
|
|
33
|
+
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
|
|
34
|
+
<tr>
|
|
35
|
+
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">org.puremvc.as3.interfaces</a></td>
|
|
36
|
+
</tr>
|
|
37
|
+
<tr>
|
|
38
|
+
<td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface IProxy</td>
|
|
39
|
+
</tr>
|
|
40
|
+
<tr>
|
|
41
|
+
<td class="classHeaderTableLabel">Implementors</td><td><a href="../patterns/proxy/Proxy.html">Proxy</a></td>
|
|
42
|
+
</tr>
|
|
43
|
+
</table>
|
|
44
|
+
<p></p>
|
|
45
|
+
The interface definition for a PureMVC Proxy.
|
|
46
|
+
<P>
|
|
47
|
+
In PureMVC, <code>IProxy</code> implementors assume these responsibilities:</P>
|
|
48
|
+
<UL>
|
|
49
|
+
<LI>Implement a common method which returns the name of the Proxy.</LI>
|
|
50
|
+
<LI>Provide methods for setting and getting the data object.</LI>
|
|
51
|
+
</UL>
|
|
52
|
+
<P>
|
|
53
|
+
Additionally, <code>IProxy</code>s typically:</P>
|
|
54
|
+
<UL>
|
|
55
|
+
<LI>Maintain references to one or more pieces of model data.</LI>
|
|
56
|
+
<LI>Provide methods for manipulating that data.</LI>
|
|
57
|
+
<LI>Generate <code>INotifications</code> when their model data changes.</LI>
|
|
58
|
+
<LI>Expose their name as a <code>public static const</code> called <code>NAME</code>, if they are not instantiated multiple times.</LI>
|
|
59
|
+
<LI>Encapsulate interaction with local or remote services used to fetch and persist model data.</LI>
|
|
60
|
+
</UL>
|
|
61
|
+
<p></p>
|
|
62
|
+
<br>
|
|
63
|
+
<hr>
|
|
64
|
+
</div>
|
|
65
|
+
<a name="methodSummary"></a>
|
|
66
|
+
<div class="summarySection">
|
|
67
|
+
<div class="summaryTableTitle">Public Methods</div>
|
|
68
|
+
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
|
|
69
|
+
<tr>
|
|
70
|
+
<th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined by</th>
|
|
71
|
+
</tr>
|
|
72
|
+
<tr class="">
|
|
73
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
74
|
+
<div class="summarySignature">
|
|
75
|
+
<a class="signatureLink" href="#getData()">getData</a>():Object</div>
|
|
76
|
+
<div class="summaryTableDescription">
|
|
77
|
+
Get the data object
|
|
78
|
+
|
|
79
|
+
</div>
|
|
80
|
+
</td><td class="summaryTableOwnerCol">IProxy</td>
|
|
81
|
+
</tr>
|
|
82
|
+
<tr class="">
|
|
83
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
84
|
+
<div class="summarySignature">
|
|
85
|
+
<a class="signatureLink" href="#getProxyName()">getProxyName</a>():String</div>
|
|
86
|
+
<div class="summaryTableDescription">
|
|
87
|
+
Get the Proxy name
|
|
88
|
+
|
|
89
|
+
</div>
|
|
90
|
+
</td><td class="summaryTableOwnerCol">IProxy</td>
|
|
91
|
+
</tr>
|
|
92
|
+
<tr class="">
|
|
93
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
94
|
+
<div class="summarySignature">
|
|
95
|
+
<a class="signatureLink" href="#onRegister()">onRegister</a>():void</div>
|
|
96
|
+
<div class="summaryTableDescription">
|
|
97
|
+
Called by the Model when the Proxy is registered
|
|
98
|
+
</div>
|
|
99
|
+
</td><td class="summaryTableOwnerCol">IProxy</td>
|
|
100
|
+
</tr>
|
|
101
|
+
<tr class="">
|
|
102
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
103
|
+
<div class="summarySignature">
|
|
104
|
+
<a class="signatureLink" href="#onRemove()">onRemove</a>():void</div>
|
|
105
|
+
<div class="summaryTableDescription">
|
|
106
|
+
Called by the Model when the Proxy is removed
|
|
107
|
+
</div>
|
|
108
|
+
</td><td class="summaryTableOwnerCol">IProxy</td>
|
|
109
|
+
</tr>
|
|
110
|
+
<tr class="">
|
|
111
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
112
|
+
<div class="summarySignature">
|
|
113
|
+
<a class="signatureLink" href="#setData()">setData</a>(data:Object):void</div>
|
|
114
|
+
<div class="summaryTableDescription">
|
|
115
|
+
Set the data object
|
|
116
|
+
|
|
117
|
+
</div>
|
|
118
|
+
</td><td class="summaryTableOwnerCol">IProxy</td>
|
|
119
|
+
</tr>
|
|
120
|
+
</table>
|
|
121
|
+
</div>
|
|
122
|
+
<script type="text/javascript" language="javascript">
|
|
123
|
+
<!--
|
|
124
|
+
showHideInherited();
|
|
125
|
+
--></script>
|
|
126
|
+
<div class="MainContent">
|
|
127
|
+
<a name="methodDetail"></a>
|
|
128
|
+
<div class="detailSectionHeader">Method detail</div>
|
|
129
|
+
<a name="getData()"></a>
|
|
130
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
131
|
+
<tr>
|
|
132
|
+
<td class="detailHeaderName">getData</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
|
|
133
|
+
</tr>
|
|
134
|
+
</table>
|
|
135
|
+
<div class="detailBody">
|
|
136
|
+
<code>public function getData():Object</code><p>
|
|
137
|
+
Get the data object
|
|
138
|
+
|
|
139
|
+
</p><p></p>
|
|
140
|
+
<span class="label">Returns</span>
|
|
141
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
142
|
+
<tr>
|
|
143
|
+
<td width="20"></td><td><code>Object</code> — the data as type Object
|
|
144
|
+
</td>
|
|
145
|
+
</tr>
|
|
146
|
+
</table>
|
|
147
|
+
</div>
|
|
148
|
+
<a name="getProxyName()"></a>
|
|
149
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
150
|
+
<tr>
|
|
151
|
+
<td class="detailHeaderName">getProxyName</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
|
|
152
|
+
</tr>
|
|
153
|
+
</table>
|
|
154
|
+
<div class="detailBody">
|
|
155
|
+
<code>public function getProxyName():String</code><p>
|
|
156
|
+
Get the Proxy name
|
|
157
|
+
|
|
158
|
+
</p><p></p>
|
|
159
|
+
<span class="label">Returns</span>
|
|
160
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
161
|
+
<tr>
|
|
162
|
+
<td width="20"></td><td><code>String</code> — the Proxy instance name
|
|
163
|
+
</td>
|
|
164
|
+
</tr>
|
|
165
|
+
</table>
|
|
166
|
+
</div>
|
|
167
|
+
<a name="onRegister()"></a>
|
|
168
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
169
|
+
<tr>
|
|
170
|
+
<td class="detailHeaderName">onRegister</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
|
|
171
|
+
</tr>
|
|
172
|
+
</table>
|
|
173
|
+
<div class="detailBody">
|
|
174
|
+
<code>public function onRegister():void</code><p>
|
|
175
|
+
Called by the Model when the Proxy is registered
|
|
176
|
+
</p></div>
|
|
177
|
+
<a name="onRemove()"></a>
|
|
178
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
179
|
+
<tr>
|
|
180
|
+
<td class="detailHeaderName">onRemove</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
|
|
181
|
+
</tr>
|
|
182
|
+
</table>
|
|
183
|
+
<div class="detailBody">
|
|
184
|
+
<code>public function onRemove():void</code><p>
|
|
185
|
+
Called by the Model when the Proxy is removed
|
|
186
|
+
</p></div>
|
|
187
|
+
<a name="setData()"></a>
|
|
188
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
189
|
+
<tr>
|
|
190
|
+
<td class="detailHeaderName">setData</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
|
|
191
|
+
</tr>
|
|
192
|
+
</table>
|
|
193
|
+
<div class="detailBody">
|
|
194
|
+
<code>public function setData(data:Object):void</code><p>
|
|
195
|
+
Set the data object
|
|
196
|
+
|
|
197
|
+
</p><span class="label">Parameters</span>
|
|
198
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
199
|
+
<tr>
|
|
200
|
+
<td width="20px"></td><td><code><span class="label">data</span>:Object</code> — the data object
|
|
201
|
+
</td>
|
|
202
|
+
</tr>
|
|
203
|
+
</table>
|
|
204
|
+
</div>
|
|
205
|
+
<br>
|
|
206
|
+
<br>
|
|
207
|
+
<hr>
|
|
208
|
+
<br>
|
|
209
|
+
<p></p>
|
|
210
|
+
<center class="copyright">
|
|
211
|
+
<footer>
|
|
212
|
+
</footer>
|
|
213
|
+
</center>
|
|
214
|
+
</div>
|
|
215
|
+
</body>
|
|
216
|
+
</html>
|
|
217
|
+
<!-- -->
|
|
@@ -0,0 +1,350 @@
|
|
|
1
|
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
5
|
+
<link rel="stylesheet" href="../../../../style.css" type="text/css" media="screen">
|
|
6
|
+
<link rel="stylesheet" href="../../../../print.css" type="text/css" media="print">
|
|
7
|
+
<meta content="IView,org.puremvc.as3.interfaces.IView,hasMediator,notifyObservers,registerMediator,registerObserver,removeMediator,removeObserver,retrieveMediator" name="keywords">
|
|
8
|
+
<title>org.puremvc.as3.interfaces.IView</title>
|
|
9
|
+
</head>
|
|
10
|
+
<body>
|
|
11
|
+
<script type="text/javascript" language="javascript" src="../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../cookies.js"></script><script type="text/javascript" language="javascript">
|
|
12
|
+
<!--
|
|
13
|
+
asdocTitle = 'IView - API Documentation';
|
|
14
|
+
var baseRef = '../../../../';
|
|
15
|
+
window.onload = configPage;
|
|
16
|
+
--></script>
|
|
17
|
+
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
|
|
18
|
+
<tr>
|
|
19
|
+
<td align="left" class="titleTableTitle">PureMVC AS3 Framework - [Standard Version]</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../package-summary.html">All Packages</a> | <a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../class-summary.html">All Classes</a> | <a onclick="loadClassListFrame('../../../../index-list.html')" href="../../../../all-index-A.html">Index</a> | <a href="../../../../index.html?org/puremvc/as3/interfaces/IView.html&org/puremvc/as3/interfaces/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../images/logo.jpg"></td>
|
|
20
|
+
</tr>
|
|
21
|
+
<tr class="titleTableRow2">
|
|
22
|
+
<td align="left" id="subTitle" class="titleTableSubTitle">Interface IView</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a></td>
|
|
23
|
+
</tr>
|
|
24
|
+
<tr class="titleTableRow3">
|
|
25
|
+
<td colspan="2"> </td>
|
|
26
|
+
</tr>
|
|
27
|
+
</table>
|
|
28
|
+
<script type="text/javascript" language="javascript">
|
|
29
|
+
<!--
|
|
30
|
+
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Interface IView"); titleBar_setSubNav(false,false,false,false,false,false,true,false,false,false,false,false,false,false);}
|
|
31
|
+
--></script>
|
|
32
|
+
<div class="MainContent">
|
|
33
|
+
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
|
|
34
|
+
<tr>
|
|
35
|
+
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">org.puremvc.as3.interfaces</a></td>
|
|
36
|
+
</tr>
|
|
37
|
+
<tr>
|
|
38
|
+
<td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface IView</td>
|
|
39
|
+
</tr>
|
|
40
|
+
<tr>
|
|
41
|
+
<td class="classHeaderTableLabel">Implementors</td><td><a href="../core/View.html">View</a></td>
|
|
42
|
+
</tr>
|
|
43
|
+
</table>
|
|
44
|
+
<p></p>
|
|
45
|
+
The interface definition for a PureMVC View.
|
|
46
|
+
|
|
47
|
+
<P>
|
|
48
|
+
In PureMVC, <code>IView</code> implementors assume these responsibilities:</P>
|
|
49
|
+
|
|
50
|
+
<P>
|
|
51
|
+
In PureMVC, the <code>View</code> class assumes these responsibilities:
|
|
52
|
+
<UL>
|
|
53
|
+
<LI>Maintain a cache of <code>IMediator</code> instances.</LI>
|
|
54
|
+
<LI>Provide methods for registering, retrieving, and removing <code>IMediators</code>.</LI>
|
|
55
|
+
<LI>Managing the observer lists for each <code>INotification</code> in the application.</LI>
|
|
56
|
+
<LI>Providing a method for attaching <code>IObservers</code> to an <code>INotification</code>'s observer list.</LI>
|
|
57
|
+
<LI>Providing a method for broadcasting an <code>INotification</code>.</LI>
|
|
58
|
+
<LI>Notifying the <code>IObservers</code> of a given <code>INotification</code> when it broadcast.</LI>
|
|
59
|
+
</UL>
|
|
60
|
+
|
|
61
|
+
<p></p>
|
|
62
|
+
<p>
|
|
63
|
+
<span class="classHeaderTableLabel">See also</span>
|
|
64
|
+
</p>
|
|
65
|
+
<div class="seeAlso">
|
|
66
|
+
<a href="../interfaces/IMediator.html" target="">IMediator</a>
|
|
67
|
+
<br>
|
|
68
|
+
<a href="../interfaces/IObserver.html" target="">IObserver</a>
|
|
69
|
+
<br>
|
|
70
|
+
<a href="../interfaces/INotification.html" target="">INotification</a>
|
|
71
|
+
</div>
|
|
72
|
+
<br>
|
|
73
|
+
<hr>
|
|
74
|
+
</div>
|
|
75
|
+
<a name="methodSummary"></a>
|
|
76
|
+
<div class="summarySection">
|
|
77
|
+
<div class="summaryTableTitle">Public Methods</div>
|
|
78
|
+
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
|
|
79
|
+
<tr>
|
|
80
|
+
<th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined by</th>
|
|
81
|
+
</tr>
|
|
82
|
+
<tr class="">
|
|
83
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
84
|
+
<div class="summarySignature">
|
|
85
|
+
<a class="signatureLink" href="#hasMediator()">hasMediator</a>(mediatorName:String):Boolean</div>
|
|
86
|
+
<div class="summaryTableDescription">
|
|
87
|
+
Check if a Mediator is registered or not
|
|
88
|
+
|
|
89
|
+
</div>
|
|
90
|
+
</td><td class="summaryTableOwnerCol">IView</td>
|
|
91
|
+
</tr>
|
|
92
|
+
<tr class="">
|
|
93
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
94
|
+
<div class="summarySignature">
|
|
95
|
+
<a class="signatureLink" href="#notifyObservers()">notifyObservers</a>(note:<a href="INotification.html">INotification</a>):void</div>
|
|
96
|
+
<div class="summaryTableDescription">
|
|
97
|
+
Notify the <code>IObservers</code> for a particular <code>INotification</code>.</div>
|
|
98
|
+
</td><td class="summaryTableOwnerCol">IView</td>
|
|
99
|
+
</tr>
|
|
100
|
+
<tr class="">
|
|
101
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
102
|
+
<div class="summarySignature">
|
|
103
|
+
<a class="signatureLink" href="#registerMediator()">registerMediator</a>(mediator:<a href="IMediator.html">IMediator</a>):void</div>
|
|
104
|
+
<div class="summaryTableDescription">
|
|
105
|
+
Register an <code>IMediator</code> instance with the <code>View</code>.</div>
|
|
106
|
+
</td><td class="summaryTableOwnerCol">IView</td>
|
|
107
|
+
</tr>
|
|
108
|
+
<tr class="">
|
|
109
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
110
|
+
<div class="summarySignature">
|
|
111
|
+
<a class="signatureLink" href="#registerObserver()">registerObserver</a>(notificationName:String, observer:<a href="IObserver.html">IObserver</a>):void</div>
|
|
112
|
+
<div class="summaryTableDescription">
|
|
113
|
+
Register an <code>IObserver</code> to be notified
|
|
114
|
+
of <code>INotifications</code> with a given name.</div>
|
|
115
|
+
</td><td class="summaryTableOwnerCol">IView</td>
|
|
116
|
+
</tr>
|
|
117
|
+
<tr class="">
|
|
118
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
119
|
+
<div class="summarySignature">
|
|
120
|
+
<a class="signatureLink" href="#removeMediator()">removeMediator</a>(mediatorName:String):<a href="../interfaces/IMediator.html">IMediator</a>
|
|
121
|
+
</div>
|
|
122
|
+
<div class="summaryTableDescription">
|
|
123
|
+
Remove an <code>IMediator</code> from the <code>View</code>.</div>
|
|
124
|
+
</td><td class="summaryTableOwnerCol">IView</td>
|
|
125
|
+
</tr>
|
|
126
|
+
<tr class="">
|
|
127
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
128
|
+
<div class="summarySignature">
|
|
129
|
+
<a class="signatureLink" href="#removeObserver()">removeObserver</a>(notificationName:String, notifyContext:Object):void</div>
|
|
130
|
+
<div class="summaryTableDescription">
|
|
131
|
+
Remove a group of observers from the observer list for a given Notification name.</div>
|
|
132
|
+
</td><td class="summaryTableOwnerCol">IView</td>
|
|
133
|
+
</tr>
|
|
134
|
+
<tr class="">
|
|
135
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
136
|
+
<div class="summarySignature">
|
|
137
|
+
<a class="signatureLink" href="#retrieveMediator()">retrieveMediator</a>(mediatorName:String):<a href="../interfaces/IMediator.html">IMediator</a>
|
|
138
|
+
</div>
|
|
139
|
+
<div class="summaryTableDescription">
|
|
140
|
+
Retrieve an <code>IMediator</code> from the <code>View</code>.</div>
|
|
141
|
+
</td><td class="summaryTableOwnerCol">IView</td>
|
|
142
|
+
</tr>
|
|
143
|
+
</table>
|
|
144
|
+
</div>
|
|
145
|
+
<script type="text/javascript" language="javascript">
|
|
146
|
+
<!--
|
|
147
|
+
showHideInherited();
|
|
148
|
+
--></script>
|
|
149
|
+
<div class="MainContent">
|
|
150
|
+
<a name="methodDetail"></a>
|
|
151
|
+
<div class="detailSectionHeader">Method detail</div>
|
|
152
|
+
<a name="hasMediator()"></a>
|
|
153
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
154
|
+
<tr>
|
|
155
|
+
<td class="detailHeaderName">hasMediator</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
|
|
156
|
+
</tr>
|
|
157
|
+
</table>
|
|
158
|
+
<div class="detailBody">
|
|
159
|
+
<code>public function hasMediator(mediatorName:String):Boolean</code><p>
|
|
160
|
+
Check if a Mediator is registered or not
|
|
161
|
+
|
|
162
|
+
</p><span class="label">Parameters</span>
|
|
163
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
164
|
+
<tr>
|
|
165
|
+
<td width="20px"></td><td><code><span class="label">mediatorName</span>:String</code></td>
|
|
166
|
+
</tr>
|
|
167
|
+
</table>
|
|
168
|
+
<p></p>
|
|
169
|
+
<span class="label">Returns</span>
|
|
170
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
171
|
+
<tr>
|
|
172
|
+
<td width="20"></td><td><code>Boolean</code> — whether a Mediator is registered with the given <code>mediatorName</code>.
|
|
173
|
+
</td>
|
|
174
|
+
</tr>
|
|
175
|
+
</table>
|
|
176
|
+
</div>
|
|
177
|
+
<a name="notifyObservers()"></a>
|
|
178
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
179
|
+
<tr>
|
|
180
|
+
<td class="detailHeaderName">notifyObservers</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
|
|
181
|
+
</tr>
|
|
182
|
+
</table>
|
|
183
|
+
<div class="detailBody">
|
|
184
|
+
<code>public function notifyObservers(note:<a href="INotification.html">INotification</a>):void</code><p>
|
|
185
|
+
Notify the <code>IObservers</code> for a particular <code>INotification</code>.
|
|
186
|
+
|
|
187
|
+
<P>
|
|
188
|
+
All previously attached <code>IObservers</code> for this <code>INotification</code>'s
|
|
189
|
+
list are notified and are passed a reference to the <code>INotification</code> in
|
|
190
|
+
the order in which they were registered.</P>
|
|
191
|
+
|
|
192
|
+
</p><span class="label">Parameters</span>
|
|
193
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
194
|
+
<tr>
|
|
195
|
+
<td width="20px"></td><td><code><span class="label">note</span>:<a href="INotification.html">INotification</a></code> — the <code>INotification</code> to notify <code>IObservers</code> of.
|
|
196
|
+
</td>
|
|
197
|
+
</tr>
|
|
198
|
+
</table>
|
|
199
|
+
</div>
|
|
200
|
+
<a name="registerMediator()"></a>
|
|
201
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
202
|
+
<tr>
|
|
203
|
+
<td class="detailHeaderName">registerMediator</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
|
|
204
|
+
</tr>
|
|
205
|
+
</table>
|
|
206
|
+
<div class="detailBody">
|
|
207
|
+
<code>public function registerMediator(mediator:<a href="IMediator.html">IMediator</a>):void</code><p>
|
|
208
|
+
Register an <code>IMediator</code> instance with the <code>View</code>.
|
|
209
|
+
|
|
210
|
+
<P>
|
|
211
|
+
Registers the <code>IMediator</code> so that it can be retrieved by name,
|
|
212
|
+
and further interrogates the <code>IMediator</code> for its
|
|
213
|
+
<code>INotification</code> interests.</P>
|
|
214
|
+
<P>
|
|
215
|
+
If the <code>IMediator</code> returns any <code>INotification</code>
|
|
216
|
+
names to be notified about, an <code>Observer</code> is created encapsulating
|
|
217
|
+
the <code>IMediator</code> instance's <code>handleNotification</code> method
|
|
218
|
+
and registering it as an <code>Observer</code> for all <code>INotifications</code> the
|
|
219
|
+
<code>IMediator</code> is interested in.</p>
|
|
220
|
+
|
|
221
|
+
</p><span class="label">Parameters</span>
|
|
222
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
223
|
+
<tr>
|
|
224
|
+
<td width="20px"></td><td><code><span class="label">mediator</span>:<a href="IMediator.html">IMediator</a></code> — the name to associate with this <code>IMediator</code> instance
|
|
225
|
+
</td>
|
|
226
|
+
</tr>
|
|
227
|
+
</table>
|
|
228
|
+
</div>
|
|
229
|
+
<a name="registerObserver()"></a>
|
|
230
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
231
|
+
<tr>
|
|
232
|
+
<td class="detailHeaderName">registerObserver</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
|
|
233
|
+
</tr>
|
|
234
|
+
</table>
|
|
235
|
+
<div class="detailBody">
|
|
236
|
+
<code>public function registerObserver(notificationName:String, observer:<a href="IObserver.html">IObserver</a>):void</code><p>
|
|
237
|
+
Register an <code>IObserver</code> to be notified
|
|
238
|
+
of <code>INotifications</code> with a given name.
|
|
239
|
+
|
|
240
|
+
</p><span class="label">Parameters</span>
|
|
241
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
242
|
+
<tr>
|
|
243
|
+
<td width="20px"></td><td><code><span class="label">notificationName</span>:String</code> — the name of the <code>INotifications</code> to notify this <code>IObserver</code> of
|
|
244
|
+
</td>
|
|
245
|
+
</tr>
|
|
246
|
+
<tr>
|
|
247
|
+
<td class="paramSpacer"> </td>
|
|
248
|
+
</tr>
|
|
249
|
+
<tr>
|
|
250
|
+
<td width="20px"></td><td><code><span class="label">observer</span>:<a href="IObserver.html">IObserver</a></code> — the <code>IObserver</code> to register
|
|
251
|
+
</td>
|
|
252
|
+
</tr>
|
|
253
|
+
</table>
|
|
254
|
+
</div>
|
|
255
|
+
<a name="removeMediator()"></a>
|
|
256
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
257
|
+
<tr>
|
|
258
|
+
<td class="detailHeaderName">removeMediator</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
|
|
259
|
+
</tr>
|
|
260
|
+
</table>
|
|
261
|
+
<div class="detailBody">
|
|
262
|
+
<code>public function removeMediator(mediatorName:String):<a href="../interfaces/IMediator.html">IMediator</a></code><p>
|
|
263
|
+
Remove an <code>IMediator</code> from the <code>View</code>.
|
|
264
|
+
|
|
265
|
+
</p><span class="label">Parameters</span>
|
|
266
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
267
|
+
<tr>
|
|
268
|
+
<td width="20px"></td><td><code><span class="label">mediatorName</span>:String</code> — name of the <code>IMediator</code> instance to be removed.
|
|
269
|
+
</td>
|
|
270
|
+
</tr>
|
|
271
|
+
</table>
|
|
272
|
+
<p></p>
|
|
273
|
+
<span class="label">Returns</span>
|
|
274
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
275
|
+
<tr>
|
|
276
|
+
<td width="20"></td><td><code><a href="../interfaces/IMediator.html">IMediator</a></code> —
|
|
277
|
+
the <code>IMediator</code> that was removed from the <code>View</code>
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
</td>
|
|
281
|
+
</tr>
|
|
282
|
+
</table>
|
|
283
|
+
</div>
|
|
284
|
+
<a name="removeObserver()"></a>
|
|
285
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
286
|
+
<tr>
|
|
287
|
+
<td class="detailHeaderName">removeObserver</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
|
|
288
|
+
</tr>
|
|
289
|
+
</table>
|
|
290
|
+
<div class="detailBody">
|
|
291
|
+
<code>public function removeObserver(notificationName:String, notifyContext:Object):void</code><p>
|
|
292
|
+
Remove a group of observers from the observer list for a given Notification name.
|
|
293
|
+
<P>
|
|
294
|
+
</p><span class="label">Parameters</span>
|
|
295
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
296
|
+
<tr>
|
|
297
|
+
<td width="20px"></td><td><code><span class="label">notificationName</span>:String</code> — which observer list to remove from
|
|
298
|
+
</td>
|
|
299
|
+
</tr>
|
|
300
|
+
<tr>
|
|
301
|
+
<td class="paramSpacer"> </td>
|
|
302
|
+
</tr>
|
|
303
|
+
<tr>
|
|
304
|
+
<td width="20px"></td><td><code><span class="label">notifyContext</span>:Object</code> — removed the observers with this object as their notifyContext
|
|
305
|
+
</td>
|
|
306
|
+
</tr>
|
|
307
|
+
</table>
|
|
308
|
+
</div>
|
|
309
|
+
<a name="retrieveMediator()"></a>
|
|
310
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
311
|
+
<tr>
|
|
312
|
+
<td class="detailHeaderName">retrieveMediator</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
|
|
313
|
+
</tr>
|
|
314
|
+
</table>
|
|
315
|
+
<div class="detailBody">
|
|
316
|
+
<code>public function retrieveMediator(mediatorName:String):<a href="../interfaces/IMediator.html">IMediator</a></code><p>
|
|
317
|
+
Retrieve an <code>IMediator</code> from the <code>View</code>.
|
|
318
|
+
|
|
319
|
+
</p><span class="label">Parameters</span>
|
|
320
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
321
|
+
<tr>
|
|
322
|
+
<td width="20px"></td><td><code><span class="label">mediatorName</span>:String</code> — the name of the <code>IMediator</code> instance to retrieve.
|
|
323
|
+
</td>
|
|
324
|
+
</tr>
|
|
325
|
+
</table>
|
|
326
|
+
<p></p>
|
|
327
|
+
<span class="label">Returns</span>
|
|
328
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
329
|
+
<tr>
|
|
330
|
+
<td width="20"></td><td><code><a href="../interfaces/IMediator.html">IMediator</a></code> —
|
|
331
|
+
the <code>IMediator</code> instance previously registered with the given <code>mediatorName</code>.
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
</td>
|
|
335
|
+
</tr>
|
|
336
|
+
</table>
|
|
337
|
+
</div>
|
|
338
|
+
<br>
|
|
339
|
+
<br>
|
|
340
|
+
<hr>
|
|
341
|
+
<br>
|
|
342
|
+
<p></p>
|
|
343
|
+
<center class="copyright">
|
|
344
|
+
<footer>
|
|
345
|
+
</footer>
|
|
346
|
+
</center>
|
|
347
|
+
</div>
|
|
348
|
+
</body>
|
|
349
|
+
</html>
|
|
350
|
+
<!-- -->
|