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.
Files changed (116) hide show
  1. data/2.0.4/asdoc/all-classes.html +81 -0
  2. data/2.0.4/asdoc/all-index-A.html +59 -0
  3. data/2.0.4/asdoc/all-index-B.html +52 -0
  4. data/2.0.4/asdoc/all-index-C.html +92 -0
  5. data/2.0.4/asdoc/all-index-D.html +58 -0
  6. data/2.0.4/asdoc/all-index-E.html +89 -0
  7. data/2.0.4/asdoc/all-index-F.html +72 -0
  8. data/2.0.4/asdoc/all-index-G.html +190 -0
  9. data/2.0.4/asdoc/all-index-H.html +174 -0
  10. data/2.0.4/asdoc/all-index-I.html +202 -0
  11. data/2.0.4/asdoc/all-index-J.html +52 -0
  12. data/2.0.4/asdoc/all-index-K.html +52 -0
  13. data/2.0.4/asdoc/all-index-L.html +67 -0
  14. data/2.0.4/asdoc/all-index-M.html +112 -0
  15. data/2.0.4/asdoc/all-index-N.html +128 -0
  16. data/2.0.4/asdoc/all-index-O.html +178 -0
  17. data/2.0.4/asdoc/all-index-P.html +79 -0
  18. data/2.0.4/asdoc/all-index-Q.html +52 -0
  19. data/2.0.4/asdoc/all-index-R.html +308 -0
  20. data/2.0.4/asdoc/all-index-S.html +193 -0
  21. data/2.0.4/asdoc/all-index-T.html +67 -0
  22. data/2.0.4/asdoc/all-index-U.html +52 -0
  23. data/2.0.4/asdoc/all-index-V.html +84 -0
  24. data/2.0.4/asdoc/all-index-W.html +52 -0
  25. data/2.0.4/asdoc/all-index-X.html +52 -0
  26. data/2.0.4/asdoc/all-index-Y.html +52 -0
  27. data/2.0.4/asdoc/all-index-Z.html +52 -0
  28. data/2.0.4/asdoc/appendixes.html +47 -0
  29. data/2.0.4/asdoc/asdoc.js +273 -0
  30. data/2.0.4/asdoc/class-summary.html +174 -0
  31. data/2.0.4/asdoc/cookies.js +84 -0
  32. data/2.0.4/asdoc/images/collapsed.gif +0 -0
  33. data/2.0.4/asdoc/images/detailHeaderRule.jpg +0 -0
  34. data/2.0.4/asdoc/images/detailSectionHeader.jpg +0 -0
  35. data/2.0.4/asdoc/images/expanded.gif +0 -0
  36. data/2.0.4/asdoc/images/inherit-arrow.gif +0 -0
  37. data/2.0.4/asdoc/images/inheritedSummary.gif +0 -0
  38. data/2.0.4/asdoc/images/logo.jpg +0 -0
  39. data/2.0.4/asdoc/images/titleTableBottom.jpg +0 -0
  40. data/2.0.4/asdoc/images/titleTableMiddle.jpg +0 -0
  41. data/2.0.4/asdoc/images/titleTableTop.jpg +0 -0
  42. data/2.0.4/asdoc/index-list.html +121 -0
  43. data/2.0.4/asdoc/index.html +63 -0
  44. data/2.0.4/asdoc/mxml-tags.html +45 -0
  45. data/2.0.4/asdoc/org/puremvc/as3/core/Controller.html +433 -0
  46. data/2.0.4/asdoc/org/puremvc/as3/core/Model.html +405 -0
  47. data/2.0.4/asdoc/org/puremvc/as3/core/View.html +524 -0
  48. data/2.0.4/asdoc/org/puremvc/as3/core/class-list.html +30 -0
  49. data/2.0.4/asdoc/org/puremvc/as3/core/package-detail.html +65 -0
  50. data/2.0.4/asdoc/org/puremvc/as3/interfaces/ICommand.html +110 -0
  51. data/2.0.4/asdoc/org/puremvc/as3/interfaces/IController.html +226 -0
  52. data/2.0.4/asdoc/org/puremvc/as3/interfaces/IFacade.html +520 -0
  53. data/2.0.4/asdoc/org/puremvc/as3/interfaces/IMediator.html +345 -0
  54. data/2.0.4/asdoc/org/puremvc/as3/interfaces/IModel.html +226 -0
  55. data/2.0.4/asdoc/org/puremvc/as3/interfaces/INotification.html +269 -0
  56. data/2.0.4/asdoc/org/puremvc/as3/interfaces/INotifier.html +151 -0
  57. data/2.0.4/asdoc/org/puremvc/as3/interfaces/IObserver.html +234 -0
  58. data/2.0.4/asdoc/org/puremvc/as3/interfaces/IProxy.html +217 -0
  59. data/2.0.4/asdoc/org/puremvc/as3/interfaces/IView.html +350 -0
  60. data/2.0.4/asdoc/org/puremvc/as3/interfaces/class-list.html +54 -0
  61. data/2.0.4/asdoc/org/puremvc/as3/interfaces/package-detail.html +93 -0
  62. data/2.0.4/asdoc/org/puremvc/as3/patterns/command/MacroCommand.html +284 -0
  63. data/2.0.4/asdoc/org/puremvc/as3/patterns/command/SimpleCommand.html +164 -0
  64. data/2.0.4/asdoc/org/puremvc/as3/patterns/command/class-list.html +27 -0
  65. data/2.0.4/asdoc/org/puremvc/as3/patterns/command/package-detail.html +61 -0
  66. data/2.0.4/asdoc/org/puremvc/as3/patterns/facade/Facade.html +940 -0
  67. data/2.0.4/asdoc/org/puremvc/as3/patterns/facade/class-list.html +24 -0
  68. data/2.0.4/asdoc/org/puremvc/as3/patterns/facade/package-detail.html +57 -0
  69. data/2.0.4/asdoc/org/puremvc/as3/patterns/mediator/Mediator.html +402 -0
  70. data/2.0.4/asdoc/org/puremvc/as3/patterns/mediator/class-list.html +24 -0
  71. data/2.0.4/asdoc/org/puremvc/as3/patterns/mediator/package-detail.html +57 -0
  72. data/2.0.4/asdoc/org/puremvc/as3/patterns/observer/Notification.html +312 -0
  73. data/2.0.4/asdoc/org/puremvc/as3/patterns/observer/Notifier.html +180 -0
  74. data/2.0.4/asdoc/org/puremvc/as3/patterns/observer/Observer.html +253 -0
  75. data/2.0.4/asdoc/org/puremvc/as3/patterns/observer/class-list.html +30 -0
  76. data/2.0.4/asdoc/org/puremvc/as3/patterns/observer/package-detail.html +65 -0
  77. data/2.0.4/asdoc/org/puremvc/as3/patterns/proxy/Proxy.html +338 -0
  78. data/2.0.4/asdoc/org/puremvc/as3/patterns/proxy/class-list.html +24 -0
  79. data/2.0.4/asdoc/org/puremvc/as3/patterns/proxy/package-detail.html +57 -0
  80. data/2.0.4/asdoc/package-frame.html +36 -0
  81. data/2.0.4/asdoc/package-list.html +52 -0
  82. data/2.0.4/asdoc/package-summary.html +68 -0
  83. data/2.0.4/asdoc/print.css +110 -0
  84. data/2.0.4/asdoc/style.css +565 -0
  85. data/2.0.4/asdoc/title-bar.html +55 -0
  86. data/2.0.4/bin/PureMVC_AS3_2_0_4.swc +0 -0
  87. data/2.0.4/license.txt +61 -0
  88. data/2.0.4/src/org/puremvc/as3/core/Controller.as +183 -0
  89. data/2.0.4/src/org/puremvc/as3/core/Model.as +144 -0
  90. data/2.0.4/src/org/puremvc/as3/core/View.as +271 -0
  91. data/2.0.4/src/org/puremvc/as3/interfaces/ICommand.as +21 -0
  92. data/2.0.4/src/org/puremvc/as3/interfaces/IController.as +64 -0
  93. data/2.0.4/src/org/puremvc/as3/interfaces/IFacade.as +131 -0
  94. data/2.0.4/src/org/puremvc/as3/interfaces/IMediator.as +150 -0
  95. data/2.0.4/src/org/puremvc/as3/interfaces/IModel.as +57 -0
  96. data/2.0.4/src/org/puremvc/as3/interfaces/INotification.as +76 -0
  97. data/2.0.4/src/org/puremvc/as3/interfaces/INotifier.as +46 -0
  98. data/2.0.4/src/org/puremvc/as3/interfaces/IObserver.as +81 -0
  99. data/2.0.4/src/org/puremvc/as3/interfaces/IProxy.as +61 -0
  100. data/2.0.4/src/org/puremvc/as3/interfaces/IView.as +106 -0
  101. data/2.0.4/src/org/puremvc/as3/patterns/command/MacroCommand.as +121 -0
  102. data/2.0.4/src/org/puremvc/as3/patterns/command/SimpleCommand.as +42 -0
  103. data/2.0.4/src/org/puremvc/as3/patterns/facade/Facade.as +419 -0
  104. data/2.0.4/src/org/puremvc/as3/patterns/mediator/Mediator.as +115 -0
  105. data/2.0.4/src/org/puremvc/as3/patterns/observer/Notification.as +128 -0
  106. data/2.0.4/src/org/puremvc/as3/patterns/observer/Notifier.as +55 -0
  107. data/2.0.4/src/org/puremvc/as3/patterns/observer/Observer.as +114 -0
  108. data/2.0.4/src/org/puremvc/as3/patterns/proxy/Proxy.as +88 -0
  109. data/2.0.4/src/puremvc-manifest.xml +20 -0
  110. data/2.0.4/version.txt +117 -0
  111. data/Gemfile +4 -0
  112. data/README.textile +107 -0
  113. data/Rakefile +24 -0
  114. data/lib/puremvc-as3.rb +29 -0
  115. data/lib/rake/rename.rb +34 -0
  116. metadata +198 -0
