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