/[cvs]/nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/Container.html
ViewVC logotype

Contents of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/Container.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.4 - (show annotations)
Thu May 6 16:24:18 2004 UTC (20 years, 2 months ago) by jonen
Branch: MAIN
CVS Tags: HEAD
Changes since 1.3: +865 -908 lines
File MIME type: text/html 
 updated all to v2.4.1 - Apr 01, 2004
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 Container</title>
7 <link rel="stylesheet" href="../media/stylesheet.css" />
8 <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9 </head>
10 <body>
11 <div class="page-body">
12
13 <h2 class="class-name">Class Container</h2>
14
15 <a name="sec-description"></a>
16 <div class="info-box">
17 <div class="info-box-title">Description</div>
18 <div class="nav-bar">
19 <span class="disabled">Description</span> |
20 <a href="#sec-descendents">Descendents</a>
21 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
22
23 </div>
24 <div class="info-box-body">
25 <!-- ========== Info from phpDoc block ========= -->
26 <p class="short-description">This class is nothing more then a</p>
27 <p class="description"><p>container widget. It lets you push data into it, and it will render each item indented properly so it works with the rest of the libs.</p><p>This is helpfull when you have a function that wants to return multiple Tag Objects or widgets. Just wrap them in this container and they will all get rendered with the current indentation level.</p><p>Base Class for phpHtmlLib</p></p>
28 <ul class="tags">
29 <li><span class="field">tutorial:</span> <a href="../phpHtmlLib/tutorial_Container.cls.html">Container</a></li>
30 <li><span class="field">author:</span> Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</li>
31 <li><span class="field">link:</span> <a href="http://phphtmllib.sourceforge.net">http://phphtmllib.sourceforge.net</a></li>
32 </ul>
33 <p class="notes">
34 Located in <a class="field" href="_ContainerClass_inc.html">/ContainerClass.inc</a> (line <span class="field">39</span>)
35 </p>
36
37
38 <pre></pre>
39
40 </div>
41 </div>
42
43 <a name="sec-descendents"></a>
44 <div class="info-box">
45 <div class="info-box-title">Direct descendents</div>
46 <div class="nav-bar">
47 <a href="#sec-description">Description</a> |
48 <span class="disabled">Descendents</span>
49 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
50
51 </div>
52 <div class="info-box-body">
53 <table cellpadding="2" cellspacing="0" class="class-table">
54 <tr>
55 <th class="class-table-header">Class</th>
56 <th class="class-table-header">Description</th>
57 </tr>
58 <tr>
59 <td style="padding-right: 2em"><a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></td>
60 <td>
61 This class is used for building and rendering an XML tag.
62 </td>
63 </tr>
64 <tr>
65 <td style="padding-right: 2em"><a href="../phpHtmlLib/FormProcessing/FormProcessor.html">FormProcessor</a></td>
66 <td>
67 This is the main engine for the processing
68 </td>
69 </tr>
70 <tr>
71 <td style="padding-right: 2em"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></td>
72 <td>
73 this is the base widget class, that all widgets are based off of. It provides some basic members and methods
74 </td>
75 </tr>
76 <tr>
77 <td style="padding-right: 2em"><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></td>
78 <td>
79 This is just to maintain compatibility with the 1.1.0 release of phphtmllib
80 </td>
81 </tr>
82 <tr>
83 <td style="padding-right: 2em"><a href="../phpHtmlLib/XMLDocumentClass.html">XMLDocumentClass</a></td>
84 <td>
85 This class lets you build a complete xml document and render it.
86 </td>
87 </tr>
88 </table>
89 </div>
90 </div>
91
92
93
94 <a name="sec-method-summary"></a>
95 <div class="info-box">
96 <div class="info-box-title">Method Summary</span></div>
97 <div class="nav-bar">
98 <a href="#sec-description">Description</a> |
99 <a href="#sec-descendents">Descendents</a> |
100 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
101 </div>
102 <div class="info-box-body">
103 <div class="method-summary">
104
105 <div class="method-definition">
106 <span class="method-result">Container</span>
107 <a href="#Container" title="details" class="method-name">Container</a>
108 ()
109 </div>
110
111 <div class="method-definition">
112 <span class="method-result">void</span>
113 <a href="#add" title="details" class="method-name">add</a>
114 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span>)
115 </div>
116
117 <div class="method-definition">
118 <span class="method-result">void</span>
119 <a href="#add_reference" title="details" class="method-name">add_reference</a>
120 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">&$content</span>)
121 </div>
122
123 <div class="method-definition">
124 <span class="method-result">int</span>
125 <a href="#count_content" title="details" class="method-name">count_content</a>
126 ()
127 </div>
128
129 <div class="method-definition">
130 <span class="method-result">mixed</span>
131 <a href="#get_element" title="details" class="method-name">&amp;get_element</a>
132 (<span class="var-type">int</span>&nbsp;<span class="var-name">$cell</span>)
133 </div>
134
135 <div class="method-definition">
136 <span class="method-result">boolean</span>
137 <a href="#get_indent_flag" title="details" class="method-name">get_indent_flag</a>
138 ()
139 </div>
140
141 <div class="method-definition">
142 <span class="method-result">void</span>
143 <a href="#push" title="details" class="method-name">push</a>
144 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span>)
145 </div>
146
147 <div class="method-definition">
148 <span class="method-result">void</span>
149 <a href="#push_reference" title="details" class="method-name">push_reference</a>
150 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">&$content</span>)
151 </div>
152
153 <div class="method-definition">
154 <span class="method-result">string</span>
155 <a href="#render" title="details" class="method-name">render</a>
156 (<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_level</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$output_debug</span>)
157 </div>
158
159 <div class="method-definition">
160 <span class="method-result">void</span>
161 <a href="#reset_content" title="details" class="method-name">reset_content</a>
162 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span>)
163 </div>
164
165 <div class="method-definition">
166 <span class="method-result">void</span>
167 <a href="#set_collapse" title="details" class="method-name">set_collapse</a>
168 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$collapse</span> = <span class="var-default">TRUE</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$indent</span> = <span class="var-default">TRUE</span>])
169 </div>
170
171 <div class="method-definition">
172 <span class="method-result">void</span>
173 <a href="#set_indent_flag" title="details" class="method-name">set_indent_flag</a>
174 (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span>)
175 </div>
176 </div>
177 </div>
178 </div>
179
180
181 <a name="sec-methods"></a>
182 <div class="info-box">
183 <div class="info-box-title">Methods</div>
184 <div class="nav-bar">
185 <a href="#sec-description">Description</a> |
186 <a href="#sec-descendents">Descendents</a> |
187 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
188
189 </div>
190 <div class="info-box-body">
191 <A NAME='method_detail'></A>
192 <a name="methodContainer" id="Container"><!-- --></a>
193 <div class="oddrow">
194
195 <div class="method-header">
196 <span class="method-title">Constructor Container</span> (line <span class="line-number">82</span>)
197 </div>
198
199 <!-- ========== Info from phpDoc block ========= -->
200 <p class="short-description">The constructor.</p>
201 <p class="description"><p>This lets you pass in data that you want automatically added to the container. This works in the same manner as the push() method.</p><p><pre><ol><li><span class="src-key">function </span><a href="../phpHtmlLib/Container.html#methodContainer">Container</a><span class="src-sym">(</span><span class="src-sym">) </span><span class="src-sym">{</span></li>
202 <li> <span class="src-comm">//We do the adding to the content var</span></li>
203 <li> <span class="src-comm">//here instead of calling $this-&gt;push()</span></li>
204 <li> <span class="src-comm">//to save some cpu cycles.</span></li>
205 <li> <span class="src-var">$num </span>= <a href="http://www.php.net/func_num_args">func_num_args</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
206 <li> <span class="src-key">for </span><span class="src-sym">(</span><span class="src-var">$i</span>=<span class="src-num">0</span><span class="src-sym">;</span><span class="src-var">$i</span>&lt;<span class="src-var">$num</span><span class="src-sym">;</span><span class="src-var">$i</span>++<span class="src-sym">) </span><span class="src-sym">{</span></li>
207 <li> <span class="src-var">$arg </span>= <a href="http://www.php.net/func_get_arg">func_get_arg</a><span class="src-sym">(</span><span class="src-var">$i</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
208 <li> <a href="http://www.php.net/array_push">array_push</a><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_content</span><span class="src-sym">, </span><span class="src-var">$arg</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
209 <li> <span class="src-sym">}</span></li>
210 <li> <span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_data_count </span>+= <span class="src-var">$num</span><span class="src-sym">;</span></li>
211 <li>&nbsp;</li>
212 <li> <span class="src-comm">//set the flag bitmask</span></li>
213 <li> <span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_set_flags</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
214 <li> <span class="src-sym">}</span></li>
215 </ol></pre></p></p>
216 <ul class="tags">
217 <li><span class="field">tutorial:</span> <a href="../phpHtmlLib/tutorial_Container.cls.html#constructor">Constructor call</a></li>
218 </ul>
219
220 <div class="method-signature">
221 <span class="method-result">Container</span>
222 <span class="method-name">
223 Container
224 </span>
225 ()
226 </div>
227
228
229
230 </div>
231 <a name="methodadd" id="add"><!-- --></a>
232 <div class="evenrow">
233
234 <div class="method-header">
235 <span class="method-title">add</span> (line <span class="line-number">187</span>)
236 </div>
237
238 <!-- ========== Info from phpDoc block ========= -->
239 <p class="short-description">add content onto content stack</p>
240 <p class="description"><p>adds content to tag as a FIFO. You can have n number of parameters. each one will get added in succession to the content.</p><p><pre><ol><li><span class="src-key">function </span><a href="../phpHtmlLib/Container.html#methodadd">add</a><span class="src-sym">( </span><span class="src-sym">) </span><span class="src-sym">{</span></li>
241 <li> <span class="src-var">$args </span>= <a href="http://www.php.net/func_get_args">func_get_args</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
242 <li> <span class="src-var">$num </span>= <span class="src-num">0</span><span class="src-sym">;</span></li>
243 <li> <span class="src-key">foreach</span><span class="src-sym">( </span><span class="src-var">$args </span><span class="src-key">as </span><span class="src-var">$arg </span><span class="src-sym">) </span><span class="src-sym">{</span></li>
244 <li> <span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_content</span><span class="src-sym">[</span><span class="src-sym">] </span>= <span class="src-var">$arg</span><span class="src-sym">;</span></li>
245 <li> <span class="src-var">$num</span>++<span class="src-sym">;</span></li>
246 <li> <span class="src-sym">}</span></li>
247 <li> <span class="src-comm">//keep track of how much data we have added.</span></li>
248 <li> <span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_data_count </span>+= <span class="src-var">$num</span><span class="src-sym">;</span></li>
249 <li> <span class="src-sym">}</span></li>
250 </ol></pre></p></p>
251 <ul class="tags">
252 <li><span class="field">access:</span> public</li>
253 <li><span class="field">tutorial:</span> <a href="../phpHtmlLib/tutorial_Container.cls.html#add">add Method</a></li>
254 </ul>
255
256 <div class="method-signature">
257 <span class="method-result">void</span>
258 <span class="method-name">
259 add
260 </span>
261 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span>)
262 </div>
263
264 <ul class="parameters">
265 <li>
266 <span class="var-type">mixed</span>
267 <span class="var-name">$content</span><span class="var-description">: - either string, or tag object.</span> </li>
268 </ul>
269
270
271 <hr class="separator" />
272 <div class="notes">Redefined in descendants as:</div>
273 <ul class="redefinitions">
274 <li>
275 <a href="../phpHtmlLib/OLtag.html#methodadd">OLtag::add()</a>
276 : add content onto content stack adds content to tag as a FIFO.
277 </li>
278 <li>
279 <a href="../phpHtmlLib/TRtag.html#methodadd">TRtag::add()</a>
280 : add content onto content stack adds content to tag as a FIFO.
281 </li>
282 <li>
283 <a href="../phpHtmlLib/ButtonPanel.html#methodadd">ButtonPanel::add()</a>
284 : Push content onto the data object
285 </li>
286 <li>
287 <a href="../phpHtmlLib/CSSContainer.html#methodadd">CSSContainer::add()</a>
288 : Only allow the adding of CSSBuilder
289 </li>
290 <li>
291 <a href="../phpHtmlLib/DialogWidget.html#methodadd">DialogWidget::add()</a>
292 : Pushes a content into the data object
293 </li>
294 <li>
295 <a href="../phpHtmlLib/FooterNav.html#methodadd">FooterNav::add()</a>
296 : add an entry to the footer nav
297 </li>
298 <li>
299 <a href="../phpHtmlLib/NavTable.html#methodadd">NavTable::add()</a>
300 : this function adds an entry to the navtable.
301 </li>
302 <li>
303 <a href="../phpHtmlLib/TabList.html#methodadd">TabList::add()</a>
304 : This public method adds a new tab to the table
305 </li>
306 <li>
307 <a href="../phpHtmlLib/TextCSSNav.html#methodadd">TextCSSNav::add()</a>
308 : this function adds a clickable link.
309 </li>
310 <li>
311 <a href="../phpHtmlLib/TextNav.html#methodadd">TextNav::add()</a>
312 : this function adds a clickable link.
313 </li>
314 <li>
315 <a href="../phpHtmlLib/VerticalCSSNavTable.html#methodadd">VerticalCSSNavTable::add()</a>
316 : this function adds a clickable link.
317 </li>
318 <li>
319 <a href="../phpHtmlLib/XMLDocumentClass.html#methodadd">XMLDocumentClass::add()</a>
320 : we override this class to make sure we push all content inside the local _xml_obj tag
321 </li>
322 </ul>
323 </div>
324 <a name="methodadd_reference" id="add_reference"><!-- --></a>
325 <div class="oddrow">
326
327 <div class="method-header">
328 <span class="method-title">add_reference</span> (line <span class="line-number">230</span>)
329 </div>
330
331 <!-- ========== Info from phpDoc block ========= -->
332 <p class="short-description">Add content onto content stack so you can change the item later.</p>
333 <p class="description"><p>adds content to tag as a FIFO You can only add 1 element at a time, and it will be added as a reference. So you can't do push_reference(&quot;something&quot;);, since &quot;something&quot; is a static.</p></p>
334 <ul class="tags">
335 <li><span class="field">access:</span> public</li>
336 </ul>
337
338 <div class="method-signature">
339 <span class="method-result">void</span>
340 <span class="method-name">
341 add_reference
342 </span>
343 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">&$content</span>)
344 </div>
345
346 <ul class="parameters">
347 <li>
348 <span class="var-type">mixed</span>
349 <span class="var-name">$content</span><span class="var-description">: - either string, or tag object. the tag object gets stored as a reference to the original, so you can push it, then modify it later.</span> </li>
350 </ul>
351
352
353 <hr class="separator" />
354 <div class="notes">Redefined in descendants as:</div>
355 <ul class="redefinitions">
356 <li>
357 <a href="../phpHtmlLib/OLtag.html#methodadd_reference">OLtag::add_reference()</a>
358 : push content onto content stack
359 </li>
360 <li>
361 <a href="../phpHtmlLib/TRtag.html#methodadd_reference">TRtag::add_reference()</a>
362 : add content onto content stack
363 </li>
364 <li>
365 <a href="../phpHtmlLib/XMLDocumentClass.html#methodadd_reference">XMLDocumentClass::add_reference()</a>
366 : we override this class to make sure we push all content inside the local _xml_obj tag
367 </li>
368 </ul>
369 </div>
370 <a name="methodcount_content" id="count_content"><!-- --></a>
371 <div class="evenrow">
372
373 <div class="method-header">
374 <span class="method-title">count_content</span> (line <span class="line-number">258</span>)
375 </div>
376
377 <!-- ========== Info from phpDoc block ========= -->
378 <p class="short-description">counts the number of content objects</p>
379 <p class="description"><p><pre><ol><li><span class="src-key">function </span><a href="../phpHtmlLib/Container.html#methodcount_content">count_content</a><span class="src-sym">( </span><span class="src-sym">) </span><span class="src-sym">{</span></li>
380 <li> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_data_count</span><span class="src-sym">;</span></li>
381 <li> <span class="src-sym">}</span></li>
382 </ol></pre></p></p>
383 <ul class="tags">
384 <li><span class="field">access:</span> public</li>
385 </ul>
386
387 <div class="method-signature">
388 <span class="method-result">int</span>
389 <span class="method-name">
390 count_content
391 </span>
392 ()
393 </div>
394
395
396
397 </div>
398 <a name="methodget_element" id="get_element"><!-- --></a>
399 <div class="oddrow">
400
401 <div class="method-header">
402 <span class="method-title">get_element</span> (line <span class="line-number">271</span>)
403 </div>
404
405 <!-- ========== Info from phpDoc block ========= -->
406 <p class="short-description">get the nth element from content array</p>
407 <p class="description"><p><pre><ol><li><span class="src-key">function </span><span class="src-sym">&amp;</span><a href="../phpHtmlLib/Container.html#methodget_element">get_element</a><span class="src-sym">( </span><span class="src-var">$cell </span><span class="src-sym">) </span><span class="src-sym">{</span></li>
408 <li> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_content</span><span class="src-sym">[</span><span class="src-var">$cell</span><span class="src-sym">]</span><span class="src-sym">;</span></li>
409 <li> <span class="src-sym">}</span></li>
410 </ol></pre></p></p>
411
412 <div class="method-signature">
413 <span class="method-result">mixed</span>
414 <span class="method-name">
415 &amp;get_element
416 </span>
417 (<span class="var-type">int</span>&nbsp;<span class="var-name">$cell</span>)
418 </div>
419
420 <ul class="parameters">
421 <li>
422 <span class="var-type">int</span>
423 <span class="var-name">$cell</span><span class="var-description">: the cell to get</span> </li>
424 </ul>
425
426
427 </div>
428 <a name="methodget_indent_flag" id="get_indent_flag"><!-- --></a>
429 <div class="evenrow">
430
431 <div class="method-header">
432 <span class="method-title">get_indent_flag</span> (line <span class="line-number">318</span>)
433 </div>
434
435 <!-- ========== Info from phpDoc block ========= -->
436 <p class="short-description">This flag gets the current value of the indent flag</p>
437 <p class="description"><p><pre><ol><li><span class="src-key">function </span><a href="../phpHtmlLib/Container.html#methodget_indent_flag">get_indent_flag</a><span class="src-sym">(</span><span class="src-sym">) </span><span class="src-sym">{</span></li>
438 <li> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_flags </span><span class="src-sym">&amp; </span><span class="src-id"><a href="../phpHtmlLib/_defines_inc.html#define_INDENT">_INDENT</a></span><span class="src-sym">;</span></li>
439 <li> <span class="src-sym">}</span></li>
440 </ol></pre></p></p>
441
442 <div class="method-signature">
443 <span class="method-result">boolean</span>
444 <span class="method-name">
445 get_indent_flag
446 </span>
447 ()
448 </div>
449
450
451
452 </div>
453 <a name="methodpush" id="push"><!-- --></a>
454 <div class="oddrow">
455
456 <div class="method-header">
457 <span class="method-title">push</span> (line <span class="line-number">168</span>)
458 </div>
459
460 <!-- ========== Info from phpDoc block ========= -->
461 <p class="short-description">Same as add().</p>
462 <p class="description"><p>NOTE: only exists for 1.1.x compatibility</p><p><pre><ol><li><span class="src-key">function </span><a href="../phpHtmlLib/Container.html#methodpush">push</a><span class="src-sym">( </span><span class="src-sym">) </span><span class="src-sym">{</span></li>
463 <li> <span class="src-var">$args </span>= <a href="http://www.php.net/func_get_args">func_get_args</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
464 <li> <a href="http://www.php.net/call_user_func_array">call_user_func_array</a><span class="src-sym">( </span><span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">&amp;</span><span class="src-var">$this</span><span class="src-sym">, </span><span class="src-str">&quot;add&quot;</span><span class="src-sym">)</span><span class="src-sym">, </span><span class="src-var">$args</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
465 <li> <span class="src-sym">}</span></li>
466 </ol></pre></p></p>
467 <ul class="tags">
468 <li><span class="field">access:</span> public</li>
469 <li><span class="field">deprecated:</span> </li>
470 </ul>
471
472 <div class="method-signature">
473 <span class="method-result">void</span>
474 <span class="method-name">
475 push
476 </span>
477 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span>)
478 </div>
479
480 <ul class="parameters">
481 <li>
482 <span class="var-type">mixed</span>
483 <span class="var-name">$content</span><span class="var-description">: - either string, or tag object.</span> </li>
484 </ul>
485
486
487 <hr class="separator" />
488 <div class="notes">Redefined in descendants as:</div>
489 <ul class="redefinitions">
490 <li>
491 <a href="../phpHtmlLib/TRtag.html#methodpush">TRtag::push()</a>
492 : Same ass add()
493 </li>
494 <li>
495 <a href="../phpHtmlLib/FooterNav.html#methodpush">FooterNav::push()</a>
496 : add an entry to the footer nav.
497 </li>
498 <li>
499 <a href="../phpHtmlLib/ImageThumbnailWidget.html#methodpush">ImageThumbnailWidget::push()</a>
500 </li>
501 <li>
502 <a href="../phpHtmlLib/NavTable.html#methodpush">NavTable::push()</a>
503 : depricated version of add()
504 </li>
505 <li>
506 <a href="../phpHtmlLib/TextCSSNav.html#methodpush">TextCSSNav::push()</a>
507 : depricated version of add()
508 </li>
509 <li>
510 <a href="../phpHtmlLib/TextNav.html#methodpush">TextNav::push()</a>
511 : depricated version of add()
512 </li>
513 <li>
514 <a href="../phpHtmlLib/TreeNav.html#methodpush">TreeNav::push()</a>
515 </li>
516 <li>
517 <a href="../phpHtmlLib/XMLDocumentClass.html#methodpush">XMLDocumentClass::push()</a>
518 : Same as add().
519 </li>
520 </ul>
521 </div>
522 <a name="methodpush_reference" id="push_reference"><!-- --></a>
523 <div class="evenrow">
524
525 <div class="method-header">
526 <span class="method-title">push_reference</span> (line <span class="line-number">209</span>)
527 </div>
528
529 <!-- ========== Info from phpDoc block ========= -->
530 <p class="short-description">Same as add_reference NOTE : only exists for compatibility with 1.1.x</p>
531 <p class="description"><p><pre><ol><li><span class="src-key">function </span><a href="../phpHtmlLib/Container.html#methodpush_reference">push_reference</a><span class="src-sym">( </span><span class="src-sym">&amp;</span><span class="src-var">$content </span><span class="src-sym">) </span><span class="src-sym">{</span></li>
532 <li> <span class="src-var">$this</span><span class="src-sym">-&gt;</span><a href="../phpHtmlLib/Container.html#methodadd_reference">add_reference</a><span class="src-sym">( </span><span class="src-var">$content </span><span class="src-sym">)</span><span class="src-sym">;</span></li>
533 <li> <span class="src-sym">}</span></li>
534 </ol></pre></p></p>
535 <ul class="tags">
536 <li><span class="field">access:</span> public</li>
537 </ul>
538
539 <div class="method-signature">
540 <span class="method-result">void</span>
541 <span class="method-name">
542 push_reference
543 </span>
544 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">&$content</span>)
545 </div>
546
547 <ul class="parameters">
548 <li>
549 <span class="var-type">mixed</span>
550 <span class="var-name">&$content</span><span class="var-description">: - a reference to some variable.</span> </li>
551 </ul>
552
553
554 <hr class="separator" />
555 <div class="notes">Redefined in descendants as:</div>
556 <ul class="redefinitions">
557 <li>
558 <a href="../phpHtmlLib/TRtag.html#methodpush_reference">TRtag::push_reference()</a>
559 : Same ass add_reference()
560 </li>
561 <li>
562 <a href="../phpHtmlLib/XMLDocumentClass.html#methodpush_reference">XMLDocumentClass::push_reference()</a>
563 : Same as add_reference NOTE : only exists for compatibility with 1.1.x
564 </li>
565 </ul>
566 </div>
567 <a name="methodrender" id="render"><!-- --></a>
568 <div class="oddrow">
569
570 <div class="method-header">
571 <span class="method-title">render</span> (line <span class="line-number">114</span>)
572 </div>
573
574 <!-- ========== Info from phpDoc block ========= -->
575 <p class="short-description">This function is compatible with the rest of the phpHtmllib API spec.</p>
576 <p class="description"><p>It just walks through each of the class' data and renders it with the appropriate indentation.</p><p><pre><ol><li><span class="src-key">function </span><a href="../phpHtmlLib/Container.html#methodrender">render</a><span class="src-sym">(</span><span class="src-var">$indent_level</span>=<span class="src-num">0</span><span class="src-sym">, </span><span class="src-var">$output_debug</span>=<span class="src-num">0</span><span class="src-sym">) </span><span class="src-sym">{</span></li>
577 <li> <span class="src-var">$html </span>= <span class="src-str">''</span><span class="src-sym">;</span></li>
578 <li> </li>
579 <li> <span class="src-key">for </span><span class="src-sym">(</span><span class="src-var">$x</span>=<span class="src-num">0</span><span class="src-sym">; </span><span class="src-var">$x</span>&lt;=<span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_data_count</span>-<span class="src-num">1</span><span class="src-sym">; </span><span class="src-var">$x</span>++<span class="src-sym">) </span><span class="src-sym">{</span></li>
580 <li> <span class="src-var">$item </span>= <span class="src-sym">&amp;</span><span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_content</span><span class="src-sym">[</span><span class="src-var">$x</span><span class="src-sym">]</span><span class="src-sym">;</span></li>
581 <li> <span class="src-key">if </span><span class="src-sym">(</span><a href="http://www.php.net/method_exists">method_exists</a><span class="src-sym">(</span><span class="src-var">$item</span><span class="src-sym">, </span><span class="src-str">&quot;render&quot;</span><span class="src-sym">) ) </span><span class="src-sym">{</span></li>
582 <li> <span class="src-key">if </span><span class="src-sym">((</span><span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_flags </span><span class="src-sym">&amp; </span><span class="src-id"><a href="../phpHtmlLib/_defines_inc.html#define_COLLAPSE">_COLLAPSE</a></span><span class="src-sym">) </span>&amp;&amp; <a href="http://www.php.net/method_exists">method_exists</a><span class="src-sym">(</span><span class="src-var">$item</span><span class="src-sym">, </span><span class="src-str">&quot;set_collapse&quot;</span><span class="src-sym">)) </span><span class="src-sym">{</span></li>
583 <li> <span class="src-var">$item</span><span class="src-sym">-&gt;</span><a href="../phpHtmlLib/Container.html#methodset_collapse">set_collapse</a><span class="src-sym">(</span><span class="src-id">TRUE</span><span class="src-sym">, </span><span class="src-id">FALSE</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
584 <li> <span class="src-sym">}</span></li>
585 <li> <span class="src-var">$html </span>.= <span class="src-var">$item</span><span class="src-sym">-&gt;</span><a href="../phpHtmlLib/Container.html#methodrender">render</a><span class="src-sym">(</span><span class="src-var">$indent_level</span><span class="src-sym">, </span><span class="src-var">$output_debug</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
586 <li> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></li>
587 <li> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_flags </span><span class="src-sym">&amp; </span><span class="src-id"><a href="../phpHtmlLib/_defines_inc.html#define_COLLAPSE">_COLLAPSE</a></span><span class="src-sym">) </span><span class="src-sym">{</span></li>
588 <li> <span class="src-var">$html </span>.= <span class="src-var">$item</span><span class="src-sym">; </span></li>
589 <li> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></li>
590 <li> <span class="src-var">$indent </span>= <span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_render_indent</span><span class="src-sym">(</span><span class="src-var">$indent_level</span><span class="src-sym">, </span><span class="src-var">$output_debug</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
591 <li> <span class="src-var">$html </span>.= <span class="src-var">$indent</span>.<span class="src-var">$item</span><span class="src-sym">;</span></li>
592 <li> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_flags </span><span class="src-sym">&amp; </span><span class="src-id"><a href="../phpHtmlLib/_defines_inc.html#define_NEWLINEAFTERCONTENT">_NEWLINEAFTERCONTENT</a></span><span class="src-sym">) </span><span class="src-sym">{</span></li>
593 <li> <span class="src-var">$html </span>.= <span class="src-str">&quot;\n&quot;</span><span class="src-sym">;</span></li>
594 <li> <span class="src-sym">}</span></li>
595 <li> <span class="src-sym">} </span></li>
596 <li> <span class="src-sym">}</span></li>
597 <li> <span class="src-sym">}</span></li>
598 <li> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_flags </span><span class="src-sym">&amp; </span><span class="src-id"><a href="../phpHtmlLib/_defines_inc.html#define_COLLAPSE">_COLLAPSE</a></span><span class="src-sym">) </span><span class="src-sym">{</span></li>
599 <li> <span class="src-var">$indent </span>= <span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_render_indent</span><span class="src-sym">(</span><span class="src-var">$indent_level</span><span class="src-sym">, </span><span class="src-var">$output_debug</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
600 <li> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_flags </span><span class="src-sym">&amp; </span><span class="src-id"><a href="../phpHtmlLib/_defines_inc.html#define_NEWLINEAFTERCONTENT">_NEWLINEAFTERCONTENT</a></span><span class="src-sym">) </span><span class="src-sym">{</span></li>
601 <li> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$output_debug</span><span class="src-sym">) </span><span class="src-sym">{</span></li>
602 <li> <span class="src-var">$html </span>= <span class="src-var">$indent </span>. <span class="src-var">$html </span>. <span class="src-str">&quot;&lt;br&gt;\n&quot;</span><span class="src-sym">; </span></li>
603 <li> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></li>
604 <li> <span class="src-var">$html </span>= <span class="src-var">$indent </span>. <span class="src-var">$html </span>. <span class="src-str">&quot;\n&quot;</span><span class="src-sym">;</span></li>
605 <li> <span class="src-sym">} </span></li>
606 <li> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></li>
607 <li> <span class="src-var">$html </span>= <span class="src-var">$indent </span>. <span class="src-var">$html</span><span class="src-sym">;</span></li>
608 <li> <span class="src-sym">}</span></li>
609 <li> </li>
610 <li> <span class="src-sym">}</span></li>
611 <li> <span class="src-key">return </span><span class="src-var">$html</span><span class="src-sym">;</span></li>
612 <li> <span class="src-sym">}</span></li>
613 </ol></pre></p></p>
614 <ul class="tags">
615 <li><span class="field">return:</span> the raw html output.</li>
616 </ul>
617
618 <div class="method-signature">
619 <span class="method-result">string</span>
620 <span class="method-name">
621 render
622 </span>
623 (<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_level</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$output_debug</span>)
624 </div>
625
626 <ul class="parameters">
627 <li>
628 <span class="var-type">int</span>
629 <span class="var-name">$indent_level</span><span class="var-description">: - the indentation level for the container.</span> </li>
630 <li>
631 <span class="var-type">int</span>
632 <span class="var-name">$output_debug</span><span class="var-description">: - the output debug flag to maintain compatibility w/ the API.</span> </li>
633 </ul>
634
635
636 <hr class="separator" />
637 <div class="notes">Redefined in descendants as:</div>
638 <ul class="redefinitions">
639 <li>
640 <a href="../phpHtmlLib/XMLTagClass.html#methodrender">XMLTagClass::render()</a>
641 : This function is responsible for rendering the tag and its contents
642 </li>
643 <li>
644 <a href="../phpHtmlLib/HTMLTagClass.html#methodrender">HTMLTagClass::render()</a>
645 : Renders the tag, attributes, content and close tag.
646 </li>
647 <li>
648 <a href="../phpHtmlLib/FormProcessing/FormProcessor.html#methodrender">FormProcessor::render()</a>
649 : This method is called to render the form's html
650 </li>
651 <li>
652 <a href="../phpHtmlLib/FormProcessing/FormWizard.html#methodrender">FormWizard::render()</a>
653 : This function renders the
654 </li>
655 <li>
656 <a href="../phpHtmlLib/SVG/SVGGraph.html#methodrender">SVGGraph::render()</a>
657 </li>
658 <li>
659 <a href="../phpHtmlLib/ActiveTab.html#methodrender">ActiveTab::render()</a>
660 </li>
661 <li>
662 <a href="../phpHtmlLib/ButtonPanel.html#methodrender">ButtonPanel::render()</a>
663 : render the entire table.
664 </li>
665 <li>
666 <a href="../phpHtmlLib/DialogWidget.html#methodrender">DialogWidget::render()</a>
667 : Creates a container with title,
668 </li>
669 <li>
670 <a href="../phpHtmlLib/MessageBoxWidget.html#methodrender">MessageBoxWidget::render()</a>
671 : We override the render function
672 </li>
673 <li>
674 <a href="../phpHtmlLib/FooterNav.html#methodrender">FooterNav::render()</a>
675 : render the code for this widget.
676 </li>
677 <li>
678 <a href="../phpHtmlLib/ImageThumbnailWidget.html#methodrender">ImageThumbnailWidget::render()</a>
679 : Render the entire widget. this includes the page offset links, as well as the thumbnails.
680 </li>
681 <li>
682 <a href="../phpHtmlLib/InfoTable.html#methodrender">InfoTable::render()</a>
683 : This function renders the object.
684 </li>
685 <li>
686 <a href="../phpHtmlLib/NavTable.html#methodrender">NavTable::render()</a>
687 : Render the Navtable and its content.
688 </li>
689 <li>
690 <a href="../phpHtmlLib/RoundTitleTable.html#methodrender">RoundTitleTable::render()</a>
691 : Render the Navtable and its content.
692 </li>
693 <li>
694 <a href="../phpHtmlLib/TabList.html#methodrender">TabList::render()</a>
695 : The render method
696 </li>
697 <li>
698 <a href="../phpHtmlLib/TextCSSNav.html#methodrender">TextCSSNav::render()</a>
699 : function that will render the widget.
700 </li>
701 <li>
702 <a href="../phpHtmlLib/TextNav.html#methodrender">TextNav::render()</a>
703 : function that will render the widget.
704 </li>
705 <li>
706 <a href="../phpHtmlLib/TreeNav.html#methodrender">TreeNav::render()</a>
707 : function that will render the widget.
708 </li>
709 <li>
710 <a href="../phpHtmlLib/VerticalCSSNavTable.html#methodrender">VerticalCSSNavTable::render()</a>
711 : function that will render the widget.
712 </li>
713 <li>
714 <a href="../phpHtmlLib/DataList.html#methodrender">DataList::render()</a>
715 : This function renders the final
716 </li>
717 <li>
718 <a href="../phpHtmlLib/XMLDocumentClass.html#methodrender">XMLDocumentClass::render()</a>
719 : function that will render the XML Document.
720 </li>
721 </ul>
722 </div>
723 <a name="methodreset_content" id="reset_content"><!-- --></a>
724 <div class="evenrow">
725
726 <div class="method-header">
727 <span class="method-title">reset_content</span> (line <span class="line-number">244</span>)
728 </div>
729
730 <!-- ========== Info from phpDoc block ========= -->
731 <p class="short-description">destroy existing content and start with new content.</p>
732 <p class="description"><p><pre><ol><li><span class="src-key">function </span><a href="../phpHtmlLib/Container.html#methodreset_content">reset_content</a><span class="src-sym">( </span><span class="src-sym">) </span><span class="src-sym">{</span></li>
733 <li> <span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_content </span>= <span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
734 <li> <span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_data_count </span>= <span class="src-num">0</span><span class="src-sym">;</span></li>
735 <li> <span class="src-var">$args </span>= <a href="http://www.php.net/func_get_args">func_get_args</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
736 <li> <a href="http://www.php.net/call_user_func_array">call_user_func_array</a><span class="src-sym">( </span><span class="src-key">array</span><span class="src-sym">(</span><span class="src-sym">&amp;</span><span class="src-var">$this</span><span class="src-sym">, </span><span class="src-str">&quot;add&quot;</span><span class="src-sym">)</span><span class="src-sym">, </span><span class="src-var">$args</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
737 <li> <span class="src-sym">}</span></li>
738 </ol></pre></p></p>
739 <ul class="tags">
740 <li><span class="field">access:</span> public</li>
741 </ul>
742
743 <div class="method-signature">
744 <span class="method-result">void</span>
745 <span class="method-name">
746 reset_content
747 </span>
748 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span>)
749 </div>
750
751 <ul class="parameters">
752 <li>
753 <span class="var-type">mixed</span>
754 <span class="var-name">$content</span><span class="var-description">: can be tag object, or raw (string).</span> </li>
755 </ul>
756
757
758 <hr class="separator" />
759 <div class="notes">Redefined in descendants as:</div>
760 <ul class="redefinitions">
761 <li>
762 <a href="../phpHtmlLib/XMLDocumentClass.html#methodreset_content">XMLDocumentClass::reset_content()</a>
763 : we override this class to make sure we push all content inside the local _xml_obj tag
764 </li>
765 </ul>
766 </div>
767 <a name="methodset_collapse" id="set_collapse"><!-- --></a>
768 <div class="oddrow">
769
770 <div class="method-header">
771 <span class="method-title">set_collapse</span> (line <span class="line-number">334</span>)
772 </div>
773
774 <!-- ========== Info from phpDoc block ========= -->
775 <p class="short-description">This function turns on the collapse flag</p>
776 <p class="description"><p><pre><ol><li><span class="src-key">function </span><a href="../phpHtmlLib/Container.html#methodset_collapse">set_collapse</a><span class="src-sym">(</span><span class="src-var">$collapse</span>=<span class="src-id">TRUE</span><span class="src-sym">, </span><span class="src-var">$indent</span>=<span class="src-id">TRUE</span><span class="src-sym">) </span><span class="src-sym">{</span></li>
777 <li> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$collapse</span><span class="src-sym">) </span><span class="src-sym">{</span></li>
778 <li> <span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_flags </span>|= <span class="src-id"><a href="../phpHtmlLib/_defines_inc.html#define_COLLAPSE">_COLLAPSE</a></span><span class="src-sym">;</span></li>
779 <li> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></li>
780 <li> <span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_flags </span>&amp;= ~<span class="src-id"><a href="../phpHtmlLib/_defines_inc.html#define_COLLAPSE">_COLLAPSE</a></span><span class="src-sym">;</span></li>
781 <li> <span class="src-sym">}</span></li>
782 <li> </li>
783 <li> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-var">$indent</span><span class="src-sym">) </span><span class="src-sym">{</span></li>
784 <li> <span class="src-var">$this</span><span class="src-sym">-&gt;</span><a href="../phpHtmlLib/Container.html#methodset_indent_flag">set_indent_flag</a><span class="src-sym">(</span><span class="src-var">$indent</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
785 <li> <span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_flags </span>&amp;= ~<span class="src-id"><a href="../phpHtmlLib/_defines_inc.html#define_NEWLINEAFTERCONTENT">_NEWLINEAFTERCONTENT</a></span><span class="src-sym">;</span></li>
786 <li> <span class="src-sym">} </span></li>
787 <li> <span class="src-sym">}</span></li>
788 </ol></pre></p></p>
789 <ul class="tags">
790 <li><span class="field">tutorial:</span> <a href="../phpHtmlLib/tutorial_Container.cls.html#collapse">Collapse</a></li>
791 </ul>
792
793 <div class="method-signature">
794 <span class="method-result">void</span>
795 <span class="method-name">
796 set_collapse
797 </span>
798 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$collapse</span> = <span class="var-default">TRUE</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$indent</span> = <span class="var-default">TRUE</span>])
799 </div>
800
801 <ul class="parameters">
802 <li>
803 <span class="var-type">boolean</span>
804 <span class="var-name">$collapse</span><span class="var-description">: - the collapse flag</span> </li>
805 <li>
806 <span class="var-type">boolean</span>
807 <span class="var-name">$indent</span><span class="var-description">: - the indent flag DEFAULT: TRUE;</span> </li>
808 </ul>
809
810
811 <hr class="separator" />
812 <div class="notes">Redefined in descendants as:</div>
813 <ul class="redefinitions">
814 <li>
815 <a href="../phpHtmlLib/XMLTagClass.html#methodset_collapse">XMLTagClass::set_collapse()</a>
816 : This function turns on the collapse flag
817 </li>
818 </ul>
819 </div>
820 <a name="methodset_indent_flag" id="set_indent_flag"><!-- --></a>
821 <div class="evenrow">
822
823 <div class="method-header">
824 <span class="method-title">set_indent_flag</span> (line <span class="line-number">301</span>)
825 </div>
826
827 <!-- ========== Info from phpDoc block ========= -->
828 <p class="short-description">function to set the indent flag</p>
829 <p class="description"><p><pre><ol><li><span class="src-key">function </span><a href="../phpHtmlLib/Container.html#methodset_indent_flag">set_indent_flag</a><span class="src-sym">( </span><span class="src-var">$flag </span><span class="src-sym">) </span><span class="src-sym">{</span></li>
830 <li> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$flag</span><span class="src-sym">) </span><span class="src-sym">{</span></li>
831 <li> <span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_flags </span>|= <span class="src-id"><a href="../phpHtmlLib/_defines_inc.html#define_INDENT">_INDENT</a></span><span class="src-sym">;</span></li>
832 <li> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></li>
833 <li> <span class="src-var">$this</span><span class="src-sym">-&gt;</span><span class="src-id">_flags </span>&amp;= ~<span class="src-id"><a href="../phpHtmlLib/_defines_inc.html#define_INDENT">_INDENT</a></span><span class="src-sym">;</span></li>
834 <li> <span class="src-sym">}</span></li>
835 <li> <span class="src-sym">}</span></li>
836 </ol></pre></p></p>
837 <ul class="tags">
838 <li><span class="field">access:</span> public</li>
839 </ul>
840
841 <div class="method-signature">
842 <span class="method-result">void</span>
843 <span class="method-name">
844 set_indent_flag
845 </span>
846 (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span>)
847 </div>
848
849 <ul class="parameters">
850 <li>
851 <span class="var-type">boolean</span>
852 <span class="var-name">$flag</span><span class="var-description">: TRUE or FALSE</span> </li>
853 </ul>
854
855
856 </div>
857
858 </div>
859 </div>
860
861
862 <p class="notes" id="credit">
863 Documentation generated on Thu, 1 Apr 2004 09:38:06 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
864 </p>
865 </div></body>
866 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed