The real release 0.46 :-)
[awl.git] / docs / api / awl / classEditor / EditorField.html
blobac2160fbdc4fccf0231e14d738f23dae8ea84919
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <!-- template designed by Marco Von Ballmoos -->
6 <title>Docs For Class EditorField</title>
7 <link rel="stylesheet" href="../../media/stylesheet.css" />
8 <script src="../../media/lib/classTree.js"></script>
9 <script language="javascript" type="text/javascript">
10 var imgPlus = new Image();
11 var imgMinus = new Image();
12 imgPlus.src = "../../media/images/plus.png";
13 imgMinus.src = "../../media/images/minus.png";
15 function showNode(Node){
16 switch(navigator.family){
17 case 'nn4':
18 // Nav 4.x code fork...
19 var oTable = document.layers["span" + Node];
20 var oImg = document.layers["img" + Node];
21 break;
22 case 'ie4':
23 // IE 4/5 code fork...
24 var oTable = document.all["span" + Node];
25 var oImg = document.all["img" + Node];
26 break;
27 case 'gecko':
28 // Standards Compliant code fork...
29 var oTable = document.getElementById("span" + Node);
30 var oImg = document.getElementById("img" + Node);
31 break;
33 oImg.src = imgMinus.src;
34 oTable.style.display = "block";
37 function hideNode(Node){
38 switch(navigator.family){
39 case 'nn4':
40 // Nav 4.x code fork...
41 var oTable = document.layers["span" + Node];
42 var oImg = document.layers["img" + Node];
43 break;
44 case 'ie4':
45 // IE 4/5 code fork...
46 var oTable = document.all["span" + Node];
47 var oImg = document.all["img" + Node];
48 break;
49 case 'gecko':
50 // Standards Compliant code fork...
51 var oTable = document.getElementById("span" + Node);
52 var oImg = document.getElementById("img" + Node);
53 break;
55 oImg.src = imgPlus.src;
56 oTable.style.display = "none";
59 function nodeIsVisible(Node){
60 switch(navigator.family){
61 case 'nn4':
62 // Nav 4.x code fork...
63 var oTable = document.layers["span" + Node];
64 break;
65 case 'ie4':
66 // IE 4/5 code fork...
67 var oTable = document.all["span" + Node];
68 break;
69 case 'gecko':
70 // Standards Compliant code fork...
71 var oTable = document.getElementById("span" + Node);
72 break;
74 return (oTable && oTable.style.display == "block");
77 function toggleNodeVisibility(Node){
78 if (nodeIsVisible(Node)){
79 hideNode(Node);
80 }else{
81 showNode(Node);
84 </script>
85 </head>
86 <body>
87 <div class="page-body">
88 <h2 class="class-name"><img src="../../media/images/Class_logo.png"
89 alt=" Class"
90 title=" Class"
91 style="vertical-align: middle"> EditorField</h2>
93 <a name="sec-description"></a>
94 <div class="info-box">
95 <div class="info-box-title">Description</div>
96 <div class="nav-bar">
97 <span class="disabled">Description</span> |
98 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
99 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
101 </div>
102 <div class="info-box-body">
103 <!-- ========== Info from phpDoc block ========= -->
104 <p class="short-description">A class for the fields in the editor</p>
105 <p class="notes">
106 Located in <a class="field" href="_classEditor.php.html">/classEditor.php</a> (line <span class="field">19</span>)
107 </p>
110 <pre></pre>
112 </div>
113 </div>
117 <a name="sec-var-summary"></a>
118 <div class="info-box">
119 <div class="info-box-title">Variable Summary</span></div>
120 <div class="nav-bar">
121 <a href="#sec-description">Description</a> |
122 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
124 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
126 </div>
127 <div class="info-box-body">
128 <div class="var-summary">
129 <div class="var-title">
130 <img src="../../media/images/Variable.png" alt=" " />
131 <span class="var-type">mixed</span>
132 <a href="#$Attributes" title="details" class="var-name">$Attributes</a>
133 </div>
134 <div class="var-title">
135 <img src="../../media/images/Variable.png" alt=" " />
136 <span class="var-type">mixed</span>
137 <a href="#$Field" title="details" class="var-name">$Field</a>
138 </div>
139 <div class="var-title">
140 <img src="../../media/images/Variable.png" alt=" " />
141 <span class="var-type">mixed</span>
142 <a href="#$LookupSql" title="details" class="var-name">$LookupSql</a>
143 </div>
144 <div class="var-title">
145 <img src="../../media/images/Variable.png" alt=" " />
146 <span class="var-type">mixed</span>
147 <a href="#$OptionList" title="details" class="var-name">$OptionList</a>
148 </div>
149 <div class="var-title">
150 <img src="../../media/images/Variable.png" alt=" " />
151 <span class="var-type">mixed</span>
152 <a href="#$Sql" title="details" class="var-name">$Sql</a>
153 </div>
154 <div class="var-title">
155 <img src="../../media/images/Variable.png" alt=" " />
156 <span class="var-type">mixed</span>
157 <a href="#$Value" title="details" class="var-name">$Value</a>
158 </div>
159 </div>
160 </div>
161 </div>
163 <a name="sec-method-summary"></a>
164 <div class="info-box">
165 <div class="info-box-title">Method Summary</span></div>
166 <div class="nav-bar">
167 <a href="#sec-description">Description</a> |
168 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
171 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
172 </div>
173 <div class="info-box-body">
174 <div class="method-summary">
176 <div class="method-definition">
177 <img src="../../media/images/Constructor.png" alt=" "/>
178 <span class="method-result">EditorField</span>
179 <a href="#__construct" title="details" class="method-name">__construct</a>
180 (<span class="var-type"></span>&nbsp;<span class="var-name">$field</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$sql</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$lookup_sql</span> = <span class="var-default">&quot;&quot;</span>])
181 </div>
183 <div class="method-definition">
184 <img src="../../media/images/Method.png" alt=" "/>
185 <span class="method-result">void</span>
186 <a href="#AddAttribute" title="details" class="method-name">AddAttribute</a>
187 (<span class="var-type"></span>&nbsp;<span class="var-name">$k</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$v</span>)
188 </div>
190 <div class="method-definition">
191 <img src="../../media/images/Method.png" alt=" "/>
192 <span class="method-result">void</span>
193 <a href="#GetTarget" title="details" class="method-name">GetTarget</a>
195 </div>
197 <div class="method-definition">
198 <img src="../../media/images/Method.png" alt=" "/>
199 <span class="method-result">void</span>
200 <a href="#RenderAttributes" title="details" class="method-name">RenderAttributes</a>
202 </div>
204 <div class="method-definition">
205 <img src="../../media/images/Method.png" alt=" "/>
206 <span class="method-result">void</span>
207 <a href="#Set" title="details" class="method-name">Set</a>
208 (<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
209 </div>
211 <div class="method-definition">
212 <img src="../../media/images/Method.png" alt=" "/>
213 <span class="method-result">void</span>
214 <a href="#SetLookup" title="details" class="method-name">SetLookup</a>
215 (<span class="var-type"></span>&nbsp;<span class="var-name">$lookup_sql</span>)
216 </div>
218 <div class="method-definition">
219 <img src="../../media/images/Method.png" alt=" "/>
220 <span class="method-result">void</span>
221 <a href="#SetOptionList" title="details" class="method-name">SetOptionList</a>
222 (<span class="var-type"></span>&nbsp;<span class="var-name">$options</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$current</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$parameters</span> = <span class="var-default">null</span>])
223 </div>
225 <div class="method-definition">
226 <img src="../../media/images/Method.png" alt=" "/>
227 <span class="method-result">void</span>
228 <a href="#SetSql" title="details" class="method-name">SetSql</a>
229 (<span class="var-type"></span>&nbsp;<span class="var-name">$sql</span>)
230 </div>
231 </div>
232 </div>
233 </div>
235 <a name="sec-vars"></a>
236 <div class="info-box">
237 <div class="info-box-title">Variables</div>
238 <div class="nav-bar">
239 <a href="#sec-description">Description</a> |
240 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
244 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
246 </div>
247 <div class="info-box-body">
249 <a name="var$Attributes" id="$Attributes"><!-- --></A>
250 <div class="oddrow">
252 <div class="var-header">
253 <img src="../../media/images/Variable.png" />
254 <span class="var-title">
255 <span class="var-type">mixed</span>
256 <span class="var-name">$Attributes</span>
257 (line <span class="line-number">24</span>)
258 </span>
259 </div>
261 <!-- ========== Info from phpDoc block ========= -->
267 </div>
268 <a name="var$Field" id="$Field"><!-- --></A>
269 <div class="evenrow">
271 <div class="var-header">
272 <img src="../../media/images/Variable.png" />
273 <span class="var-title">
274 <span class="var-type">mixed</span>
275 <span class="var-name">$Field</span>
276 (line <span class="line-number">21</span>)
277 </span>
278 </div>
280 <!-- ========== Info from phpDoc block ========= -->
286 </div>
287 <a name="var$LookupSql" id="$LookupSql"><!-- --></A>
288 <div class="oddrow">
290 <div class="var-header">
291 <img src="../../media/images/Variable.png" />
292 <span class="var-title">
293 <span class="var-type">mixed</span>
294 <span class="var-name">$LookupSql</span>
295 (line <span class="line-number">25</span>)
296 </span>
297 </div>
299 <!-- ========== Info from phpDoc block ========= -->
305 </div>
306 <a name="var$OptionList" id="$OptionList"><!-- --></A>
307 <div class="evenrow">
309 <div class="var-header">
310 <img src="../../media/images/Variable.png" />
311 <span class="var-title">
312 <span class="var-type">mixed</span>
313 <span class="var-name">$OptionList</span>
314 (line <span class="line-number">26</span>)
315 </span>
316 </div>
318 <!-- ========== Info from phpDoc block ========= -->
324 </div>
325 <a name="var$Sql" id="$Sql"><!-- --></A>
326 <div class="oddrow">
328 <div class="var-header">
329 <img src="../../media/images/Variable.png" />
330 <span class="var-title">
331 <span class="var-type">mixed</span>
332 <span class="var-name">$Sql</span>
333 (line <span class="line-number">22</span>)
334 </span>
335 </div>
337 <!-- ========== Info from phpDoc block ========= -->
343 </div>
344 <a name="var$Value" id="$Value"><!-- --></A>
345 <div class="evenrow">
347 <div class="var-header">
348 <img src="../../media/images/Variable.png" />
349 <span class="var-title">
350 <span class="var-type">mixed</span>
351 <span class="var-name">$Value</span>
352 (line <span class="line-number">23</span>)
353 </span>
354 </div>
356 <!-- ========== Info from phpDoc block ========= -->
362 </div>
364 </div>
365 </div>
367 <a name="sec-methods"></a>
368 <div class="info-box">
369 <div class="info-box-title">Methods</div>
370 <div class="nav-bar">
371 <a href="#sec-description">Description</a> |
372 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
373 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
375 </div>
376 <div class="info-box-body">
377 <A NAME='method_detail'></A>
378 <a name="method__construct" id="__construct"><!-- --></a>
379 <div class="oddrow">
381 <div class="method-header">
382 <img src="../../media/images/Constructor.png" />
383 <span class="method-title">Constructor __construct</span> (line <span class="line-number">28</span>)
384 </div>
386 <!-- ========== Info from phpDoc block ========= -->
388 <div class="method-signature">
389 <span class="method-result">EditorField</span>
390 <span class="method-name">
391 __construct
392 </span>
393 (<span class="var-type"></span>&nbsp;<span class="var-name">$field</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$sql</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$lookup_sql</span> = <span class="var-default">&quot;&quot;</span>])
394 </div>
396 <ul class="parameters">
397 <li>
398 <span class="var-type"></span>
399 <span class="var-name">$field</span> </li>
400 <li>
401 <span class="var-type"></span>
402 <span class="var-name">$sql</span> </li>
403 <li>
404 <span class="var-type"></span>
405 <span class="var-name">$lookup_sql</span> </li>
406 </ul>
409 </div>
410 <a name="methodAddAttribute" id="AddAttribute"><!-- --></a>
411 <div class="evenrow">
413 <div class="method-header">
414 <img src="../../media/images/Method.png" />
415 <span class="method-title">AddAttribute</span> (line <span class="line-number">79</span>)
416 </div>
418 <!-- ========== Info from phpDoc block ========= -->
420 <div class="method-signature">
421 <span class="method-result">void</span>
422 <span class="method-name">
423 AddAttribute
424 </span>
425 (<span class="var-type"></span>&nbsp;<span class="var-name">$k</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$v</span>)
426 </div>
428 <ul class="parameters">
429 <li>
430 <span class="var-type"></span>
431 <span class="var-name">$k</span> </li>
432 <li>
433 <span class="var-type"></span>
434 <span class="var-name">$v</span> </li>
435 </ul>
438 </div>
439 <a name="methodGetTarget" id="GetTarget"><!-- --></a>
440 <div class="oddrow">
442 <div class="method-header">
443 <img src="../../media/images/Method.png" />
444 <span class="method-title">GetTarget</span> (line <span class="line-number">74</span>)
445 </div>
447 <!-- ========== Info from phpDoc block ========= -->
449 <div class="method-signature">
450 <span class="method-result">void</span>
451 <span class="method-name">
452 GetTarget
453 </span>
455 </div>
459 </div>
460 <a name="methodRenderAttributes" id="RenderAttributes"><!-- --></a>
461 <div class="evenrow">
463 <div class="method-header">
464 <img src="../../media/images/Method.png" />
465 <span class="method-title">RenderAttributes</span> (line <span class="line-number">83</span>)
466 </div>
468 <!-- ========== Info from phpDoc block ========= -->
470 <div class="method-signature">
471 <span class="method-result">void</span>
472 <span class="method-name">
473 RenderAttributes
474 </span>
476 </div>
480 </div>
481 <a name="methodSet" id="Set"><!-- --></a>
482 <div class="oddrow">
484 <div class="method-header">
485 <img src="../../media/images/Method.png" />
486 <span class="method-title">Set</span> (line <span class="line-number">36</span>)
487 </div>
489 <!-- ========== Info from phpDoc block ========= -->
491 <div class="method-signature">
492 <span class="method-result">void</span>
493 <span class="method-name">
495 </span>
496 (<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
497 </div>
499 <ul class="parameters">
500 <li>
501 <span class="var-type"></span>
502 <span class="var-name">$value</span> </li>
503 </ul>
506 </div>
507 <a name="methodSetLookup" id="SetLookup"><!-- --></a>
508 <div class="evenrow">
510 <div class="method-header">
511 <img src="../../media/images/Method.png" />
512 <span class="method-title">SetLookup</span> (line <span class="line-number">44</span>)
513 </div>
515 <!-- ========== Info from phpDoc block ========= -->
517 <div class="method-signature">
518 <span class="method-result">void</span>
519 <span class="method-name">
520 SetLookup
521 </span>
522 (<span class="var-type"></span>&nbsp;<span class="var-name">$lookup_sql</span>)
523 </div>
525 <ul class="parameters">
526 <li>
527 <span class="var-type"></span>
528 <span class="var-name">$lookup_sql</span> </li>
529 </ul>
532 </div>
533 <a name="methodSetOptionList" id="SetOptionList"><!-- --></a>
534 <div class="oddrow">
536 <div class="method-header">
537 <img src="../../media/images/Method.png" />
538 <span class="method-title">SetOptionList</span> (line <span class="line-number">48</span>)
539 </div>
541 <!-- ========== Info from phpDoc block ========= -->
543 <div class="method-signature">
544 <span class="method-result">void</span>
545 <span class="method-name">
546 SetOptionList
547 </span>
548 (<span class="var-type"></span>&nbsp;<span class="var-name">$options</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$current</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$parameters</span> = <span class="var-default">null</span>])
549 </div>
551 <ul class="parameters">
552 <li>
553 <span class="var-type"></span>
554 <span class="var-name">$options</span> </li>
555 <li>
556 <span class="var-type"></span>
557 <span class="var-name">$current</span> </li>
558 <li>
559 <span class="var-type"></span>
560 <span class="var-name">$parameters</span> </li>
561 </ul>
564 </div>
565 <a name="methodSetSql" id="SetSql"><!-- --></a>
566 <div class="evenrow">
568 <div class="method-header">
569 <img src="../../media/images/Method.png" />
570 <span class="method-title">SetSql</span> (line <span class="line-number">40</span>)
571 </div>
573 <!-- ========== Info from phpDoc block ========= -->
575 <div class="method-signature">
576 <span class="method-result">void</span>
577 <span class="method-name">
578 SetSql
579 </span>
580 (<span class="var-type"></span>&nbsp;<span class="var-name">$sql</span>)
581 </div>
583 <ul class="parameters">
584 <li>
585 <span class="var-type"></span>
586 <span class="var-name">$sql</span> </li>
587 </ul>
590 </div>
592 </div>
593 </div>
596 <p class="notes" id="credit">
597 Documentation generated on Tue, 28 Dec 2010 02:01:35 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
598 </p>
599 </div></body>
600 </html>