1 |
4307
|
leinfelder
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
2 |
|
|
<!--NewPage-->
|
3 |
|
|
<HTML>
|
4 |
|
|
<HEAD>
|
5 |
|
|
<TITLE>
|
6 |
|
|
ModelBase
|
7 |
|
|
</TITLE>
|
8 |
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
9 |
|
|
</HEAD>
|
10 |
|
|
<SCRIPT>
|
11 |
|
|
function asd()
|
12 |
|
|
{
|
13 |
|
|
parent.document.title="ModelBase";
|
14 |
|
|
}
|
15 |
|
|
</SCRIPT>
|
16 |
|
|
<BODY BGCOLOR="white" onload="asd();">
|
17 |
|
|
|
18 |
|
|
<!-- ========== START OF NAVBAR ========== -->
|
19 |
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
20 |
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
21 |
|
|
<TR>
|
22 |
|
|
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
23 |
|
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
24 |
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
25 |
|
|
<TR ALIGN="center" VALIGN="top">
|
26 |
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
27 |
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary-ModelBase.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD>
|
28 |
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
29 |
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
30 |
|
|
<!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD-->
|
31 |
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"--><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
32 |
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
33 |
|
|
</TR>
|
34 |
|
|
</TABLE>
|
35 |
|
|
</TD>
|
36 |
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
37 |
|
|
<B><a href='http://mapbuilder.sourceforge.net'>Community Map Builder</a> 27 Apr 2008</B>
|
38 |
|
|
</EM>
|
39 |
|
|
</TD
|
40 |
|
|
</TR>
|
41 |
|
|
|
42 |
|
|
<TR>
|
43 |
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
44 |
|
|
<A HREF="Model.html"><B>PREV CLASS</B></A><!--
|
45 |
|
|
NEXT CLASS
|
46 |
|
|
-->
|
47 |
|
|
<A HREF="ModelStatus.html"><B>NEXT CLASS</B></A></FONT></TD>
|
48 |
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
49 |
|
|
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
|
50 |
|
|
<A HREF="ModelBase.html" TARGET="_top"><B>NO FRAMES</B></A>
|
51 |
|
|
|
52 |
|
|
<SCRIPT>
|
53 |
|
|
<!--
|
54 |
|
|
if(window==top) {
|
55 |
|
|
document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
|
56 |
|
|
}
|
57 |
|
|
//-->
|
58 |
|
|
</SCRIPT>
|
59 |
|
|
<NOSCRIPT>
|
60 |
|
|
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
|
61 |
|
|
</NOSCRIPT>
|
62 |
|
|
</FONT></TD>
|
63 |
|
|
</TR>
|
64 |
|
|
<TR>
|
65 |
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
66 |
|
|
SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
67 |
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
68 |
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
69 |
|
|
</TR>
|
70 |
|
|
</TABLE>
|
71 |
|
|
<!-- =========== END OF NAVBAR =========== -->
|
72 |
|
|
<HR>
|
73 |
|
|
|
74 |
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
75 |
|
|
<H2>Class ModelBase</H2>
|
76 |
|
|
<PRE>Object
|
77 |
|
|
|
|
78 |
|
|
+--<a href='Listener.html'>Listener</a>
|
79 |
|
|
|
|
80 |
|
|
+--<b>ModelBase</b>
|
81 |
|
|
</PRE>
|
82 |
|
|
|
83 |
|
|
<DL>
|
84 |
|
|
<DT>
|
85 |
|
|
<B>Direct Known Subclasses:</B>
|
86 |
|
|
<DD>
|
87 |
|
|
<a href="GeoRSS.html">GeoRSS</a>, <a href="FeatureCollection.html">FeatureCollection</a>, <a href="Config.html">Config</a>, <a href="Model.html">Model</a>, <a href="Transaction.html">Transaction</a>, <a href="StyledLayerDescriptor.html">StyledLayerDescriptor</a>, <a href="WmsCapabilities.html">WmsCapabilities</a>, <a href="Context.html">Context</a>, <a href="OwsContext.html">OwsContext</a>, <a href="WpsCapabilities.html">WpsCapabilities</a>, <a href="Logger.html">Logger</a>, <a href="WpsDescribeProcess.html">WpsDescribeProcess</a>, <a href="WfsCapabilities.html">WfsCapabilities</a>
|
88 |
|
|
</DD>
|
89 |
|
|
</DL>
|
90 |
|
|
|
91 |
|
|
|
92 |
|
|
<HR>
|
93 |
|
|
<DL>
|
94 |
|
|
<!-- Class definition -->
|
95 |
|
|
<DT>class
|
96 |
|
|
<B>ModelBase</B>
|
97 |
|
|
|
98 |
|
|
<DT>extends <a href='Listener.html'>Listener</a>
|
99 |
|
|
|
100 |
|
|
|
101 |
|
|
</DL>
|
102 |
|
|
|
103 |
|
|
<P>
|
104 |
|
|
<I>Defined in <a href='overview-summary-ModelBase.js.html'>ModelBase.js</a></I><BR/><BR/><B>Author:</B> Cameron Shorter <BR/>
|
105 |
|
|
</P>
|
106 |
|
|
|
107 |
|
|
<HR>
|
108 |
|
|
|
109 |
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
110 |
|
|
|
111 |
|
|
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
112 |
|
|
|
113 |
|
|
|
114 |
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
115 |
|
|
|
116 |
|
|
<A NAME="field_summary"><!-- --></A>
|
117 |
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
118 |
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
119 |
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
120 |
|
|
<B>Field Summary</B></FONT></TD>
|
121 |
|
|
</TR>
|
122 |
|
|
|
123 |
|
|
<!-- This is one instance field summary -->
|
124 |
|
|
|
125 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
126 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
127 |
|
|
<CODE> Object</CODE></FONT></TD>
|
128 |
|
|
<TD><CODE><B><A HREF="#async">async</A></B></CODE>
|
129 |
|
|
<BR>
|
130 |
|
|
</TD>
|
131 |
|
|
</TR>
|
132 |
|
|
|
133 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
134 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
135 |
|
|
<CODE> Object</CODE></FONT></TD>
|
136 |
|
|
<TD><CODE><B><A HREF="#config">config</A></B></CODE>
|
137 |
|
|
<BR>
|
138 |
|
|
Widgets can place configurations in a model.</TD>
|
139 |
|
|
</TR>
|
140 |
|
|
|
141 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
142 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
143 |
|
|
<CODE> Object</CODE></FONT></TD>
|
144 |
|
|
<TD><CODE><B><A HREF="#contentType">contentType</A></B></CODE>
|
145 |
|
|
<BR>
|
146 |
|
|
</TD>
|
147 |
|
|
</TR>
|
148 |
|
|
|
149 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
150 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
151 |
|
|
<CODE> Object</CODE></FONT></TD>
|
152 |
|
|
<TD><CODE><B><A HREF="#debug">debug</A></B></CODE>
|
153 |
|
|
<BR>
|
154 |
|
|
</TD>
|
155 |
|
|
</TR>
|
156 |
|
|
|
157 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
158 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
159 |
|
|
<CODE> Object</CODE></FONT></TD>
|
160 |
|
|
<TD><CODE><B><A HREF="#id">id</A></B></CODE>
|
161 |
|
|
<BR>
|
162 |
|
|
</TD>
|
163 |
|
|
</TR>
|
164 |
|
|
|
165 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
166 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
167 |
|
|
<CODE> Object</CODE></FONT></TD>
|
168 |
|
|
<TD><CODE><B><A HREF="#method">method</A></B></CODE>
|
169 |
|
|
<BR>
|
170 |
|
|
</TD>
|
171 |
|
|
</TR>
|
172 |
|
|
|
173 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
174 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
175 |
|
|
<CODE> Object</CODE></FONT></TD>
|
176 |
|
|
<TD><CODE><B><A HREF="#modelNode">modelNode</A></B></CODE>
|
177 |
|
|
<BR>
|
178 |
|
|
</TD>
|
179 |
|
|
</TR>
|
180 |
|
|
|
181 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
182 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
183 |
|
|
<CODE> Object</CODE></FONT></TD>
|
184 |
|
|
<TD><CODE><B><A HREF="#namespace">namespace</A></B></CODE>
|
185 |
|
|
<BR>
|
186 |
|
|
</TD>
|
187 |
|
|
</TR>
|
188 |
|
|
|
189 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
190 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
191 |
|
|
<CODE> Object</CODE></FONT></TD>
|
192 |
|
|
<TD><CODE><B><A HREF="#nodeSelectXpath">nodeSelectXpath</A></B></CODE>
|
193 |
|
|
<BR>
|
194 |
|
|
</TD>
|
195 |
|
|
</TR>
|
196 |
|
|
|
197 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
198 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
199 |
|
|
<CODE> Object</CODE></FONT></TD>
|
200 |
|
|
<TD><CODE><B><A HREF="#parentModel">parentModel</A></B></CODE>
|
201 |
|
|
<BR>
|
202 |
|
|
</TD>
|
203 |
|
|
</TR>
|
204 |
|
|
|
205 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
206 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
207 |
|
|
<CODE> Object</CODE></FONT></TD>
|
208 |
|
|
<TD><CODE><B><A HREF="#template">template</A></B></CODE>
|
209 |
|
|
<BR>
|
210 |
|
|
</TD>
|
211 |
|
|
</TR>
|
212 |
|
|
|
213 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
214 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
215 |
|
|
<CODE> Object</CODE></FONT></TD>
|
216 |
|
|
<TD><CODE><B><A HREF="#title">title</A></B></CODE>
|
217 |
|
|
<BR>
|
218 |
|
|
</TD>
|
219 |
|
|
</TR>
|
220 |
|
|
|
221 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
222 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
223 |
|
|
<CODE> Object</CODE></FONT></TD>
|
224 |
|
|
<TD><CODE><B><A HREF="#url">url</A></B></CODE>
|
225 |
|
|
<BR>
|
226 |
|
|
</TD>
|
227 |
|
|
</TR>
|
228 |
|
|
|
229 |
|
|
|
230 |
|
|
</TABLE>
|
231 |
|
|
|
232 |
|
|
|
233 |
|
|
|
234 |
|
|
|
235 |
|
|
|
236 |
|
|
<A NAME=""><!-- --></A>
|
237 |
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
238 |
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
239 |
|
|
<TD><B>Fields inherited from class <A HREF="Listener.html">Listener</A></B></TD>
|
240 |
|
|
</TR>
|
241 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
242 |
|
|
<TD><CODE>
|
243 |
|
|
<a href="Listener.html#listeners">listeners</a>, <a href="Listener.html#values">values</a>
|
244 |
|
|
</CODE></TD>
|
245 |
|
|
</TR>
|
246 |
|
|
</TABLE>
|
247 |
|
|
|
248 |
|
|
|
249 |
|
|
|
250 |
|
|
|
251 |
|
|
<!-- =========== END FIELD SUMMARY =========== -->
|
252 |
|
|
|
253 |
|
|
|
254 |
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
255 |
|
|
|
256 |
|
|
<A NAME="constructor_summary"><!-- --></A>
|
257 |
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
258 |
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
259 |
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
260 |
|
|
<B>Constructor Summary</B></FONT></TD>
|
261 |
|
|
</TR>
|
262 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
263 |
|
|
<TD>
|
264 |
|
|
<CODE>
|
265 |
|
|
<B>
|
266 |
|
|
<A HREF="ModelBase.html#ModelBase()">ModelBase</A>
|
267 |
|
|
</B>
|
268 |
|
|
(modelNode, parentModel)
|
269 |
|
|
</CODE>
|
270 |
|
|
<BR>
|
271 |
|
|
|
272 |
|
|
Base Model class to be inherited by all Model objects and provdes methods
|
273 |
|
|
and properties common to all models.
|
274 |
|
|
</TD>
|
275 |
|
|
</TR>
|
276 |
|
|
</TABLE>
|
277 |
|
|
|
278 |
|
|
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
|
279 |
|
|
|
280 |
|
|
|
281 |
|
|
|
282 |
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
283 |
|
|
|
284 |
|
|
<A NAME="method_summary"><!-- --></A>
|
285 |
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
286 |
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
287 |
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
288 |
|
|
<B>Method Summary</B></FONT></TD>
|
289 |
|
|
</TR>
|
290 |
|
|
|
291 |
|
|
|
292 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
293 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
294 |
|
|
<FONT SIZE="-1">
|
295 |
|
|
<CODE> void</CODE>
|
296 |
|
|
</FONT>
|
297 |
|
|
</TD>
|
298 |
|
|
<TD>
|
299 |
|
|
<CODE>
|
300 |
|
|
<B>
|
301 |
|
|
<A HREF="#clearModel">clearModel</A></B>(objRef)
|
302 |
|
|
</CODE>
|
303 |
|
|
<BR>
|
304 |
|
|
|
305 |
|
|
Listener registered with the parent model to remove the doc and url
|
306 |
|
|
of child models whenever the parent is reloaded.
|
307 |
|
|
</TD>
|
308 |
|
|
</TR>
|
309 |
|
|
|
310 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
311 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
312 |
|
|
<FONT SIZE="-1">
|
313 |
|
|
<CODE> Object</CODE>
|
314 |
|
|
</FONT>
|
315 |
|
|
</TD>
|
316 |
|
|
<TD>
|
317 |
|
|
<CODE>
|
318 |
|
|
<B>
|
319 |
|
|
<A HREF="#createObject">createObject</A></B>(configNode)
|
320 |
|
|
</CODE>
|
321 |
|
|
<BR>
|
322 |
|
|
|
323 |
|
|
Creates all mapbuilder JavaScript objects based on the Object nodes defined
|
324 |
|
|
in the configuration file.
|
325 |
|
|
</TD>
|
326 |
|
|
</TR>
|
327 |
|
|
|
328 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
329 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
330 |
|
|
<FONT SIZE="-1">
|
331 |
|
|
<CODE> void</CODE>
|
332 |
|
|
</FONT>
|
333 |
|
|
</TD>
|
334 |
|
|
<TD>
|
335 |
|
|
<CODE>
|
336 |
|
|
<B>
|
337 |
|
|
<A HREF="#deleteTemplates">deleteTemplates</A></B>()
|
338 |
|
|
</CODE>
|
339 |
|
|
<BR>
|
340 |
|
|
|
341 |
|
|
deletes all template models and clears their widgets
|
342 |
|
|
</TD>
|
343 |
|
|
</TR>
|
344 |
|
|
|
345 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
346 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
347 |
|
|
<FONT SIZE="-1">
|
348 |
|
|
<CODE> void</CODE>
|
349 |
|
|
</FONT>
|
350 |
|
|
</TD>
|
351 |
|
|
<TD>
|
352 |
|
|
<CODE>
|
353 |
|
|
<B>
|
354 |
|
|
<A HREF="#finishLoading">finishLoading</A></B>()
|
355 |
|
|
</CODE>
|
356 |
|
|
<BR>
|
357 |
|
|
|
358 |
|
|
Common steps to be carried out after all manner of model loading
|
359 |
|
|
Called to set the namespace for XPath selections and call the loadModel
|
360 |
|
|
listeners.
|
361 |
|
|
</TD>
|
362 |
|
|
</TR>
|
363 |
|
|
|
364 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
365 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
366 |
|
|
<FONT SIZE="-1">
|
367 |
|
|
<CODE> Object</CODE>
|
368 |
|
|
</FONT>
|
369 |
|
|
</TD>
|
370 |
|
|
<TD>
|
371 |
|
|
<CODE>
|
372 |
|
|
<B>
|
373 |
|
|
<A HREF="#getProperty">getProperty</A></B>(property, defaultValue)
|
374 |
|
|
</CODE>
|
375 |
|
|
<BR>
|
376 |
|
|
|
377 |
|
|
Convenient access to Mapbuilder.getProperty
|
378 |
|
|
</TD>
|
379 |
|
|
</TR>
|
380 |
|
|
|
381 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
382 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
383 |
|
|
<FONT SIZE="-1">
|
384 |
|
|
<CODE> Object</CODE>
|
385 |
|
|
</FONT>
|
386 |
|
|
</TD>
|
387 |
|
|
<TD>
|
388 |
|
|
<CODE>
|
389 |
|
|
<B>
|
390 |
|
|
<A HREF="#getXpathValue">getXpathValue</A></B>(objRef,xpath)
|
391 |
|
|
</CODE>
|
392 |
|
|
<BR>
|
393 |
|
|
|
394 |
|
|
Get the value of a node as selected by an XPath expression.1
|
395 |
|
|
</TD>
|
396 |
|
|
</TR>
|
397 |
|
|
|
398 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
399 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
400 |
|
|
<FONT SIZE="-1">
|
401 |
|
|
<CODE> void</CODE>
|
402 |
|
|
</FONT>
|
403 |
|
|
</TD>
|
404 |
|
|
<TD>
|
405 |
|
|
<CODE>
|
406 |
|
|
<B>
|
407 |
|
|
<A HREF="#init">init</A></B>(objRef)
|
408 |
|
|
</CODE>
|
409 |
|
|
<BR>
|
410 |
|
|
|
411 |
|
|
Listener registered with the parent model to call init listeners when
|
412 |
|
|
the parent model is init'ed
|
413 |
|
|
</TD>
|
414 |
|
|
</TR>
|
415 |
|
|
|
416 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
417 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
418 |
|
|
<FONT SIZE="-1">
|
419 |
|
|
<CODE> void</CODE>
|
420 |
|
|
</FONT>
|
421 |
|
|
</TD>
|
422 |
|
|
<TD>
|
423 |
|
|
<CODE>
|
424 |
|
|
<B>
|
425 |
|
|
<A HREF="#loadModelDoc">loadModelDoc</A></B>(objRef)
|
426 |
|
|
</CODE>
|
427 |
|
|
<BR>
|
428 |
|
|
|
429 |
|
|
Load a Model's document.
|
430 |
|
|
</TD>
|
431 |
|
|
</TR>
|
432 |
|
|
|
433 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
434 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
435 |
|
|
<FONT SIZE="-1">
|
436 |
|
|
<CODE> void</CODE>
|
437 |
|
|
</FONT>
|
438 |
|
|
</TD>
|
439 |
|
|
<TD>
|
440 |
|
|
<CODE>
|
441 |
|
|
<B>
|
442 |
|
|
<A HREF="#loadObjects">loadObjects</A></B>(objectXpath)
|
443 |
|
|
</CODE>
|
444 |
|
|
<BR>
|
445 |
|
|
|
446 |
|
|
Creates all the mapbuilder objects from the config file as selected by the
|
447 |
|
|
XPath value passed in.
|
448 |
|
|
</TD>
|
449 |
|
|
</TR>
|
450 |
|
|
|
451 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
452 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
453 |
|
|
<FONT SIZE="-1">
|
454 |
|
|
<CODE> void</CODE>
|
455 |
|
|
</FONT>
|
456 |
|
|
</TD>
|
457 |
|
|
<TD>
|
458 |
|
|
<CODE>
|
459 |
|
|
<B>
|
460 |
|
|
<A HREF="#newRequest">newRequest</A></B>(objRef, httpPayload)
|
461 |
|
|
</CODE>
|
462 |
|
|
<BR>
|
463 |
|
|
|
464 |
|
|
Load XML for a model from an httpPayload object.
|
465 |
|
|
</TD>
|
466 |
|
|
</TR>
|
467 |
|
|
|
468 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
469 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
470 |
|
|
<FONT SIZE="-1">
|
471 |
|
|
<CODE> void</CODE>
|
472 |
|
|
</FONT>
|
473 |
|
|
</TD>
|
474 |
|
|
<TD>
|
475 |
|
|
<CODE>
|
476 |
|
|
<B>
|
477 |
|
|
<A HREF="#parseConfig">parseConfig</A></B>(objRef)
|
478 |
|
|
</CODE>
|
479 |
|
|
<BR>
|
480 |
|
|
|
481 |
|
|
Initialization of all javascript model, widget and tool objects for this model.
|
482 |
|
|
</TD>
|
483 |
|
|
</TR>
|
484 |
|
|
|
485 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
486 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
487 |
|
|
<FONT SIZE="-1">
|
488 |
|
|
<CODE> void</CODE>
|
489 |
|
|
</FONT>
|
490 |
|
|
</TD>
|
491 |
|
|
<TD>
|
492 |
|
|
<CODE>
|
493 |
|
|
<B>
|
494 |
|
|
<A HREF="#refresh">refresh</A></B>(objRef)
|
495 |
|
|
</CODE>
|
496 |
|
|
<BR>
|
497 |
|
|
|
498 |
|
|
Listener registered with the parent model to call refresh listeners when
|
499 |
|
|
the model document is loaded
|
500 |
|
|
</TD>
|
501 |
|
|
</TR>
|
502 |
|
|
|
503 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
504 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
505 |
|
|
<FONT SIZE="-1">
|
506 |
|
|
<CODE> void</CODE>
|
507 |
|
|
</FONT>
|
508 |
|
|
</TD>
|
509 |
|
|
<TD>
|
510 |
|
|
<CODE>
|
511 |
|
|
<B>
|
512 |
|
|
<A HREF="#saveModel">saveModel</A></B>(objRef)
|
513 |
|
|
</CODE>
|
514 |
|
|
<BR>
|
515 |
|
|
|
516 |
|
|
save the model by posting it to the serializeUrl, which is defined as a
|
517 |
|
|
property of config.
|
518 |
|
|
</TD>
|
519 |
|
|
</TR>
|
520 |
|
|
|
521 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
522 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
523 |
|
|
<FONT SIZE="-1">
|
524 |
|
|
<CODE> void</CODE>
|
525 |
|
|
</FONT>
|
526 |
|
|
</TD>
|
527 |
|
|
<TD>
|
528 |
|
|
<CODE>
|
529 |
|
|
<B>
|
530 |
|
|
<A HREF="#setModel">setModel</A></B>(objRef,newModel)
|
531 |
|
|
</CODE>
|
532 |
|
|
<BR>
|
533 |
|
|
|
534 |
|
|
Set the model's XML document using an XML object as a parameter.
|
535 |
|
|
</TD>
|
536 |
|
|
</TR>
|
537 |
|
|
|
538 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
539 |
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
540 |
|
|
<FONT SIZE="-1">
|
541 |
|
|
<CODE> Object</CODE>
|
542 |
|
|
</FONT>
|
543 |
|
|
</TD>
|
544 |
|
|
<TD>
|
545 |
|
|
<CODE>
|
546 |
|
|
<B>
|
547 |
|
|
<A HREF="#setXpathValue">setXpathValue</A></B>(objRef,xpath,value,refresh)
|
548 |
|
|
</CODE>
|
549 |
|
|
<BR>
|
550 |
|
|
|
551 |
|
|
Update the value of a node within this model's XML document.
|
552 |
|
|
</TD>
|
553 |
|
|
</TR>
|
554 |
|
|
|
555 |
|
|
|
556 |
|
|
</TABLE>
|
557 |
|
|
|
558 |
|
|
|
559 |
|
|
|
560 |
|
|
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
561 |
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
562 |
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
563 |
|
|
<TD><B>Methods inherited from class <a href="Listener.html">Listener</a></B></TD>
|
564 |
|
|
</TR>
|
565 |
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
566 |
|
|
<TD><CODE>
|
567 |
|
|
<!-- Inherited methods -->
|
568 |
|
|
<a href="Listener.html#addListener">addListener</a>, <a href="Listener.html#addFirstListener">addFirstListener</a>, <a href="Listener.html#removeListener">removeListener</a>, <a href="Listener.html#callListeners">callListeners</a>, <a href="Listener.html#setParam">setParam</a>, <a href="Listener.html#getParam">getParam</a>
|
569 |
|
|
</CODE></TD>
|
570 |
|
|
</TR>
|
571 |
|
|
</TABLE>
|
572 |
|
|
|
573 |
|
|
|
574 |
|
|
<P>
|
575 |
|
|
<!-- ========== END METHOD SUMMARY =========== -->
|
576 |
|
|
|
577 |
|
|
|
578 |
|
|
<!-- ============ FIELD DETAIL START =========== -->
|
579 |
|
|
|
580 |
|
|
<A NAME="field_detail"><!-- --></A>
|
581 |
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
582 |
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
583 |
|
|
<TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
|
584 |
|
|
</TR>
|
585 |
|
|
</TABLE>
|
586 |
|
|
|
587 |
|
|
|
588 |
|
|
<A NAME="async"><!-- --></A>
|
589 |
|
|
<H3>async</H3>
|
590 |
|
|
<PRE>Object <B>async</B></PRE>
|
591 |
|
|
<UL>
|
592 |
|
|
|
593 |
|
|
|
594 |
|
|
</UL>
|
595 |
|
|
<HR>
|
596 |
|
|
|
597 |
|
|
<A NAME="config"><!-- --></A>
|
598 |
|
|
<H3>config</H3>
|
599 |
|
|
<PRE>Object <B>config</B></PRE>
|
600 |
|
|
<UL>
|
601 |
|
|
Widgets can place configurations in a model. This is an associative
|
602 |
|
|
array with the widgetId of the widget that places its configuration
|
603 |
|
|
here as key.
|
604 |
|
|
|
605 |
|
|
</UL>
|
606 |
|
|
<HR>
|
607 |
|
|
|
608 |
|
|
<A NAME="contentType"><!-- --></A>
|
609 |
|
|
<H3>contentType</H3>
|
610 |
|
|
<PRE>Object <B>contentType</B></PRE>
|
611 |
|
|
<UL>
|
612 |
|
|
|
613 |
|
|
|
614 |
|
|
</UL>
|
615 |
|
|
<HR>
|
616 |
|
|
|
617 |
|
|
<A NAME="debug"><!-- --></A>
|
618 |
|
|
<H3>debug</H3>
|
619 |
|
|
<PRE>Object <B>debug</B></PRE>
|
620 |
|
|
<UL>
|
621 |
|
|
|
622 |
|
|
|
623 |
|
|
</UL>
|
624 |
|
|
<HR>
|
625 |
|
|
|
626 |
|
|
<A NAME="id"><!-- --></A>
|
627 |
|
|
<H3>id</H3>
|
628 |
|
|
<PRE>Object <B>id</B></PRE>
|
629 |
|
|
<UL>
|
630 |
|
|
|
631 |
|
|
|
632 |
|
|
</UL>
|
633 |
|
|
<HR>
|
634 |
|
|
|
635 |
|
|
<A NAME="method"><!-- --></A>
|
636 |
|
|
<H3>method</H3>
|
637 |
|
|
<PRE>Object <B>method</B></PRE>
|
638 |
|
|
<UL>
|
639 |
|
|
|
640 |
|
|
|
641 |
|
|
</UL>
|
642 |
|
|
<HR>
|
643 |
|
|
|
644 |
|
|
<A NAME="modelNode"><!-- --></A>
|
645 |
|
|
<H3>modelNode</H3>
|
646 |
|
|
<PRE>Object <B>modelNode</B></PRE>
|
647 |
|
|
<UL>
|
648 |
|
|
|
649 |
|
|
|
650 |
|
|
</UL>
|
651 |
|
|
<HR>
|
652 |
|
|
|
653 |
|
|
<A NAME="namespace"><!-- --></A>
|
654 |
|
|
<H3>namespace</H3>
|
655 |
|
|
<PRE>Object <B>namespace</B></PRE>
|
656 |
|
|
<UL>
|
657 |
|
|
|
658 |
|
|
|
659 |
|
|
</UL>
|
660 |
|
|
<HR>
|
661 |
|
|
|
662 |
|
|
<A NAME="nodeSelectXpath"><!-- --></A>
|
663 |
|
|
<H3>nodeSelectXpath</H3>
|
664 |
|
|
<PRE>Object <B>nodeSelectXpath</B></PRE>
|
665 |
|
|
<UL>
|
666 |
|
|
|
667 |
|
|
|
668 |
|
|
</UL>
|
669 |
|
|
<HR>
|
670 |
|
|
|
671 |
|
|
<A NAME="parentModel"><!-- --></A>
|
672 |
|
|
<H3>parentModel</H3>
|
673 |
|
|
<PRE>Object <B>parentModel</B></PRE>
|
674 |
|
|
<UL>
|
675 |
|
|
|
676 |
|
|
|
677 |
|
|
</UL>
|
678 |
|
|
<HR>
|
679 |
|
|
|
680 |
|
|
<A NAME="template"><!-- --></A>
|
681 |
|
|
<H3>template</H3>
|
682 |
|
|
<PRE>Object <B>template</B></PRE>
|
683 |
|
|
<UL>
|
684 |
|
|
|
685 |
|
|
|
686 |
|
|
</UL>
|
687 |
|
|
<HR>
|
688 |
|
|
|
689 |
|
|
<A NAME="title"><!-- --></A>
|
690 |
|
|
<H3>title</H3>
|
691 |
|
|
<PRE>Object <B>title</B></PRE>
|
692 |
|
|
<UL>
|
693 |
|
|
|
694 |
|
|
|
695 |
|
|
</UL>
|
696 |
|
|
<HR>
|
697 |
|
|
|
698 |
|
|
<A NAME="url"><!-- --></A>
|
699 |
|
|
<H3>url</H3>
|
700 |
|
|
<PRE>Object <B>url</B></PRE>
|
701 |
|
|
<UL>
|
702 |
|
|
|
703 |
|
|
|
704 |
|
|
</UL>
|
705 |
|
|
<HR>
|
706 |
|
|
|
707 |
|
|
|
708 |
|
|
|
709 |
|
|
<!-- ============ FIELD DETAIL END =========== -->
|
710 |
|
|
|
711 |
|
|
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
|
712 |
|
|
|
713 |
|
|
<A NAME="constructor_detail"><!-- --></A>
|
714 |
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
715 |
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
716 |
|
|
<TD COLSPAN=1>
|
717 |
|
|
<FONT SIZE="+2"><B>Constructor Detail</B></FONT>
|
718 |
|
|
</TD>
|
719 |
|
|
</TR>
|
720 |
|
|
</TABLE>
|
721 |
|
|
|
722 |
|
|
<A NAME="ModelBase()"><!-- --></A><H3>
|
723 |
|
|
ModelBase</H3>
|
724 |
|
|
<PRE><B>ModelBase</B>(modelNode, parentModel)</PRE>
|
725 |
|
|
|
726 |
|
|
|
727 |
|
|
<UL>
|
728 |
|
|
Base Model class to be inherited by all Model objects and provdes methods
|
729 |
|
|
and properties common to all models.
|
730 |
|
|
Stores the XML document as the .doc property of the model.
|
731 |
|
|
Inherits from the Listener class so all models are also listener objects that
|
732 |
|
|
can call registered listeners.
|
733 |
|
|
</UL>
|
734 |
|
|
|
735 |
|
|
|
736 |
|
|
|
737 |
|
|
<UL>
|
738 |
|
|
<B>Parameters:</B>
|
739 |
|
|
|
740 |
|
|
<UL><CODE>modelNode</CODE> - The model's XML object node from the configuration document.
|
741 |
|
|
</UL>
|
742 |
|
|
|
743 |
|
|
<UL><CODE>parentModel</CODE> - The model object that this model belongs to.
|
744 |
|
|
</UL>
|
745 |
|
|
|
746 |
|
|
|
747 |
|
|
</UL>
|
748 |
|
|
|
749 |
|
|
|
750 |
|
|
<!-- Constructor return value(s) -->
|
751 |
|
|
|
752 |
|
|
<!-- End constructor return value(s) -->
|
753 |
|
|
|
754 |
|
|
<!-- ADDITIONAL ATTRIBUTES -->
|
755 |
|
|
|
756 |
|
|
<UL>
|
757 |
|
|
<B>Author:</B> Cameron Shorter <BR/>
|
758 |
|
|
</UL>
|
759 |
|
|
|
760 |
|
|
<HR/>
|
761 |
|
|
<!-- END ADDITIONAL ATTRIBUTES -->
|
762 |
|
|
|
763 |
|
|
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
|
764 |
|
|
|
765 |
|
|
|
766 |
|
|
<!-- ============ METHOD DETAIL START ========== -->
|
767 |
|
|
|
768 |
|
|
<A NAME="method_detail"><!-- --></A>
|
769 |
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
770 |
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
771 |
|
|
<TD COLSPAN=1><FONT SIZE="+2">
|
772 |
|
|
<B>Method Detail</B></FONT>
|
773 |
|
|
</TD>
|
774 |
|
|
</TR>
|
775 |
|
|
</TABLE>
|
776 |
|
|
|
777 |
|
|
<!-- One single method detail entry -->
|
778 |
|
|
|
779 |
|
|
<A NAME="clearModel"><!-- --></A>
|
780 |
|
|
<H3>clearModel</H3>
|
781 |
|
|
<PRE>void <B>clearModel</B>(objRef)</PRE>
|
782 |
|
|
|
783 |
|
|
<UL>Listener registered with the parent model to remove the doc and url
|
784 |
|
|
of child models whenever the parent is reloaded.</UL>
|
785 |
|
|
|
786 |
|
|
|
787 |
|
|
<!-- METHOD PARAMETERS START -->
|
788 |
|
|
|
789 |
|
|
<UL>
|
790 |
|
|
<B>Parameters:</B>
|
791 |
|
|
|
792 |
|
|
<UL><CODE>objRef</CODE> - Pointer to this object.
|
793 |
|
|
</UL>
|
794 |
|
|
|
795 |
|
|
</UL>
|
796 |
|
|
|
797 |
|
|
<!-- METHOD PARAMETERS END -->
|
798 |
|
|
|
799 |
|
|
|
800 |
|
|
|
801 |
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
802 |
|
|
|
803 |
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
804 |
|
|
<HR>
|
805 |
|
|
|
806 |
|
|
<A NAME="createObject"><!-- --></A>
|
807 |
|
|
<H3>createObject</H3>
|
808 |
|
|
<PRE>Object <B>createObject</B>(configNode)</PRE>
|
809 |
|
|
|
810 |
|
|
<UL>Creates all mapbuilder JavaScript objects based on the Object nodes defined
|
811 |
|
|
in the configuration file.
|
812 |
|
|
A reference to the created model is stored as a property of the config.objects
|
813 |
|
|
property using the model's ID; you can always get a reference to a mapbuilder
|
814 |
|
|
object as: "config.objects.objectId"</UL>
|
815 |
|
|
|
816 |
|
|
|
817 |
|
|
<!-- METHOD PARAMETERS START -->
|
818 |
|
|
|
819 |
|
|
<UL>
|
820 |
|
|
<B>Parameters:</B>
|
821 |
|
|
|
822 |
|
|
<UL><CODE>configNode</CODE> - The node from config for the model to be created
|
823 |
|
|
</UL>
|
824 |
|
|
|
825 |
|
|
</UL>
|
826 |
|
|
|
827 |
|
|
<!-- METHOD PARAMETERS END -->
|
828 |
|
|
|
829 |
|
|
|
830 |
|
|
|
831 |
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
832 |
|
|
|
833 |
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
834 |
|
|
<HR>
|
835 |
|
|
|
836 |
|
|
<A NAME="deleteTemplates"><!-- --></A>
|
837 |
|
|
<H3>deleteTemplates</H3>
|
838 |
|
|
<PRE>void <B>deleteTemplates</B>()</PRE>
|
839 |
|
|
|
840 |
|
|
<UL>deletes all template models and clears their widgets</UL>
|
841 |
|
|
|
842 |
|
|
|
843 |
|
|
<!-- METHOD PARAMETERS START -->
|
844 |
|
|
|
845 |
|
|
<!-- METHOD PARAMETERS END -->
|
846 |
|
|
|
847 |
|
|
|
848 |
|
|
|
849 |
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
850 |
|
|
|
851 |
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
852 |
|
|
<HR>
|
853 |
|
|
|
854 |
|
|
<A NAME="finishLoading"><!-- --></A>
|
855 |
|
|
<H3>finishLoading</H3>
|
856 |
|
|
<PRE>void <B>finishLoading</B>()</PRE>
|
857 |
|
|
|
858 |
|
|
<UL>Common steps to be carried out after all manner of model loading
|
859 |
|
|
Called to set the namespace for XPath selections and call the loadModel
|
860 |
|
|
listeners.</UL>
|
861 |
|
|
|
862 |
|
|
|
863 |
|
|
<!-- METHOD PARAMETERS START -->
|
864 |
|
|
|
865 |
|
|
<!-- METHOD PARAMETERS END -->
|
866 |
|
|
|
867 |
|
|
|
868 |
|
|
|
869 |
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
870 |
|
|
|
871 |
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
872 |
|
|
<HR>
|
873 |
|
|
|
874 |
|
|
<A NAME="getProperty"><!-- --></A>
|
875 |
|
|
<H3>getProperty</H3>
|
876 |
|
|
<PRE>Object <B>getProperty</B>(property, defaultValue)</PRE>
|
877 |
|
|
|
878 |
|
|
<UL>Convenient access to Mapbuilder.getProperty</UL>
|
879 |
|
|
|
880 |
|
|
|
881 |
|
|
<!-- METHOD PARAMETERS START -->
|
882 |
|
|
|
883 |
|
|
<UL>
|
884 |
|
|
<B>Parameters:</B>
|
885 |
|
|
|
886 |
|
|
<UL><CODE>property</CODE> - property to get
|
887 |
|
|
</UL>
|
888 |
|
|
|
889 |
|
|
<UL><CODE>default</CODE> - value to use if property is not set
|
890 |
|
|
</UL>
|
891 |
|
|
|
892 |
|
|
</UL>
|
893 |
|
|
|
894 |
|
|
<!-- METHOD PARAMETERS END -->
|
895 |
|
|
|
896 |
|
|
|
897 |
|
|
<UL>
|
898 |
|
|
<B>Returns:</B>
|
899 |
|
|
<UL>
|
900 |
|
|
the value for the property
|
901 |
|
|
</UL>
|
902 |
|
|
</UL>
|
903 |
|
|
|
904 |
|
|
|
905 |
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
906 |
|
|
|
907 |
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
908 |
|
|
<HR>
|
909 |
|
|
|
910 |
|
|
<A NAME="getXpathValue"><!-- --></A>
|
911 |
|
|
<H3>getXpathValue</H3>
|
912 |
|
|
<PRE>Object <B>getXpathValue</B>(objRef,xpath)</PRE>
|
913 |
|
|
|
914 |
|
|
<UL>Get the value of a node as selected by an XPath expression.1</UL>
|
915 |
|
|
|
916 |
|
|
|
917 |
|
|
<!-- METHOD PARAMETERS START -->
|
918 |
|
|
|
919 |
|
|
<UL>
|
920 |
|
|
<B>Parameters:</B>
|
921 |
|
|
|
922 |
|
|
<UL><CODE>objRef</CODE> - Reference to this node.
|
923 |
|
|
</UL>
|
924 |
|
|
|
925 |
|
|
<UL><CODE>xpath</CODE> - XPath of the node to update.
|
926 |
|
|
</UL>
|
927 |
|
|
|
928 |
|
|
</UL>
|
929 |
|
|
|
930 |
|
|
<!-- METHOD PARAMETERS END -->
|
931 |
|
|
|
932 |
|
|
|
933 |
|
|
<UL>
|
934 |
|
|
<B>Returns:</B>
|
935 |
|
|
<UL>
|
936 |
|
|
value of the node or null if XPath does not find a node.
|
937 |
|
|
</UL>
|
938 |
|
|
</UL>
|
939 |
|
|
|
940 |
|
|
|
941 |
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
942 |
|
|
|
943 |
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
944 |
|
|
<HR>
|
945 |
|
|
|
946 |
|
|
<A NAME="init"><!-- --></A>
|
947 |
|
|
<H3>init</H3>
|
948 |
|
|
<PRE>void <B>init</B>(objRef)</PRE>
|
949 |
|
|
|
950 |
|
|
<UL>Listener registered with the parent model to call init listeners when
|
951 |
|
|
the parent model is init'ed</UL>
|
952 |
|
|
|
953 |
|
|
|
954 |
|
|
<!-- METHOD PARAMETERS START -->
|
955 |
|
|
|
956 |
|
|
<UL>
|
957 |
|
|
<B>Parameters:</B>
|
958 |
|
|
|
959 |
|
|
<UL><CODE>objRef</CODE> - Pointer to this object.
|
960 |
|
|
</UL>
|
961 |
|
|
|
962 |
|
|
</UL>
|
963 |
|
|
|
964 |
|
|
<!-- METHOD PARAMETERS END -->
|
965 |
|
|
|
966 |
|
|
|
967 |
|
|
|
968 |
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
969 |
|
|
|
970 |
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
971 |
|
|
<HR>
|
972 |
|
|
|
973 |
|
|
<A NAME="loadModelDoc"><!-- --></A>
|
974 |
|
|
<H3>loadModelDoc</H3>
|
975 |
|
|
<PRE>void <B>loadModelDoc</B>(objRef)</PRE>
|
976 |
|
|
|
977 |
|
|
<UL>Load a Model's document.
|
978 |
|
|
This will only occur if the model.url property is set.
|
979 |
|
|
Calling this method triggers several events:
|
980 |
|
|
modelStatus - to indicate that the model state is changing
|
981 |
|
|
newModel - to give widgets a chance to clear themselves before the doc is loaded
|
982 |
|
|
loadModel - to indicate that the document is loaded successfully</UL>
|
983 |
|
|
|
984 |
|
|
|
985 |
|
|
<!-- METHOD PARAMETERS START -->
|
986 |
|
|
|
987 |
|
|
<UL>
|
988 |
|
|
<B>Parameters:</B>
|
989 |
|
|
|
990 |
|
|
<UL><CODE>objRef</CODE> - Pointer to the model object being loaded.
|
991 |
|
|
</UL>
|
992 |
|
|
|
993 |
|
|
</UL>
|
994 |
|
|
|
995 |
|
|
<!-- METHOD PARAMETERS END -->
|
996 |
|
|
|
997 |
|
|
|
998 |
|
|
|
999 |
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
1000 |
|
|
|
1001 |
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
1002 |
|
|
<HR>
|
1003 |
|
|
|
1004 |
|
|
<A NAME="loadObjects"><!-- --></A>
|
1005 |
|
|
<H3>loadObjects</H3>
|
1006 |
|
|
<PRE>void <B>loadObjects</B>(objectXpath)</PRE>
|
1007 |
|
|
|
1008 |
|
|
<UL>Creates all the mapbuilder objects from the config file as selected by the
|
1009 |
|
|
XPath value passed in.</UL>
|
1010 |
|
|
|
1011 |
|
|
|
1012 |
|
|
<!-- METHOD PARAMETERS START -->
|
1013 |
|
|
|
1014 |
|
|
<UL>
|
1015 |
|
|
<B>Parameters:</B>
|
1016 |
|
|
|
1017 |
|
|
<UL><CODE>objectXpath</CODE> - The XPath for the set of nodes being created
|
1018 |
|
|
</UL>
|
1019 |
|
|
|
1020 |
|
|
</UL>
|
1021 |
|
|
|
1022 |
|
|
<!-- METHOD PARAMETERS END -->
|
1023 |
|
|
|
1024 |
|
|
|
1025 |
|
|
|
1026 |
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
1027 |
|
|
|
1028 |
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
1029 |
|
|
<HR>
|
1030 |
|
|
|
1031 |
|
|
<A NAME="newRequest"><!-- --></A>
|
1032 |
|
|
<H3>newRequest</H3>
|
1033 |
|
|
<PRE>void <B>newRequest</B>(objRef, httpPayload)</PRE>
|
1034 |
|
|
|
1035 |
|
|
<UL>Load XML for a model from an httpPayload object. This will also handle
|
1036 |
|
|
instantiating template models if they have the "template" attribute set.
|
1037 |
|
|
To update model data, use:<br/>
|
1038 |
|
|
httpPayload=new Object();<br/>
|
1039 |
|
|
httpPayload.url="url" or null. If set to null, all dependant widgets
|
1040 |
|
|
will be removed from the display.<br/>
|
1041 |
|
|
httpPayload.httpMethod="post" or "get"<br/>
|
1042 |
|
|
httpPayload.postData=XML or null<br/></UL>
|
1043 |
|
|
|
1044 |
|
|
|
1045 |
|
|
<!-- METHOD PARAMETERS START -->
|
1046 |
|
|
|
1047 |
|
|
<UL>
|
1048 |
|
|
<B>Parameters:</B>
|
1049 |
|
|
|
1050 |
|
|
<UL><CODE>objRef</CODE> - Pointer to the model object being loaded.
|
1051 |
|
|
</UL>
|
1052 |
|
|
|
1053 |
|
|
<UL><CODE>httpPayload</CODE> - an object to fully specify the request to be made
|
1054 |
|
|
</UL>
|
1055 |
|
|
|
1056 |
|
|
</UL>
|
1057 |
|
|
|
1058 |
|
|
<!-- METHOD PARAMETERS END -->
|
1059 |
|
|
|
1060 |
|
|
|
1061 |
|
|
|
1062 |
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
1063 |
|
|
|
1064 |
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
1065 |
|
|
<HR>
|
1066 |
|
|
|
1067 |
|
|
<A NAME="parseConfig"><!-- --></A>
|
1068 |
|
|
<H3>parseConfig</H3>
|
1069 |
|
|
<PRE>void <B>parseConfig</B>(objRef)</PRE>
|
1070 |
|
|
|
1071 |
|
|
<UL>Initialization of all javascript model, widget and tool objects for this model.
|
1072 |
|
|
Calling this method triggers an init event for this model.</UL>
|
1073 |
|
|
|
1074 |
|
|
|
1075 |
|
|
<!-- METHOD PARAMETERS START -->
|
1076 |
|
|
|
1077 |
|
|
<UL>
|
1078 |
|
|
<B>Parameters:</B>
|
1079 |
|
|
|
1080 |
|
|
<UL><CODE>objRef</CODE> - Pointer to this object.
|
1081 |
|
|
</UL>
|
1082 |
|
|
|
1083 |
|
|
</UL>
|
1084 |
|
|
|
1085 |
|
|
<!-- METHOD PARAMETERS END -->
|
1086 |
|
|
|
1087 |
|
|
|
1088 |
|
|
|
1089 |
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
1090 |
|
|
|
1091 |
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
1092 |
|
|
<HR>
|
1093 |
|
|
|
1094 |
|
|
<A NAME="refresh"><!-- --></A>
|
1095 |
|
|
<H3>refresh</H3>
|
1096 |
|
|
<PRE>void <B>refresh</B>(objRef)</PRE>
|
1097 |
|
|
|
1098 |
|
|
<UL>Listener registered with the parent model to call refresh listeners when
|
1099 |
|
|
the model document is loaded</UL>
|
1100 |
|
|
|
1101 |
|
|
|
1102 |
|
|
<!-- METHOD PARAMETERS START -->
|
1103 |
|
|
|
1104 |
|
|
<UL>
|
1105 |
|
|
<B>Parameters:</B>
|
1106 |
|
|
|
1107 |
|
|
<UL><CODE>objRef</CODE> - Pointer to this object.
|
1108 |
|
|
</UL>
|
1109 |
|
|
|
1110 |
|
|
</UL>
|
1111 |
|
|
|
1112 |
|
|
<!-- METHOD PARAMETERS END -->
|
1113 |
|
|
|
1114 |
|
|
|
1115 |
|
|
|
1116 |
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
1117 |
|
|
|
1118 |
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
1119 |
|
|
<HR>
|
1120 |
|
|
|
1121 |
|
|
<A NAME="saveModel"><!-- --></A>
|
1122 |
|
|
<H3>saveModel</H3>
|
1123 |
|
|
<PRE>void <B>saveModel</B>(objRef)</PRE>
|
1124 |
|
|
|
1125 |
|
|
<UL>save the model by posting it to the serializeUrl, which is defined as a
|
1126 |
|
|
property of config.</UL>
|
1127 |
|
|
|
1128 |
|
|
|
1129 |
|
|
<!-- METHOD PARAMETERS START -->
|
1130 |
|
|
|
1131 |
|
|
<UL>
|
1132 |
|
|
<B>Parameters:</B>
|
1133 |
|
|
|
1134 |
|
|
<UL><CODE>objRef</CODE> - Pointer to this object.
|
1135 |
|
|
</UL>
|
1136 |
|
|
|
1137 |
|
|
</UL>
|
1138 |
|
|
|
1139 |
|
|
<!-- METHOD PARAMETERS END -->
|
1140 |
|
|
|
1141 |
|
|
|
1142 |
|
|
|
1143 |
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
1144 |
|
|
|
1145 |
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
1146 |
|
|
<HR>
|
1147 |
|
|
|
1148 |
|
|
<A NAME="setModel"><!-- --></A>
|
1149 |
|
|
<H3>setModel</H3>
|
1150 |
|
|
<PRE>void <B>setModel</B>(objRef,newModel)</PRE>
|
1151 |
|
|
|
1152 |
|
|
<UL>Set the model's XML document using an XML object as a parameter.</UL>
|
1153 |
|
|
|
1154 |
|
|
|
1155 |
|
|
<!-- METHOD PARAMETERS START -->
|
1156 |
|
|
|
1157 |
|
|
<UL>
|
1158 |
|
|
<B>Parameters:</B>
|
1159 |
|
|
|
1160 |
|
|
<UL><CODE>objRef</CODE> - Pointer to this object.
|
1161 |
|
|
</UL>
|
1162 |
|
|
|
1163 |
|
|
<UL><CODE>newModel</CODE> - XML object to be inserted into the new model.
|
1164 |
|
|
</UL>
|
1165 |
|
|
|
1166 |
|
|
</UL>
|
1167 |
|
|
|
1168 |
|
|
<!-- METHOD PARAMETERS END -->
|
1169 |
|
|
|
1170 |
|
|
|
1171 |
|
|
|
1172 |
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
1173 |
|
|
|
1174 |
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
1175 |
|
|
<HR>
|
1176 |
|
|
|
1177 |
|
|
<A NAME="setXpathValue"><!-- --></A>
|
1178 |
|
|
<H3>setXpathValue</H3>
|
1179 |
|
|
<PRE>Object <B>setXpathValue</B>(objRef,xpath,value,refresh)</PRE>
|
1180 |
|
|
|
1181 |
|
|
<UL>Update the value of a node within this model's XML document.
|
1182 |
|
|
Triggers a refresh event from the model.</UL>
|
1183 |
|
|
|
1184 |
|
|
|
1185 |
|
|
<!-- METHOD PARAMETERS START -->
|
1186 |
|
|
|
1187 |
|
|
<UL>
|
1188 |
|
|
<B>Parameters:</B>
|
1189 |
|
|
|
1190 |
|
|
<UL><CODE>objRef</CODE> - Reference to this node.
|
1191 |
|
|
</UL>
|
1192 |
|
|
|
1193 |
|
|
<UL><CODE>xpath</CODE> - Xpath of the node to update.
|
1194 |
|
|
</UL>
|
1195 |
|
|
|
1196 |
|
|
<UL><CODE>value</CODE> - Node's new value.
|
1197 |
|
|
</UL>
|
1198 |
|
|
|
1199 |
|
|
<UL><CODE>refresh</CODE> - determines if the model should be refreshed (optional).
|
1200 |
|
|
</UL>
|
1201 |
|
|
|
1202 |
|
|
</UL>
|
1203 |
|
|
|
1204 |
|
|
<!-- METHOD PARAMETERS END -->
|
1205 |
|
|
|
1206 |
|
|
|
1207 |
|
|
<UL>
|
1208 |
|
|
<B>Returns:</B>
|
1209 |
|
|
<UL>
|
1210 |
|
|
Returns false if Xpath does not find a node.
|
1211 |
|
|
</UL>
|
1212 |
|
|
</UL>
|
1213 |
|
|
|
1214 |
|
|
|
1215 |
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
1216 |
|
|
|
1217 |
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
1218 |
|
|
<HR>
|
1219 |
|
|
|
1220 |
|
|
|
1221 |
|
|
|
1222 |
|
|
<!-- ============ METHOD DETAIL END ========== -->
|
1223 |
|
|
|
1224 |
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
1225 |
|
|
|
1226 |
|
|
<!-- ========== START OF NAVBAR ========== -->
|
1227 |
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
1228 |
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
1229 |
|
|
<TR>
|
1230 |
|
|
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
1231 |
|
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
1232 |
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
1233 |
|
|
<TR ALIGN="center" VALIGN="top">
|
1234 |
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
1235 |
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary-ModelBase.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD>
|
1236 |
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
1237 |
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><b>Tree</b></FONT></A> </TD>
|
1238 |
|
|
<!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD-->
|
1239 |
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
1240 |
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
1241 |
|
|
</TR>
|
1242 |
|
|
</TABLE>
|
1243 |
|
|
</TD>
|
1244 |
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
1245 |
|
|
<B><a href='http://mapbuilder.sourceforge.net'>Community Map Builder</a> 27 Apr 2008</B>
|
1246 |
|
|
</EM>
|
1247 |
|
|
</TD
|
1248 |
|
|
</TR>
|
1249 |
|
|
|
1250 |
|
|
<TR>
|
1251 |
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
1252 |
|
|
<A HREF="Model.html"><B>PREV CLASS</B></A><!--
|
1253 |
|
|
NEXT CLASS
|
1254 |
|
|
-->
|
1255 |
|
|
<A HREF="ModelStatus.html"><B>NEXT CLASS</B></A></FONT></TD>
|
1256 |
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
1257 |
|
|
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
|
1258 |
|
|
<A HREF="ModelBase.html" TARGET="_top"><B>NO FRAMES</B></A>
|
1259 |
|
|
|
1260 |
|
|
<SCRIPT>
|
1261 |
|
|
<!--
|
1262 |
|
|
if(window==top) {
|
1263 |
|
|
document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
|
1264 |
|
|
}
|
1265 |
|
|
//-->
|
1266 |
|
|
</SCRIPT>
|
1267 |
|
|
<NOSCRIPT>
|
1268 |
|
|
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
|
1269 |
|
|
</NOSCRIPT>
|
1270 |
|
|
</FONT></TD>
|
1271 |
|
|
</TR>
|
1272 |
|
|
<TR>
|
1273 |
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
1274 |
|
|
SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
1275 |
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
1276 |
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
1277 |
|
|
</TR>
|
1278 |
|
|
</TABLE>
|
1279 |
|
|
|
1280 |
|
|
<!-- =========== END OF NAVBAR =========== -->
|
1281 |
|
|
|
1282 |
|
|
<HR>
|
1283 |
|
|
<FONT SIZE="-1">
|
1284 |
|
|
|
1285 |
|
|
</FONT>
|
1286 |
|
|
<div class="jsdoc_ctime">Documentation generated by <a href="http://jsdoc.sourceforge.net/" target="_parent">JSDoc</a> on Sun Apr 27 20:30:54 2008</div>
|
1287 |
|
|
</BODY>
|
1288 |
|
|
</HTML>
|