Project

General

Profile

1
<!doctype html public "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
2
<html>
3
<head>
4
<title>
5
<a href='http://mapbuilder.sourceforge.net'>Community Map Builder</a> 27 Apr 2008 Overview
6
</title>
7
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
8
<script>
9
function asd() {
10
	
11
		parent.document.title="EditButtonBase.js Overview";
12
	
13
}
14
</script>
15
</head>
16
<body bgcolor="white" onload="asd();">
17

    
18
<!-- ========== START OF NAVBAR ========== -->
19
<a name="navbar_top"><!-- --></a>
20
<table border="0" width="100%" cellpadding="1" cellspacing="0">
21
<tr>
22
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
23
<a name="navbar_top_firstrow"><!-- --></a>
24
<table border="0" cellpadding="0" cellspacing="3">
25
  <tr align="center" valign="top">
26
  
27
  
28
  <td bgcolor="#EEEEFF" class="NavBarCell1">    <a href="overview-summary.html"><font class="NavBarFont1"><b>Overview</b></font></a>&nbsp;</td>
29
  <td bgcolor="#FFFFFF" class="NavBarCell1Rev">	&nbsp;<font class="NavBarFont1Rev"><b>File</b></font>&nbsp;</td>
30
  
31

    
32
  <td bgcolor="#FFFFFF" class="NavBarCell1"> 	<font class="NavBarFont1">Class</font>&nbsp;</td>
33
  <td bgcolor="#EEEEFF" class="NavBarCell1">    <a href="overview-tree.html"><font class="NavBarFont1"><b>Tree</b></font></a>&nbsp;</td>
34
  <td bgcolor="#EEEEFF" class="NavBarCell1">    <a href="index-all.html"--><font class="NavBarFont1"><b>Index</b></font></a>&nbsp;</td>
35
  <td bgcolor="#EEEEFF" class="NavBarCell1">    <a href="help-doc.html"><font class="NavBarFont1"><b>Help</b></font></a>&nbsp;</td>
36
  </tr>
37
</table>
38
</td>
39
<td bgcolor="#EEEEFF" align="right" valign="top">
40
<em>
41
<b><a href='http://mapbuilder.sourceforge.net'>Community Map Builder</a> 27 Apr 2008</b></em>
42
</td>
43
</tr>
44

    
45
<tr>
46
<td bgcolor="white" class="NavBarCell2"><font size="-2">
47
&nbsp;PREV&nbsp;
48
&nbsp;NEXT</font></td>
49
<td bgcolor="white" class="NavBarCell2"><font size="-2">
50
  <a href="index.html" target="_top"><b>FRAMES</b></a>  &nbsp;
51
&nbsp;<a href="overview-summary.html" target="_top"><b>NO FRAMES</b></a>
52
&nbsp;&nbsp;
53
<script>
54
  <!--
55
  if(window==top) {
56
    document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
57
  }
58
  //-->
59
</script>
60
<noscript>
61
<a href="allclasses-noframe.html" target=""><b>All Classes</b></a>
62
</noscript>
63
</font></td>
64
</tr>
65
</table>
66
<!-- =========== END OF NAVBAR =========== -->
67

    
68
<hr>
69
<center>
70
	
71
	   <h2>EditButtonBase.js</h2>
72
	
73
</center>
74

    
75
	
76

    
77

    
78
<h4>Summary</h4>
79
<p>
80
	
81
		No overview generated for 'EditButtonBase.js'<BR/><BR/>
82
	
83
</p>
84

    
85
<hr>
86

    
87

    
88
    <table border="1" cellpadding="3" cellspacing="0" width="100%">
89
    <tr bgcolor="#CCCCFF" class="TableHeadingColor">
90
    <td colspan=2><font size="+2">
91
    
92
        <b>Class Summary</b>
93
    
94
    </font></td>
95
    </tr>
96
    
97
    <tr bgcolor="white" class="TableRowColor">
98
    <td width="15%"><b><a href="EditButtonBase.html">EditButtonBase</a></b></td>
99
    <td>&nbsp;</td>
100
    </tr>
101
    
102
    </table>
103
    <hr/> 
