1 |
jonen |
1.1 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'> |
2 |
|
|
<!--NewPage--> |
3 |
|
|
<HTML> |
4 |
|
|
<HEAD> |
5 |
|
|
<!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:29 -0800' --> |
6 |
|
|
<TITLE>Docs For Class CSSBuilder</TITLE> |
7 |
|
|
<LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'> |
8 |
|
|
</HEAD> |
9 |
|
|
<BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> |
10 |
|
|
|
11 |
|
|
|
12 |
|
|
<!-- Links --> |
13 |
|
|
<a NAME="top"></A> |
14 |
|
|
<table WIDTH="100%" class="links"> |
15 |
|
|
<TR> |
16 |
|
|
<TD class="font10"> |
17 |
|
|
Links: |
18 |
|
|
<A HREF="#children_summary" class="links" title="Classes extended from CSSBuilder">Child Classes</A> |
19 |
|
|
<A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A> |
20 |
|
|
<A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A> |
21 |
|
|
<A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inerited Methods</A> |
22 |
|
|
<A HREF="#functions_summary" class="links" title="Method Summary">Methods</A> |
23 |
|
|
<A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A> |
24 |
|
|
<A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A> |
25 |
|
|
</TD> |
26 |
|
|
</TR> |
27 |
|
|
</TABLE> |
28 |
|
|
<BR> |
29 |
|
|
|
30 |
|
|
<!-- Start of Class Data --> |
31 |
|
|
<H2> |
32 |
|
|
Class CSSBuilder |
33 |
|
|
</H2> |
34 |
|
|
|
35 |
|
|
<pre> |
36 |
|
|
CSSBuilder |
37 |
|
|
</pre> |
38 |
|
|
|
39 |
|
|
<A NAME="children_summary"</A> |
40 |
|
|
<H3> |
41 |
|
|
Classes extended from CSSBuilder: <A HREF="#top" CLASS="links">^TOP</A> |
42 |
|
|
</H3> |
43 |
|
|
<a href="../phpHtmlLib/FooterNavCSS.html">FooterNavCSS</a>, <a href="../phpHtmlLib/ActiveTabCSS.html">ActiveTabCSS</a>, <a href="../phpHtmlLib/InfoTableCSS.html">InfoTableCSS</a>, <a href="../phpHtmlLib/NavTableCSS.html">NavTableCSS</a>, <a href="../phpHtmlLib/TextNavCSS.html">TextNavCSS</a>, <a href="../phpHtmlLib/TextCSSNavCSS.html">TextCSSNavCSS</a>, <a href="../phpHtmlLib/VerticalCSSNavTableCSS.html">VerticalCSSNavTableCSS</a>, <a href="../phpHtmlLib/ImageThumbnailWidgetCSS.html">ImageThumbnailWidgetCSS</a>, <a href="../phpHtmlLib/DefaultGUIDataListCSS.html">DefaultGUIDataListCSS</a> |
44 |
|
|
<p> |
45 |
|
|
<b><i>Located in File: Program_Root/widgets/CSSBuilder.inc</i></b><br> |
46 |
|
|
</p> |
47 |
|
|
<hr> |
48 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
49 |
|
|
This class is a widget for constructing and |
50 |
|
|
rendering css. |
51 |
|
|
<BR> |
52 |
|
|
It exports API's for adding |
53 |
|
|
classes, ids and their attributes. |
54 |
|
|
It can render as either a stand alone |
55 |
|
|
foo.css type of file, with the appropriate |
56 |
|
|
httpd header, or as part of a <style> tag's |
57 |
|
|
content that lives as part of an html document. |
58 |
|
|
|
59 |
|
|
This class lets you create classes in the format |
60 |
|
|
|
61 |
|
|
name extends_list { |
62 |
|
|
property: value; |
63 |
|
|
} |
64 |
|
|
|
65 |
|
|
|
66 |
|
|
ie. |
67 |
|
|
#foo div, span { |
68 |
|
|
font-family: arial, helvetica; |
69 |
|
|
font-size: 10pt; |
70 |
|
|
} |
71 |
|
|
|
72 |
|
|
<UL> |
73 |
|
|
|
74 |
|
|
<LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI> |
75 |
|
|
|
76 |
|
|
<LI><b>Author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></CODE></LI> |
77 |
|
|
|
78 |
|
|
</UL> |
79 |
|
|
|
80 |
|
|
<hr> |
81 |
|
|
<!-- =========== VAR SUMMARY =========== --> |
82 |
|
|
<A NAME='var_summary'><!-- --></A> |
83 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
84 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
85 |
|
|
<TD> |
86 |
|
|
<span CLASS="font12bold">Class Variable Summary</span> |
87 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
88 |
|
|
</TD> |
89 |
|
|
</TR> |
90 |
|
|
|
91 |
|
|
|
92 |
|
|
<!-- =========== Summary =========== --> |
93 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
94 |
|
|
<TD> |
95 |
|
|
<CODE><B><A HREF='CSSBuilder.html#$indent_flag'>$indent_flag</A></B></CODE> |
96 |
|
|
<BR> |
97 |
|
|
<blockquote> Flag for pretty (indented) output </blockquote> |
98 |
|
|
<blockquote> Default Value: <CODE>->TRUE<-</CODE> </blockquote> |
99 |
|
|
</TD> |
100 |
|
|
</TR> |
101 |
|
|
|
102 |
|
|
<!-- =========== Summary =========== --> |
103 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
104 |
|
|
<TD> |
105 |
|
|
<CODE><B><A HREF='CSSBuilder.html#$_entries'>$_entries</A></B></CODE> |
106 |
|
|
<BR> |
107 |
|
|
<blockquote> This holds the entries for the css </blockquote> |
108 |
|
|
<blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote> |
109 |
|
|
</TD> |
110 |
|
|
</TR> |
111 |
|
|
|
112 |
|
|
<!-- =========== Summary =========== --> |
113 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
114 |
|
|
<TD> |
115 |
|
|
<CODE><B><A HREF='CSSBuilder.html#$_header_flag'>$_header_flag</A></B></CODE> |
116 |
|
|
<BR> |
117 |
|
|
<blockquote> Flag to let us know if we should </blockquote> |
118 |
|
|
<blockquote> Default Value: <CODE>->FALSE<-</CODE> </blockquote> |
119 |
|
|
</TD> |
120 |
|
|
</TR> |
121 |
|
|
|
122 |
|
|
</TABLE> |
123 |
|
|
|
124 |
|
|
<hr> |
125 |
|
|
<!-- =========== VAR INHERITED SUMMARY =========== --> |
126 |
|
|
<A NAME='var_inherited_summary'><!-- --></A> |
127 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
128 |
|
|
<TR CLASS='TableHeadingColor'> |
129 |
|
|
<TD> |
130 |
|
|
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
131 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
132 |
|
|
</TD> |
133 |
|
|
</TR> |
134 |
|
|
|
135 |
|
|
|
136 |
|
|
</TABLE> |
137 |
|
|
|
138 |
|
|
<hr> |
139 |
|
|
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
140 |
|
|
<A NAME='functions_inherited'><!-- --></A> |
141 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
142 |
|
|
<TR CLASS='TableHeadingColor'> |
143 |
|
|
<TD> |
144 |
|
|
<span CLASS="font12bold">Inherited Method Summary</span> |
145 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
146 |
|
|
</TD> |
147 |
|
|
</TR> |
148 |
|
|
|
149 |
|
|
|
150 |
|
|
</TABLE> |
151 |
|
|
|
152 |
|
|
<hr> |
153 |
|
|
<!-- should have constructor at some point --> |
154 |
|
|
<!-- =========== Method SUMMARY =========== --> |
155 |
|
|
<A NAME='Method_summary'><!-- --></A> |
156 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
157 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
158 |
|
|
<TD> |
159 |
|
|
<span class="font12bold">Method Summary</span> |
160 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
161 |
|
|
</TD> |
162 |
|
|
</TR> |
163 |
|
|
|
164 |
|
|
|
165 |
|
|
<!-- =========== Summary =========== --> |
166 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
167 |
|
|
<TD> |
168 |
|
|
<CODE><B><A HREF='CSSBuilder.html#constructor CSSBuilder'>void constructor CSSBuilder ( [$header_flag = FALSE] )</A></B></CODE> |
169 |
|
|
<BR> |
170 |
|
|
<blockquote> The CSSBuilder constructor </blockquote> |
171 |
|
|
</TD> |
172 |
|
|
</TR> |
173 |
|
|
|
174 |
|
|
<!-- =========== Summary =========== --> |
175 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
176 |
|
|
<TD> |
177 |
|
|
<CODE><B><A HREF='CSSBuilder.html#add_entry'>void add_entry ( $name, $extends, $attributes )</A></B></CODE> |
178 |
|
|
<BR> |
179 |
|
|
<blockquote> This function adds a new class entry </blockquote> |
180 |
|
|
</TD> |
181 |
|
|
</TR> |
182 |
|
|
|
183 |
|
|
<!-- =========== Summary =========== --> |
184 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
185 |
|
|
<TD> |
186 |
|
|
<CODE><B><A HREF='CSSBuilder.html#render'>string render ( [$indent_level = 1], [$output_debug = 0] )</A></B></CODE> |
187 |
|
|
<BR> |
188 |
|
|
<blockquote> The render method for compatibility |
189 |
|
|
with the rest of the phphtmllib api </blockquote> |
190 |
|
|
</TD> |
191 |
|
|
</TR> |
192 |
|
|
|
193 |
|
|
<!-- =========== Summary =========== --> |
194 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
195 |
|
|
<TD> |
196 |
|
|
<CODE><B><A HREF='CSSBuilder.html#set_header_flag'>void set_header_flag ( $flag )</A></B></CODE> |
197 |
|
|
<BR> |
198 |
|
|
<blockquote> This is used to set/update the header |
199 |
|
|
flag. </blockquote> |
200 |
|
|
</TD> |
201 |
|
|
</TR> |
202 |
|
|
|
203 |
|
|
<!-- =========== Summary =========== --> |
204 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
205 |
|
|
<TD> |
206 |
|
|
<CODE><B><A HREF='CSSBuilder.html#update_all_values'>void update_all_values ( $property, $search, $value )</A></B></CODE> |
207 |
|
|
<BR> |
208 |
|
|
<blockquote> This function is a macro for walking the entire |
209 |
|
|
list of classes, looking for particular property |
210 |
|
|
in each class. </blockquote> |
211 |
|
|
</TD> |
212 |
|
|
</TR> |
213 |
|
|
|
214 |
|
|
<!-- =========== Summary =========== --> |
215 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
216 |
|
|
<TD> |
217 |
|
|
<CODE><B><A HREF='CSSBuilder.html#update_properties'>void update_properties ( $name, $extends, $properties )</A></B></CODE> |
218 |
|
|
<BR> |
219 |
|
|
<blockquote> This function updates a css property value |
220 |
|
|
for a specific class/id </blockquote> |
221 |
|
|
</TD> |
222 |
|
|
</TR> |
223 |
|
|
|
224 |
|
|
<!-- =========== Summary =========== --> |
225 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
226 |
|
|
<TD> |
227 |
|
|
<CODE><B><A HREF='CSSBuilder.html#update_property'>void update_property ( $name, $extends, $property, $value )</A></B></CODE> |
228 |
|
|
<BR> |
229 |
|
|
<blockquote> This function updates a css property value |
230 |
|
|
for a specific class/id </blockquote> |
231 |
|
|
</TD> |
232 |
|
|
</TR> |
233 |
|
|
|
234 |
|
|
<!-- =========== Summary =========== --> |
235 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
236 |
|
|
<TD> |
237 |
|
|
<CODE><B><A HREF='CSSBuilder.html#user_setup'>void user_setup ( )</A></B></CODE> |
238 |
|
|
<BR> |
239 |
|
|
<blockquote> Call the child class' setup function </blockquote> |
240 |
|
|
</TD> |
241 |
|
|
</TR> |
242 |
|
|
|
243 |
|
|
<!-- =========== Summary =========== --> |
244 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
245 |
|
|
<TD> |
246 |
|
|
<CODE><B><A HREF='CSSBuilder.html#_build_name'>the _build_name ( $class )</A></B></CODE> |
247 |
|
|
<BR> |
248 |
|
|
<blockquote> This function is used to construct the css name |
249 |
|
|
declaration string. </blockquote> |
250 |
|
|
</TD> |
251 |
|
|
</TR> |
252 |
|
|
|
253 |
|
|
<!-- =========== Summary =========== --> |
254 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
255 |
|
|
<TD> |
256 |
|
|
<CODE><B><A HREF='CSSBuilder.html#_build_properties'>string _build_properties ( $properties, $indent_str )</A></B></CODE> |
257 |
|
|
<BR> |
258 |
|
|
<blockquote> This function is used to construct the |
259 |
|
|
property: value strings for the class </blockquote> |
260 |
|
|
</TD> |
261 |
|
|
</TR> |
262 |
|
|
|
263 |
|
|
<!-- =========== Summary =========== --> |
264 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
265 |
|
|
<TD> |
266 |
|
|
<CODE><B><A HREF='CSSBuilder.html#_replace_value'>void _replace_value ( &$item, $key, $blah )</A></B></CODE> |
267 |
|
|
<BR> |
268 |
|
|
<blockquote> This function does the main work for update_all_values </blockquote> |
269 |
|
|
</TD> |
270 |
|
|
</TR> |
271 |
|
|
|
272 |
|
|
</TABLE> |
273 |
|
|
|
274 |
|
|
<hr> |
275 |
|
|
<!-- ============ VARIABLE DETAIL =========== --> |
276 |
|
|
|
277 |
|
|
<A NAME='variable_detail'></A> |
278 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
279 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
280 |
|
|
<TD> |
281 |
|
|
<span CLASS="font12bold">Variable Detail</span> |
282 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
283 |
|
|
</TD> |
284 |
|
|
</TR> |
285 |
|
|
</TABLE> |
286 |
|
|
|
287 |
|
|
|
288 |
|
|
<A NAME='$indent_flag'><!-- --></A><H3>$indent_flag</H3> |
289 |
|
|
<b>Data type:</b> boolean<br> |
290 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
291 |
|
|
Flag for pretty (indented) output |
292 |
|
|
<BR> |
293 |
|
|
|
294 |
|
|
|
295 |
|
|
<UL> |
296 |
|
|
|
297 |
|
|
<LI><b>Access</b> - <CODE>public</CODE></LI> |
298 |
|
|
|
299 |
|
|
</UL> |
300 |
|
|
|
301 |
|
|
<HR> |
302 |
|
|
|
303 |
|
|
<A NAME='$_entries'><!-- --></A><H3>$_entries</H3> |
304 |
|
|
<b>Data type:</b> array<br> |
305 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
306 |
|
|
This holds the entries for the css |
307 |
|
|
<BR> |
308 |
|
|
|
309 |
|
|
|
310 |
|
|
<UL> |
311 |
|
|
|
312 |
|
|
</UL> |
313 |
|
|
|
314 |
|
|
<HR> |
315 |
|
|
|
316 |
|
|
<A NAME='$_header_flag'><!-- --></A><H3>$_header_flag</H3> |
317 |
|
|
<b>Data type:</b> boolean<br> |
318 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
319 |
|
|
Flag to let us know if we should |
320 |
|
|
<BR> |
321 |
|
|
output a header content-type value |
322 |
|
|
header("Content-Type: text/css"); |
323 |
|
|
|
324 |
|
|
<UL> |
325 |
|
|
|
326 |
|
|
</UL> |
327 |
|
|
|
328 |
|
|
<HR> |
329 |
|
|
|
330 |
|
|
|
331 |
|
|
<hr> |
332 |
|
|
<!-- ============ FUNCTION DETAIL =========== --> |
333 |
|
|
|
334 |
|
|
<A NAME='function_detail'></A> |
335 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
336 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
337 |
|
|
<TD> |
338 |
|
|
<span class="font12bold">Method Detail</span> |
339 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
340 |
|
|
</TD> |
341 |
|
|
</TR> |
342 |
|
|
</TABLE> |
343 |
|
|
<BR> |
344 |
|
|
|
345 |
|
|
<DIV CLASS="function"> |
346 |
|
|
<A NAME='constructor CSSBuilder'><!-- --></A> |
347 |
|
|
<SPAN CLASS="font12bold">constructor CSSBuilder</SPAN> |
348 |
|
|
<BR> |
349 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
350 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
351 |
|
|
<span class="font10bold" style="color: #0000FF">constructor CSSBuilder ( [$header_flag = FALSE] )</SPAN> |
352 |
|
|
<BR> |
353 |
|
|
|
354 |
|
|
<BR> |
355 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
356 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
357 |
|
|
The CSSBuilder constructor |
358 |
|
|
<BR> |
359 |
|
|
|
360 |
|
|
<DL> |
361 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
362 |
|
|
|
363 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">boolean</SPAN> <span style="color: #0000FF;font-weight:bold">$header_flag</SPAN></SPAN> - output the http header |
364 |
|
|
content type mime type |
365 |
|
|
or not.</DD> |
366 |
|
|
|
367 |
|
|
|
368 |
|
|
<DT class="font10bold">Function Info:</DT> |
369 |
|
|
|
370 |
|
|
</DL> |
371 |
|
|
|
372 |
|
|
</DIV> |
373 |
|
|
<BR> |
374 |
|
|
|
375 |
|
|
<DIV CLASS="function"> |
376 |
|
|
<A NAME='add_entry'><!-- --></A> |
377 |
|
|
<SPAN CLASS="font12bold">add_entry</SPAN> |
378 |
|
|
<BR> |
379 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
380 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
381 |
|
|
<span class="font10bold" style="color: #0000FF">add_entry ( $name, $extends, $attributes )</SPAN> |
382 |
|
|
<BR> |
383 |
|
|
|
384 |
|
|
<BR> |
385 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
386 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
387 |
|
|
This function adds a new class entry |
388 |
|
|
<BR> |
389 |
|
|
|
390 |
|
|
<DL> |
391 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
392 |
|
|
|
393 |
|
|
<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">$name</SPAN></SPAN> - class/id name</DD> |
394 |
|
|
|
395 |
|
|
<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">$extends</SPAN></SPAN> - the list of extends |
396 |
|
|
ie #foo div, a { } |
397 |
|
|
where "div, a" are the extends</DD> |
398 |
|
|
|
399 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$attributes</SPAN></SPAN> - the attributes</DD> |
400 |
|
|
|
401 |
|
|
|
402 |
|
|
<DT class="font10bold">Function Info:</DT> |
403 |
|
|
|
404 |
|
|
</DL> |
405 |
|
|
|
406 |
|
|
</DIV> |
407 |
|
|
<BR> |
408 |
|
|
|
409 |
|
|
<DIV CLASS="function"> |
410 |
|
|
<A NAME='render'><!-- --></A> |
411 |
|
|
<SPAN CLASS="font12bold">render</SPAN> |
412 |
|
|
<BR> |
413 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
414 |
|
|
<span class="font10bold" style="color: #FF0000">string</SPAN> |
415 |
|
|
<span class="font10bold" style="color: #0000FF">render ( [$indent_level = 1], [$output_debug = 0] )</SPAN> |
416 |
|
|
<BR> |
417 |
|
|
|
418 |
|
|
<BR> |
419 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
420 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
421 |
|
|
The render method for compatibility |
422 |
|
|
with the rest of the phphtmllib api |
423 |
|
|
<BR> |
424 |
|
|
|
425 |
|
|
<DL> |
426 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
427 |
|
|
|
428 |
|
|
<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 |
429 |
|
|
the container.</DD> |
430 |
|
|
|
431 |
|
|
<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 |
432 |
|
|
maintain compatibility w/ the API.</DD> |
433 |
|
|
|
434 |
|
|
|
435 |
|
|
<DT class="font10bold">Function Info:</DT> |
436 |
|
|
|
437 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the raw html output.</DD> |
438 |
|
|
|
439 |
|
|
</DL> |
440 |
|
|
|
441 |
|
|
</DIV> |
442 |
|
|
<BR> |
443 |
|
|
|
444 |
|
|
<DIV CLASS="function"> |
445 |
|
|
<A NAME='set_header_flag'><!-- --></A> |
446 |
|
|
<SPAN CLASS="font12bold">set_header_flag</SPAN> |
447 |
|
|
<BR> |
448 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
449 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
450 |
|
|
<span class="font10bold" style="color: #0000FF">set_header_flag ( $flag )</SPAN> |
451 |
|
|
<BR> |
452 |
|
|
|
453 |
|
|
<BR> |
454 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
455 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
456 |
|
|
This is used to set/update the header |
457 |
|
|
flag. |
458 |
|
|
<BR> |
459 |
|
|
|
460 |
|
|
<DL> |
461 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
462 |
|
|
|
463 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">boolean</SPAN> <span style="color: #0000FF;font-weight:bold">$flag</SPAN></SPAN> </DD> |
464 |
|
|
|
465 |
|
|
|
466 |
|
|
<DT class="font10bold">Function Info:</DT> |
467 |
|
|
|
468 |
|
|
</DL> |
469 |
|
|
|
470 |
|
|
</DIV> |
471 |
|
|
<BR> |
472 |
|
|
|
473 |
|
|
<DIV CLASS="function"> |
474 |
|
|
<A NAME='update_all_values'><!-- --></A> |
475 |
|
|
<SPAN CLASS="font12bold">update_all_values</SPAN> |
476 |
|
|
<BR> |
477 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
478 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
479 |
|
|
<span class="font10bold" style="color: #0000FF">update_all_values ( $property, $search, $value )</SPAN> |
480 |
|
|
<BR> |
481 |
|
|
|
482 |
|
|
<BR> |
483 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
484 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
485 |
|
|
This function is a macro for walking the entire |
486 |
|
|
list of classes, looking for particular property |
487 |
|
|
in each class. |
488 |
|
|
<BR> |
489 |
|
|
It then tries to match |
490 |
|
|
the current value of that property and then |
491 |
|
|
replaces the value with the new value. |
492 |
|
|
|
493 |
|
|
NOTE: this is a way of templating themes. |
494 |
|
|
you create the original css w/ a value |
495 |
|
|
of something like _DARK_COLOR_ |
496 |
|
|
and use this function to replace all occurrences |
497 |
|
|
with #dbdbdb |
498 |
|
|
<DL> |
499 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
500 |
|
|
|
501 |
|
|
<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">$property</SPAN></SPAN> - the property that the search lives in</DD> |
502 |
|
|
|
503 |
|
|
<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">$search</SPAN></SPAN> - the original value to find</DD> |
504 |
|
|
|
505 |
|
|
<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">$value</SPAN></SPAN> - the new value</DD> |
506 |
|
|
|
507 |
|
|
|
508 |
|
|
<DT class="font10bold">Function Info:</DT> |
509 |
|
|
|
510 |
|
|
</DL> |
511 |
|
|
|
512 |
|
|
</DIV> |
513 |
|
|
<BR> |
514 |
|
|
|
515 |
|
|
<DIV CLASS="function"> |
516 |
|
|
<A NAME='update_properties'><!-- --></A> |
517 |
|
|
<SPAN CLASS="font12bold">update_properties</SPAN> |
518 |
|
|
<BR> |
519 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
520 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
521 |
|
|
<span class="font10bold" style="color: #0000FF">update_properties ( $name, $extends, $properties )</SPAN> |
522 |
|
|
<BR> |
523 |
|
|
|
524 |
|
|
<BR> |
525 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
526 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
527 |
|
|
This function updates a css property value |
528 |
|
|
for a specific class/id |
529 |
|
|
<BR> |
530 |
|
|
|
531 |
|
|
<DL> |
532 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
533 |
|
|
|
534 |
|
|
<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">$name</SPAN></SPAN> - the class/id name</DD> |
535 |
|
|
|
536 |
|
|
<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">$extends</SPAN></SPAN> - the list of extends |
537 |
|
|
ie #foo div, a { } |
538 |
|
|
where "div, a" are the extends</DD> |
539 |
|
|
|
540 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$properties</SPAN></SPAN> - the array of array(property => value ) pairs.</DD> |
541 |
|
|
|
542 |
|
|
|
543 |
|
|
<DT class="font10bold">Function Info:</DT> |
544 |
|
|
|
545 |
|
|
</DL> |
546 |
|
|
|
547 |
|
|
</DIV> |
548 |
|
|
<BR> |
549 |
|
|
|
550 |
|
|
<DIV CLASS="function"> |
551 |
|
|
<A NAME='update_property'><!-- --></A> |
552 |
|
|
<SPAN CLASS="font12bold">update_property</SPAN> |
553 |
|
|
<BR> |
554 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
555 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
556 |
|
|
<span class="font10bold" style="color: #0000FF">update_property ( $name, $extends, $property, $value )</SPAN> |
557 |
|
|
<BR> |
558 |
|
|
|
559 |
|
|
<BR> |
560 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
561 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
562 |
|
|
This function updates a css property value |
563 |
|
|
for a specific class/id |
564 |
|
|
<BR> |
565 |
|
|
|
566 |
|
|
<DL> |
567 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
568 |
|
|
|
569 |
|
|
<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">$name</SPAN></SPAN> - the class/id name</DD> |
570 |
|
|
|
571 |
|
|
<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">$extends</SPAN></SPAN> - the list of extends |
572 |
|
|
ie #foo div, a { } |
573 |
|
|
where "div, a" are the extends</DD> |
574 |
|
|
|
575 |
|
|
<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">$property</SPAN></SPAN> - the property to adjust</DD> |
576 |
|
|
|
577 |
|
|
<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">$value</SPAN></SPAN> - the value for the property</DD> |
578 |
|
|
|
579 |
|
|
|
580 |
|
|
<DT class="font10bold">Function Info:</DT> |
581 |
|
|
|
582 |
|
|
</DL> |
583 |
|
|
|
584 |
|
|
</DIV> |
585 |
|
|
<BR> |
586 |
|
|
|
587 |
|
|
<DIV CLASS="function"> |
588 |
|
|
<A NAME='user_setup'><!-- --></A> |
589 |
|
|
<SPAN CLASS="font12bold">user_setup</SPAN> |
590 |
|
|
<BR> |
591 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
592 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
593 |
|
|
<span class="font10bold" style="color: #0000FF">user_setup ( )</SPAN> |
594 |
|
|
<BR> |
595 |
|
|
Overridden in child class(es) as: <a href="../phpHtmlLib/FooterNavCSS.html#user_setup">FooterNavCSS::user_setup()</a>, <a href="../phpHtmlLib/ActiveTabCSS.html#user_setup">ActiveTabCSS::user_setup()</a>, <a href="../phpHtmlLib/InfoTableCSS.html#user_setup">InfoTableCSS::user_setup()</a>, <a href="../phpHtmlLib/NavTableCSS.html#user_setup">NavTableCSS::user_setup()</a>, <a href="../phpHtmlLib/TextNavCSS.html#user_setup">TextNavCSS::user_setup()</a>, <a href="../phpHtmlLib/TextCSSNavCSS.html#user_setup">TextCSSNavCSS::user_setup()</a>, <a href="../phpHtmlLib/VerticalCSSNavTableCSS.html#user_setup">VerticalCSSNavTableCSS::user_setup()</a>, <a href="../phpHtmlLib/ImageThumbnailWidgetCSS.html#user_setup">ImageThumbnailWidgetCSS::user_setup()</a>, <a href="../phpHtmlLib/DefaultGUIDataListCSS.html#user_setup">DefaultGUIDataListCSS::user_setup()</a><br> |
596 |
|
|
<BR> |
597 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
598 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
599 |
|
|
Call the child class' setup function |
600 |
|
|
<BR> |
601 |
|
|
to build the actual css classes and their |
602 |
|
|
attributes |
603 |
|
|
<DL> |
604 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
605 |
|
|
|
606 |
|
|
|
607 |
|
|
<DT class="font10bold">Function Info:</DT> |
608 |
|
|
|
609 |
|
|
</DL> |
610 |
|
|
|
611 |
|
|
</DIV> |
612 |
|
|
<BR> |
613 |
|
|
|
614 |
|
|
<DIV CLASS="function"> |
615 |
|
|
<A NAME='_build_name'><!-- --></A> |
616 |
|
|
<SPAN CLASS="font12bold">_build_name</SPAN> |
617 |
|
|
<BR> |
618 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
619 |
|
|
<span class="font10bold" style="color: #FF0000">the</SPAN> |
620 |
|
|
<span class="font10bold" style="color: #0000FF">_build_name ( $class )</SPAN> |
621 |
|
|
<BR> |
622 |
|
|
|
623 |
|
|
<BR> |
624 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
625 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
626 |
|
|
This function is used to construct the css name |
627 |
|
|
declaration string. |
628 |
|
|
<BR> |
629 |
|
|
ie #foo div,span { |
630 |
|
|
<DL> |
631 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
632 |
|
|
|
633 |
|
|
<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">$class</SPAN></SPAN> the name-extends string</DD> |
634 |
|
|
|
635 |
|
|
|
636 |
|
|
<DT class="font10bold">Function Info:</DT> |
637 |
|
|
|
638 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - css name declaration</DD> |
639 |
|
|
|
640 |
|
|
</DL> |
641 |
|
|
|
642 |
|
|
</DIV> |
643 |
|
|
<BR> |
644 |
|
|
|
645 |
|
|
<DIV CLASS="function"> |
646 |
|
|
<A NAME='_build_properties'><!-- --></A> |
647 |
|
|
<SPAN CLASS="font12bold">_build_properties</SPAN> |
648 |
|
|
<BR> |
649 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
650 |
|
|
<span class="font10bold" style="color: #FF0000">string</SPAN> |
651 |
|
|
<span class="font10bold" style="color: #0000FF">_build_properties ( $properties, $indent_str )</SPAN> |
652 |
|
|
<BR> |
653 |
|
|
|
654 |
|
|
<BR> |
655 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
656 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
657 |
|
|
This function is used to construct the |
658 |
|
|
property: value strings for the class |
659 |
|
|
<BR> |
660 |
|
|
|
661 |
|
|
<DL> |
662 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
663 |
|
|
|
664 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$properties</SPAN></SPAN> - the properties</DD> |
665 |
|
|
|
666 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$indent_str</SPAN></SPAN> - the indent string.</DD> |
667 |
|
|
|
668 |
|
|
|
669 |
|
|
<DT class="font10bold">Function Info:</DT> |
670 |
|
|
|
671 |
|
|
</DL> |
672 |
|
|
|
673 |
|
|
</DIV> |
674 |
|
|
<BR> |
675 |
|
|
|
676 |
|
|
<DIV CLASS="function"> |
677 |
|
|
<A NAME='_replace_value'><!-- --></A> |
678 |
|
|
<SPAN CLASS="font12bold">_replace_value</SPAN> |
679 |
|
|
<BR> |
680 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
681 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
682 |
|
|
<span class="font10bold" style="color: #0000FF">_replace_value ( &$item, $key, $blah )</SPAN> |
683 |
|
|
<BR> |
684 |
|
|
|
685 |
|
|
<BR> |
686 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
687 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
688 |
|
|
This function does the main work for update_all_values |
689 |
|
|
<BR> |
690 |
|
|
|
691 |
|
|
<DL> |
692 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
693 |
|
|
|
694 |
|
|
|
695 |
|
|
<DT class="font10bold">Function Info:</DT> |
696 |
|
|
|
697 |
|
|
</DL> |
698 |
|
|
|
699 |
|
|
</DIV> |
700 |
|
|
<BR> |
701 |
|
|
|
702 |
|
|
|
703 |
|
|
<hr> |
704 |
|
|
</HTML> |