puremvc-as3 2.0.4

Sign up to get free protection for your applications and to get access to all the features.
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/INotification.html ADDED
@@ -0,0 +1,269 @@
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="INotification,org.puremvc.as3.interfaces.INotification,getBody,getName,getType,setBody,setType,toString" name="keywords">
8
+ <title>org.puremvc.as3.interfaces.INotification</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 = 'INotification - 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/INotification.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;INotification</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 INotification"); 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 INotification</td>
39
+ </tr>
40
+ <tr>
41
+ <td class="classHeaderTableLabel">Implementors</td><td><a href="../patterns/observer/Notification.html">Notification</a></td>
42
+ </tr>
43
+ </table>
44
+ <p></p>
45
+ The interface definition for a PureMVC Notification.
46
+ <P>
47
+ PureMVC does not rely upon underlying event models such
48
+ as the one provided with Flash, and ActionScript 3 does
49
+ not have an inherent event model.</P>
50
+
51
+ <P>
52
+ The Observer Pattern as implemented within PureMVC exists
53
+ to support event-driven communication between the
54
+ application and the actors of the MVC triad.</P>
55
+
56
+ <P>
57
+ Notifications are not meant to be a replacement for Events
58
+ in Flex/Flash/AIR. Generally, <code>IMediator</code> implementors
59
+ place event listeners on their view components, which they
60
+ then handle in the usual way. This may lead to the broadcast of <code>Notification</code>s to
61
+ trigger <code>ICommand</code>s or to communicate with other <code>IMediators</code>. <code>IProxy</code> and <code>ICommand</code>
62
+ instances communicate with each other and <code>IMediator</code>s
63
+ by broadcasting <code>INotification</code>s.</P>
64
+
65
+ <P>
66
+ A key difference between Flash <code>Event</code>s and PureMVC
67
+ <code>Notification</code>s is that <code>Event</code>s follow the
68
+ 'Chain of Responsibility' pattern, 'bubbling' up the display hierarchy
69
+ until some parent component handles the <code>Event</code>, while
70
+ PureMVC <code>Notification</code>s follow a 'Publish/Subscribe'
71
+ pattern. PureMVC classes need not be related to each other in a
72
+ parent/child relationship in order to communicate with one another
73
+ using <code>Notification</code>s.
74
+
75
+ <p></p>
76
+ <p>
77
+ <span class="classHeaderTableLabel">See also</span>
78
+ </p>
79
+ <div class="seeAlso">
80
+ <a href="../interfaces/IView.html" target="">IView</a>
81
+ <br>
82
+ <a href="../interfaces/IObserver.html" target="">IObserver</a>
83
+ </div>
84
+ <br>
85
+ <hr>
86
+ </div>
87
+ <a name="methodSummary"></a>
88
+ <div class="summarySection">
89
+ <div class="summaryTableTitle">Public Methods</div>
90
+ <table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
91
+ <tr>
92
+ <th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
93
+ </tr>
94
+ <tr class="">
95
+ <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
96
+ <div class="summarySignature">
97
+ <a class="signatureLink" href="#getBody()">getBody</a>():Object</div>
98
+ <div class="summaryTableDescription">
99
+ Get the body of the <code>INotification</code> instance
100
+ </div>
101
+ </td><td class="summaryTableOwnerCol">INotification</td>
102
+ </tr>
103
+ <tr class="">
104
+ <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
105
+ <div class="summarySignature">
106
+ <a class="signatureLink" href="#getName()">getName</a>():String</div>
107
+ <div class="summaryTableDescription">
108
+ Get the name of the <code>INotification</code> instance.</div>
109
+ </td><td class="summaryTableOwnerCol">INotification</td>
110
+ </tr>
111
+ <tr class="">
112
+ <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
113
+ <div class="summarySignature">
114
+ <a class="signatureLink" href="#getType()">getType</a>():String</div>
115
+ <div class="summaryTableDescription">
116
+ Get the type of the <code>INotification</code> instance
117
+ </div>
118
+ </td><td class="summaryTableOwnerCol">INotification</td>
119
+ </tr>
120
+ <tr class="">
121
+ <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
122
+ <div class="summarySignature">
123
+ <a class="signatureLink" href="#setBody()">setBody</a>(body:Object):void</div>
124
+ <div class="summaryTableDescription">
125
+ Set the body of the <code>INotification</code> instance
126
+ </div>
127
+ </td><td class="summaryTableOwnerCol">INotification</td>
128
+ </tr>
129
+ <tr class="">
130
+ <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
131
+ <div class="summarySignature">
132
+ <a class="signatureLink" href="#setType()">setType</a>(type:String):void</div>
133
+ <div class="summaryTableDescription">
134
+ Set the type of the <code>INotification</code> instance
135
+ </div>
136
+ </td><td class="summaryTableOwnerCol">INotification</td>
137
+ </tr>
138
+ <tr class="">
139
+ <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
140
+ <div class="summarySignature">
141
+ <a class="signatureLink" href="#toString()">toString</a>():String</div>
142
+ <div class="summaryTableDescription">
143
+ Get the string representation of the <code>INotification</code> instance
144
+ </div>
145
+ </td><td class="summaryTableOwnerCol">INotification</td>
146
+ </tr>
147
+ </table>
148
+ </div>
149
+ <script type="text/javascript" language="javascript">
150
+ <!--
151
+ showHideInherited();
152
+ --></script>
153
+ <div class="MainContent">
154
+ <a name="methodDetail"></a>
155
+ <div class="detailSectionHeader">Method detail</div>
156
+ <a name="getBody()"></a>
157
+ <table cellspacing="0" cellpadding="0" class="detailHeader">
158
+ <tr>
159
+ <td class="detailHeaderName">getBody</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
160
+ </tr>
161
+ </table>
162
+ <div class="detailBody">
163
+ <code>public function getBody():Object</code><p>
164
+ Get the body of the <code>INotification</code> instance
165
+ </p><p></p>
166
+ <span class="label">Returns</span>
167
+ <table border="0" cellspacing="0" cellpadding="0">
168
+ <tr>
169
+ <td width="20"></td><td><code>Object</code></td>
170
+ </tr>
171
+ </table>
172
+ </div>
173
+ <a name="getName()"></a>
174
+ <table cellspacing="0" cellpadding="0" class="detailHeader">
175
+ <tr>
176
+ <td class="detailHeaderName">getName</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
177
+ </tr>
178
+ </table>
179
+ <div class="detailBody">
180
+ <code>public function getName():String</code><p>
181
+ Get the name of the <code>INotification</code> instance.
182
+ No setter, should be set by constructor only
183
+ </p><p></p>
184
+ <span class="label">Returns</span>
185
+ <table border="0" cellspacing="0" cellpadding="0">
186
+ <tr>
187
+ <td width="20"></td><td><code>String</code></td>
188
+ </tr>
189
+ </table>
190
+ </div>
191
+ <a name="getType()"></a>
192
+ <table cellspacing="0" cellpadding="0" class="detailHeader">
193
+ <tr>
194
+ <td class="detailHeaderName">getType</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
195
+ </tr>
196
+ </table>
197
+ <div class="detailBody">
198
+ <code>public function getType():String</code><p>
199
+ Get the type of the <code>INotification</code> instance
200
+ </p><p></p>
201
+ <span class="label">Returns</span>
202
+ <table border="0" cellspacing="0" cellpadding="0">
203
+ <tr>
204
+ <td width="20"></td><td><code>String</code></td>
205
+ </tr>
206
+ </table>
207
+ </div>
208
+ <a name="setBody()"></a>
209
+ <table cellspacing="0" cellpadding="0" class="detailHeader">
210
+ <tr>
211
+ <td class="detailHeaderName">setBody</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
212
+ </tr>
213
+ </table>
214
+ <div class="detailBody">
215
+ <code>public function setBody(body:Object):void</code><p>
216
+ Set the body of the <code>INotification</code> instance
217
+ </p><span class="label">Parameters</span>
218
+ <table border="0" cellspacing="0" cellpadding="0">
219
+ <tr>
220
+ <td width="20px"></td><td><code><span class="label">body</span>:Object</code></td>
221
+ </tr>
222
+ </table>
223
+ </div>
224
+ <a name="setType()"></a>
225
+ <table cellspacing="0" cellpadding="0" class="detailHeader">
226
+ <tr>
227
+ <td class="detailHeaderName">setType</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
228
+ </tr>
229
+ </table>
230
+ <div class="detailBody">
231
+ <code>public function setType(type:String):void</code><p>
232
+ Set the type of the <code>INotification</code> instance
233
+ </p><span class="label">Parameters</span>
234
+ <table border="0" cellspacing="0" cellpadding="0">
235
+ <tr>
236
+ <td width="20px"></td><td><code><span class="label">type</span>:String</code></td>
237
+ </tr>
238
+ </table>
239
+ </div>
240
+ <a name="toString()"></a>
241
+ <table cellspacing="0" cellpadding="0" class="detailHeader">
242
+ <tr>
243
+ <td class="detailHeaderName">toString</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
244
+ </tr>
245
+ </table>
246
+ <div class="detailBody">
247
+ <code>public function toString():String</code><p>
248
+ Get the string representation of the <code>INotification</code> instance
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>String</code></td>
254
+ </tr>
255
+ </table>
256
+ </div>
257
+ <br>
258
+ <br>
259
+ <hr>
260
+ <br>
261
+ <p></p>
262
+ <center class="copyright">
263
+ <footer>
264
+ </footer>
265
+ </center>
266
+ </div>
267
+ </body>
268
+ </html>
269
+ <!-- -->
data/2.0.4/asdoc/org/puremvc/as3/interfaces/INotifier.html ADDED
@@ -0,0 +1,151 @@
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="INotifier,org.puremvc.as3.interfaces.INotifier,sendNotification" name="keywords">
8
+ <title>org.puremvc.as3.interfaces.INotifier</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 = 'INotifier - 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/INotifier.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;INotifier</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 INotifier"); 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 INotifier</td>
39
+ </tr>
40
+ <tr>
41
+ <td class="classHeaderTableLabel">Subinterfaces</td><td><a href="../interfaces/IFacade.html">IFacade</a></td>
42
+ </tr>
43
+ <tr>
44
+ <td class="classHeaderTableLabel">Implementors</td><td><a href="../patterns/command/MacroCommand.html">MacroCommand</a>, <a href="../patterns/mediator/Mediator.html">Mediator</a>, <a href="../patterns/observer/Notifier.html">Notifier</a>, <a href="../patterns/proxy/Proxy.html">Proxy</a>, <a href="../patterns/command/SimpleCommand.html">SimpleCommand</a></td>
45
+ </tr>
46
+ </table>
47
+ <p></p>
48
+ The interface definition for a PureMVC Notifier.
49
+
50
+ <P>
51
+ <code>MacroCommand, Command, Mediator</code> and <code>Proxy</code>
52
+ all have a need to send <code>Notifications</code>. </P>
53
+
54
+ <P>
55
+ The <code>INotifier</code> interface provides a common method called
56
+ <code>sendNotification</code> that relieves implementation code of
57
+ the necessity to actually construct <code>Notifications</code>.</P>
58
+
59
+ <P>
60
+ The <code>Notifier</code> class, which all of the above mentioned classes
61
+ extend, also provides an initialized reference to the <code>Facade</code>
62
+ Singleton, which is required for the convienience method
63
+ for sending <code>Notifications</code>, but also eases implementation as these
64
+ classes have frequent <code>Facade</code> interactions and usually require
65
+ access to the facade anyway.</P>
66
+
67
+ <p></p>
68
+ <p>
69
+ <span class="classHeaderTableLabel">See also</span>
70
+ </p>
71
+ <div class="seeAlso">
72
+ <a href="../interfaces/IFacade.html" target="">IFacade</a>
73
+ <br>
74
+ <a href="../interfaces/INotification.html" target="">INotification</a>
75
+ </div>
76
+ <br>
77
+ <hr>
78
+ </div>
79
+ <a name="methodSummary"></a>
80
+ <div class="summarySection">
81
+ <div class="summaryTableTitle">Public Methods</div>
82
+ <table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
83
+ <tr>
84
+ <th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
85
+ </tr>
86
+ <tr class="">
87
+ <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
88
+ <div class="summarySignature">
89
+ <a class="signatureLink" href="#sendNotification()">sendNotification</a>(notificationName:String, body:Object = null, type:String = null):void</div>
90
+ <div class="summaryTableDescription">
91
+ Send a <code>INotification</code>.</div>
92
+ </td><td class="summaryTableOwnerCol">INotifier</td>
93
+ </tr>
94
+ </table>
95
+ </div>
96
+ <script type="text/javascript" language="javascript">
97
+ <!--
98
+ showHideInherited();
99
+ --></script>
100
+ <div class="MainContent">
101
+ <a name="methodDetail"></a>
102
+ <div class="detailSectionHeader">Method detail</div>
103
+ <a name="sendNotification()"></a>
104
+ <table cellspacing="0" cellpadding="0" class="detailHeader">
105
+ <tr>
106
+ <td class="detailHeaderName">sendNotification</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
107
+ </tr>
108
+ </table>
109
+ <div class="detailBody">
110
+ <code>public function sendNotification(notificationName:String, body:Object = null, type:String = null):void</code><p>
111
+ Send a <code>INotification</code>.
112
+
113
+ <P>
114
+ Convenience method to prevent having to construct new
115
+ notification instances in our implementation code.</P>
116
+
117
+ </p><span class="label">Parameters</span>
118
+ <table border="0" cellspacing="0" cellpadding="0">
119
+ <tr>
120
+ <td width="20px"></td><td><code><span class="label">notificationName</span>:String</code> &mdash; the name of the notification to send
121
+ </td>
122
+ </tr>
123
+ <tr>
124
+ <td class="paramSpacer">&nbsp;</td>
125
+ </tr>
126
+ <tr>
127
+ <td width="20px"></td><td><code><span class="label">body</span>:Object</code> (default = <code>null</code>)<code></code> &mdash; the body of the notification (optional)
128
+ </td>
129
+ </tr>
130
+ <tr>
131
+ <td class="paramSpacer">&nbsp;</td>
132
+ </tr>
133
+ <tr>
134
+ <td width="20px"></td><td><code><span class="label">type</span>:String</code> (default = <code>null</code>)<code></code> &mdash; the type of the notification (optional)
135
+ </td>
136
+ </tr>
137
+ </table>
138
+ </div>
139
+ <br>
140
+ <br>
141
+ <hr>
142
+ <br>
143
+ <p></p>
144
+ <center class="copyright">
145
+ <footer>
146
+ </footer>
147
+ </center>
148
+ </div>
149
+ </body>
150
+ </html>
151
+ <!-- -->
data/2.0.4/asdoc/org/puremvc/as3/interfaces/IObserver.html ADDED
@@ -0,0 +1,234 @@
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="IObserver,org.puremvc.as3.interfaces.IObserver,compareNotifyContext,notifyObserver,setNotifyContext,setNotifyMethod" name="keywords">
8
+ <title>org.puremvc.as3.interfaces.IObserver</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 = 'IObserver - 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/IObserver.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;IObserver</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 IObserver"); 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 IObserver</td>
39
+ </tr>
40
+ <tr>
41
+ <td class="classHeaderTableLabel">Implementors</td><td><a href="../patterns/observer/Observer.html">Observer</a></td>
42
+ </tr>
43
+ </table>
44
+ <p></p>
45
+ The interface definition for a PureMVC Observer.
46
+ <P>
47
+ In PureMVC, <code>IObserver</code> implementors assume these responsibilities:
48
+ <UL>
49
+ <LI>Encapsulate the notification (callback) method of the interested object.</LI>
50
+ <LI>Encapsulate the notification context (this) of the interested object.</LI>
51
+ <LI>Provide methods for setting the interested object' notification method and context.</LI>
52
+ <LI>Provide a method for notifying the interested object.</LI>
53
+ </UL>
54
+
55
+ <P>
56
+ PureMVC does not rely upon underlying event
57
+ models such as the one provided with Flash,
58
+ and ActionScript 3 does not have an inherent
59
+ event model.</P>
60
+
61
+ <P>
62
+ The Observer Pattern as implemented within
63
+ PureMVC exists to support event driven communication
64
+ between the application and the actors of the
65
+ MVC triad.</P>
66
+
67
+ <P>
68
+ An Observer is an object that encapsulates information
69
+ about an interested object with a notification method that
70
+ should be called when an </code>INotification</code> is broadcast. The Observer then
71
+ acts as a proxy for notifying the interested object.
72
+
73
+ <P>
74
+ Observers can receive <code>Notification</code>s by having their
75
+ <code>notifyObserver</code> method invoked, passing
76
+ in an object implementing the <code>INotification</code> interface, such
77
+ as a subclass of <code>Notification</code>.</P>
78
+
79
+ <p></p>
80
+ <p>
81
+ <span class="classHeaderTableLabel">See also</span>
82
+ </p>
83
+ <div class="seeAlso">
84
+ <a href="../interfaces/IView.html" target="">IView</a>
85
+ <br>
86
+ <a href="../interfaces/INotification.html" target="">INotification</a>
87
+ </div>
88
+ <br>
89
+ <hr>
90
+ </div>
91
+ <a name="methodSummary"></a>
92
+ <div class="summarySection">
93
+ <div class="summaryTableTitle">Public Methods</div>
94
+ <table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
95
+ <tr>
96
+ <th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
97
+ </tr>
98
+ <tr class="">
99
+ <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
100
+ <div class="summarySignature">
101
+ <a class="signatureLink" href="#compareNotifyContext()">compareNotifyContext</a>(object:Object):Boolean</div>
102
+ <div class="summaryTableDescription">
103
+ Compare the given object to the notificaiton context object.</div>
104
+ </td><td class="summaryTableOwnerCol">IObserver</td>
105
+ </tr>
106
+ <tr class="">
107
+ <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
108
+ <div class="summarySignature">
109
+ <a class="signatureLink" href="#notifyObserver()">notifyObserver</a>(notification:<a href="INotification.html">INotification</a>):void</div>
110
+ <div class="summaryTableDescription">
111
+ Notify the interested object.</div>
112
+ </td><td class="summaryTableOwnerCol">IObserver</td>
113
+ </tr>
114
+ <tr class="">
115
+ <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
116
+ <div class="summarySignature">
117
+ <a class="signatureLink" href="#setNotifyContext()">setNotifyContext</a>(notifyContext:Object):void</div>
118
+ <div class="summaryTableDescription">
119
+ Set the notification context.</div>
120
+ </td><td class="summaryTableOwnerCol">IObserver</td>
121
+ </tr>
122
+ <tr class="">
123
+ <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
124
+ <div class="summarySignature">
125
+ <a class="signatureLink" href="#setNotifyMethod()">setNotifyMethod</a>(notifyMethod:Function):void</div>
126
+ <div class="summaryTableDescription">
127
+ Set the notification method.</div>
128
+ </td><td class="summaryTableOwnerCol">IObserver</td>
129
+ </tr>
130
+ </table>
131
+ </div>
132
+ <script type="text/javascript" language="javascript">
133
+ <!--
134
+ showHideInherited();
135
+ --></script>
136
+ <div class="MainContent">
137
+ <a name="methodDetail"></a>
138
+ <div class="detailSectionHeader">Method detail</div>
139
+ <a name="compareNotifyContext()"></a>
140
+ <table cellspacing="0" cellpadding="0" class="detailHeader">
141
+ <tr>
142
+ <td class="detailHeaderName">compareNotifyContext</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
143
+ </tr>
144
+ </table>
145
+ <div class="detailBody">
146
+ <code>public function compareNotifyContext(object:Object):Boolean</code><p>
147
+ Compare the given object to the notificaiton context object.
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">object</span>:Object</code> &mdash; the object to compare.
153
+ </td>
154
+ </tr>
155
+ </table>
156
+ <p></p>
157
+ <span class="label">Returns</span>
158
+ <table border="0" cellspacing="0" cellpadding="0">
159
+ <tr>
160
+ <td width="20"></td><td><code>Boolean</code> &mdash; boolean indicating if the notification context and the object are the same.
161
+ </td>
162
+ </tr>
163
+ </table>
164
+ </div>
165
+ <a name="notifyObserver()"></a>
166
+ <table cellspacing="0" cellpadding="0" class="detailHeader">
167
+ <tr>
168
+ <td class="detailHeaderName">notifyObserver</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
169
+ </tr>
170
+ </table>
171
+ <div class="detailBody">
172
+ <code>public function notifyObserver(notification:<a href="INotification.html">INotification</a>):void</code><p>
173
+ Notify the interested object.
174
+
175
+ </p><span class="label">Parameters</span>
176
+ <table border="0" cellspacing="0" cellpadding="0">
177
+ <tr>
178
+ <td width="20px"></td><td><code><span class="label">notification</span>:<a href="INotification.html">INotification</a></code> &mdash; the <code>INotification</code> to pass to the interested object's notification method
179
+ </td>
180
+ </tr>
181
+ </table>
182
+ </div>
183
+ <a name="setNotifyContext()"></a>
184
+ <table cellspacing="0" cellpadding="0" class="detailHeader">
185
+ <tr>
186
+ <td class="detailHeaderName">setNotifyContext</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
187
+ </tr>
188
+ </table>
189
+ <div class="detailBody">
190
+ <code>public function setNotifyContext(notifyContext:Object):void</code><p>
191
+ Set the notification context.
192
+
193
+ </p><span class="label">Parameters</span>
194
+ <table border="0" cellspacing="0" cellpadding="0">
195
+ <tr>
196
+ <td width="20px"></td><td><code><span class="label">notifyContext</span>:Object</code> &mdash; the notification context (this) of the interested object
197
+ </td>
198
+ </tr>
199
+ </table>
200
+ </div>
201
+ <a name="setNotifyMethod()"></a>
202
+ <table cellspacing="0" cellpadding="0" class="detailHeader">
203
+ <tr>
204
+ <td class="detailHeaderName">setNotifyMethod</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
205
+ </tr>
206
+ </table>
207
+ <div class="detailBody">
208
+ <code>public function setNotifyMethod(notifyMethod:Function):void</code><p>
209
+ Set the notification method.
210
+
211
+ <P>
212
+ The notification method should take one parameter of type <code>INotification</code></P>
213
+
214
+ </p><span class="label">Parameters</span>
215
+ <table border="0" cellspacing="0" cellpadding="0">
216
+ <tr>
217
+ <td width="20px"></td><td><code><span class="label">notifyMethod</span>:Function</code> &mdash; the notification (callback) method of the interested object
218
+ </td>
219
+ </tr>
220
+ </table>
221
+ </div>
222
+ <br>
223
+ <br>
224
+ <hr>
225
+ <br>
226
+ <p></p>
227
+ <center class="copyright">
228
+ <footer>
229
+ </footer>
230
+ </center>
231
+ </div>
232
+ </body>
233
+ </html>
234
+ <!-- -->