104

    
105

    
106
<!-- ========== METHOD SUMMARY =========== -->
107

    
108
<!-- ========== END METHOD SUMMARY =========== -->
109

    
110

    
111
        <pre class="sourceview"><span class="comment">/*
112
License: LGPL as per: http://www.gnu.org/copyleft/lesser.html
113
$Id: EditButtonBase.js 3879 2008-02-27 14:20:29Z gjvoosten $
114
*/</span>
115
<span class="comment">
116
// Ensure this object's dependancies are loaded.</span>
117
mapbuilder.loadScript(baseDir+<span class="literal">"/widget/ButtonBase.js"</span>);
118

    
119
<span class="comment">/**
120
 * Base class for tools which update GML by clicking on the mapPane.
121
 * <span class="attrib">@constructor</span>
122
 * <span class="attrib">@base</span> ButtonBase
123
 * <span class="attrib">@author</span> Cameron Shorter cameronATshorter.net
124
 * <span class="attrib">@param</span> widgetNode The node from the Config XML file.
125
 * <span class="attrib">@param</span> model  The ButtonBar widget.
126
 */</span>
127
<span class="reserved">function</span> EditButtonBase(widgetNode, model) {
128
<span class="comment">  // Extend ButtonBase</span>
129
  ButtonBase.apply(<span class="reserved">this</span>, new Array(widgetNode, model));
130
<span class="comment">
131
  // override default cursor by user</span>
132
<span class="comment">  // cursor can be changed by specifying a new cursor in config file</span>
133
  <span class="reserved">this</span>.cursor = <span class="literal">"crosshair"</span>; 
134

    
135
  <span class="reserved">this</span>.trm=<span class="reserved">this</span>.getProperty(<span class="literal">"mb:transactionResponseModel"</span>);
136

    
137
  <span class="comment">/** Empty GML to load when this tool is selected. */</span>
138
  <span class="reserved">this</span>.defaultModelUrl=<span class="reserved">this</span>.getProperty(<span class="literal">"mb:defaultModelUrl"</span>);
139

    
140
  <span class="comment">/** Reference to GML node to update when a feature is added. */</span>
141
  <span class="reserved">this</span>.featureXpath=<span class="reserved">this</span>.getProperty(<span class="literal">"mb:featureXpath"</span>);
142

    
143
  <span class="comment">/** Should a new empty feature be appended after creating one? */</span>
144
  <span class="reserved">this</span>.appendOnEdit = Mapbuilder.parseBoolean(<span class="reserved">this</span>.getProperty(<span class="literal">"mb:appendOnEdit"</span>, true));
145

    
146
  <span class="comment">/**
147
   * OpenLayers DrawFeature control.
148
   * <span class="attrib">@param</span> objRef reference to this object.
149
   * <span class="attrib">@return</span> {OpenLayers.Control} class of the OL control.
150
   */</span>
151
  <span class="reserved">this</span>.createControl = <span class="reserved">function</span>(objRef) {
152
    <span class="reserved">return</span> OpenLayers.Control.DrawFeature;
153
  }
154
  
155
  <span class="comment">/**
156
   * If tool is selected and the Edit Tool has changed (eg, changed from
157
   * LineEdit to PointEdit) then load new default feature.
158
   * This function is called when a tool is selected or deselected.
159
   * <span class="attrib">@param</span> objRef Pointer to this object.
160
   * <span class="attrib">@param</span> selected True when selected.
161
   */</span>
162
  <span class="reserved">this</span>.doSelect = <span class="reserved">function</span>(objRef, selected) {
163
    <span class="reserved">if</span> (objRef.control.active) {
164
<span class="comment">      // Model that will be populated with the WFS response.</span>
165
      <span class="reserved">if</span> (objRef.trm &amp;&amp; !objRef.transactionResponseModel){
166
        objRef.transactionResponseModel=window.config.objects[objRef.trm];
167
      }
168
<span class="comment">      // Remove the transactionResponseModel (and result of last transaction)</span>
169
<span class="comment">      // when a transaction button is deselected</span>
170
      <span class="reserved">if</span>(!selected &amp;&amp; objRef.transactionResponseModel){
171
        objRef.transactionResponseModel.setModel(objRef.transactionResponseModel,null);
172
      }
173
      
174
      config.loadModel(objRef.targetModel.id, objRef.defaultModelUrl);
175
    }
176
  }
177
  
178
  <span class="comment">/**
179
   * start a new editing session
180
   * <span class="attrib">@param</span> objRef reference to this widget
181
   */</span>
182
  <span class="reserved">this</span>.newSession = <span class="reserved">function</span>(objRef) {
183
    objRef.modified = false;
184
  }
185

    
186
  <span class="comment">/**
187
   * This is called by the OL onFeatureInsert handler. It will
188
   * call the superclass's setFeature() method to handle the
189
   * created feature.
190
   * <span class="attrib">@param</span> feature OpenLayers feature
191
   */</span>
192
  <span class="reserved">this</span>.handleFeatureInsert = <span class="reserved">function</span>(feature) {
193
<span class="comment">    // use the objRef reference stored by setEditingLayer()</span>
194
    var objRef = feature.layer.mbButton;
195
    objRef.feature = OpenLayers.Util.extend({}, feature);
196
    objRef.geometry = OpenLayers.Util.extend({}, feature.geometry);
197
    
198
    var previousFeatureNode = objRef.targetModel.doc.selectSingleNode(<span class="literal">"/*/*"</span>).cloneNode(true);
199
<span class="comment">
200
    // add a new empty node if this is not the first feature</span>
201
    <span class="reserved">if</span> (objRef.modified &amp;&amp; objRef.appendOnEdit) {
202
      objRef.targetModel.doc.selectSingleNode(<span class="literal">"/*"</span>).appendChild(previousFeatureNode);
203
    }
204

    
205
    objRef.setFeature(objRef);
206
    objRef.modified = true;
207
<span class="comment">    
208
    // destroy the feature in OL, because we do not use</span>
209
<span class="comment">    // the OL vector layer for displaying the feature</span>
210
    feature.mbSelectStyle = null;
211
    feature.destroy();
212
  }
213

    
214
  <span class="comment">/**
215
   * Set editing layer and register for editing events in OL,
216
   * called after model loads.
217
   * <span class="attrib">@param</span> objRef Pointer to this object.
218
   */</span>
219
  <span class="reserved">this</span>.setEditingLayer = <span class="reserved">function</span>(objRef) {
220
    <span class="reserved">if</span> (!objRef.targetContext.featureLayers[objRef.id]) {
221
      objRef.featureLayer = new OpenLayers.Layer.Vector(objRef.id);
222
<span class="comment">      // layer should always be visible, independent of the resolution</span>
223
      objRef.featureLayer.calculateInRange = <span class="reserved">function</span>() {<span class="reserved">return</span> true;};
224
<span class="comment">      // set objRef as mbButton attribute of the OL featureLayer,</span>
225
<span class="comment">      // because we otherwise don't have it available in</span>
226
<span class="comment">      // handleFeatureInsert()</span>
227
      objRef.featureLayer.mbButton = objRef;
228
      objRef.targetContext.featureLayers[objRef.id] = objRef.featureLayer;
229
<span class="comment">      // register OL event handler</span>
230
      objRef.featureLayer.onFeatureInsert = objRef.handleFeatureInsert;
231
    }
232
  }
233

    
234
  <span class="comment">/**
235
   * Add a geometry to the enclosing GML model.
236
   * <span class="attrib">@param</span> objRef      Pointer to this object.
237
   */</span>
238
  <span class="reserved">this</span>.setFeature = <span class="reserved">function</span>(objRef) {
239
    <span class="reserved">if</span> (!objRef.enabled) {
240
      <span class="reserved">return</span>;
241
    }
242

    
243
    var gml = new OpenLayers.Format.GML().write([objRef.feature]);
244
    var gmlDoc = Sarissa.getDomDocument();
245
    gmlDoc = (new DOMParser()).parseFromString(gml, <span class="literal">"text/xml"</span>);
246
    <span class="reserved">if</span> (objRef.targetModel.namespace) {
247
      Sarissa.setXpathNamespaces(gmlDoc, objRef.targetModel.namespace);
248
    }
249
    var insertPoint = objRef.featureXpath.lastIndexOf(<span class="literal">"/"</span>)+1;
250
    var insertXpath = objRef.featureXpath.substring(insertPoint);
251
    var insertNode = gmlDoc.selectSingleNode(<span class="literal">"//"</span>+insertXpath);
252
    <span class="reserved">if</span> (!insertNode) {
253
      insertNode = gmlDoc.selectSingleNode(<span class="literal">"//gml:featureMember/*/*"</span>);
254
    }
255
    var targetNode = objRef.targetModel.doc.selectSingleNode(objRef.featureXpath);
256
    <span class="reserved">if</span> (targetNode.childNodes.length &gt; 0) {
257
      targetNode.removeChild(targetNode.firstChild);
258
    }
259

    
260
    try {
261
      Sarissa.copyChildNodes(insertNode, targetNode);
262
    } catch(e) {
263
      alert(mbGetMessage(<span class="literal">"invalidFeatureXpathEditLine"</span>, objRef.featureXpath));      
264
    }
265
    objRef.targetModel.setParam(<span class="literal">"refresh"</span>);
266
  }
267

    
268
  <span class="comment">/**
269
   * Create the array that will hold all OL feature layers
270
   * for editing buttons. Also register event handler to
271
   * create feature layers when the OL map is available.
272
   * <span class="attrib">@param</span> objRef Pointer to this object.
273
   */</span>
274
  <span class="reserved">this</span>.initButton = <span class="reserved">function</span>(objRef) {
275
<span class="comment">    // initialize feature layers for the context.</span>
276
<span class="comment">    // each editing button gets its own feature layer,</span>
277
<span class="comment">    // which is not used for displaying the features,</span>
278
<span class="comment">    // because the transaction response model has its</span>
279
<span class="comment">    // own feature renderer.</span>
280
    <span class="reserved">if</span> (!objRef.targetContext.featureLayers) {
281
<span class="comment">    	// this array in the context will hold all</span>
282
<span class="comment">    	// featureLayers used by editButton widgets</span>
283
    	objRef.targetContext.featureLayers = new Array();
284
    }
285
<span class="comment">    
286
    // feature layers will be created when the OL map is available</span>
287
    objRef.targetContext.addFirstListener(<span class="literal">"refresh"</span>,objRef.setEditingLayer, objRef);
288

    
289
    objRef.targetModel.addListener(<span class="literal">"loadModel"</span>, objRef.newSession, objRef);
290
  }
291
  <span class="reserved">this</span>.model.addListener(<span class="literal">"init"</span>,<span class="reserved">this</span>.initButton, <span class="reserved">this</span>);
292
}
293
</pre>
294
	<hr>
