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