data/2.0.4/asdoc/org/puremvc/as3/interfaces/IMediator.html ADDED
@@ -0,0 +1,345 @@
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="IMediator,org.puremvc.as3.interfaces.IMediator,getMediatorName,getViewComponent,handleNotification,listNotificationInterests,onRegister,onRemove,setViewComponent" name="keywords">
8
+ <title>org.puremvc.as3.interfaces.IMediator</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 = 'IMediator - 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&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../index-list.html')" href="../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../index.html?org/puremvc/as3/interfaces/IMediator.html&amp;org/puremvc/as3/interfaces/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;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&nbsp;IMediator</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a></td>
23
+ </tr>
24
+ <tr class="titleTableRow3">
25
+ <td colspan="2">&nbsp;</td>
26
+ </tr>
27
+ </table>
28
+ <script type="text/javascript" language="javascript">
29
+ <!--
30
+ if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Interface IMediator"); 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 IMediator</td>
39
+ </tr>
40
+ <tr>
41
+ <td class="classHeaderTableLabel">Implementors</td><td><a href="../patterns/mediator/Mediator.html">Mediator</a></td>
42
+ </tr>
43
+ </table>
44
+ <p></p>
45
+ The interface definition for a PureMVC Mediator.
46
+ <P>
47
+ In PureMVC, <code>IMediator</code> implementors assume these responsibilities:</P>
48
+ <UL>
49
+ <LI>Implement a common method which returns a list of all <code>INotification</code>s
50
+ the <code>IMediator</code> has interest in.</LI>
51
+ <LI>Implement a notification callback method.</LI>
52
+ <LI>Implement methods that are called when the IMediator is registered or removed from the View.</LI>
53
+ </UL>
54
+ <P>
55
+ Additionally, <code>IMediator</code>s typically:
56
+ <UL>
57
+ <LI>Act as an intermediary between one or more view components such as text boxes or
58
+ list controls, maintaining references and coordinating their behavior.</LI>
59
+ <LI>In Flash-based apps, this is often the place where event listeners are
60
+ added to view components, and their handlers implemented.</LI>
61
+ <LI>Respond to and generate <code>INotifications</code>, interacting with of
62
+ the rest of the PureMVC app.
63
+ </UL></P>
64
+ <P>
65
+ When an <code>IMediator</code> is registered with the <code>IView</code>,
66
+ the <code>IView</code> will call the <code>IMediator</code>'s
67
+ <code>listNotificationInterests</code> method. The <code>IMediator</code> will
68
+ return an <code>Array</code> of <code>INotification</code> names which
69
+ it wishes to be notified about.</P>
70
+
71
+ <P>
72
+ The <code>IView</code> will then create an <code>Observer</code> object
73
+ encapsulating that <code>IMediator</code>'s (<code>handleNotification</code>) method
74
+ and register it as an Observer for each <code>INotification</code> name returned by
75
+ <code>listNotificationInterests</code>.</P>
76
+
77
+ <P>
78
+ A concrete IMediator implementor usually looks something like this:</P>
79
+
80
+ <div class='listing'><pre>
81
+ import org.puremvc.as3.patterns.mediator.*;
82
+ import org.puremvc.as3.patterns.observer.*;
83
+ import org.puremvc.as3.core.view.*;
84
+
85
+ import com.me.myapp.model.*;
86
+ import com.me.myapp.view.*;
87
+ import com.me.myapp.controller.*;
88
+
89
+ import mx.controls.ComboBox;
90
+ import mx.events.ListEvent;
91
+
92
+ public class MyMediator extends Mediator implements IMediator {
93
+
94
+ public function MyComboMediator( viewComponent:Object ) {
95
+ super( viewComponent );
96
+ combo.addEventListener( Event.CHANGE, onChange );
97
+ }
98
+
99
+ override public function listNotificationInterests():Array {
100
+ return [ MyFacade.SET_SELECTION,
101
+ MyFacade.SET_DATAPROVIDER ];
102
+ }
103
+
104
+ override public function handleNotification( notification:INotification ):void {
105
+ switch ( notification.getName() ) {
106
+ case MyFacade.SET_SELECTION:
107
+ setSelection(notification);
108
+ break;
109
+ case MyFacade.SET_DATAPROVIDER:
110
+ setDataProvider(notification);
111
+ break;
112
+ }
113
+ }
114
+
115
+ // Set the data provider of the combo box
116
+ protected function setDataProvider( notification:INotification ):void {
117
+ combo.dataProvider = notification.getBody() as Array;
118
+ }
119
+
120
+ // Invoked when the combo box dispatches a change event, we send a
121
+ // notification with the
122
+ protected function onChange(event:ListEvent):void {
123
+ sendNotification( MyFacade.MYCOMBO_CHANGED, this );
124
+ }
125
+
126
+ // A private getter for accessing the view object by class
127
+ protected function get combo():ComboBox {
128
+ return view as ComboBox;
129
+ }
130
+
131
+ }
132
+ </pre></div>
133
+
134
+ <p></p>
135
+ <p>
136
+ <span class="classHeaderTableLabel">See also</span>
137
+ </p>
138
+ <div class="seeAlso">
139
+ <a href="../interfaces/INotification.html" target="">INotification</a>
140
+ </div>
141
+ <br>
142
+ <hr>
143
+ </div>
144
+ <a name="methodSummary"></a>
145
+ <div class="summarySection">
146
+ <div class="summaryTableTitle">Public Methods</div>
147
+ <table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
148
+ <tr>
149
+ <th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
150
+ </tr>
151
+ <tr class="">
152
+ <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
153
+ <div class="summarySignature">
154
+ <a class="signatureLink" href="#getMediatorName()">getMediatorName</a>():String</div>
155
+ <div class="summaryTableDescription">
156
+ Get the <code>IMediator</code> instance name
157
+
158
+ </div>
159
+ </td><td class="summaryTableOwnerCol">IMediator</td>
160
+ </tr>
161
+ <tr class="">
162
+ <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
163
+ <div class="summarySignature">
164
+ <a class="signatureLink" href="#getViewComponent()">getViewComponent</a>():Object</div>
165
+ <div class="summaryTableDescription">
166
+ Get the <code>IMediator</code>'s view component.</div>
167
+ </td><td class="summaryTableOwnerCol">IMediator</td>
168
+ </tr>
169
+ <tr class="">
170
+ <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
171
+ <div class="summarySignature">
172
+ <a class="signatureLink" href="#handleNotification()">handleNotification</a>(notification:<a href="INotification.html">INotification</a>):void</div>
173
+ <div class="summaryTableDescription">
174
+ Handle an <code>INotification</code>.</div>
175
+ </td><td class="summaryTableOwnerCol">IMediator</td>
176
+ </tr>
177
+ <tr class="">
178
+ <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
179
+ <div class="summarySignature">
180
+ <a class="signatureLink" href="#listNotificationInterests()">listNotificationInterests</a>():Array</div>
181
+ <div class="summaryTableDescription">
182
+ List <code>INotification</code> interests.</div>
183
+ </td><td class="summaryTableOwnerCol">IMediator</td>
184
+ </tr>
185
+ <tr class="">
186
+ <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
187
+ <div class="summarySignature">
188
+ <a class="signatureLink" href="#onRegister()">onRegister</a>():void</div>
189
+ <div class="summaryTableDescription">
190
+ Called by the View when the Mediator is registered
191
+ </div>
192
+ </td><td class="summaryTableOwnerCol">IMediator</td>
193
+ </tr>
194
+ <tr class="">
195
+ <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
196
+ <div class="summarySignature">
197
+ <a class="signatureLink" href="#onRemove()">onRemove</a>():void</div>
198
+ <div class="summaryTableDescription">
199
+ Called by the View when the Mediator is removed
200
+ </div>
201
+ </td><td class="summaryTableOwnerCol">IMediator</td>
202
+ </tr>
203
+ <tr class="">
204
+ <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
205
+ <div class="summarySignature">
206
+ <a class="signatureLink" href="#setViewComponent()">setViewComponent</a>(viewComponent:Object):void</div>
207
+ <div class="summaryTableDescription">
208
+ Set the <code>IMediator</code>'s view component.</div>
209
+ </td><td class="summaryTableOwnerCol">IMediator</td>
210
+ </tr>
211
+ </table>
212
+ </div>
213
+ <script type="text/javascript" language="javascript">
214
+ <!--
215
+ showHideInherited();
216
+ --></script>
217
+ <div class="MainContent">
218
+ <a name="methodDetail"></a>
219
+ <div class="detailSectionHeader">Method detail</div>
220
+ <a name="getMediatorName()"></a>
221
+ <table cellspacing="0" cellpadding="0" class="detailHeader">
222
+ <tr>
223
+ <td class="detailHeaderName">getMediatorName</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
224
+ </tr>
225
+ </table>
226
+ <div class="detailBody">
227
+ <code>public function getMediatorName():String</code><p>
228
+ Get the <code>IMediator</code> instance name
229
+
230
+ </p><p></p>
231
+ <span class="label">Returns</span>
232
+ <table border="0" cellspacing="0" cellpadding="0">
233
+ <tr>
234
+ <td width="20"></td><td><code>String</code> &mdash; the <code>IMediator</code> instance name
235
+ </td>
236
+ </tr>
237
+ </table>
238
+ </div>
239
+ <a name="getViewComponent()"></a>
240
+ <table cellspacing="0" cellpadding="0" class="detailHeader">
241
+ <tr>
242
+ <td class="detailHeaderName">getViewComponent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
243
+ </tr>
244
+ </table>
245
+ <div class="detailBody">
246
+ <code>public function getViewComponent():Object</code><p>
247
+ Get the <code>IMediator</code>'s view component.
248
+
249
+ </p><p></p>
250
+ <span class="label">Returns</span>
251
+ <table border="0" cellspacing="0" cellpadding="0">
252
+ <tr>
253
+ <td width="20"></td><td><code>Object</code> &mdash; Object the view component
254
+ </td>
255
+ </tr>
256
+ </table>
257
+ </div>
258
+ <a name="handleNotification()"></a>
259
+ <table cellspacing="0" cellpadding="0" class="detailHeader">
260
+ <tr>
261
+ <td class="detailHeaderName">handleNotification</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
262
+ </tr>
263
+ </table>
264
+ <div class="detailBody">
265
+ <code>public function handleNotification(notification:<a href="INotification.html">INotification</a>):void</code><p>
266
+ Handle an <code>INotification</code>.
267
+
268
+ </p><span class="label">Parameters</span>
269
+ <table border="0" cellspacing="0" cellpadding="0">
270
+ <tr>
271
+ <td width="20px"></td><td><code><span class="label">notification</span>:<a href="INotification.html">INotification</a></code> &mdash; the <code>INotification</code> to be handled
272
+ </td>
273
+ </tr>
274
+ </table>
275
+ </div>
276
+ <a name="listNotificationInterests()"></a>
277
+ <table cellspacing="0" cellpadding="0" class="detailHeader">
278
+ <tr>
279
+ <td class="detailHeaderName">listNotificationInterests</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
280
+ </tr>
281
+ </table>
282
+ <div class="detailBody">
283
+ <code>public function listNotificationInterests():Array</code><p>
284
+ List <code>INotification</code> interests.
285
+
286
+ </p><p></p>
287
+ <span class="label">Returns</span>
288
+ <table border="0" cellspacing="0" cellpadding="0">
289
+ <tr>
290
+ <td width="20"></td><td><code>Array</code> &mdash; an <code>Array</code> of the <code>INotification</code> names this <code>IMediator</code> has an interest in.
291
+ </td>
292
+ </tr>
293
+ </table>
294
+ </div>
295
+ <a name="onRegister()"></a>
296
+ <table cellspacing="0" cellpadding="0" class="detailHeader">
297
+ <tr>
298
+ <td class="detailHeaderName">onRegister</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
299
+ </tr>
300
+ </table>
301
+ <div class="detailBody">
302
+ <code>public function onRegister():void</code><p>
303
+ Called by the View when the Mediator is registered
304
+ </p></div>
305
+ <a name="onRemove()"></a>
306
+ <table cellspacing="0" cellpadding="0" class="detailHeader">
307
+ <tr>
308
+ <td class="detailHeaderName">onRemove</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
309
+ </tr>
310
+ </table>
311
+ <div class="detailBody">
312
+ <code>public function onRemove():void</code><p>
313
+ Called by the View when the Mediator is removed
314
+ </p></div>
315
+ <a name="setViewComponent()"></a>
316
+ <table cellspacing="0" cellpadding="0" class="detailHeader">
317
+ <tr>
318
+ <td class="detailHeaderName">setViewComponent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
319
+ </tr>
320
+ </table>
321
+ <div class="detailBody">
322
+ <code>public function setViewComponent(viewComponent:Object):void</code><p>
323
+ Set the <code>IMediator</code>'s view component.
324
+
325
+ </p><span class="label">Parameters</span>
326
+ <table border="0" cellspacing="0" cellpadding="0">
327
+ <tr>
328
+ <td width="20px"></td><td><code><span class="label">viewComponent</span>:Object</code> &mdash; the view component
329
+ </td>
330
+ </tr>
331
+ </table>
332
+ </div>
333
+ <br>
334
+ <br>
335
+ <hr>
336
+ <br>
337
+ <p></p>
338
+ <center class="copyright">
339
+ <footer>
340
+ </footer>
341
+ </center>
342
+ </div>
343
+ </body>
344
+ </html>
345
+ <!-- -->
data/2.0.4/asdoc/org/puremvc/as3/interfaces/IModel.html ADDED
@@ -0,0 +1,226 @@
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="IModel,org.puremvc.as3.interfaces.IModel,hasProxy,registerProxy,removeProxy,retrieveProxy" name="keywords">
8
+ <title>org.puremvc.as3.interfaces.IModel</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 = 'IModel - 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&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../index-list.html')" href="../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../index.html?org/puremvc/as3/interfaces/IModel.html&amp;org/puremvc/as3/interfaces/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;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&nbsp;IModel</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a></td>
23
+ </tr>
24
+ <tr class="titleTableRow3">
25
+ <td colspan="2">&nbsp;</td>
26
+ </tr>
27
+ </table>
28
+ <script type="text/javascript" language="javascript">
29
+ <!--
30
+ if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Interface IModel"); 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 IModel</td>
39
+ </tr>
40
+ <tr>
41
+ <td class="classHeaderTableLabel">Implementors</td><td><a href="../core/Model.html">Model</a></td>
42
+ </tr>
43
+ </table>
44
+ <p></p>
45
+ The interface definition for a PureMVC Model.
46
+
47
+ <P>
48
+ In PureMVC, <code>IModel</code> implementors provide
49
+ access to <code>IProxy</code> objects by named lookup. </P>
50
+
51
+ <P>
52
+ An <code>IModel</code> assumes these responsibilities:</P>
53
+
54
+ <UL>
55
+ <LI>Maintain a cache of <code>IProxy</code> instances</LI>
56
+ <LI>Provide methods for registering, retrieving, and removing <code>IProxy</code> instances</LI>
57
+ </UL>
58
+ <p></p>
59
+ <br>
60
+ <hr>
61
+ </div>
62
+ <a name="methodSummary"></a>
63
+ <div class="summarySection">
64
+ <div class="summaryTableTitle">Public Methods</div>
65
+ <table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
66
+ <tr>
67
+ <th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
68
+ </tr>
69
+ <tr class="">
70
+ <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
71
+ <div class="summarySignature">
72
+ <a class="signatureLink" href="#hasProxy()">hasProxy</a>(proxyName:String):Boolean</div>
73
+ <div class="summaryTableDescription">
74
+ Check if a Proxy is registered
75
+
76
+ </div>
77
+ </td><td class="summaryTableOwnerCol">IModel</td>
78
+ </tr>
79
+ <tr class="">
80
+ <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
81
+ <div class="summarySignature">
82
+ <a class="signatureLink" href="#registerProxy()">registerProxy</a>(proxy:<a href="IProxy.html">IProxy</a>):void</div>
83
+ <div class="summaryTableDescription">
84
+ Register an <code>IProxy</code> instance with the <code>Model</code>.</div>
85
+ </td><td class="summaryTableOwnerCol">IModel</td>
86
+ </tr>
87
+ <tr class="">
88
+ <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
89
+ <div class="summarySignature">
90
+ <a class="signatureLink" href="#removeProxy()">removeProxy</a>(proxyName:String):<a href="../interfaces/IProxy.html">IProxy</a>
91
+ </div>
92
+ <div class="summaryTableDescription">
93
+ Remove an <code>IProxy</code> instance from the Model.</div>
94
+ </td><td class="summaryTableOwnerCol">IModel</td>
95
+ </tr>
96
+ <tr class="">
97
+ <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
98
+ <div class="summarySignature">
99
+ <a class="signatureLink" href="#retrieveProxy()">retrieveProxy</a>(proxyName:String):<a href="../interfaces/IProxy.html">IProxy</a>
100
+ </div>
101
+ <div class="summaryTableDescription">
102
+ Retrieve an <code>IProxy</code> instance from the Model.</div>
103
+ </td><td class="summaryTableOwnerCol">IModel</td>
104
+ </tr>
105
+ </table>
106
+ </div>
107
+ <script type="text/javascript" language="javascript">
108
+ <!--
109
+ showHideInherited();
110
+ --></script>
111
+ <div class="MainContent">
112
+ <a name="methodDetail"></a>
113
+ <div class="detailSectionHeader">Method detail</div>
114
+ <a name="hasProxy()"></a>
115
+ <table cellspacing="0" cellpadding="0" class="detailHeader">
116
+ <tr>
117
+ <td class="detailHeaderName">hasProxy</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
118
+ </tr>
119
+ </table>
120
+ <div class="detailBody">
121
+ <code>public function hasProxy(proxyName:String):Boolean</code><p>
122
+ Check if a Proxy is registered
123
+
124
+ </p><span class="label">Parameters</span>
125
+ <table border="0" cellspacing="0" cellpadding="0">
126
+ <tr>
127
+ <td width="20px"></td><td><code><span class="label">proxyName</span>:String</code></td>
128
+ </tr>
129
+ </table>
130
+ <p></p>
131
+ <span class="label">Returns</span>
132
+ <table border="0" cellspacing="0" cellpadding="0">
133
+ <tr>
134
+ <td width="20"></td><td><code>Boolean</code> &mdash; whether a Proxy is currently registered with the given <code>proxyName</code>.
135
+ </td>
136
+ </tr>
137
+ </table>
138
+ </div>
139
+ <a name="registerProxy()"></a>
140
+ <table cellspacing="0" cellpadding="0" class="detailHeader">
141
+ <tr>
142
+ <td class="detailHeaderName">registerProxy</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
143
+ </tr>
144
+ </table>
145
+ <div class="detailBody">
146
+ <code>public function registerProxy(proxy:<a href="IProxy.html">IProxy</a>):void</code><p>
147
+ Register an <code>IProxy</code> instance with the <code>Model</code>.
148
+
149
+ </p><span class="label">Parameters</span>
150
+ <table border="0" cellspacing="0" cellpadding="0">
151
+ <tr>
152
+ <td width="20px"></td><td><code><span class="label">proxy</span>:<a href="IProxy.html">IProxy</a></code> &mdash; the name to associate with this <code>IProxy</code> instance.
153
+ </td>
154
+ </tr>
155
+ </table>
156
+ </div>
157
+ <a name="removeProxy()"></a>
158
+ <table cellspacing="0" cellpadding="0" class="detailHeader">
159
+ <tr>
160
+ <td class="detailHeaderName">removeProxy</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
161
+ </tr>
162
+ </table>
163
+ <div class="detailBody">
164
+ <code>public function removeProxy(proxyName:String):<a href="../interfaces/IProxy.html">IProxy</a></code><p>
165
+ Remove an <code>IProxy</code> instance from the Model.
166
+
167
+ </p><span class="label">Parameters</span>
168
+ <table border="0" cellspacing="0" cellpadding="0">
169
+ <tr>
170
+ <td width="20px"></td><td><code><span class="label">proxyName</span>:String</code> &mdash; name of the <code>IProxy</code> instance to be removed.
171
+ </td>
172
+ </tr>
173
+ </table>
174
+ <p></p>
175
+ <span class="label">Returns</span>
176
+ <table border="0" cellspacing="0" cellpadding="0">
177
+ <tr>
178
+ <td width="20"></td><td><code><a href="../interfaces/IProxy.html">IProxy</a></code> &mdash;
179
+ the <code>IProxy</code> that was removed from the <code>Model</code>
180
+
181
+
182
+ </td>
183
+ </tr>
184
+ </table>
185
+ </div>
186
+ <a name="retrieveProxy()"></a>
187
+ <table cellspacing="0" cellpadding="0" class="detailHeader">
188
+ <tr>
189
+ <td class="detailHeaderName">retrieveProxy</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
190
+ </tr>
191
+ </table>
192
+ <div class="detailBody">
193
+ <code>public function retrieveProxy(proxyName:String):<a href="../interfaces/IProxy.html">IProxy</a></code><p>
194
+ Retrieve an <code>IProxy</code> instance from the Model.
195
+
196
+ </p><span class="label">Parameters</span>
197
+ <table border="0" cellspacing="0" cellpadding="0">
198
+ <tr>
199
+ <td width="20px"></td><td><code><span class="label">proxyName</span>:String</code></td>
200
+ </tr>
201
+ </table>
202
+ <p></p>
203
+ <span class="label">Returns</span>
204
+ <table border="0" cellspacing="0" cellpadding="0">
205
+ <tr>
206
+ <td width="20"></td><td><code><a href="../interfaces/IProxy.html">IProxy</a></code> &mdash;
207
+ the <code>IProxy</code> instance previously registered with the given <code>proxyName</code>.
208
+
209
+
210
+ </td>
211
+ </tr>
212
+ </table>
213
+ </div>
214
+ <br>
215
+ <br>
216
+ <hr>
217
+ <br>
218
+ <p></p>
219
+ <center class="copyright">
220
+ <footer>
221
+ </footer>
222
+ </center>
223
+ </div>
224
+ </body>
225
+ </html>
226
+ <!-- -->