295

    
296

    
297

    
298
<!-- ========== START OF NAVBAR ========== -->
299
<a name="navbar_top"><!-- --></a>
300
<table border="0" width="100%" cellpadding="1" cellspacing="0">
301
<tr>
302
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
303
<a name="navbar_top_firstrow"><!-- --></a>
304
<table border="0" cellpadding="0" cellspacing="3">
305
  <tr align="center" valign="top">
306
  
307
  
308
  <td bgcolor="#EEEEFF" class="NavBarCell1">    <a href="overview-summary.html"><font class="NavBarFont1"><b>Overview</b></font></a>&nbsp;</td>
309
  <td bgcolor="#FFFFFF" class="NavBarCell1Rev">	&nbsp;<font class="NavBarFont1Rev"><b>File</b></font>&nbsp;</td>
310
  
311

    
312
  <td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</font>&nbsp;</td>
313
  <td bgcolor="#EEEEFF" class="NavBarCell1">    <a href="overview-tree.html"><font class="NavBarFont1"><b>Tree</b></font></a>&nbsp;</td>
314
  <td bgcolor="#EEEEFF" class="NavBarCell1">    <a href="index-all.html"--><font class="NavBarFont1"><b>Index</b></font></a>&nbsp;</td>
315
  <td bgcolor="#EEEEFF" class="NavBarCell1">    <a href="help-doc.html"><font class="NavBarFont1"><b>Help</b></font></a>&nbsp;</td>
