| 1 | jonen | 1.3 | <?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 CSSBuilder</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 |  |  | <h2 class="class-name">Class CSSBuilder</h2> | 
| 13 |  |  |  | 
| 14 |  |  | <a name="sec-description"></a> | 
| 15 |  |  | <div class="info-box"> | 
| 16 |  |  | <div class="info-box-title">Description</div> | 
| 17 |  |  | <div class="nav-bar"> | 
| 18 |  |  | <span class="disabled">Description</span> | | 
| 19 |  |  | <a href="#sec-descendents">Descendents</a> | 
| 20 |  |  | |                                                                                       <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</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 a widget for constructing and   rendering css.  It exports API's for adding   classes, ids and their attributes.</p> | 
| 27 |  |  | <p class="description"><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></p> | 
| 28 |  |  | <ul class="tags"> | 
| 29 |  |  | <li><span class="field">author:</span> <p>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></p></li> | 
| 30 |  |  | </ul> | 
| 31 |  |  | <p class="notes"> | 
| 32 |  |  | Located in <a class="field" href="_widgets_CSSBuilder_inc.html">Program_Root/widgets/CSSBuilder.inc</a> (line <span class="field">41</span>) | 
| 33 |  |  | </p> | 
| 34 |  |  |  | 
| 35 |  |  |  | 
| 36 |  |  | <pre></pre> | 
| 37 |  |  |  | 
| 38 |  |  | </div> | 
| 39 |  |  | </div> | 
| 40 |  |  |  | 
| 41 |  |  | <a name="sec-descendents"></a> | 
| 42 |  |  | <div class="info-box"> | 
| 43 |  |  | <div class="info-box-title">Direct descendents</div> | 
| 44 |  |  | <div class="nav-bar"> | 
| 45 |  |  | <a href="#sec-description">Description</a> | | 
| 46 |  |  | <span class="disabled">Descendents</span> | 
| 47 |  |  | |                                                                                               <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) | 
| 48 |  |  | |                                                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) | 
| 49 |  |  |  | 
| 50 |  |  | </div> | 
| 51 |  |  | <div class="info-box-body"> | 
| 52 |  |  | <table cellpadding="2" cellspacing="0" class="class-table"> | 
| 53 |  |  | <tr> | 
| 54 |  |  | <th class="class-table-header">Class</th> | 
| 55 |  |  | <th class="class-table-header">Description</th> | 
| 56 |  |  | </tr> | 
| 57 |  |  | <tr> | 
| 58 |  |  | <td style="padding-right: 2em"><a href="../phpHtmlLib/ActiveTabCSS.html">ActiveTabCSS</a></td> | 
| 59 |  |  | <td> | 
| 60 |  |  | The CSSBuilder object for the ActiveTab widget | 
| 61 |  |  | </td> | 
| 62 |  |  | </tr> | 
| 63 |  |  | <tr> | 
| 64 |  |  | <td style="padding-right: 2em"><a href="../phpHtmlLib/FooterNavCSS.html">FooterNavCSS</a></td> | 
| 65 |  |  | <td> | 
| 66 |  |  | This class defines the css used by the  FooterNav Object. | 
| 67 |  |  | </td> | 
| 68 |  |  | </tr> | 
| 69 |  |  | <tr> | 
| 70 |  |  | <td style="padding-right: 2em"><a href="../phpHtmlLib/ImageThumbnailWidgetCSS.html">ImageThumbnailWidgetCSS</a></td> | 
| 71 |  |  | <td> | 
| 72 |  |  | This class defines the css used by the  FooterNav Object. | 
| 73 |  |  | </td> | 
| 74 |  |  | </tr> | 
| 75 |  |  | <tr> | 
| 76 |  |  | <td style="padding-right: 2em"><a href="../phpHtmlLib/InfoTableCSS.html">InfoTableCSS</a></td> | 
| 77 |  |  | <td> | 
| 78 |  |  | This class defines the css used by the  FooterNav Object. | 
| 79 |  |  | </td> | 
| 80 |  |  | </tr> | 
| 81 |  |  | <tr> | 
| 82 |  |  | <td style="padding-right: 2em"><a href="../phpHtmlLib/NavTableCSS.html">NavTableCSS</a></td> | 
| 83 |  |  | <td> | 
| 84 |  |  | This class defines the css used by the  FooterNav Object. | 
| 85 |  |  | </td> | 
| 86 |  |  | </tr> | 
| 87 |  |  | <tr> | 
| 88 |  |  | <td style="padding-right: 2em"><a href="../phpHtmlLib/TextCSSNavCSS.html">TextCSSNavCSS</a></td> | 
| 89 |  |  | <td> | 
| 90 |  |  | This class defines the css used by the  FooterNav Object. | 
| 91 |  |  | </td> | 
| 92 |  |  | </tr> | 
| 93 |  |  | <tr> | 
| 94 |  |  | <td style="padding-right: 2em"><a href="../phpHtmlLib/RoundTitleTableCSS.html">RoundTitleTableCSS</a></td> | 
| 95 |  |  | <td> | 
| 96 |  |  | This class defines the css used by the  RoundTitleTable Object. | 
| 97 |  |  | </td> | 
| 98 |  |  | </tr> | 
| 99 |  |  | <tr> | 
| 100 |  |  | <td style="padding-right: 2em"><a href="../phpHtmlLib/TextNavCSS.html">TextNavCSS</a></td> | 
| 101 |  |  | <td> | 
| 102 |  |  | This class defines the css used by the  TextNav Object. | 
| 103 |  |  | </td> | 
| 104 |  |  | </tr> | 
| 105 |  |  | <tr> | 
| 106 |  |  | <td style="padding-right: 2em"><a href="../phpHtmlLib/VerticalCSSNavTableCSS.html">VerticalCSSNavTableCSS</a></td> | 
| 107 |  |  | <td> | 
| 108 |  |  | This class defines the css used by the  VerticalCSSNavTable Object. | 
| 109 |  |  | </td> | 
| 110 |  |  | </tr> | 
| 111 |  |  | <tr> | 
| 112 |  |  | <td style="padding-right: 2em"><a href="../phpHtmlLib/DefaultGUIDataListCSS.html">DefaultGUIDataListCSS</a></td> | 
| 113 |  |  | <td> | 
| 114 |  |  | This class defines the css used by the  FooterNav Object. | 
| 115 |  |  | </td> | 
| 116 |  |  | </tr> | 
| 117 |  |  | </table> | 
| 118 |  |  | </div> | 
| 119 |  |  | </div> | 
| 120 |  |  |  | 
| 121 |  |  | <a name="sec-var-summary"></a> | 
| 122 |  |  | <div class="info-box"> | 
| 123 |  |  | <div class="info-box-title">Variable Summary</span></div> | 
| 124 |  |  | <div class="nav-bar"> | 
| 125 |  |  | <a href="#sec-description">Description</a> | | 
| 126 |  |  | <a href="#sec-descendents">Descendents</a> | | 
| 127 |  |  | <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) | 
| 128 |  |  | | | 
| 129 |  |  | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) | 
| 130 |  |  |  | 
| 131 |  |  | </div> | 
| 132 |  |  | <div class="info-box-body"> | 
| 133 |  |  | <div class="var-summary"> | 
| 134 |  |  | <div class="var-title"> | 
| 135 |  |  | <span class="var-type">boolean</span> | 
| 136 |  |  | <a href="#$indent_flag" title="details" class="var-name">$indent_flag</a> | 
| 137 |  |  | </div> | 
| 138 |  |  | <div class="var-title"> | 
| 139 |  |  | <span class="var-type">array</span> | 
| 140 |  |  | <a href="#$_entries" title="details" class="var-name">$_entries</a> | 
| 141 |  |  | </div> | 
| 142 |  |  | <div class="var-title"> | 
| 143 |  |  | <span class="var-type">boolean</span> | 
| 144 |  |  | <a href="#$_header_flag" title="details" class="var-name">$_header_flag</a> | 
| 145 |  |  | </div> | 
| 146 |  |  | </div> | 
| 147 |  |  | </div> | 
| 148 |  |  | </div> | 
| 149 |  |  |  | 
| 150 |  |  | <a name="sec-method-summary"></a> | 
| 151 |  |  | <div class="info-box"> | 
| 152 |  |  | <div class="info-box-title">Method Summary</span></div> | 
| 153 |  |  | <div class="nav-bar"> | 
| 154 |  |  | <a href="#sec-description">Description</a> | | 
| 155 |  |  | <a href="#sec-descendents">Descendents</a> | | 
| 156 |  |  | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) | 
| 157 |  |  |  | 
| 158 |  |  | | | 
| 159 |  |  | <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) | 
| 160 |  |  | </div> | 
| 161 |  |  | <div class="info-box-body"> | 
| 162 |  |  | <div class="method-summary"> | 
| 163 |  |  |  | 
| 164 |  |  | <div class="method-definition"> | 
| 165 |  |  | <span class="method-result">void</span> | 
| 166 |  |  | <a href="#CSSBuilder" title="details" class="method-name">CSSBuilder</a> | 
| 167 |  |  | ([<span class="var-type">boolean</span> <span class="var-name">$header_flag</span> = <span class="var-default">FALSE</span>]) | 
| 168 |  |  | </div> | 
| 169 |  |  |  | 
| 170 |  |  | <div class="method-definition"> | 
| 171 |  |  | <span class="method-result">void</span> | 
| 172 |  |  | <a href="#add_entry" title="details" class="method-name">add_entry</a> | 
| 173 |  |  | (<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$extends</span>, <span class="var-type">array</span> <span class="var-name">$attributes</span>) | 
| 174 |  |  | </div> | 
| 175 |  |  |  | 
| 176 |  |  | <div class="method-definition"> | 
| 177 |  |  | <span class="method-result">string</span> | 
| 178 |  |  | <a href="#render" title="details" class="method-name">render</a> | 
| 179 |  |  | ([<span class="var-type">int</span> <span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">int</span> <span class="var-name">$output_debug</span>) | 
| 180 |  |  | </div> | 
| 181 |  |  |  | 
| 182 |  |  | <div class="method-definition"> | 
| 183 |  |  | <span class="method-result">void</span> | 
| 184 |  |  | <a href="#set_header_flag" title="details" class="method-name">set_header_flag</a> | 
| 185 |  |  | (<span class="var-type">boolean</span> <span class="var-name">$flag</span>) | 
| 186 |  |  | </div> | 
| 187 |  |  |  | 
| 188 |  |  | <div class="method-definition"> | 
| 189 |  |  | <span class="method-result">void</span> | 
| 190 |  |  | <a href="#update_all_values" title="details" class="method-name">update_all_values</a> | 
| 191 |  |  | (<span class="var-type">string</span> <span class="var-name">$property</span>, <span class="var-type">string</span> <span class="var-name">$search</span>, <span class="var-type">string</span> <span class="var-name">$value</span>) | 
| 192 |  |  | </div> | 
| 193 |  |  |  | 
| 194 |  |  | <div class="method-definition"> | 
| 195 |  |  | <span class="method-result">void</span> | 
| 196 |  |  | <a href="#update_properties" title="details" class="method-name">update_properties</a> | 
| 197 |  |  | (<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$extends</span>, <span class="var-type">array</span> <span class="var-name">$properties</span>) | 
| 198 |  |  | </div> | 
| 199 |  |  |  | 
| 200 |  |  | <div class="method-definition"> | 
| 201 |  |  | <span class="method-result">void</span> | 
| 202 |  |  | <a href="#update_property" title="details" class="method-name">update_property</a> | 
| 203 |  |  | (<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$extends</span>, <span class="var-type">string</span> <span class="var-name">$property</span>, <span class="var-type">string</span> <span class="var-name">$value</span>) | 
| 204 |  |  | </div> | 
| 205 |  |  |  | 
| 206 |  |  | <div class="method-definition"> | 
| 207 |  |  | <span class="method-result">void</span> | 
| 208 |  |  | <a href="#user_setup" title="details" class="method-name">user_setup</a> | 
| 209 |  |  | () | 
| 210 |  |  | </div> | 
| 211 |  |  |  | 
| 212 |  |  | <div class="method-definition"> | 
| 213 |  |  | <span class="method-result">the</span> | 
| 214 |  |  | <a href="#_build_name" title="details" class="method-name">_build_name</a> | 
| 215 |  |  | (<span class="var-type">string</span> <span class="var-name">$class</span>) | 
| 216 |  |  | </div> | 
| 217 |  |  |  | 
| 218 |  |  | <div class="method-definition"> | 
| 219 |  |  | <span class="method-result">string</span> | 
| 220 |  |  | <a href="#_build_properties" title="details" class="method-name">_build_properties</a> | 
| 221 |  |  | (<span class="var-type">array</span> <span class="var-name">$properties</span>, <span class="var-type">array</span> <span class="var-name">$indent_str</span>) | 
| 222 |  |  | </div> | 
| 223 |  |  |  | 
| 224 |  |  | <div class="method-definition"> | 
| 225 |  |  | <span class="method-result">void</span> | 
| 226 |  |  | <a href="#_replace_value" title="details" class="method-name">_replace_value</a> | 
| 227 |  |  | (<span class="var-type">mixed</span> <span class="var-name">&$item</span>, <span class="var-type">mixed</span> <span class="var-name">$key</span>, <span class="var-type">mixed</span> <span class="var-name">$blah</span>) | 
| 228 |  |  | </div> | 
| 229 |  |  | </div> | 
| 230 |  |  | </div> | 
| 231 |  |  | </div> | 
| 232 |  |  |  | 
| 233 |  |  | <a name="sec-vars"></a> | 
| 234 |  |  | <div class="info-box"> | 
| 235 |  |  | <div class="info-box-title">Variables</div> | 
| 236 |  |  | <div class="nav-bar"> | 
| 237 |  |  | <a href="#sec-description">Description</a> | | 
| 238 |  |  | <a href="#sec-descendents">Descendents</a> | | 
| 239 |  |  | <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) | 
| 240 |  |  |  | 
| 241 |  |  |  | 
| 242 |  |  | | | 
| 243 |  |  | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) | 
| 244 |  |  |  | 
| 245 |  |  | </div> | 
| 246 |  |  | <div class="info-box-body"> | 
| 247 |  |  | <a name="var$indent_flag" id="$indent_flag"><!-- --></A> | 
| 248 |  |  | <div class="oddrow"> | 
| 249 |  |  |  | 
| 250 |  |  | <div class="var-header"> | 
| 251 |  |  | <span class="var-title"> | 
| 252 |  |  | <span class="var-type">boolean</span> | 
| 253 |  |  | <span class="var-name">$indent_flag</span> | 
| 254 |  |  | = <span class="var-default"> TRUE</span>                       (line <span class="line-number">75</span>) | 
| 255 |  |  | </span> | 
| 256 |  |  | </div> | 
| 257 |  |  |  | 
| 258 |  |  | <!-- ========== Info from phpDoc block ========= --> | 
| 259 |  |  | <p class="short-description">Flag for pretty (indented) output</p> | 
| 260 |  |  | <ul class="tags"> | 
| 261 |  |  | <li><span class="field">access:</span> public</li> | 
| 262 |  |  | </ul> | 
| 263 |  |  |  | 
| 264 |  |  |  | 
| 265 |  |  |  | 
| 266 |  |  |  | 
| 267 |  |  |  | 
| 268 |  |  | </div> | 
| 269 |  |  | <a name="var$_entries" id="$_entries"><!-- --></A> | 
| 270 |  |  | <div class="evenrow"> | 
| 271 |  |  |  | 
| 272 |  |  | <div class="var-header"> | 
| 273 |  |  | <span class="var-title"> | 
| 274 |  |  | <span class="var-type">array</span> | 
| 275 |  |  | <span class="var-name">$_entries</span> | 
| 276 |  |  | = <span class="var-default">array()</span>                     (line <span class="line-number">49</span>) | 
| 277 |  |  | </span> | 
| 278 |  |  | </div> | 
| 279 |  |  |  | 
| 280 |  |  | <!-- ========== Info from phpDoc block ========= --> | 
| 281 |  |  | <p class="short-description">This holds the entries for the css</p> | 
| 282 |  |  |  | 
| 283 |  |  |  | 
| 284 |  |  |  | 
| 285 |  |  |  | 
| 286 |  |  |  | 
| 287 |  |  | </div> | 
| 288 |  |  | <a name="var$_header_flag" id="$_header_flag"><!-- --></A> | 
| 289 |  |  | <div class="oddrow"> | 
| 290 |  |  |  | 
| 291 |  |  | <div class="var-header"> | 
| 292 |  |  | <span class="var-title"> | 
| 293 |  |  | <span class="var-type">boolean</span> | 
| 294 |  |  | <span class="var-name">$_header_flag</span> | 
| 295 |  |  | = <span class="var-default"> FALSE</span>                      (line <span class="line-number">59</span>) | 
| 296 |  |  | </span> | 
| 297 |  |  | </div> | 
| 298 |  |  |  | 
| 299 |  |  | <!-- ========== Info from phpDoc block ========= --> | 
| 300 |  |  | <p class="short-description">Flag to let us know if we should  output a header content-type value  header("Content-Type: text/css");</p> | 
| 301 |  |  |  | 
| 302 |  |  |  | 
| 303 |  |  |  | 
| 304 |  |  |  | 
| 305 | jonen | 1.2 |  | 
| 306 | jonen | 1.3 | </div> | 
| 307 |  |  |  | 
| 308 |  |  | </div> | 
| 309 |  |  | </div> | 
| 310 |  |  |  | 
| 311 |  |  | <a name="sec-methods"></a> | 
| 312 |  |  | <div class="info-box"> | 
| 313 |  |  | <div class="info-box-title">Methods</div> | 
| 314 |  |  | <div class="nav-bar"> | 
| 315 |  |  | <a href="#sec-description">Description</a> | | 
| 316 |  |  | <a href="#sec-descendents">Descendents</a> | | 
| 317 |  |  | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) | 
| 318 |  |  | <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) | 
| 319 |  |  |  | 
| 320 |  |  | </div> | 
| 321 |  |  | <div class="info-box-body"> | 
| 322 |  |  | <A NAME='method_detail'></A> | 
| 323 |  |  | <a name="methodCSSBuilder" id="CSSBuilder"><!-- --></a> | 
| 324 |  |  | <div class="evenrow"> | 
| 325 |  |  |  | 
| 326 |  |  | <div class="method-header"> | 
| 327 |  |  | <span class="method-title">Constructor CSSBuilder</span> (line <span class="line-number">86</span>) | 
| 328 |  |  | </div> | 
| 329 |  |  |  | 
| 330 |  |  | <!-- ========== Info from phpDoc block ========= --> | 
| 331 |  |  | <p class="short-description">The CSSBuilder constructor</p> | 
| 332 |  |  |  | 
| 333 |  |  | <div class="method-signature"> | 
| 334 |  |  | <span class="method-result">void</span> | 
| 335 |  |  | <span class="method-name"> | 
| 336 |  |  | CSSBuilder | 
| 337 |  |  | </span> | 
| 338 |  |  | ([<span class="var-type">boolean</span> <span class="var-name">$header_flag</span> = <span class="var-default">FALSE</span>]) | 
| 339 |  |  | </div> | 
| 340 |  |  |  | 
| 341 |  |  | <ul class="parameters"> | 
| 342 |  |  | <li> | 
| 343 |  |  | <span class="var-type">boolean</span> | 
| 344 |  |  | <span class="var-name">$header_flag</span><span class="var-description">: <p>- output the http header                   content type mime type                   or not.</p></span>                     </li> | 
| 345 |  |  | </ul> | 
| 346 |  |  |  | 
| 347 |  |  |  | 
| 348 |  |  | </div> | 
| 349 |  |  | <a name="methodadd_entry" id="add_entry"><!-- --></a> | 
| 350 |  |  | <div class="oddrow"> | 
| 351 |  |  |  | 
| 352 |  |  | <div class="method-header"> | 
| 353 |  |  | <span class="method-title">add_entry</span> (line <span class="line-number">189</span>) | 
| 354 |  |  | </div> | 
| 355 |  |  |  | 
| 356 |  |  | <!-- ========== Info from phpDoc block ========= --> | 
| 357 |  |  | <p class="short-description">This function adds a new class entry</p> | 
| 358 |  |  |  | 
| 359 |  |  | <div class="method-signature"> | 
| 360 |  |  | <span class="method-result">void</span> | 
| 361 |  |  | <span class="method-name"> | 
| 362 |  |  | add_entry | 
| 363 |  |  | </span> | 
| 364 |  |  | (<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$extends</span>, <span class="var-type">array</span> <span class="var-name">$attributes</span>) | 
| 365 |  |  | </div> | 
| 366 |  |  |  | 
| 367 |  |  | <ul class="parameters"> | 
| 368 |  |  | <li> | 
| 369 |  |  | <span class="var-type">string</span> | 
| 370 |  |  | <span class="var-name">$name</span><span class="var-description">: <p>- class/id name</p></span>                        </li> | 
| 371 |  |  | <li> | 
| 372 |  |  | <span class="var-type">string</span> | 
| 373 |  |  | <span class="var-name">$extends</span><span class="var-description">: <p>- the list of extends                  ie #foo div, a { }                  where "div, a" are the extends</p></span>                 </li> | 
| 374 |  |  | <li> | 
| 375 |  |  | <span class="var-type">array</span> | 
| 376 |  |  | <span class="var-name">$attributes</span><span class="var-description">: <p>- the attributes</p></span>                 </li> | 
| 377 |  |  | </ul> | 
| 378 |  |  |  | 
| 379 |  |  |  | 
| 380 |  |  | </div> | 
| 381 |  |  | <a name="methodrender" id="render"><!-- --></a> | 
| 382 |  |  | <div class="evenrow"> | 
| 383 |  |  |  | 
| 384 |  |  | <div class="method-header"> | 
| 385 |  |  | <span class="method-title">render</span> (line <span class="line-number">103</span>) | 
| 386 |  |  | </div> | 
| 387 |  |  |  | 
| 388 |  |  | <!-- ========== Info from phpDoc block ========= --> | 
| 389 |  |  | <p class="short-description">The render method for compatibility  with the rest of the phphtmllib api</p> | 
| 390 |  |  | <ul class="tags"> | 
| 391 |  |  | <li><span class="field">return:</span> <p>the raw html output.</p></li> | 
| 392 |  |  | </ul> | 
| 393 |  |  |  | 
| 394 |  |  | <div class="method-signature"> | 
| 395 |  |  | <span class="method-result">string</span> | 
| 396 |  |  | <span class="method-name"> | 
| 397 |  |  | render | 
| 398 |  |  | </span> | 
| 399 |  |  | ([<span class="var-type">int</span> <span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">int</span> <span class="var-name">$output_debug</span>) | 
| 400 |  |  | </div> | 
| 401 |  |  |  | 
| 402 |  |  | <ul class="parameters"> | 
| 403 |  |  | <li> | 
| 404 |  |  | <span class="var-type">int</span> | 
| 405 |  |  | <span class="var-name">$indent_level</span><span class="var-description">: <p>- the indentation level for               the container.</p></span>                       </li> | 
| 406 |  |  | <li> | 
| 407 |  |  | <span class="var-type">int</span> | 
| 408 |  |  | <span class="var-name">$output_debug</span><span class="var-description">: <p>- the output debug flag to               maintain compatibility w/ the API.</p></span>                    </li> | 
| 409 |  |  | </ul> | 
| 410 |  |  |  | 
| 411 |  |  |  | 
| 412 | jonen | 1.2 | </div> | 
| 413 | jonen | 1.3 | <a name="methodset_header_flag" id="set_header_flag"><!-- --></a> | 
| 414 |  |  | <div class="oddrow"> | 
| 415 |  |  |  | 
| 416 |  |  | <div class="method-header"> | 
| 417 |  |  | <span class="method-title">set_header_flag</span> (line <span class="line-number">127</span>) | 
| 418 |  |  | </div> | 
| 419 |  |  |  | 
| 420 |  |  | <!-- ========== Info from phpDoc block ========= --> | 
| 421 |  |  | <p class="short-description">This is used to set/update the header  flag.</p> | 
| 422 |  |  |  | 
| 423 |  |  | <div class="method-signature"> | 
| 424 |  |  | <span class="method-result">void</span> | 
| 425 |  |  | <span class="method-name"> | 
| 426 |  |  | set_header_flag | 
| 427 |  |  | </span> | 
| 428 |  |  | (<span class="var-type">boolean</span> <span class="var-name">$flag</span>) | 
| 429 |  |  | </div> | 
| 430 |  |  |  | 
| 431 |  |  | <ul class="parameters"> | 
| 432 |  |  | <li> | 
| 433 |  |  | <span class="var-type">boolean</span> | 
| 434 |  |  | <span class="var-name">$flag</span>                     </li> | 
| 435 |  |  | </ul> | 
| 436 |  |  |  | 
| 437 |  |  |  | 
| 438 |  |  | </div> | 
| 439 |  |  | <a name="methodupdate_all_values" id="update_all_values"><!-- --></a> | 
| 440 |  |  | <div class="evenrow"> | 
| 441 |  |  |  | 
| 442 |  |  | <div class="method-header"> | 
| 443 |  |  | <span class="method-title">update_all_values</span> (line <span class="line-number">244</span>) | 
| 444 |  |  | </div> | 
| 445 |  |  |  | 
| 446 |  |  | <!-- ========== Info from phpDoc block ========= --> | 
| 447 |  |  | <p class="short-description">This function is a macro for walking the entire</p> | 
| 448 |  |  | <p class="description"><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></p> | 
| 449 |  |  |  | 
| 450 |  |  | <div class="method-signature"> | 
| 451 |  |  | <span class="method-result">void</span> | 
| 452 |  |  | <span class="method-name"> | 
| 453 |  |  | update_all_values | 
| 454 |  |  | </span> | 
| 455 |  |  | (<span class="var-type">string</span> <span class="var-name">$property</span>, <span class="var-type">string</span> <span class="var-name">$search</span>, <span class="var-type">string</span> <span class="var-name">$value</span>) | 
| 456 |  |  | </div> | 
| 457 |  |  |  | 
| 458 |  |  | <ul class="parameters"> | 
| 459 |  |  | <li> | 
| 460 |  |  | <span class="var-type">string</span> | 
| 461 |  |  | <span class="var-name">$property</span><span class="var-description">: <p>- the property that the search lives in</p></span>                    </li> | 
| 462 |  |  | <li> | 
| 463 |  |  | <span class="var-type">string</span> | 
| 464 |  |  | <span class="var-name">$search</span><span class="var-description">: <p>- the original value to find</p></span>                 </li> | 
| 465 |  |  | <li> | 
| 466 |  |  | <span class="var-type">string</span> | 
| 467 |  |  | <span class="var-name">$value</span><span class="var-description">: <p>- the new value</p></span>                       </li> | 
| 468 |  |  | </ul> | 
| 469 |  |  |  | 
| 470 |  |  |  | 
| 471 |  |  | </div> | 
| 472 |  |  | <a name="methodupdate_properties" id="update_properties"><!-- --></a> | 
| 473 |  |  | <div class="oddrow"> | 
| 474 |  |  |  | 
| 475 |  |  | <div class="method-header"> | 
| 476 |  |  | <span class="method-title">update_properties</span> (line <span class="line-number">219</span>) | 
| 477 |  |  | </div> | 
| 478 |  |  |  | 
| 479 |  |  | <!-- ========== Info from phpDoc block ========= --> | 
| 480 |  |  | <p class="short-description">This function updates a css property value  for a specific class/id</p> | 
| 481 |  |  |  | 
| 482 |  |  | <div class="method-signature"> | 
| 483 |  |  | <span class="method-result">void</span> | 
| 484 |  |  | <span class="method-name"> | 
| 485 |  |  | update_properties | 
| 486 |  |  | </span> | 
| 487 |  |  | (<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$extends</span>, <span class="var-type">array</span> <span class="var-name">$properties</span>) | 
| 488 |  |  | </div> | 
| 489 |  |  |  | 
| 490 |  |  | <ul class="parameters"> | 
| 491 |  |  | <li> | 
| 492 |  |  | <span class="var-type">string</span> | 
| 493 |  |  | <span class="var-name">$name</span><span class="var-description">: <p>- the class/id name</p></span>                    </li> | 
| 494 |  |  | <li> | 
| 495 |  |  | <span class="var-type">string</span> | 
| 496 |  |  | <span class="var-name">$extends</span><span class="var-description">: <p>- the list of extends                  ie #foo div, a { }                  where "div, a" are the extends</p></span>                 </li> | 
| 497 |  |  | <li> | 
| 498 |  |  | <span class="var-type">array</span> | 
| 499 |  |  | <span class="var-name">$properties</span><span class="var-description">: <p>- the array of array(property => value ) pairs.</p></span>                       </li> | 
| 500 |  |  | </ul> | 
| 501 |  |  |  | 
| 502 |  |  |  | 
| 503 |  |  | </div> | 
| 504 |  |  | <a name="methodupdate_property" id="update_property"><!-- --></a> | 
| 505 |  |  | <div class="evenrow"> | 
| 506 |  |  |  | 
| 507 |  |  | <div class="method-header"> | 
| 508 |  |  | <span class="method-title">update_property</span> (line <span class="line-number">205</span>) | 
| 509 |  |  | </div> | 
| 510 |  |  |  | 
| 511 |  |  | <!-- ========== Info from phpDoc block ========= --> | 
| 512 |  |  | <p class="short-description">This function updates a css property value  for a specific class/id</p> | 
| 513 |  |  |  | 
| 514 |  |  | <div class="method-signature"> | 
| 515 |  |  | <span class="method-result">void</span> | 
| 516 |  |  | <span class="method-name"> | 
| 517 |  |  | update_property | 
| 518 |  |  | </span> | 
| 519 |  |  | (<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$extends</span>, <span class="var-type">string</span> <span class="var-name">$property</span>, <span class="var-type">string</span> <span class="var-name">$value</span>) | 
| 520 |  |  | </div> | 
| 521 |  |  |  | 
| 522 |  |  | <ul class="parameters"> | 
| 523 |  |  | <li> | 
| 524 |  |  | <span class="var-type">string</span> | 
| 525 |  |  | <span class="var-name">$name</span><span class="var-description">: <p>- the class/id name</p></span>                    </li> | 
| 526 |  |  | <li> | 
| 527 |  |  | <span class="var-type">string</span> | 
| 528 |  |  | <span class="var-name">$extends</span><span class="var-description">: <p>- the list of extends                  ie #foo div, a { }                  where "div, a" are the extends</p></span>                 </li> | 
| 529 |  |  | <li> | 
| 530 |  |  | <span class="var-type">string</span> | 
| 531 |  |  | <span class="var-name">$property</span><span class="var-description">: <p>- the property to adjust</p></span>                   </li> | 
| 532 |  |  | <li> | 
| 533 |  |  | <span class="var-type">string</span> | 
| 534 |  |  | <span class="var-name">$value</span><span class="var-description">: <p>- the value for the property</p></span>                  </li> | 
| 535 |  |  | </ul> | 
| 536 |  |  |  | 
| 537 |  |  |  | 
| 538 |  |  | </div> | 
| 539 |  |  | <a name="methoduser_setup" id="user_setup"><!-- --></a> | 
| 540 |  |  | <div class="oddrow"> | 
| 541 |  |  |  | 
| 542 |  |  | <div class="method-header"> | 
| 543 |  |  | <span class="method-title">user_setup</span> (line <span class="line-number">136</span>) | 
| 544 |  |  | </div> | 
| 545 |  |  |  | 
| 546 |  |  | <!-- ========== Info from phpDoc block ========= --> | 
| 547 |  |  | <p class="short-description">Call the child class' setup function</p> | 
| 548 |  |  | <p class="description"><p>to build the actual css classes and their  attributes</p></p> | 
| 549 |  |  |  | 
| 550 |  |  | <div class="method-signature"> | 
| 551 |  |  | <span class="method-result">void</span> | 
| 552 |  |  | <span class="method-name"> | 
| 553 |  |  | user_setup | 
| 554 |  |  | </span> | 
| 555 |  |  | () | 
| 556 |  |  | </div> | 
| 557 |  |  |  | 
| 558 |  |  |  | 
| 559 |  |  |  | 
| 560 |  |  | <hr class="separator" /> | 
| 561 |  |  | <div class="notes">Redefined in descendants as:</div> | 
| 562 |  |  | <ul class="redefinitions"> | 
| 563 |  |  | <li> | 
| 564 |  |  | <a href="../phpHtmlLib/ActiveTabCSS.html#methoduser_setup">ActiveTabCSS::user_setup()</a> | 
| 565 |  |  | </li> | 
| 566 |  |  | <li> | 
| 567 |  |  | <a href="../phpHtmlLib/FooterNavCSS.html#methoduser_setup">FooterNavCSS::user_setup()</a> | 
| 568 |  |  | </li> | 
| 569 |  |  | <li> | 
| 570 |  |  | <a href="../phpHtmlLib/ImageThumbnailWidgetCSS.html#methoduser_setup">ImageThumbnailWidgetCSS::user_setup()</a> | 
| 571 |  |  | </li> | 
| 572 |  |  | <li> | 
| 573 |  |  | <a href="../phpHtmlLib/InfoTableCSS.html#methoduser_setup">InfoTableCSS::user_setup()</a> | 
| 574 |  |  | </li> | 
| 575 |  |  | <li> | 
| 576 |  |  | <a href="../phpHtmlLib/NavTableCSS.html#methoduser_setup">NavTableCSS::user_setup()</a> | 
| 577 |  |  | </li> | 
| 578 |  |  | <li> | 
| 579 |  |  | <a href="../phpHtmlLib/TextCSSNavCSS.html#methoduser_setup">TextCSSNavCSS::user_setup()</a> | 
| 580 |  |  | </li> | 
| 581 |  |  | <li> | 
| 582 |  |  | <a href="../phpHtmlLib/RoundTitleTableCSS.html#methoduser_setup">RoundTitleTableCSS::user_setup()</a> | 
| 583 |  |  | </li> | 
| 584 |  |  | <li> | 
| 585 |  |  | <a href="../phpHtmlLib/TextNavCSS.html#methoduser_setup">TextNavCSS::user_setup()</a> | 
| 586 |  |  | </li> | 
| 587 |  |  | <li> | 
| 588 |  |  | <a href="../phpHtmlLib/VerticalCSSNavTableCSS.html#methoduser_setup">VerticalCSSNavTableCSS::user_setup()</a> | 
| 589 |  |  | </li> | 
| 590 |  |  | <li> | 
| 591 |  |  | <a href="../phpHtmlLib/DefaultGUIDataListCSS.html#methoduser_setup">DefaultGUIDataListCSS::user_setup()</a> | 
| 592 |  |  | </li> | 
| 593 |  |  | </ul> | 
| 594 |  |  | </div> | 
| 595 |  |  | <a name="method_build_name" id="_build_name"><!-- --></a> | 
| 596 |  |  | <div class="evenrow"> | 
| 597 |  |  |  | 
| 598 |  |  | <div class="method-header"> | 
| 599 |  |  | <span class="method-title">_build_name</span> (line <span class="line-number">154</span>) | 
| 600 |  |  | </div> | 
| 601 |  |  |  | 
| 602 |  |  | <!-- ========== Info from phpDoc block ========= --> | 
| 603 |  |  | <p class="short-description">This function is used to construct the css name  declaration string.</p> | 
| 604 |  |  | <p class="description"><p>ie #foo div,span {</p></p> | 
| 605 |  |  | <ul class="tags"> | 
| 606 |  |  | <li><span class="field">return:</span> <p>css name declaration</p></li> | 
| 607 |  |  | </ul> | 
| 608 |  |  |  | 
| 609 |  |  | <div class="method-signature"> | 
| 610 |  |  | <span class="method-result">the</span> | 
| 611 |  |  | <span class="method-name"> | 
| 612 |  |  | _build_name | 
| 613 |  |  | </span> | 
| 614 |  |  | (<span class="var-type">string</span> <span class="var-name">$class</span>) | 
| 615 |  |  | </div> | 
| 616 |  |  |  | 
| 617 |  |  | <ul class="parameters"> | 
| 618 |  |  | <li> | 
| 619 |  |  | <span class="var-type">string</span> | 
| 620 |  |  | <span class="var-name">$class</span><span class="var-description">: <p>the name-extends string</p></span>                       </li> | 
| 621 |  |  | </ul> | 
| 622 |  |  |  | 
| 623 |  |  |  | 
| 624 |  |  | </div> | 
| 625 |  |  | <a name="method_build_properties" id="_build_properties"><!-- --></a> | 
| 626 |  |  | <div class="oddrow"> | 
| 627 |  |  |  | 
| 628 |  |  | <div class="method-header"> | 
| 629 |  |  | <span class="method-title">_build_properties</span> (line <span class="line-number">169</span>) | 
| 630 |  |  | </div> | 
| 631 |  |  |  | 
| 632 |  |  | <!-- ========== Info from phpDoc block ========= --> | 
| 633 |  |  | <p class="short-description">This function is used to construct the  property: value strings for the class</p> | 
| 634 |  |  |  | 
| 635 |  |  | <div class="method-signature"> | 
| 636 |  |  | <span class="method-result">string</span> | 
| 637 |  |  | <span class="method-name"> | 
| 638 |  |  | _build_properties | 
| 639 |  |  | </span> | 
| 640 |  |  | (<span class="var-type">array</span> <span class="var-name">$properties</span>, <span class="var-type">array</span> <span class="var-name">$indent_str</span>) | 
| 641 |  |  | </div> | 
| 642 |  |  |  | 
| 643 |  |  | <ul class="parameters"> | 
| 644 |  |  | <li> | 
| 645 |  |  | <span class="var-type">array</span> | 
| 646 |  |  | <span class="var-name">$properties</span><span class="var-description">: <p>- the properties</p></span>                 </li> | 
| 647 |  |  | <li> | 
| 648 |  |  | <span class="var-type">array</span> | 
| 649 |  |  | <span class="var-name">$indent_str</span><span class="var-description">: <p>- the indent string.</p></span>                     </li> | 
| 650 |  |  | </ul> | 
| 651 |  |  |  | 
| 652 |  |  |  | 
| 653 |  |  | </div> | 
| 654 |  |  | <a name="method_replace_value" id="_replace_value"><!-- --></a> | 
| 655 |  |  | <div class="evenrow"> | 
| 656 |  |  |  | 
| 657 |  |  | <div class="method-header"> | 
| 658 |  |  | <span class="method-title">_replace_value</span> (line <span class="line-number">258</span>) | 
| 659 |  |  | </div> | 
| 660 |  |  |  | 
| 661 |  |  | <!-- ========== Info from phpDoc block ========= --> | 
| 662 |  |  | <p class="short-description">This function does the main work for update_all_values</p> | 
| 663 |  |  |  | 
| 664 |  |  | <div class="method-signature"> | 
| 665 |  |  | <span class="method-result">void</span> | 
| 666 |  |  | <span class="method-name"> | 
| 667 |  |  | _replace_value | 
| 668 |  |  | </span> | 
| 669 |  |  | (<span class="var-type">mixed</span> <span class="var-name">&$item</span>, <span class="var-type">mixed</span> <span class="var-name">$key</span>, <span class="var-type">mixed</span> <span class="var-name">$blah</span>) | 
| 670 |  |  | </div> | 
| 671 |  |  |  | 
| 672 |  |  |  | 
| 673 |  |  |  | 
| 674 |  |  | </div> | 
| 675 |  |  |  | 
| 676 |  |  | </div> | 
| 677 |  |  | </div> | 
| 678 |  |  |  | 
| 679 |  |  | <p class="notes" id="credit"> | 
| 680 |  |  | Documention generated on Thu, 31 Jul 2003 18:32:20 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a> | 
| 681 |  |  | </p> | 
| 682 |  |  | </div></body> | 
| 683 | jonen | 1.2 | </html> |