?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
The real release 0.46 :-)
[awl.git] / docs / api / awl / Browser / BrowserColumn.html
blobf82de34836641fb45e8dd7613a91b70c87c6b327
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 BrowserColumn</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";
14
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;
32 }
33 oImg.src = imgMinus.src;
34 oTable.style.display = "block";
35 }
36
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;
54 }
55 oImg.src = imgPlus.src;
56 oTable.style.display = "none";
57 }
58
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;
73 }
74 return (oTable && oTable.style.display == "block");
75 }
76
77 function toggleNodeVisibility(Node){
78 if (nodeIsVisible(Node)){
79 hideNode(Node);
80 }else{
81 showNode(Node);
82 }
83 }
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"> BrowserColumn</h2>
92
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>)
100
101 </div>
102 <div class="info-box-body">
103 <!-- ========== Info from phpDoc block ========= -->
104 <p class="short-description">BrowserColumns are the basic building blocks. You can specify just the field name, and the column header or you can get fancy and specify an alignment, format string, SQL formula and cell CSS class.</p>
105 <p class="notes">
106 Located in <a class="field" href="_classBrowser.php.html">/classBrowser.php</a> (line <span class="field">32</span>)
107 </p>
108
109
110 <pre></pre>
111
112 </div>
113 </div>
114
115
116
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>)
123 |
124 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
125
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="#$Align" title="details" class="var-name">$Align</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="#$Class" title="details" class="var-name">$Class</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="#$current_row" title="details" class="var-name">$current_row</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="#$Field" title="details" class="var-name">$Field</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="#$Format" title="details" class="var-name">$Format</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="#$Header" title="details" class="var-name">$Header</a>
158 </div>
159 <div class="var-title">
160 <img src="../../media/images/Variable.png" alt=" " />
161 <span class="var-type">mixed</span>
162 <a href="#$Hook" title="details" class="var-name">$Hook</a>
163 </div>
164 <div class="var-title">
165 <img src="../../media/images/Variable.png" alt=" " />
166 <span class="var-type">mixed</span>
167 <a href="#$Sql" title="details" class="var-name">$Sql</a>
168 </div>
169 <div class="var-title">
170 <img src="../../media/images/Variable.png" alt=" " />
171 <span class="var-type">mixed</span>
172 <a href="#$Translatable" title="details" class="var-name">$Translatable</a>
173 </div>
174 <div class="var-title">
175 <img src="../../media/images/Variable.png" alt=" " />
176 <span class="var-type">mixed</span>
177 <a href="#$Type" title="details" class="var-name">$Type</a>
178 </div>
179 </div>
180 </div>
181 </div>
182
183 <a name="sec-method-summary"></a>
184 <div class="info-box">
185 <div class="info-box-title">Method Summary</span></div>
186 <div class="nav-bar">
187 <a href="#sec-description">Description</a> |
188 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
189
190 |
191 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
192 </div>
193 <div class="info-box-body">
194 <div class="method-summary">
195
196 <div class="method-definition">
197 <img src="../../media/images/Constructor.png" alt=" "/>
198 <span class="method-result">BrowserColumn</span>
199 <a href="#BrowserColumn" title="details" class="method-name">BrowserColumn</a>
200 (<span class="var-type">string</span>&nbsp;<span class="var-name">$field</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$header</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$align</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$datatype</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$hook</span> = <span class="var-default">null</span>])
201 </div>
202
203 <div class="method-definition">
204 <img src="../../media/images/Method.png" alt=" "/>
205 <span class="method-result">void</span>
206 <a href="#GetTarget" title="details" class="method-name">GetTarget</a>
207 ()
208 </div>
209
210 <div class="method-definition">
211 <img src="../../media/images/Method.png" alt=" "/>
212 <span class="method-result">void</span>
213 <a href="#RenderHeader" title="details" class="method-name">RenderHeader</a>
214 (<span class="var-type">string</span>&nbsp;<span class="var-name">$order_field</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$order_direction</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$browser_array_key</span> = <span class="var-default">0</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$forced_order</span> = <span class="var-default">false</span>])
215 </div>
216
217 <div class="method-definition">
218 <img src="../../media/images/Method.png" alt=" "/>
219 <span class="method-result">void</span>
220 <a href="#RenderValue" title="details" class="method-name">RenderValue</a>
221 (<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$extraclass</span> = <span class="var-default">&quot;&quot;</span>])
222 </div>
223
224 <div class="method-definition">
225 <img src="../../media/images/Method.png" alt=" "/>
226 <span class="method-result">void</span>
227 <a href="#SetTranslatable" title="details" class="method-name">SetTranslatable</a>
228 ()
229 </div>
230 </div>
231 </div>
232 </div>
233
234 <a name="sec-vars"></a>
235 <div class="info-box">
236 <div class="info-box-title">Variables</div>
237 <div class="nav-bar">
238 <a href="#sec-description">Description</a> |
239 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
240
241
242 |
243 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
244
245 </div>
246 <div class="info-box-body">
247
248 <a name="var$Align" id="$Align"><!-- --></A>
249 <div class="evenrow">
250
251 <div class="var-header">
252 <img src="../../media/images/Variable.png" />
253 <span class="var-title">
254 <span class="var-type">mixed</span>
255 <span class="var-name">$Align</span>
256 (line <span class="line-number">38</span>)
257 </span>
258 </div>
259
260 <!-- ========== Info from phpDoc block ========= -->
261
262
263
264
265
266 </div>
267 <a name="var$Class" id="$Class"><!-- --></A>
268 <div class="oddrow">
269
270 <div class="var-header">
271 <img src="../../media/images/Variable.png" />
272 <span class="var-title">
273 <span class="var-type">mixed</span>
274 <span class="var-name">$Class</span>
275 (line <span class="line-number">39</span>)
276 </span>
277 </div>
278
279 <!-- ========== Info from phpDoc block ========= -->
280
281
282
283
284
285 </div>
286 <a name="var$current_row" id="$current_row"><!-- --></A>
287 <div class="evenrow">
288
289 <div class="var-header">
290 <img src="../../media/images/Variable.png" />
291 <span class="var-title">
292 <span class="var-type">mixed</span>
293 <span class="var-name">$current_row</span>
294 (line <span class="line-number">43</span>)
295 </span>
296 </div>
297
298 <!-- ========== Info from phpDoc block ========= -->
299
300
301
302
303
304 </div>
305 <a name="var$Field" id="$Field"><!-- --></A>
306 <div class="oddrow">
307
308 <div class="var-header">
309 <img src="../../media/images/Variable.png" />
310 <span class="var-title">
311 <span class="var-type">mixed</span>
312 <span class="var-name">$Field</span>
313 (line <span class="line-number">34</span>)
314 </span>
315 </div>
316
317 <!-- ========== Info from phpDoc block ========= -->
318
319
320
321
322
323 </div>
324 <a name="var$Format" id="$Format"><!-- --></A>
325 <div class="evenrow">
326
327 <div class="var-header">
328 <img src="../../media/images/Variable.png" />
329 <span class="var-title">
330 <span class="var-type">mixed</span>
331 <span class="var-name">$Format</span>
332 (line <span class="line-number">36</span>)
333 </span>
334 </div>
335
336 <!-- ========== Info from phpDoc block ========= -->
337
338
339
340
341
342 </div>
343 <a name="var$Header" id="$Header"><!-- --></A>
344 <div class="oddrow">
345
346 <div class="var-header">
347 <img src="../../media/images/Variable.png" />
348 <span class="var-title">
349 <span class="var-type">mixed</span>
350 <span class="var-name">$Header</span>
351 (line <span class="line-number">35</span>)
352 </span>
353 </div>
354
355 <!-- ========== Info from phpDoc block ========= -->
356
357
358
359
360
361 </div>
362 <a name="var$Hook" id="$Hook"><!-- --></A>
363 <div class="evenrow">
364
365 <div class="var-header">
366 <img src="../../media/images/Variable.png" />
367 <span class="var-title">
368 <span class="var-type">mixed</span>
369 <span class="var-name">$Hook</span>
370 (line <span class="line-number">42</span>)
371 </span>
372 </div>
373
374 <!-- ========== Info from phpDoc block ========= -->
375
376
377
378
379
380 </div>
381 <a name="var$Sql" id="$Sql"><!-- --></A>
382 <div class="oddrow">
383
384 <div class="var-header">
385 <img src="../../media/images/Variable.png" />
386 <span class="var-title">
387 <span class="var-type">mixed</span>
388 <span class="var-name">$Sql</span>
389 (line <span class="line-number">37</span>)
390 </span>
391 </div>
392
393 <!-- ========== Info from phpDoc block ========= -->
394
395
396
397
398
399 </div>
400 <a name="var$Translatable" id="$Translatable"><!-- --></A>
401 <div class="evenrow">
402
403 <div class="var-header">
404 <img src="../../media/images/Variable.png" />
405 <span class="var-title">
406 <span class="var-type">mixed</span>
407 <span class="var-name">$Translatable</span>
408 (line <span class="line-number">41</span>)
409 </span>
410 </div>
411
412 <!-- ========== Info from phpDoc block ========= -->
413
414
415
416
417
418 </div>
419 <a name="var$Type" id="$Type"><!-- --></A>
420 <div class="oddrow">
421
422 <div class="var-header">
423 <img src="../../media/images/Variable.png" />
424 <span class="var-title">
425 <span class="var-type">mixed</span>
426 <span class="var-name">$Type</span>
427 (line <span class="line-number">40</span>)
428 </span>
429 </div>
430
431 <!-- ========== Info from phpDoc block ========= -->
432
433
434
435
436
437 </div>
438
439 </div>
440 </div>
441
442 <a name="sec-methods"></a>
443 <div class="info-box">
444 <div class="info-box-title">Methods</div>
445 <div class="nav-bar">
446 <a href="#sec-description">Description</a> |
447 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
448 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
449
450 </div>
451 <div class="info-box-body">
452 <A NAME='method_detail'></A>
453 <a name="methodBrowserColumn" id="BrowserColumn"><!-- --></a>
454 <div class="evenrow">
455
456 <div class="method-header">
457 <img src="../../media/images/Constructor.png" />
458 <span class="method-title">Constructor BrowserColumn</span> (line <span class="line-number">69</span>)
459 </div>
460
461 <!-- ========== Info from phpDoc block ========= -->
462 <p class="short-description">BrowserColumn constructor. Only the first parameter is mandatory.</p>
463
464 <div class="method-signature">
465 <span class="method-result">BrowserColumn</span>
466 <span class="method-name">
467 BrowserColumn
468 </span>
469 (<span class="var-type">string</span>&nbsp;<span class="var-name">$field</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$header</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$align</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$sql</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$datatype</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$hook</span> = <span class="var-default">null</span>])
470 </div>
471
472 <ul class="parameters">
473 <li>
474 <span class="var-type">string</span>
475 <span class="var-name">$hook</span><span class="var-description">: <p>The name of a global function which will preprocess the column value</p><p>The hook function should be defined as follows: function hookfunction( $column_value, $column_name, $database_row ) { ... return $value; }</p></span> </li>
476 <li>
477 <span class="var-type">string</span>
478 <span class="var-name">$field</span><span class="var-description">: field The name of the column in the SQL result.</span> </li>
479 <li>
480 <span class="var-type">string</span>
481 <span class="var-name">$header</span><span class="var-description">: header The text to appear in the column header on output (@see BrowserColumn::RenderHeader()). If this is not supplied then a default of the field name will be used.</span> </li>
482 <li>
483 <span class="var-type">string</span>
484 <span class="var-name">$align</span><span class="var-description">: align left|center|right - text alignment. Defaults to 'left'.</span> </li>
485 <li>
486 <span class="var-type">string</span>
487 <span class="var-name">$format</span><span class="var-description">: format A format (a-la-printf) to render data values within. (@see BrowserColumn::RenderValue()). If this is not supplied then the default will ensure the column value is displayed as-is.</span> </li>
488 <li>
489 <span class="var-type">string</span>
490 <span class="var-name">$sql</span><span class="var-description">: sql Some SQL which will return the desired value to be presented as column 'field' of the result. If this is blank then the column is assumed to be a real data column.</span> </li>
491 <li>
492 <span class="var-type">string</span>
493 <span class="var-name">$class</span><span class="var-description">: class Additional classes to apply to the column header and column value cells.</span> </li>
494 <li>
495 <span class="var-type">string</span>
496 <span class="var-name">$datatype</span><span class="var-description">: datatype This will allow 'date' or 'timestamp' to preformat the field correctly before using it in replacements or display. Other types may be added in future.</span> </li>
497 </ul>
498
499
500 </div>
501 <a name="methodGetTarget" id="GetTarget"><!-- --></a>
502 <div class="oddrow">
503
504 <div class="method-header">
505 <img src="../../media/images/Method.png" />
506 <span class="method-title">GetTarget</span> (line <span class="line-number">86</span>)
507 </div>
508
509 <!-- ========== Info from phpDoc block ========= -->
510 <p class="short-description">GetTarget</p>
511 <p class="description"><p>Retrieves a 'field' or '...SQL... AS field' definition for the target list of the SQL.</p></p>
512
513 <div class="method-signature">
514 <span class="method-result">void</span>
515 <span class="method-name">
516 GetTarget
517 </span>
518 ()
519 </div>
520
521
522
523 </div>
524 <a name="methodRenderHeader" id="RenderHeader"><!-- --></a>
525 <div class="evenrow">
526
527 <div class="method-header">
528 <img src="../../media/images/Method.png" />
529 <span class="method-title">RenderHeader</span> (line <span class="line-number">104</span>)
530 </div>
531
532 <!-- ========== Info from phpDoc block ========= -->
533 <p class="short-description">RenderHeader</p>
534 <p class="description"><p>Renders the column header cell for this column. This will be rendered as a &lt;th&gt;...&lt;/th&gt; with class and alignment applied to it. Browser column headers are clickable, and the ordering will also display an 'up' or 'down' triangle with the column header that the SQL is sorted on at the moment.</p></p>
535
536 <div class="method-signature">
537 <span class="method-result">void</span>
538 <span class="method-name">
539 RenderHeader
540 </span>
541 (<span class="var-type">string</span>&nbsp;<span class="var-name">$order_field</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$order_direction</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$browser_array_key</span> = <span class="var-default">0</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$forced_order</span> = <span class="var-default">false</span>])
542 </div>
543
544 <ul class="parameters">
545 <li>
546 <span class="var-type">string</span>
547 <span class="var-name">$order_field</span><span class="var-description">: order_field The name of the field currently being sorted on.</span> </li>
548 <li>
549 <span class="var-type">string</span>
550 <span class="var-name">$order_direction</span><span class="var-description">: order_direction Whether the sort is Ascending or Descending.</span> </li>
551 <li>
552 <span class="var-type">int</span>
553 <span class="var-name">$browser_array_key</span><span class="var-description">: browser_array_key Used this to help handle separate ordering of multiple browsers on the same page.</span> </li>
554 <li>
555 <span class="var-type">string</span>
556 <span class="var-name">$forced_order</span><span class="var-description">: forced_order If true, then we don't allow order to be changed.</span> </li>
557 </ul>
558
559
560 </div>
561 <a name="methodRenderValue" id="RenderValue"><!-- --></a>
562 <div class="oddrow">
563
564 <div class="method-header">
565 <img src="../../media/images/Method.png" />
566 <span class="method-title">RenderValue</span> (line <span class="line-number">133</span>)
567 </div>
568
569 <!-- ========== Info from phpDoc block ========= -->
570
571 <div class="method-signature">
572 <span class="method-result">void</span>
573 <span class="method-name">
574 RenderValue
575 </span>
576 (<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$extraclass</span> = <span class="var-default">&quot;&quot;</span>])
577 </div>
578
579 <ul class="parameters">
580 <li>
581 <span class="var-type"></span>
582 <span class="var-name">$value</span> </li>
583 <li>
584 <span class="var-type"></span>
585 <span class="var-name">$extraclass</span> </li>
586 </ul>
587
588
589 </div>
590 <a name="methodSetTranslatable" id="SetTranslatable"><!-- --></a>
591 <div class="evenrow">
592
593 <div class="method-header">
594 <img src="../../media/images/Method.png" />
595 <span class="method-title">SetTranslatable</span> (line <span class="line-number">129</span>)
596 </div>
597
598 <!-- ========== Info from phpDoc block ========= -->
599
600 <div class="method-signature">
601 <span class="method-result">void</span>
602 <span class="method-name">
603 SetTranslatable
604 </span>
605 ()
606 </div>
607
608
609
610 </div>
611
612 </div>
613 </div>
614
615
616 <p class="notes" id="credit">
617 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>
618 </p>
619 </div></body>
620 </html>
Andrew's Web Libraries