Release 0.52
[awl.git] / docs / api / awl / classEditor / EditorField.html
blob13cc0b44eae0b5e77545b6961ab031b70f7108bb
2 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
3 <?xml version="1.0" encoding="iso-8859-1"?>
4 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5 <html xmlns="http://www.w3.org/1999/xhtml">
6 <head>
7 <!-- template designed by Marco Von Ballmoos -->
8 <title>Docs For Class EditorField</title>
9 <link rel="stylesheet" href="../../media/stylesheet.css" />
10 <script src="../../media/lib/classTree.js"></script>
11 <script language="javascript" type="text/javascript">
12 var imgPlus = new Image();
13 var imgMinus = new Image();
14 imgPlus.src = "../../media/images/plus.png";
15 imgMinus.src = "../../media/images/minus.png";
17 function showNode(Node){
18 switch(navigator.family){
19 case 'nn4':
20 // Nav 4.x code fork...
21 var oTable = document.layers["span" + Node];
22 var oImg = document.layers["img" + Node];
23 break;
24 case 'ie4':
25 // IE 4/5 code fork...
26 var oTable = document.all["span" + Node];
27 var oImg = document.all["img" + Node];
28 break;
29 case 'gecko':
30 // Standards Compliant code fork...
31 var oTable = document.getElementById("span" + Node);
32 var oImg = document.getElementById("img" + Node);
33 break;
35 oImg.src = imgMinus.src;
36 oTable.style.display = "block";
39 function hideNode(Node){
40 switch(navigator.family){
41 case 'nn4':
42 // Nav 4.x code fork...
43 var oTable = document.layers["span" + Node];
44 var oImg = document.layers["img" + Node];
45 break;
46 case 'ie4':
47 // IE 4/5 code fork...
48 var oTable = document.all["span" + Node];
49 var oImg = document.all["img" + Node];
50 break;
51 case 'gecko':
52 // Standards Compliant code fork...
53 var oTable = document.getElementById("span" + Node);
54 var oImg = document.getElementById("img" + Node);
55 break;
57 oImg.src = imgPlus.src;
58 oTable.style.display = "none";
61 function nodeIsVisible(Node){
62 switch(navigator.family){
63 case 'nn4':
64 // Nav 4.x code fork...
65 var oTable = document.layers["span" + Node];
66 break;
67 case 'ie4':
68 // IE 4/5 code fork...
69 var oTable = document.all["span" + Node];
70 break;
71 case 'gecko':
72 // Standards Compliant code fork...
73 var oTable = document.getElementById("span" + Node);
74 break;
76 return (oTable && oTable.style.display == "block");
79 function toggleNodeVisibility(Node){
80 if (nodeIsVisible(Node)){
81 hideNode(Node);
82 }else{
83 showNode(Node);
86 </script>
87 </head>
88 <body>
89 <div class="page-body">
90 <h2 class="class-name"><img src="../../media/images/Class_logo.png"
91 alt=" Class"
92 title=" Class"
93 style="vertical-align: middle"> EditorField</h2>
95 <a name="sec-description"></a>
96 <div class="info-box">
97 <div class="info-box-title">Description</div>
98 <div class="nav-bar">
99 <span class="disabled">Description</span> |
100 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
101 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
103 </div>
104 <div class="info-box-body">
106 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
107 <!-- ========== Info from phpDoc block ========= -->
108 <p class="short-description">A class for the fields in the editor</p>
109 <p class="notes">
110 Located in <a class="field" href="_classEditor.php.html">/classEditor.php</a> (line <span class="field">19</span>)
111 </p>
114 <pre></pre>
116 </div>
117 </div>
121 <a name="sec-var-summary"></a>
122 <div class="info-box">
123 <div class="info-box-title">Variable Summary</span></div>
124 <div class="nav-bar">
125 <a href="#sec-description">Description</a> |
126 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
128 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
130 </div>
131 <div class="info-box-body">
132 <div class="var-summary">
133 <div class="var-title">
134 <img src="../../media/images/Variable.png" alt=" " />
135 <span class="var-type">mixed</span>
136 <a href="#$Attributes" title="details" class="var-name">$Attributes</a>
137 </div>
138 <div class="var-title">
139 <img src="../../media/images/Variable.png" alt=" " />
140 <span class="var-type">mixed</span>
141 <a href="#$Field" title="details" class="var-name">$Field</a>
142 </div>
143 <div class="var-title">
144 <img src="../../media/images/Variable.png" alt=" " />
145 <span class="var-type">mixed</span>
146 <a href="#$LookupSql" title="details" class="var-name">$LookupSql</a>
147 </div>
148 <div class="var-title">
149 <img src="../../media/images/Variable.png" alt=" " />
150 <span class="var-type">mixed</span>
151 <a href="#$OptionList" title="details" class="var-name">$OptionList</a>
152 </div>
153 <div class="var-title">
154 <img src="../../media/images/Variable.png" alt=" " />
155 <span class="var-type">mixed</span>
156 <a href="#$Sql" title="details" class="var-name">$Sql</a>
157 </div>
158 <div class="var-title">
159 <img src="../../media/images/Variable.png" alt=" " />
160 <span class="var-type">mixed</span>
161 <a href="#$Value" title="details" class="var-name">$Value</a>
162 </div>
163 </div>
164 </div>
165 </div>
167 <a name="sec-method-summary"></a>
168 <div class="info-box">
169 <div class="info-box-title">Method Summary</span></div>
170 <div class="nav-bar">
171 <a href="#sec-description">Description</a> |
172 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
175 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
176 </div>
177 <div class="info-box-body">
178 <div class="method-summary">
180 <div class="method-definition">
181 <img src="../../media/images/Constructor.png" alt=" "/>
182 <span class="method-result">EditorField</span>
183 <a href="#__construct" title="details" class="method-name">__construct</a>
184 (<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>])
185 </div>
187 <div class="method-definition">
188 <img src="../../media/images/Method.png" alt=" "/>
189 <span class="method-result">void</span>
190 <a href="#AddAttribute" title="details" class="method-name">AddAttribute</a>
191 (<span class="var-type"></span>&nbsp;<span class="var-name">$k</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$v</span>)
192 </div>
194 <div class="method-definition">
195 <img src="../../media/images/Method.png" alt=" "/>
196 <span class="method-result">void</span>
197 <a href="#GetTarget" title="details" class="method-name">GetTarget</a>
199 </div>
201 <div class="method-definition">
202 <img src="../../media/images/Method.png" alt=" "/>
203 <span class="method-result">void</span>
204 <a href="#RenderAttributes" title="details" class="method-name">RenderAttributes</a>
206 </div>
208 <div class="method-definition">
209 <img src="../../media/images/Method.png" alt=" "/>
210 <span class="method-result">void</span>
211 <a href="#RenderLabel" title="details" class="method-name">RenderLabel</a>
212 (<span class="var-type"></span>&nbsp;<span class="var-name">$wrapme</span>)
213 </div>
215 <div class="method-definition">
216 <img src="../../media/images/Method.png" alt=" "/>
217 <span class="method-result">void</span>
218 <a href="#Set" title="details" class="method-name">Set</a>
219 (<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
220 </div>
222 <div class="method-definition">
223 <img src="../../media/images/Method.png" alt=" "/>
224 <span class="method-result">void</span>
225 <a href="#SetLookup" title="details" class="method-name">SetLookup</a>
226 (<span class="var-type"></span>&nbsp;<span class="var-name">$lookup_sql</span>)
227 </div>
229 <div class="method-definition">
230 <img src="../../media/images/Method.png" alt=" "/>
231 <span class="method-result">void</span>
232 <a href="#SetOptionList" title="details" class="method-name">SetOptionList</a>
233 (<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>])
234 </div>
236 <div class="method-definition">
237 <img src="../../media/images/Method.png" alt=" "/>
238 <span class="method-result">void</span>
239 <a href="#SetSql" title="details" class="method-name">SetSql</a>
240 (<span class="var-type"></span>&nbsp;<span class="var-name">$sql</span>)
241 </div>
242 </div>
243 </div>
244 </div>
246 <a name="sec-vars"></a>
247 <div class="info-box">
248 <div class="info-box-title">Variables</div>
249 <div class="nav-bar">
250 <a href="#sec-description">Description</a> |
251 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
255 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
257 </div>
258 <div class="info-box-body">
260 Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712
262 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
264 <a name="var$Attributes" id="$Attributes"><!-- --></A>
265 <div class="evenrow">
267 <div class="var-header">
268 <img src="../../media/images/Variable.png" />
269 <span class="var-title">
270 <span class="var-type">mixed</span>
271 <span class="var-name">$Attributes</span>
272 (line <span class="line-number">24</span>)
273 </span>
274 </div>
276 <!-- ========== Info from phpDoc block ========= -->
282 </div>
283 <a name="var$Field" id="$Field"><!-- --></A>
284 <div class="oddrow">
286 <div class="var-header">
287 <img src="../../media/images/Variable.png" />
288 <span class="var-title">
289 <span class="var-type">mixed</span>
290 <span class="var-name">$Field</span>
291 (line <span class="line-number">21</span>)
292 </span>
293 </div>
295 <!-- ========== Info from phpDoc block ========= -->
301 </div>
302 <a name="var$LookupSql" id="$LookupSql"><!-- --></A>
303 <div class="evenrow">
305 <div class="var-header">
306 <img src="../../media/images/Variable.png" />
307 <span class="var-title">
308 <span class="var-type">mixed</span>
309 <span class="var-name">$LookupSql</span>
310 (line <span class="line-number">25</span>)
311 </span>
312 </div>
314 <!-- ========== Info from phpDoc block ========= -->
320 </div>
321 <a name="var$OptionList" id="$OptionList"><!-- --></A>
322 <div class="oddrow">
324 <div class="var-header">
325 <img src="../../media/images/Variable.png" />
326 <span class="var-title">
327 <span class="var-type">mixed</span>
328 <span class="var-name">$OptionList</span>
329 (line <span class="line-number">26</span>)
330 </span>
331 </div>
333 <!-- ========== Info from phpDoc block ========= -->
339 </div>
340 <a name="var$Sql" id="$Sql"><!-- --></A>
341 <div class="evenrow">
343 <div class="var-header">
344 <img src="../../media/images/Variable.png" />
345 <span class="var-title">
346 <span class="var-type">mixed</span>
347 <span class="var-name">$Sql</span>
348 (line <span class="line-number">22</span>)
349 </span>
350 </div>
352 <!-- ========== Info from phpDoc block ========= -->
358 </div>
359 <a name="var$Value" id="$Value"><!-- --></A>
360 <div class="oddrow">
362 <div class="var-header">
363 <img src="../../media/images/Variable.png" />
364 <span class="var-title">
365 <span class="var-type">mixed</span>
366 <span class="var-name">$Value</span>
367 (line <span class="line-number">23</span>)
368 </span>
369 </div>
371 <!-- ========== Info from phpDoc block ========= -->
377 </div>
379 </div>
380 </div>
382 <a name="sec-methods"></a>
383 <div class="info-box">
384 <div class="info-box-title">Methods</div>
385 <div class="nav-bar">
386 <a href="#sec-description">Description</a> |
387 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
388 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
390 </div>
391 <div class="info-box-body">
393 Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712
395 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
396 <A NAME='method_detail'></A>
397 <a name="method__construct" id="__construct"><!-- --></a>
398 <div class="evenrow">
400 <div class="method-header">
401 <img src="../../media/images/Constructor.png" />
402 <span class="method-title">Constructor __construct</span> (line <span class="line-number">28</span>)
403 </div>
405 <!-- ========== Info from phpDoc block ========= -->
407 <div class="method-signature">
408 <span class="method-result">EditorField</span>
409 <span class="method-name">
410 __construct
411 </span>
412 (<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>])
413 </div>
415 <ul class="parameters">
416 <li>
417 <span class="var-type"></span>
418 <span class="var-name">$field</span> </li>
419 <li>
420 <span class="var-type"></span>
421 <span class="var-name">$sql</span> </li>
422 <li>
423 <span class="var-type"></span>
424 <span class="var-name">$lookup_sql</span> </li>
425 </ul>
428 </div>
429 <a name="methodAddAttribute" id="AddAttribute"><!-- --></a>
430 <div class="oddrow">
432 <div class="method-header">
433 <img src="../../media/images/Method.png" />
434 <span class="method-title">AddAttribute</span> (line <span class="line-number">79</span>)
435 </div>
437 <!-- ========== Info from phpDoc block ========= -->
439 <div class="method-signature">
440 <span class="method-result">void</span>
441 <span class="method-name">
442 AddAttribute
443 </span>
444 (<span class="var-type"></span>&nbsp;<span class="var-name">$k</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$v</span>)
445 </div>
447 <ul class="parameters">
448 <li>
449 <span class="var-type"></span>
450 <span class="var-name">$k</span> </li>
451 <li>
452 <span class="var-type"></span>
453 <span class="var-name">$v</span> </li>
454 </ul>
457 </div>
458 <a name="methodGetTarget" id="GetTarget"><!-- --></a>
459 <div class="evenrow">
461 <div class="method-header">
462 <img src="../../media/images/Method.png" />
463 <span class="method-title">GetTarget</span> (line <span class="line-number">74</span>)
464 </div>
466 <!-- ========== Info from phpDoc block ========= -->
468 <div class="method-signature">
469 <span class="method-result">void</span>
470 <span class="method-name">
471 GetTarget
472 </span>
474 </div>
478 </div>
479 <a name="methodRenderAttributes" id="RenderAttributes"><!-- --></a>
480 <div class="oddrow">
482 <div class="method-header">
483 <img src="../../media/images/Method.png" />
484 <span class="method-title">RenderAttributes</span> (line <span class="line-number">91</span>)
485 </div>
487 <!-- ========== Info from phpDoc block ========= -->
489 <div class="method-signature">
490 <span class="method-result">void</span>
491 <span class="method-name">
492 RenderAttributes
493 </span>
495 </div>
499 </div>
500 <a name="methodRenderLabel" id="RenderLabel"><!-- --></a>
501 <div class="evenrow">
503 <div class="method-header">
504 <img src="../../media/images/Method.png" />
505 <span class="method-title">RenderLabel</span> (line <span class="line-number">83</span>)
506 </div>
508 <!-- ========== Info from phpDoc block ========= -->
510 <div class="method-signature">
511 <span class="method-result">void</span>
512 <span class="method-name">
513 RenderLabel
514 </span>
515 (<span class="var-type"></span>&nbsp;<span class="var-name">$wrapme</span>)
516 </div>
518 <ul class="parameters">
519 <li>
520 <span class="var-type"></span>
521 <span class="var-name">$wrapme</span> </li>
522 </ul>
525 </div>
526 <a name="methodSet" id="Set"><!-- --></a>
527 <div class="oddrow">
529 <div class="method-header">
530 <img src="../../media/images/Method.png" />
531 <span class="method-title">Set</span> (line <span class="line-number">36</span>)
532 </div>
534 <!-- ========== Info from phpDoc block ========= -->
536 <div class="method-signature">
537 <span class="method-result">void</span>
538 <span class="method-name">
540 </span>
541 (<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
542 </div>
544 <ul class="parameters">
545 <li>
546 <span class="var-type"></span>
547 <span class="var-name">$value</span> </li>
548 </ul>
551 </div>
552 <a name="methodSetLookup" id="SetLookup"><!-- --></a>
553 <div class="evenrow">
555 <div class="method-header">
556 <img src="../../media/images/Method.png" />
557 <span class="method-title">SetLookup</span> (line <span class="line-number">44</span>)
558 </div>
560 <!-- ========== Info from phpDoc block ========= -->
562 <div class="method-signature">
563 <span class="method-result">void</span>
564 <span class="method-name">
565 SetLookup
566 </span>
567 (<span class="var-type"></span>&nbsp;<span class="var-name">$lookup_sql</span>)
568 </div>
570 <ul class="parameters">
571 <li>
572 <span class="var-type"></span>
573 <span class="var-name">$lookup_sql</span> </li>
574 </ul>
577 </div>
578 <a name="methodSetOptionList" id="SetOptionList"><!-- --></a>
579 <div class="oddrow">
581 <div class="method-header">
582 <img src="../../media/images/Method.png" />
583 <span class="method-title">SetOptionList</span> (line <span class="line-number">48</span>)
584 </div>
586 <!-- ========== Info from phpDoc block ========= -->
588 <div class="method-signature">
589 <span class="method-result">void</span>
590 <span class="method-name">
591 SetOptionList
592 </span>
593 (<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>])
594 </div>
596 <ul class="parameters">
597 <li>
598 <span class="var-type"></span>
599 <span class="var-name">$options</span> </li>
600 <li>
601 <span class="var-type"></span>
602 <span class="var-name">$current</span> </li>
603 <li>
604 <span class="var-type"></span>
605 <span class="var-name">$parameters</span> </li>
606 </ul>
609 </div>
610 <a name="methodSetSql" id="SetSql"><!-- --></a>
611 <div class="evenrow">
613 <div class="method-header">
614 <img src="../../media/images/Method.png" />
615 <span class="method-title">SetSql</span> (line <span class="line-number">40</span>)
616 </div>
618 <!-- ========== Info from phpDoc block ========= -->
620 <div class="method-signature">
621 <span class="method-result">void</span>
622 <span class="method-name">
623 SetSql
624 </span>
625 (<span class="var-type"></span>&nbsp;<span class="var-name">$sql</span>)
626 </div>
628 <ul class="parameters">
629 <li>
630 <span class="var-type"></span>
631 <span class="var-name">$sql</span> </li>
632 </ul>
635 </div>
637 </div>
638 </div>
642 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
643 <p class="notes" id="credit">
644 Documentation generated on Sun, 17 Jun 2012 10:00:15 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
645 </p>
646 </div></body>
647 </html>