316
  </tr>
317
</table>
318
</td>
319
<td bgcolor="#EEEEFF" align="right" valign="top"><em>
320
<b><a href='http://mapbuilder.sourceforge.net'>Community Map Builder</a> 27 Apr 2008</b></em>
321
</td>
322
</tr>
323

    
324
<tr>
325
<td bgcolor="white" class="NavBarCell2"><font size="-2">
326
&nbsp;PREV&nbsp;
327
&nbsp;NEXT</font></td>
328
<td bgcolor="white" class="NavBarCell2"><font size="-2">
329
  <a href="index.html" target="_top"><b>FRAMES</b></a>  &nbsp;
330
&nbsp;<a href="overview-summary.html" target="_top"><b>NO FRAMES</b></a>
331
&nbsp;&nbsp;
332
<script>
333
  <!--
334
  if(window==top) {
335
    document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
336
  }
337
  //-->
338
</script>
339
<noscript>
340
<a href="allclasses-noframe.html" target=""><b>All Classes</b></a>
341
</noscript>
342
</font></td>
343
</tr>
344
</table>
345
<!-- =========== END OF NAVBAR =========== -->
346

    
347
<hr>
348
<font size="-1">
349

    
350
</font>
351
<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>
352
</body>
353
</html>
(228-228/316)