1 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'> |
2 |
<!--NewPage--> |
3 |
<HTML> |
4 |
<HEAD> |
5 |
<!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:23:07 -0800' --> |
6 |
<TITLE>Docs For Class RoundTitleTable</TITLE> |
7 |
<LINK REL ='stylesheet' TYPE='text/css' HREF='../media/stylesheet.css' TITLE='Style'> |
8 |
</HEAD> |
9 |
<BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> |
10 |
<!-- Links --> |
11 |
<a NAME="top"></A> |
12 |
<table WIDTH="100%" class="links"> |
13 |
<TR> |
14 |
<TD class="font10"> |
15 |
Links: |
16 |
<A HREF="#children_summary" class="links" title="Classes extended from RoundTitleTable">Child Classes</A> |
17 |
<A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A> |
18 |
<A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A> |
19 |
<A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A> |
20 |
<A HREF="#method_summary" class="links" title="Method Summary">Methods</A> |
21 |
<A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A> |
22 |
<A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A> |
23 |
</TD> |
24 |
</TR> |
25 |
</TABLE> |
26 |
<BR> |
27 |
<!-- Start of Class Data --> |
28 |
<H2> |
29 |
Class RoundTitleTable |
30 |
</H2> (line <span class="linenumber">25</span>) |
31 |
<pre> |
32 |
<a href="../phpHtmlLib/Container.html">Container</a> |
33 |
| |
34 |
--<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a> |
35 |
| |
36 |
--RoundTitleTable</pre> |
37 |
<p> |
38 |
<b><i>Located in File: Program_Root/widgets/RoundTitleTable.inc</i></b><br> |
39 |
</p> |
40 |
<hr> |
41 |
This builds a table widget that has a nice rounded title, a subtitle area and any amount of data. |
42 |
<br /> |
43 |
|
44 |
<UL> |
45 |
<LI><b>author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></CODE></LI> |
46 |
</UL> |
47 |
<hr> |
48 |
<!-- =========== VAR SUMMARY =========== --> |
49 |
<A NAME='var_summary'><!-- --></A> |
50 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
51 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
52 |
<TD> |
53 |
<span CLASS="font12bold">Class Variable Summary</span> |
54 |
<A HREF="#top" CLASS="links">^TOP</A> |
55 |
</TD> |
56 |
</TR> |
57 |
|
58 |
</TABLE> |
59 |
<hr> |
60 |
<!-- =========== VAR INHERITED SUMMARY =========== --> |
61 |
<A NAME='var_inherited_summary'><!-- --></A> |
62 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
63 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
64 |
<TD> |
65 |
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
66 |
<A HREF="#top" CLASS="links">^TOP</A> |
67 |
</TD> |
68 |
</TR> |
69 |
|
70 |
<!-- =========== Summary =========== --> |
71 |
<TR BGCOLOR='white'> |
72 |
<TD> |
73 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span> |
74 |
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
75 |
<tr CLASS="tableheadingcolor"> |
76 |
<th>Variable</th> |
77 |
<th>Default Value</th> |
78 |
<th>Description</th> |
79 |
</tr> |
80 |
<tr> |
81 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></td> |
82 |
<td CLASS="font10" STYLE="white-space: nowrap">->''<-</td> |
83 |
<td CLASS="font10">The title of the table.</td> |
84 |
</tr> |
85 |
<tr> |
86 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></td> |
87 |
<td CLASS="font10" STYLE="white-space: nowrap">->"100%"<-</td> |
88 |
<td CLASS="font10">the width of the widget</td> |
89 |
</tr> |
90 |
</table> |
91 |
<BR> |
92 |
</TD> |
93 |
</TR> |
94 |
<!-- =========== Summary =========== --> |
95 |
<TR BGCOLOR='white'> |
96 |
<TD> |
97 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> |
98 |
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
99 |
<tr CLASS="tableheadingcolor"> |
100 |
<th>Variable</th> |
101 |
<th>Default Value</th> |
102 |
<th>Description</th> |
103 |
</tr> |
104 |
<tr> |
105 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></td> |
106 |
<td CLASS="font10" STYLE="white-space: nowrap">-> _NEWLINEAFTERCONTENT<-</td> |
107 |
<td CLASS="font10">The flags that tell us</td> |
108 |
</tr> |
109 |
</table> |
110 |
<BR> |
111 |
</TD> |
112 |
</TR> |
113 |
</TABLE> |
114 |
|
115 |
<hr> |
116 |
<!-- =========== METHOD SUMMARY =========== --> |
117 |
<A NAME='method_summary'><!-- --></A> |
118 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
119 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
120 |
<TD> |
121 |
<span class="font12bold">Method Summary</span> |
122 |
<A HREF="#top" CLASS="links">^TOP</A> |
123 |
</TD> |
124 |
</TR> |
125 |
|
126 |
<!-- =========== Summary =========== --> |
127 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
128 |
<TD> |
129 |
<CODE><B><A HREF='../phpHtmlLib/RoundTitleTable.html#methodRoundTitleTable'>void constructor RoundTitleTable ( $title, [$subtitle = NULL], [$width = "100%"] )</A></B></CODE> |
130 |
<BR> |
131 |
<blockquote> the constructor for this class. </blockquote> |
132 |
</TD> |
133 |
</TR> |
134 |
<!-- =========== Summary =========== --> |
135 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
136 |
<TD> |
137 |
<CODE><B><A HREF='../phpHtmlLib/RoundTitleTable.html#methodrender'>string render ( [$indent_level = 1], [$output_debug = 0] )</A></B></CODE> |
138 |
<BR> |
139 |
<blockquote> Render the Navtable and its content. </blockquote> |
140 |
</TD> |
141 |
</TR> |
142 |
<!-- =========== Summary =========== --> |
143 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
144 |
<TD> |
145 |
<CODE><B><A HREF='../phpHtmlLib/RoundTitleTable.html#methodset_subtitle'>void set_subtitle ( $subtitle )</A></B></CODE> |
146 |
<BR> |
147 |
<blockquote> </blockquote> |
148 |
</TD> |
149 |
</TR> |
150 |
<!-- =========== Summary =========== --> |
151 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
152 |
<TD> |
153 |
<CODE><B><A HREF='../phpHtmlLib/RoundTitleTable.html#method_build_subtitle'><a href="../phpHtmlLib/TDtag.html">TDtag</a> _build_subtitle ( )</A></B></CODE> |
154 |
<BR> |
155 |
<blockquote> this function builds the subtitle td to hold the...subtitle! </blockquote> |
156 |
</TD> |
157 |
</TR> |
158 |
</TABLE> |
159 |
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
160 |
<A NAME='functions_inherited'><!-- --></A> |
161 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
162 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
163 |
<TD> |
164 |
<span CLASS="font12bold">Inherited Method Summary</span> |
165 |
<A HREF="#top" CLASS="links">^TOP</A> |
166 |
</TD> |
167 |
</TR> |
168 |
|
169 |
<!-- =========== Summary =========== --> |
170 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
171 |
<TD> |
172 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span> |
173 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
174 |
<tr CLASS="tableheadingcolor"> |
175 |
<th>Function</th> |
176 |
<th>Description</th> |
177 |
</tr> |
178 |
<tr> |
179 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></td> |
180 |
<td CLASS="font10">This gets the alignment value for the outer table</td> |
181 |
<tr> |
182 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></td> |
183 |
<td CLASS="font10">This function provides the mechanism to build and return the css needed by this widget</td> |
184 |
<tr> |
185 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></td> |
186 |
<td CLASS="font10">Function for returning the raw javascript that is required for this widget.</td> |
187 |
<tr> |
188 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></td> |
189 |
<td CLASS="font10">Function for accessing the title of this widget</td> |
190 |
<tr> |
191 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></td> |
192 |
<td CLASS="font10">Function for getting the current widget width setting.</td> |
193 |
<tr> |
194 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></td> |
195 |
<td CLASS="font10">This function sets the align attribute for the outer table.</td> |
196 |
<tr> |
197 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></td> |
198 |
<td CLASS="font10">Set the title for the widget.</td> |
199 |
<tr> |
200 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></td> |
201 |
<td CLASS="font10">Set the width for the widget.</td> |
202 |
</table> |
203 |
<br> |
204 |
</TD> |
205 |
</TR> |
206 |
<!-- =========== Summary =========== --> |
207 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
208 |
<TD> |
209 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> |
210 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
211 |
<tr CLASS="tableheadingcolor"> |
212 |
<th>Function</th> |
213 |
<th>Description</th> |
214 |
</tr> |
215 |
<tr> |
216 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></td> |
217 |
<td CLASS="font10">The constructor.</td> |
218 |
<tr> |
219 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></td> |
220 |
<td CLASS="font10">add content onto content stack</td> |
221 |
<tr> |
222 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></td> |
223 |
<td CLASS="font10">Add content onto content stack so you can change the item later.</td> |
224 |
<tr> |
225 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></td> |
226 |
<td CLASS="font10">counts the number of content objects</td> |
227 |
<tr> |
228 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></td> |
229 |
<td CLASS="font10">This flag gets the current value of the indent flag</td> |
230 |
<tr> |
231 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></td> |
232 |
<td CLASS="font10">Same as add().</td> |
233 |
<tr> |
234 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></td> |
235 |
<td CLASS="font10">Same as add_reference NOTE : only exists for compatibility with 1.1.x</td> |
236 |
<tr> |
237 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></td> |
238 |
<td CLASS="font10">This function is compatible with the rest of the phpHtmllib API spec.</td> |
239 |
<tr> |
240 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></td> |
241 |
<td CLASS="font10">destroy existing content and start with new content.</td> |
242 |
<tr> |
243 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></td> |
244 |
<td CLASS="font10">This function turns on the collapse flag</td> |
245 |
<tr> |
246 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></td> |
247 |
<td CLASS="font10">function to set the indent flag</td> |
248 |
<tr> |
249 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></td> |
250 |
<td CLASS="font10">This method is used to set the bitmask flags for this tag. It tells the class how to render the tag.</td> |
251 |
</table> |
252 |
<br> |
253 |
</TD> |
254 |
</TR> |
255 |
</TABLE> |
256 |
<hr> |
257 |
<!-- ============ VARIABLE DETAIL =========== --> |
258 |
|
259 |
<A NAME='variable_detail'></A> |
260 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
261 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
262 |
<TD> |
263 |
<span CLASS="font12bold">Variable Detail</span> |
264 |
<A HREF="#top" CLASS="links">^TOP</A> |
265 |
</TD> |
266 |
</TR> |
267 |
</TABLE> |
268 |
|
269 |
<hr> |
270 |
<!-- ============ METHOD DETAIL =========== --> |
271 |
|
272 |
<A NAME='method_detail'></A> |
273 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
274 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
275 |
<TD> |
276 |
<span class="font12bold">Method Detail</span> |
277 |
<A HREF="#top" CLASS="links">^TOP</A> |
278 |
</TD> |
279 |
</TR> |
280 |
</TABLE> |
281 |
<BR> |
282 |
<DIV CLASS="function"> |
283 |
<A NAME='methodRoundTitleTable'><!-- --></A> |
284 |
<SPAN CLASS="font12bold">Constructor RoundTitleTable</SPAN> (line <span class="linenumber">35</span>) |
285 |
<BR> |
286 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
287 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
288 |
<span class="font10bold" style="color: #0000FF">RoundTitleTable( |
289 |
string |
290 |
$title, [string |
291 |
$subtitle = NULL], [mixed |
292 |
$width = "100%"])</SPAN> |
293 |
<BR> |
294 |
|
295 |
<BR> |
296 |
<SPAN CLASS="font10bold">Description : </SPAN> |
297 |
the constructor for this class. |
298 |
<br /> |
299 |
|
300 |
<DL> |
301 |
<DT class="font10bold">Function Parameters:</DT> |
302 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$title</SPAN></SPAN> - the title for the widget.</DD> |
303 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$subtitle</SPAN></SPAN> - the subtitle if any.</DD> |
304 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">$width</SPAN></SPAN> - the width of the widget. can be a % or an int.</DD> |
305 |
|
306 |
<DT class="font10bold">Function Info:</DT> |
307 |
</DL> |
308 |
</DIV> |
309 |
<BR> |
310 |
<DIV CLASS="function"> |
311 |
<A NAME='methodrender'><!-- --></A> |
312 |
<SPAN CLASS="font12bold">render</SPAN> (line <span class="linenumber">98</span>) |
313 |
<BR> |
314 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
315 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
316 |
<span class="font10bold" style="color: #0000FF">render( |
317 |
[int |
318 |
$indent_level = 1], int |
319 |
$output_debug)</SPAN> |
320 |
<BR> |
321 |
|
322 |
<BR> |
323 |
<SPAN CLASS="font10bold">Description : </SPAN> |
324 |
Render the Navtable and its content. |
325 |
<br /> |
326 |
|
327 |
<DL> |
328 |
<DT class="font10bold">Function Parameters:</DT> |
329 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$indent_level</SPAN></SPAN> - the indentation level for the container.</DD> |
330 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$output_debug</SPAN></SPAN> - the output debug flag to maintain compatibility w/ the API.</DD> |
331 |
|
332 |
<DT class="font10bold">Function Info:</DT> |
333 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - the raw html output.</DD> |
334 |
</DL> |
335 |
</DIV> |
336 |
<BR> |
337 |
<DIV CLASS="function"> |
338 |
<A NAME='methodset_subtitle'><!-- --></A> |
339 |
<SPAN CLASS="font12bold">set_subtitle</SPAN> (line <span class="linenumber">43</span>) |
340 |
<BR> |
341 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
342 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
343 |
<span class="font10bold" style="color: #0000FF">set_subtitle( |
344 |
mixed |
345 |
$subtitle)</SPAN> |
346 |
<BR> |
347 |
|
348 |
<BR> |
349 |
<SPAN CLASS="font10bold">Description : </SPAN> |
350 |
|
351 |
<br /> |
352 |
|
353 |
<DL> |
354 |
|
355 |
<DT class="font10bold">Function Info:</DT> |
356 |
</DL> |
357 |
</DIV> |
358 |
<BR> |
359 |
<DIV CLASS="function"> |
360 |
<A NAME='method_build_subtitle'><!-- --></A> |
361 |
<SPAN CLASS="font12bold">_build_subtitle</SPAN> (line <span class="linenumber">80</span>) |
362 |
<BR> |
363 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
364 |
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/TDtag.html">TDtag</a></SPAN> |
365 |
<span class="font10bold" style="color: #0000FF">_build_subtitle( |
366 |
)</SPAN> |
367 |
<BR> |
368 |
|
369 |
<BR> |
370 |
<SPAN CLASS="font10bold">Description : </SPAN> |
371 |
this function builds the subtitle td to hold the...subtitle! |
372 |
<br /> |
373 |
|
374 |
<DL> |
375 |
|
376 |
<DT class="font10bold">Function Info:</DT> |
377 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object</DD> |
378 |
</DL> |
379 |
</DIV> |
380 |
<BR> |
381 |
<div id="credit"> |
382 |
<hr> |
383 |
Documention generated on Thu, 20 Feb 2003 16:23:07 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a> |
384 |
</div> |
385 |
</body> |
386 |
</html> |