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,405 @@
|
|
|
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="Model,org.puremvc.as3.core.Model,SINGLETON_MSG,instance,proxyMap,getInstance,hasProxy,initializeModel,registerProxy,removeProxy,retrieveProxy" name="keywords">
|
|
8
|
+
<title>org.puremvc.as3.core.Model</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 = 'Model - 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/core/Model.html&org/puremvc/as3/core/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">Class Model</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a> | <a href="#constantSummary">Constants</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("Class Model"); titleBar_setSubNav(true,true,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.core</a></td>
|
|
36
|
+
</tr>
|
|
37
|
+
<tr>
|
|
38
|
+
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class Model</td>
|
|
39
|
+
</tr>
|
|
40
|
+
<tr>
|
|
41
|
+
<td class="classHeaderTableLabel">Implements</td><td><a href="../interfaces/IModel.html">IModel</a></td>
|
|
42
|
+
</tr>
|
|
43
|
+
</table>
|
|
44
|
+
<p></p>
|
|
45
|
+
A Singleton <code>IModel</code> implementation.
|
|
46
|
+
|
|
47
|
+
<P>
|
|
48
|
+
In PureMVC, the <code>Model</code> class provides
|
|
49
|
+
access to model objects (Proxies) by named lookup.
|
|
50
|
+
|
|
51
|
+
<P>
|
|
52
|
+
The <code>Model</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
|
|
57
|
+
<code>IProxy</code> instances.</LI>
|
|
58
|
+
</UL>
|
|
59
|
+
|
|
60
|
+
<P>
|
|
61
|
+
Your application must register <code>IProxy</code> instances
|
|
62
|
+
with the <code>Model</code>. Typically, you use an
|
|
63
|
+
<code>ICommand</code> to create and register <code>IProxy</code>
|
|
64
|
+
instances once the <code>Facade</code> has initialized the Core
|
|
65
|
+
actors.</p>
|
|
66
|
+
<p></p>
|
|
67
|
+
<p>
|
|
68
|
+
<span class="classHeaderTableLabel">See also</span>
|
|
69
|
+
</p>
|
|
70
|
+
<div class="seeAlso">
|
|
71
|
+
<a href="../patterns/proxy/Proxy.html" target="">Proxy</a>
|
|
72
|
+
<br>
|
|
73
|
+
<a href="../interfaces/IProxy.html" target="">IProxy</a>
|
|
74
|
+
</div>
|
|
75
|
+
<br>
|
|
76
|
+
<hr>
|
|
77
|
+
</div>
|
|
78
|
+
<a name="propertySummary"></a><a name="protectedPropertySummary"></a>
|
|
79
|
+
<div class="summarySection">
|
|
80
|
+
<div class="summaryTableTitle">Protected Properties</div>
|
|
81
|
+
<table id="summaryTableProtectedProperty" class="summaryTable " cellpadding="3" cellspacing="0">
|
|
82
|
+
<tr>
|
|
83
|
+
<th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined by</th>
|
|
84
|
+
</tr>
|
|
85
|
+
<tr class="">
|
|
86
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#instance">instance</a> : <a href="../interfaces/IModel.html">IModel</a>
|
|
87
|
+
<div class="summaryTableDescription">[static]</div>
|
|
88
|
+
</td><td class="summaryTableOwnerCol">Model</td>
|
|
89
|
+
</tr>
|
|
90
|
+
<tr class="">
|
|
91
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#proxyMap">proxyMap</a> : Array<div class="summaryTableDescription"></div>
|
|
92
|
+
</td><td class="summaryTableOwnerCol">Model</td>
|
|
93
|
+
</tr>
|
|
94
|
+
</table>
|
|
95
|
+
</div>
|
|
96
|
+
<a name="methodSummary"></a>
|
|
97
|
+
<div class="summarySection">
|
|
98
|
+
<div class="summaryTableTitle">Public Methods</div>
|
|
99
|
+
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
|
|
100
|
+
<tr>
|
|
101
|
+
<th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined by</th>
|
|
102
|
+
</tr>
|
|
103
|
+
<tr class="">
|
|
104
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
105
|
+
<div class="summarySignature">
|
|
106
|
+
<a class="signatureLink" href="#Model()">Model</a>()</div>
|
|
107
|
+
<div class="summaryTableDescription">
|
|
108
|
+
Constructor.</div>
|
|
109
|
+
</td><td class="summaryTableOwnerCol">Model</td>
|
|
110
|
+
</tr>
|
|
111
|
+
<tr class="">
|
|
112
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
113
|
+
<div class="summarySignature">
|
|
114
|
+
<a class="signatureLink" href="#getInstance()">getInstance</a>():<a href="../interfaces/IModel.html">IModel</a>
|
|
115
|
+
</div>
|
|
116
|
+
<div class="summaryTableDescription">[static]
|
|
117
|
+
<code>Model</code> Singleton Factory method.</div>
|
|
118
|
+
</td><td class="summaryTableOwnerCol">Model</td>
|
|
119
|
+
</tr>
|
|
120
|
+
<tr class="">
|
|
121
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
122
|
+
<div class="summarySignature">
|
|
123
|
+
<a class="signatureLink" href="#hasProxy()">hasProxy</a>(proxyName:String):Boolean</div>
|
|
124
|
+
<div class="summaryTableDescription">
|
|
125
|
+
Check if a Proxy is registered
|
|
126
|
+
|
|
127
|
+
</div>
|
|
128
|
+
</td><td class="summaryTableOwnerCol">Model</td>
|
|
129
|
+
</tr>
|
|
130
|
+
<tr class="">
|
|
131
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
132
|
+
<div class="summarySignature">
|
|
133
|
+
<a class="signatureLink" href="#registerProxy()">registerProxy</a>(proxy:<a href="../interfaces/IProxy.html">IProxy</a>):void</div>
|
|
134
|
+
<div class="summaryTableDescription">
|
|
135
|
+
Register an <code>IProxy</code> with the <code>Model</code>.</div>
|
|
136
|
+
</td><td class="summaryTableOwnerCol">Model</td>
|
|
137
|
+
</tr>
|
|
138
|
+
<tr class="">
|
|
139
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
140
|
+
<div class="summarySignature">
|
|
141
|
+
<a class="signatureLink" href="#removeProxy()">removeProxy</a>(proxyName:String):<a href="../interfaces/IProxy.html">IProxy</a>
|
|
142
|
+
</div>
|
|
143
|
+
<div class="summaryTableDescription">
|
|
144
|
+
Remove an <code>IProxy</code> from the <code>Model</code>.</div>
|
|
145
|
+
</td><td class="summaryTableOwnerCol">Model</td>
|
|
146
|
+
</tr>
|
|
147
|
+
<tr class="">
|
|
148
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
149
|
+
<div class="summarySignature">
|
|
150
|
+
<a class="signatureLink" href="#retrieveProxy()">retrieveProxy</a>(proxyName:String):<a href="../interfaces/IProxy.html">IProxy</a>
|
|
151
|
+
</div>
|
|
152
|
+
<div class="summaryTableDescription">
|
|
153
|
+
Retrieve an <code>IProxy</code> from the <code>Model</code>.</div>
|
|
154
|
+
</td><td class="summaryTableOwnerCol">Model</td>
|
|
155
|
+
</tr>
|
|
156
|
+
</table>
|
|
157
|
+
</div>
|
|
158
|
+
<a name="protectedMethodSummary"></a>
|
|
159
|
+
<div class="summarySection">
|
|
160
|
+
<div class="summaryTableTitle">Protected Methods</div>
|
|
161
|
+
<table id="summaryTableProtectedMethod" class="summaryTable " cellpadding="3" cellspacing="0">
|
|
162
|
+
<tr>
|
|
163
|
+
<th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined by</th>
|
|
164
|
+
</tr>
|
|
165
|
+
<tr class="">
|
|
166
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
167
|
+
<div class="summarySignature">
|
|
168
|
+
<a class="signatureLink" href="#initializeModel()">initializeModel</a>():void</div>
|
|
169
|
+
<div class="summaryTableDescription">
|
|
170
|
+
Initialize the Singleton <code>Model</code> instance.</div>
|
|
171
|
+
</td><td class="summaryTableOwnerCol">Model</td>
|
|
172
|
+
</tr>
|
|
173
|
+
</table>
|
|
174
|
+
</div>
|
|
175
|
+
<a name="constantSummary"></a><a name="protectedConstantSummary"></a>
|
|
176
|
+
<div class="summarySection">
|
|
177
|
+
<div class="summaryTableTitle">Protected Constants</div>
|
|
178
|
+
<table id="summaryTableProtectedConstant" class="summaryTable " cellpadding="3" cellspacing="0">
|
|
179
|
+
<tr>
|
|
180
|
+
<th> </th><th colspan="2">Constant</th><th class="summaryTableOwnerCol">Defined by</th>
|
|
181
|
+
</tr>
|
|
182
|
+
<tr class="">
|
|
183
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#SINGLETON_MSG">SINGLETON_MSG</a> : String = "Model Singleton already constructed!"<div class="summaryTableDescription"></div>
|
|
184
|
+
</td><td class="summaryTableOwnerCol">Model</td>
|
|
185
|
+
</tr>
|
|
186
|
+
</table>
|
|
187
|
+
</div>
|
|
188
|
+
<script type="text/javascript" language="javascript">
|
|
189
|
+
<!--
|
|
190
|
+
showHideInherited();
|
|
191
|
+
--></script>
|
|
192
|
+
<div class="MainContent">
|
|
193
|
+
<a name="propertyDetail"></a>
|
|
194
|
+
<div class="detailSectionHeader">Property detail</div>
|
|
195
|
+
<a name="instance"></a>
|
|
196
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
197
|
+
<tr>
|
|
198
|
+
<td class="detailHeaderName">instance</td><td class="detailHeaderType">property</td>
|
|
199
|
+
</tr>
|
|
200
|
+
</table>
|
|
201
|
+
<div class="detailBody">
|
|
202
|
+
<code>protected static var instance:<a href="../interfaces/IModel.html">IModel</a></code>
|
|
203
|
+
</div>
|
|
204
|
+
<a name="proxyMap"></a>
|
|
205
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
206
|
+
<tr>
|
|
207
|
+
<td class="detailHeaderName">proxyMap</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
|
|
208
|
+
</tr>
|
|
209
|
+
</table>
|
|
210
|
+
<div class="detailBody">
|
|
211
|
+
<code>protected var proxyMap:Array</code>
|
|
212
|
+
</div>
|
|
213
|
+
<a name="constructorDetail"></a>
|
|
214
|
+
<div class="detailSectionHeader">Constructor detail</div>
|
|
215
|
+
<a name="Model()"></a>
|
|
216
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
217
|
+
<tr>
|
|
218
|
+
<td class="detailHeaderName">Model</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
|
|
219
|
+
</tr>
|
|
220
|
+
</table>
|
|
221
|
+
<div class="detailBody">
|
|
222
|
+
<code>public function Model()</code><p>
|
|
223
|
+
Constructor.
|
|
224
|
+
|
|
225
|
+
<P>
|
|
226
|
+
This <code>IModel</code> implementation is a Singleton,
|
|
227
|
+
so you should not call the constructor
|
|
228
|
+
directly, but instead call the static Singleton
|
|
229
|
+
Factory method <code>Model.getInstance()</code>
|
|
230
|
+
|
|
231
|
+
</p><br>
|
|
232
|
+
<span class="label">Throws</span>
|
|
233
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
234
|
+
<tr>
|
|
235
|
+
<td width="20"></td><td><code></code> — Error if Singleton instance has already been constructed
|
|
236
|
+
|
|
237
|
+
</td>
|
|
238
|
+
</tr>
|
|
239
|
+
</table>
|
|
240
|
+
</div>
|
|
241
|
+
<a name="methodDetail"></a>
|
|
242
|
+
<div class="detailSectionHeader">Method detail</div>
|
|
243
|
+
<a name="getInstance()"></a>
|
|
244
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
245
|
+
<tr>
|
|
246
|
+
<td class="detailHeaderName">getInstance</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
|
|
247
|
+
</tr>
|
|
248
|
+
</table>
|
|
249
|
+
<div class="detailBody">
|
|
250
|
+
<code>public static function getInstance():<a href="../interfaces/IModel.html">IModel</a></code><p>
|
|
251
|
+
<code>Model</code> Singleton Factory method.
|
|
252
|
+
|
|
253
|
+
</p><p></p>
|
|
254
|
+
<span class="label">Returns</span>
|
|
255
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
256
|
+
<tr>
|
|
257
|
+
<td width="20"></td><td><code><a href="../interfaces/IModel.html">IModel</a></code> —
|
|
258
|
+
the Singleton instance
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
</td>
|
|
262
|
+
</tr>
|
|
263
|
+
</table>
|
|
264
|
+
</div>
|
|
265
|
+
<a name="hasProxy()"></a>
|
|
266
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
267
|
+
<tr>
|
|
268
|
+
<td class="detailHeaderName">hasProxy</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
|
|
269
|
+
</tr>
|
|
270
|
+
</table>
|
|
271
|
+
<div class="detailBody">
|
|
272
|
+
<code>public function hasProxy(proxyName:String):Boolean</code><p>
|
|
273
|
+
Check if a Proxy is registered
|
|
274
|
+
|
|
275
|
+
</p><span class="label">Parameters</span>
|
|
276
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
277
|
+
<tr>
|
|
278
|
+
<td width="20px"></td><td><code><span class="label">proxyName</span>:String</code></td>
|
|
279
|
+
</tr>
|
|
280
|
+
</table>
|
|
281
|
+
<p></p>
|
|
282
|
+
<span class="label">Returns</span>
|
|
283
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
284
|
+
<tr>
|
|
285
|
+
<td width="20"></td><td><code>Boolean</code> — whether a Proxy is currently registered with the given <code>proxyName</code>.
|
|
286
|
+
</td>
|
|
287
|
+
</tr>
|
|
288
|
+
</table>
|
|
289
|
+
</div>
|
|
290
|
+
<a name="initializeModel()"></a>
|
|
291
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
292
|
+
<tr>
|
|
293
|
+
<td class="detailHeaderName">initializeModel</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
|
|
294
|
+
</tr>
|
|
295
|
+
</table>
|
|
296
|
+
<div class="detailBody">
|
|
297
|
+
<code>protected function initializeModel():void</code><p>
|
|
298
|
+
Initialize the Singleton <code>Model</code> instance.
|
|
299
|
+
|
|
300
|
+
<P>
|
|
301
|
+
Called automatically by the constructor, this
|
|
302
|
+
is your opportunity to initialize the Singleton
|
|
303
|
+
instance in your subclass without overriding the
|
|
304
|
+
constructor.</P>
|
|
305
|
+
|
|
306
|
+
</p></div>
|
|
307
|
+
<a name="registerProxy()"></a>
|
|
308
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
309
|
+
<tr>
|
|
310
|
+
<td class="detailHeaderName">registerProxy</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
|
|
311
|
+
</tr>
|
|
312
|
+
</table>
|
|
313
|
+
<div class="detailBody">
|
|
314
|
+
<code>public function registerProxy(proxy:<a href="../interfaces/IProxy.html">IProxy</a>):void</code><p>
|
|
315
|
+
Register an <code>IProxy</code> with the <code>Model</code>.
|
|
316
|
+
|
|
317
|
+
</p><span class="label">Parameters</span>
|
|
318
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
319
|
+
<tr>
|
|
320
|
+
<td width="20px"></td><td><code><span class="label">proxy</span>:<a href="../interfaces/IProxy.html">IProxy</a></code> — an <code>IProxy</code> to be held by the <code>Model</code>.
|
|
321
|
+
</td>
|
|
322
|
+
</tr>
|
|
323
|
+
</table>
|
|
324
|
+
</div>
|
|
325
|
+
<a name="removeProxy()"></a>
|
|
326
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
327
|
+
<tr>
|
|
328
|
+
<td class="detailHeaderName">removeProxy</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
|
|
329
|
+
</tr>
|
|
330
|
+
</table>
|
|
331
|
+
<div class="detailBody">
|
|
332
|
+
<code>public function removeProxy(proxyName:String):<a href="../interfaces/IProxy.html">IProxy</a></code><p>
|
|
333
|
+
Remove an <code>IProxy</code> from the <code>Model</code>.
|
|
334
|
+
|
|
335
|
+
</p><span class="label">Parameters</span>
|
|
336
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
337
|
+
<tr>
|
|
338
|
+
<td width="20px"></td><td><code><span class="label">proxyName</span>:String</code> — name of the <code>IProxy</code> instance to be removed.
|
|
339
|
+
</td>
|
|
340
|
+
</tr>
|
|
341
|
+
</table>
|
|
342
|
+
<p></p>
|
|
343
|
+
<span class="label">Returns</span>
|
|
344
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
345
|
+
<tr>
|
|
346
|
+
<td width="20"></td><td><code><a href="../interfaces/IProxy.html">IProxy</a></code> —
|
|
347
|
+
the <code>IProxy</code> that was removed from the <code>Model</code>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
</td>
|
|
351
|
+
</tr>
|
|
352
|
+
</table>
|
|
353
|
+
</div>
|
|
354
|
+
<a name="retrieveProxy()"></a>
|
|
355
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
356
|
+
<tr>
|
|
357
|
+
<td class="detailHeaderName">retrieveProxy</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
|
|
358
|
+
</tr>
|
|
359
|
+
</table>
|
|
360
|
+
<div class="detailBody">
|
|
361
|
+
<code>public function retrieveProxy(proxyName:String):<a href="../interfaces/IProxy.html">IProxy</a></code><p>
|
|
362
|
+
Retrieve an <code>IProxy</code> from the <code>Model</code>.
|
|
363
|
+
|
|
364
|
+
</p><span class="label">Parameters</span>
|
|
365
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
366
|
+
<tr>
|
|
367
|
+
<td width="20px"></td><td><code><span class="label">proxyName</span>:String</code></td>
|
|
368
|
+
</tr>
|
|
369
|
+
</table>
|
|
370
|
+
<p></p>
|
|
371
|
+
<span class="label">Returns</span>
|
|
372
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
373
|
+
<tr>
|
|
374
|
+
<td width="20"></td><td><code><a href="../interfaces/IProxy.html">IProxy</a></code> —
|
|
375
|
+
the <code>IProxy</code> instance previously registered with the given <code>proxyName</code>.
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
</td>
|
|
379
|
+
</tr>
|
|
380
|
+
</table>
|
|
381
|
+
</div>
|
|
382
|
+
<a name="constantDetail"></a>
|
|
383
|
+
<div class="detailSectionHeader">Constant detail</div>
|
|
384
|
+
<a name="SINGLETON_MSG"></a>
|
|
385
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
386
|
+
<tr>
|
|
387
|
+
<td class="detailHeaderName">SINGLETON_MSG</td><td class="detailHeaderType">constant</td>
|
|
388
|
+
</tr>
|
|
389
|
+
</table>
|
|
390
|
+
<div class="detailBody">
|
|
391
|
+
<code>protected const SINGLETON_MSG:String = "Model Singleton already constructed!"</code>
|
|
392
|
+
</div>
|
|
393
|
+
<br>
|
|
394
|
+
<br>
|
|
395
|
+
<hr>
|
|
396
|
+
<br>
|
|
397
|
+
<p></p>
|
|
398
|
+
<center class="copyright">
|
|
399
|
+
<footer>
|
|
400
|
+
</footer>
|
|
401
|
+
</center>
|
|
402
|
+
</div>
|
|
403
|
+
</body>
|
|
404
|
+
</html>
|
|
405
|
+
<!-- -->
|
|
@@ -0,0 +1,524 @@
|
|
|
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="View,org.puremvc.as3.core.View,SINGLETON_MSG,instance,mediatorMap,observerMap,getInstance,hasMediator,initializeView,notifyObservers,registerMediator,registerObserver,removeMediator,removeObserver,retrieveMediator" name="keywords">
|
|
8
|
+
<title>org.puremvc.as3.core.View</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 = 'View - 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/core/View.html&org/puremvc/as3/core/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">Class View</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a> | <a href="#constantSummary">Constants</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("Class View"); titleBar_setSubNav(true,true,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.core</a></td>
|
|
36
|
+
</tr>
|
|
37
|
+
<tr>
|
|
38
|
+
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class View</td>
|
|
39
|
+
</tr>
|
|
40
|
+
<tr>
|
|
41
|
+
<td class="classHeaderTableLabel">Implements</td><td><a href="../interfaces/IView.html">IView</a></td>
|
|
42
|
+
</tr>
|
|
43
|
+
</table>
|
|
44
|
+
<p></p>
|
|
45
|
+
A Singleton <code>IView</code> implementation.
|
|
46
|
+
|
|
47
|
+
<P>
|
|
48
|
+
In PureMVC, the <code>View</code> class assumes these responsibilities:
|
|
49
|
+
<UL>
|
|
50
|
+
<LI>Maintain a cache of <code>IMediator</code> instances.</LI>
|
|
51
|
+
<LI>Provide methods for registering, retrieving, and removing <code>IMediators</code>.</LI>
|
|
52
|
+
<LI>Notifiying <code>IMediators</code> when they are registered or removed.</LI>
|
|
53
|
+
<LI>Managing the observer lists for each <code>INotification</code> in the application.</LI>
|
|
54
|
+
<LI>Providing a method for attaching <code>IObservers</code> to an <code>INotification</code>'s observer list.</LI>
|
|
55
|
+
<LI>Providing a method for broadcasting an <code>INotification</code>.</LI>
|
|
56
|
+
<LI>Notifying the <code>IObservers</code> of a given <code>INotification</code> when it broadcast.</LI>
|
|
57
|
+
</UL>
|
|
58
|
+
|
|
59
|
+
<p></p>
|
|
60
|
+
<p>
|
|
61
|
+
<span class="classHeaderTableLabel">See also</span>
|
|
62
|
+
</p>
|
|
63
|
+
<div class="seeAlso">
|
|
64
|
+
<a href="../patterns/mediator/Mediator.html" target="">Mediator</a>
|
|
65
|
+
<br>
|
|
66
|
+
<a href="../patterns/observer/Observer.html" target="">Observer</a>
|
|
67
|
+
<br>
|
|
68
|
+
<a href="../patterns/observer/Notification.html" target="">Notification</a>
|
|
69
|
+
</div>
|
|
70
|
+
<br>
|
|
71
|
+
<hr>
|
|
72
|
+
</div>
|
|
73
|
+
<a name="propertySummary"></a><a name="protectedPropertySummary"></a>
|
|
74
|
+
<div class="summarySection">
|
|
75
|
+
<div class="summaryTableTitle">Protected Properties</div>
|
|
76
|
+
<table id="summaryTableProtectedProperty" class="summaryTable " cellpadding="3" cellspacing="0">
|
|
77
|
+
<tr>
|
|
78
|
+
<th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined by</th>
|
|
79
|
+
</tr>
|
|
80
|
+
<tr class="">
|
|
81
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#instance">instance</a> : <a href="../interfaces/IView.html">IView</a>
|
|
82
|
+
<div class="summaryTableDescription">[static]</div>
|
|
83
|
+
</td><td class="summaryTableOwnerCol">View</td>
|
|
84
|
+
</tr>
|
|
85
|
+
<tr class="">
|
|
86
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#mediatorMap">mediatorMap</a> : Array<div class="summaryTableDescription"></div>
|
|
87
|
+
</td><td class="summaryTableOwnerCol">View</td>
|
|
88
|
+
</tr>
|
|
89
|
+
<tr class="">
|
|
90
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#observerMap">observerMap</a> : Array<div class="summaryTableDescription"></div>
|
|
91
|
+
</td><td class="summaryTableOwnerCol">View</td>
|
|
92
|
+
</tr>
|
|
93
|
+
</table>
|
|
94
|
+
</div>
|
|
95
|
+
<a name="methodSummary"></a>
|
|
96
|
+
<div class="summarySection">
|
|
97
|
+
<div class="summaryTableTitle">Public Methods</div>
|
|
98
|
+
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
|
|
99
|
+
<tr>
|
|
100
|
+
<th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined by</th>
|
|
101
|
+
</tr>
|
|
102
|
+
<tr class="">
|
|
103
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
104
|
+
<div class="summarySignature">
|
|
105
|
+
<a class="signatureLink" href="#View()">View</a>()</div>
|
|
106
|
+
<div class="summaryTableDescription">
|
|
107
|
+
Constructor.</div>
|
|
108
|
+
</td><td class="summaryTableOwnerCol">View</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="#getInstance()">getInstance</a>():<a href="../interfaces/IView.html">IView</a>
|
|
114
|
+
</div>
|
|
115
|
+
<div class="summaryTableDescription">[static]
|
|
116
|
+
View Singleton Factory method.</div>
|
|
117
|
+
</td><td class="summaryTableOwnerCol">View</td>
|
|
118
|
+
</tr>
|
|
119
|
+
<tr class="">
|
|
120
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
121
|
+
<div class="summarySignature">
|
|
122
|
+
<a class="signatureLink" href="#hasMediator()">hasMediator</a>(mediatorName:String):Boolean</div>
|
|
123
|
+
<div class="summaryTableDescription">
|
|
124
|
+
Check if a Mediator is registered or not
|
|
125
|
+
|
|
126
|
+
</div>
|
|
127
|
+
</td><td class="summaryTableOwnerCol">View</td>
|
|
128
|
+
</tr>
|
|
129
|
+
<tr class="">
|
|
130
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
131
|
+
<div class="summarySignature">
|
|
132
|
+
<a class="signatureLink" href="#notifyObservers()">notifyObservers</a>(notification:<a href="../interfaces/INotification.html">INotification</a>):void</div>
|
|
133
|
+
<div class="summaryTableDescription">
|
|
134
|
+
Notify the <code>IObservers</code> for a particular <code>INotification</code>.</div>
|
|
135
|
+
</td><td class="summaryTableOwnerCol">View</td>
|
|
136
|
+
</tr>
|
|
137
|
+
<tr class="">
|
|
138
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
139
|
+
<div class="summarySignature">
|
|
140
|
+
<a class="signatureLink" href="#registerMediator()">registerMediator</a>(mediator:<a href="../interfaces/IMediator.html">IMediator</a>):void</div>
|
|
141
|
+
<div class="summaryTableDescription">
|
|
142
|
+
Register an <code>IMediator</code> instance with the <code>View</code>.</div>
|
|
143
|
+
</td><td class="summaryTableOwnerCol">View</td>
|
|
144
|
+
</tr>
|
|
145
|
+
<tr class="">
|
|
146
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
147
|
+
<div class="summarySignature">
|
|
148
|
+
<a class="signatureLink" href="#registerObserver()">registerObserver</a>(notificationName:String, observer:<a href="../interfaces/IObserver.html">IObserver</a>):void</div>
|
|
149
|
+
<div class="summaryTableDescription">
|
|
150
|
+
Register an <code>IObserver</code> to be notified
|
|
151
|
+
of <code>INotifications</code> with a given name.</div>
|
|
152
|
+
</td><td class="summaryTableOwnerCol">View</td>
|
|
153
|
+
</tr>
|
|
154
|
+
<tr class="">
|
|
155
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
156
|
+
<div class="summarySignature">
|
|
157
|
+
<a class="signatureLink" href="#removeMediator()">removeMediator</a>(mediatorName:String):<a href="../interfaces/IMediator.html">IMediator</a>
|
|
158
|
+
</div>
|
|
159
|
+
<div class="summaryTableDescription">
|
|
160
|
+
Remove an <code>IMediator</code> from the <code>View</code>.</div>
|
|
161
|
+
</td><td class="summaryTableOwnerCol">View</td>
|
|
162
|
+
</tr>
|
|
163
|
+
<tr class="">
|
|
164
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
165
|
+
<div class="summarySignature">
|
|
166
|
+
<a class="signatureLink" href="#removeObserver()">removeObserver</a>(notificationName:String, notifyContext:Object):void</div>
|
|
167
|
+
<div class="summaryTableDescription">
|
|
168
|
+
Remove the observer for a given notifyContext from an observer list for a given Notification name.</div>
|
|
169
|
+
</td><td class="summaryTableOwnerCol">View</td>
|
|
170
|
+
</tr>
|
|
171
|
+
<tr class="">
|
|
172
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
173
|
+
<div class="summarySignature">
|
|
174
|
+
<a class="signatureLink" href="#retrieveMediator()">retrieveMediator</a>(mediatorName:String):<a href="../interfaces/IMediator.html">IMediator</a>
|
|
175
|
+
</div>
|
|
176
|
+
<div class="summaryTableDescription">
|
|
177
|
+
Retrieve an <code>IMediator</code> from the <code>View</code>.</div>
|
|
178
|
+
</td><td class="summaryTableOwnerCol">View</td>
|
|
179
|
+
</tr>
|
|
180
|
+
</table>
|
|
181
|
+
</div>
|
|
182
|
+
<a name="protectedMethodSummary"></a>
|
|
183
|
+
<div class="summarySection">
|
|
184
|
+
<div class="summaryTableTitle">Protected Methods</div>
|
|
185
|
+
<table id="summaryTableProtectedMethod" class="summaryTable " cellpadding="3" cellspacing="0">
|
|
186
|
+
<tr>
|
|
187
|
+
<th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined by</th>
|
|
188
|
+
</tr>
|
|
189
|
+
<tr class="">
|
|
190
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
|
|
191
|
+
<div class="summarySignature">
|
|
192
|
+
<a class="signatureLink" href="#initializeView()">initializeView</a>():void</div>
|
|
193
|
+
<div class="summaryTableDescription">
|
|
194
|
+
Initialize the Singleton View instance.</div>
|
|
195
|
+
</td><td class="summaryTableOwnerCol">View</td>
|
|
196
|
+
</tr>
|
|
197
|
+
</table>
|
|
198
|
+
</div>
|
|
199
|
+
<a name="constantSummary"></a><a name="protectedConstantSummary"></a>
|
|
200
|
+
<div class="summarySection">
|
|
201
|
+
<div class="summaryTableTitle">Protected Constants</div>
|
|
202
|
+
<table id="summaryTableProtectedConstant" class="summaryTable " cellpadding="3" cellspacing="0">
|
|
203
|
+
<tr>
|
|
204
|
+
<th> </th><th colspan="2">Constant</th><th class="summaryTableOwnerCol">Defined by</th>
|
|
205
|
+
</tr>
|
|
206
|
+
<tr class="">
|
|
207
|
+
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#SINGLETON_MSG">SINGLETON_MSG</a> : String = "View Singleton already constructed!"<div class="summaryTableDescription"></div>
|
|
208
|
+
</td><td class="summaryTableOwnerCol">View</td>
|
|
209
|
+
</tr>
|
|
210
|
+
</table>
|
|
211
|
+
</div>
|
|
212
|
+
<script type="text/javascript" language="javascript">
|
|
213
|
+
<!--
|
|
214
|
+
showHideInherited();
|
|
215
|
+
--></script>
|
|
216
|
+
<div class="MainContent">
|
|
217
|
+
<a name="propertyDetail"></a>
|
|
218
|
+
<div class="detailSectionHeader">Property detail</div>
|
|
219
|
+
<a name="instance"></a>
|
|
220
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
221
|
+
<tr>
|
|
222
|
+
<td class="detailHeaderName">instance</td><td class="detailHeaderType">property</td>
|
|
223
|
+
</tr>
|
|
224
|
+
</table>
|
|
225
|
+
<div class="detailBody">
|
|
226
|
+
<code>protected static var instance:<a href="../interfaces/IView.html">IView</a></code>
|
|
227
|
+
</div>
|
|
228
|
+
<a name="mediatorMap"></a>
|
|
229
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
230
|
+
<tr>
|
|
231
|
+
<td class="detailHeaderName">mediatorMap</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
|
|
232
|
+
</tr>
|
|
233
|
+
</table>
|
|
234
|
+
<div class="detailBody">
|
|
235
|
+
<code>protected var mediatorMap:Array</code>
|
|
236
|
+
</div>
|
|
237
|
+
<a name="observerMap"></a>
|
|
238
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
239
|
+
<tr>
|
|
240
|
+
<td class="detailHeaderName">observerMap</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td>
|
|
241
|
+
</tr>
|
|
242
|
+
</table>
|
|
243
|
+
<div class="detailBody">
|
|
244
|
+
<code>protected var observerMap:Array</code>
|
|
245
|
+
</div>
|
|
246
|
+
<a name="constructorDetail"></a>
|
|
247
|
+
<div class="detailSectionHeader">Constructor detail</div>
|
|
248
|
+
<a name="View()"></a>
|
|
249
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
250
|
+
<tr>
|
|
251
|
+
<td class="detailHeaderName">View</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
|
|
252
|
+
</tr>
|
|
253
|
+
</table>
|
|
254
|
+
<div class="detailBody">
|
|
255
|
+
<code>public function View()</code><p>
|
|
256
|
+
Constructor.
|
|
257
|
+
|
|
258
|
+
<P>
|
|
259
|
+
This <code>IView</code> implementation is a Singleton,
|
|
260
|
+
so you should not call the constructor
|
|
261
|
+
directly, but instead call the static Singleton
|
|
262
|
+
Factory method <code>View.getInstance()</code>
|
|
263
|
+
|
|
264
|
+
</p><br>
|
|
265
|
+
<span class="label">Throws</span>
|
|
266
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
267
|
+
<tr>
|
|
268
|
+
<td width="20"></td><td><code></code> — Error if Singleton instance has already been constructed
|
|
269
|
+
|
|
270
|
+
</td>
|
|
271
|
+
</tr>
|
|
272
|
+
</table>
|
|
273
|
+
</div>
|
|
274
|
+
<a name="methodDetail"></a>
|
|
275
|
+
<div class="detailSectionHeader">Method detail</div>
|
|
276
|
+
<a name="getInstance()"></a>
|
|
277
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
278
|
+
<tr>
|
|
279
|
+
<td class="detailHeaderName">getInstance</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
|
|
280
|
+
</tr>
|
|
281
|
+
</table>
|
|
282
|
+
<div class="detailBody">
|
|
283
|
+
<code>public static function getInstance():<a href="../interfaces/IView.html">IView</a></code><p>
|
|
284
|
+
View Singleton Factory method.
|
|
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><a href="../interfaces/IView.html">IView</a></code> —
|
|
291
|
+
the Singleton instance of <code>View</code>
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
</td>
|
|
295
|
+
</tr>
|
|
296
|
+
</table>
|
|
297
|
+
</div>
|
|
298
|
+
<a name="hasMediator()"></a>
|
|
299
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
300
|
+
<tr>
|
|
301
|
+
<td class="detailHeaderName">hasMediator</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
|
|
302
|
+
</tr>
|
|
303
|
+
</table>
|
|
304
|
+
<div class="detailBody">
|
|
305
|
+
<code>public function hasMediator(mediatorName:String):Boolean</code><p>
|
|
306
|
+
Check if a Mediator is registered or not
|
|
307
|
+
|
|
308
|
+
</p><span class="label">Parameters</span>
|
|
309
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
310
|
+
<tr>
|
|
311
|
+
<td width="20px"></td><td><code><span class="label">mediatorName</span>:String</code></td>
|
|
312
|
+
</tr>
|
|
313
|
+
</table>
|
|
314
|
+
<p></p>
|
|
315
|
+
<span class="label">Returns</span>
|
|
316
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
317
|
+
<tr>
|
|
318
|
+
<td width="20"></td><td><code>Boolean</code> — whether a Mediator is registered with the given <code>mediatorName</code>.
|
|
319
|
+
</td>
|
|
320
|
+
</tr>
|
|
321
|
+
</table>
|
|
322
|
+
</div>
|
|
323
|
+
<a name="initializeView()"></a>
|
|
324
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
325
|
+
<tr>
|
|
326
|
+
<td class="detailHeaderName">initializeView</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
|
|
327
|
+
</tr>
|
|
328
|
+
</table>
|
|
329
|
+
<div class="detailBody">
|
|
330
|
+
<code>protected function initializeView():void</code><p>
|
|
331
|
+
Initialize the Singleton View instance.
|
|
332
|
+
|
|
333
|
+
<P>
|
|
334
|
+
Called automatically by the constructor, this
|
|
335
|
+
is your opportunity to initialize the Singleton
|
|
336
|
+
instance in your subclass without overriding the
|
|
337
|
+
constructor.</P>
|
|
338
|
+
|
|
339
|
+
</p></div>
|
|
340
|
+
<a name="notifyObservers()"></a>
|
|
341
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
342
|
+
<tr>
|
|
343
|
+
<td class="detailHeaderName">notifyObservers</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
|
|
344
|
+
</tr>
|
|
345
|
+
</table>
|
|
346
|
+
<div class="detailBody">
|
|
347
|
+
<code>public function notifyObservers(notification:<a href="../interfaces/INotification.html">INotification</a>):void</code><p>
|
|
348
|
+
Notify the <code>IObservers</code> for a particular <code>INotification</code>.
|
|
349
|
+
|
|
350
|
+
<P>
|
|
351
|
+
All previously attached <code>IObservers</code> for this <code>INotification</code>'s
|
|
352
|
+
list are notified and are passed a reference to the <code>INotification</code> in
|
|
353
|
+
the order in which they were registered.</P>
|
|
354
|
+
|
|
355
|
+
</p><span class="label">Parameters</span>
|
|
356
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
357
|
+
<tr>
|
|
358
|
+
<td width="20px"></td><td><code><span class="label">notification</span>:<a href="../interfaces/INotification.html">INotification</a></code> — the <code>INotification</code> to notify <code>IObservers</code> of.
|
|
359
|
+
</td>
|
|
360
|
+
</tr>
|
|
361
|
+
</table>
|
|
362
|
+
</div>
|
|
363
|
+
<a name="registerMediator()"></a>
|
|
364
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
365
|
+
<tr>
|
|
366
|
+
<td class="detailHeaderName">registerMediator</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
|
|
367
|
+
</tr>
|
|
368
|
+
</table>
|
|
369
|
+
<div class="detailBody">
|
|
370
|
+
<code>public function registerMediator(mediator:<a href="../interfaces/IMediator.html">IMediator</a>):void</code><p>
|
|
371
|
+
Register an <code>IMediator</code> instance with the <code>View</code>.
|
|
372
|
+
|
|
373
|
+
<P>
|
|
374
|
+
Registers the <code>IMediator</code> so that it can be retrieved by name,
|
|
375
|
+
and further interrogates the <code>IMediator</code> for its
|
|
376
|
+
<code>INotification</code> interests.</P>
|
|
377
|
+
<P>
|
|
378
|
+
If the <code>IMediator</code> returns any <code>INotification</code>
|
|
379
|
+
names to be notified about, an <code>Observer</code> is created encapsulating
|
|
380
|
+
the <code>IMediator</code> instance's <code>handleNotification</code> method
|
|
381
|
+
and registering it as an <code>Observer</code> for all <code>INotifications</code> the
|
|
382
|
+
<code>IMediator</code> is interested in.</p>
|
|
383
|
+
|
|
384
|
+
</p><span class="label">Parameters</span>
|
|
385
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
386
|
+
<tr>
|
|
387
|
+
<td width="20px"></td><td><code><span class="label">mediator</span>:<a href="../interfaces/IMediator.html">IMediator</a></code> — the name to associate with this <code>IMediator</code> instance
|
|
388
|
+
</td>
|
|
389
|
+
</tr>
|
|
390
|
+
</table>
|
|
391
|
+
</div>
|
|
392
|
+
<a name="registerObserver()"></a>
|
|
393
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
394
|
+
<tr>
|
|
395
|
+
<td class="detailHeaderName">registerObserver</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
|
|
396
|
+
</tr>
|
|
397
|
+
</table>
|
|
398
|
+
<div class="detailBody">
|
|
399
|
+
<code>public function registerObserver(notificationName:String, observer:<a href="../interfaces/IObserver.html">IObserver</a>):void</code><p>
|
|
400
|
+
Register an <code>IObserver</code> to be notified
|
|
401
|
+
of <code>INotifications</code> with a given name.
|
|
402
|
+
|
|
403
|
+
</p><span class="label">Parameters</span>
|
|
404
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
405
|
+
<tr>
|
|
406
|
+
<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
|
|
407
|
+
</td>
|
|
408
|
+
</tr>
|
|
409
|
+
<tr>
|
|
410
|
+
<td class="paramSpacer"> </td>
|
|
411
|
+
</tr>
|
|
412
|
+
<tr>
|
|
413
|
+
<td width="20px"></td><td><code><span class="label">observer</span>:<a href="../interfaces/IObserver.html">IObserver</a></code> — the <code>IObserver</code> to register
|
|
414
|
+
</td>
|
|
415
|
+
</tr>
|
|
416
|
+
</table>
|
|
417
|
+
</div>
|
|
418
|
+
<a name="removeMediator()"></a>
|
|
419
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
420
|
+
<tr>
|
|
421
|
+
<td class="detailHeaderName">removeMediator</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
|
|
422
|
+
</tr>
|
|
423
|
+
</table>
|
|
424
|
+
<div class="detailBody">
|
|
425
|
+
<code>public function removeMediator(mediatorName:String):<a href="../interfaces/IMediator.html">IMediator</a></code><p>
|
|
426
|
+
Remove an <code>IMediator</code> from the <code>View</code>.
|
|
427
|
+
|
|
428
|
+
</p><span class="label">Parameters</span>
|
|
429
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
430
|
+
<tr>
|
|
431
|
+
<td width="20px"></td><td><code><span class="label">mediatorName</span>:String</code> — name of the <code>IMediator</code> instance to be removed.
|
|
432
|
+
</td>
|
|
433
|
+
</tr>
|
|
434
|
+
</table>
|
|
435
|
+
<p></p>
|
|
436
|
+
<span class="label">Returns</span>
|
|
437
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
438
|
+
<tr>
|
|
439
|
+
<td width="20"></td><td><code><a href="../interfaces/IMediator.html">IMediator</a></code> —
|
|
440
|
+
the <code>IMediator</code> that was removed from the <code>View</code>
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
</td>
|
|
444
|
+
</tr>
|
|
445
|
+
</table>
|
|
446
|
+
</div>
|
|
447
|
+
<a name="removeObserver()"></a>
|
|
448
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
449
|
+
<tr>
|
|
450
|
+
<td class="detailHeaderName">removeObserver</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
|
|
451
|
+
</tr>
|
|
452
|
+
</table>
|
|
453
|
+
<div class="detailBody">
|
|
454
|
+
<code>public function removeObserver(notificationName:String, notifyContext:Object):void</code><p>
|
|
455
|
+
Remove the observer for a given notifyContext from an observer list for a given Notification name.
|
|
456
|
+
<P>
|
|
457
|
+
</p><span class="label">Parameters</span>
|
|
458
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
459
|
+
<tr>
|
|
460
|
+
<td width="20px"></td><td><code><span class="label">notificationName</span>:String</code> — which observer list to remove from
|
|
461
|
+
</td>
|
|
462
|
+
</tr>
|
|
463
|
+
<tr>
|
|
464
|
+
<td class="paramSpacer"> </td>
|
|
465
|
+
</tr>
|
|
466
|
+
<tr>
|
|
467
|
+
<td width="20px"></td><td><code><span class="label">notifyContext</span>:Object</code> — remove the observer with this object as its notifyContext
|
|
468
|
+
</td>
|
|
469
|
+
</tr>
|
|
470
|
+
</table>
|
|
471
|
+
</div>
|
|
472
|
+
<a name="retrieveMediator()"></a>
|
|
473
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
474
|
+
<tr>
|
|
475
|
+
<td class="detailHeaderName">retrieveMediator</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
|
|
476
|
+
</tr>
|
|
477
|
+
</table>
|
|
478
|
+
<div class="detailBody">
|
|
479
|
+
<code>public function retrieveMediator(mediatorName:String):<a href="../interfaces/IMediator.html">IMediator</a></code><p>
|
|
480
|
+
Retrieve an <code>IMediator</code> from the <code>View</code>.
|
|
481
|
+
|
|
482
|
+
</p><span class="label">Parameters</span>
|
|
483
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
484
|
+
<tr>
|
|
485
|
+
<td width="20px"></td><td><code><span class="label">mediatorName</span>:String</code> — the name of the <code>IMediator</code> instance to retrieve.
|
|
486
|
+
</td>
|
|
487
|
+
</tr>
|
|
488
|
+
</table>
|
|
489
|
+
<p></p>
|
|
490
|
+
<span class="label">Returns</span>
|
|
491
|
+
<table border="0" cellspacing="0" cellpadding="0">
|
|
492
|
+
<tr>
|
|
493
|
+
<td width="20"></td><td><code><a href="../interfaces/IMediator.html">IMediator</a></code> —
|
|
494
|
+
the <code>IMediator</code> instance previously registered with the given <code>mediatorName</code>.
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
</td>
|
|
498
|
+
</tr>
|
|
499
|
+
</table>
|
|
500
|
+
</div>
|
|
501
|
+
<a name="constantDetail"></a>
|
|
502
|
+
<div class="detailSectionHeader">Constant detail</div>
|
|
503
|
+
<a name="SINGLETON_MSG"></a>
|
|
504
|
+
<table cellspacing="0" cellpadding="0" class="detailHeader">
|
|
505
|
+
<tr>
|
|
506
|
+
<td class="detailHeaderName">SINGLETON_MSG</td><td class="detailHeaderType">constant</td>
|
|
507
|
+
</tr>
|
|
508
|
+
</table>
|
|
509
|
+
<div class="detailBody">
|
|
510
|
+
<code>protected const SINGLETON_MSG:String = "View Singleton already constructed!"</code>
|
|
511
|
+
</div>
|
|
512
|
+
<br>
|
|
513
|
+
<br>
|
|
514
|
+
<hr>
|
|
515
|
+
<br>
|
|
516
|
+
<p></p>
|
|
517
|
+
<center class="copyright">
|
|
518
|
+
<footer>
|
|
519
|
+
</footer>
|
|
520
|
+
</center>
|
|
521
|
+
</div>
|
|
522
|
+
</body>
|
|
523
|
+
</html>
|
|
524
|
+
<!-- -->
|