/[cvs]/nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/CSSBuilder.html
ViewVC logotype

Diff of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/CSSBuilder.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.2 by jonen, Sat Feb 22 20:56:16 2003 UTC revision 1.4 by jonen, Thu May 6 16:24:15 2004 UTC
# Line 1  Line 1 
 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'>  
 <!--NewPage-->  
 <HTML>  
 <HEAD>  
         <!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:22:33 -0800' -->  
         <TITLE>Docs For Class CSSBuilder</TITLE>  
 <LINK REL ='stylesheet' TYPE='text/css' HREF='../media/stylesheet.css' TITLE='Style'>  
 </HEAD>  
 <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">  
 <!-- Links -->  
 <a NAME="top"></A>  
 <table WIDTH="100%" class="links">  
  <TR>  
    <TD class="font10">  
       Links:  
       <A HREF="#children_summary" class="links" title="Classes extended from CSSBuilder">Child Classes</A>  
       <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>  
       <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>  
       <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A>  
       <A HREF="#method_summary" class="links" title="Method Summary">Methods</A>  
       <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>  
       <A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A>  
    </TD>  
  </TR>  
 </TABLE>  
 <BR>  
 <!-- Start of Class Data -->  
 <H2>  
         Class CSSBuilder  
 </H2> (line <span class="linenumber">41</span>)  
 <pre>  
 </pre>  
 <SPAN class="type">Classes extended from CSSBuilder:</SPAN>  
                 <dl>  
         <dt><a href="../phpHtmlLib/FooterNavCSS.html">FooterNavCSS</a></dt>  
                 <dd>This class defines the css used by the  FooterNav Object.</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/ActiveTabCSS.html">ActiveTabCSS</a></dt>  
                 <dd>The CSSBuilder object for the ActiveTab widget</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/InfoTableCSS.html">InfoTableCSS</a></dt>  
                 <dd>This class defines the css used by the  FooterNav Object.</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/NavTableCSS.html">NavTableCSS</a></dt>  
                 <dd>This class defines the css used by the  FooterNav Object.</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/TextNavCSS.html">TextNavCSS</a></dt>  
                 <dd>This class defines the css used by the  TextNav Object.</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/TextCSSNavCSS.html">TextCSSNavCSS</a></dt>  
                 <dd>This class defines the css used by the  FooterNav Object.</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/ImageThumbnailWidgetCSS.html">ImageThumbnailWidgetCSS</a></dt>  
                 <dd>This class defines the css used by the  FooterNav Object.</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/RoundTitleTableCSS.html">RoundTitleTableCSS</a></dt>  
                 <dd>This class defines the css used by the  RoundTitleTable Object.</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/DefaultGUIDataListCSS.html">DefaultGUIDataListCSS</a></dt>  
                 <dd>This class defines the css used by the  FooterNav Object.</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/VerticalCSSNavTableCSS.html">VerticalCSSNavTableCSS</a></dt>  
                 <dd>This class defines the css used by the  VerticalCSSNavTable Object.</dd>  
         </dl>  
         </p>  
 <p>  
         <b><i>Located in File: Program_Root/widgets/CSSBuilder.inc</i></b><br>  
 </p>  
 <hr>  
 This class is a widget for constructing and   rendering css.  It exports API's for adding   classes, ids and their attributes.  
 <br />  
 <p>It can render as either a stand alone   foo.css type of file, with the appropriate   httpd header, or as part of a &lt;style&gt; 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>  
 <UL>  
                 <LI><b>author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</CODE></LI>  
         </UL>  
 <hr>  
 <!-- =========== VAR SUMMARY =========== -->  
 <A NAME='var_summary'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Class Variable Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF="../phpHtmlLib/CSSBuilder.html#var$indent_flag">$indent_flag</A></B></CODE>  
                         <BR>  
                         <blockquote> Flag for pretty (indented) output </blockquote>  
                         <blockquote> Default Value: <CODE>->&nbsp;TRUE<-</CODE> </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF="../phpHtmlLib/CSSBuilder.html#var$_entries">$_entries</A></B></CODE>  
                         <BR>  
                         <blockquote> This holds the entries for the css </blockquote>  
                         <blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF="../phpHtmlLib/CSSBuilder.html#var$_header_flag">$_header_flag</A></B></CODE>  
                         <BR>  
                         <blockquote> Flag to let us know if we should  output a header content-type value  header("Content-Type: text/css"); </blockquote>  
                         <blockquote> Default Value: <CODE>->&nbsp;FALSE<-</CODE> </blockquote>  
                 </TD>  
         </TR>  
         </TABLE>  
 <hr>  
 <!-- =========== VAR INHERITED SUMMARY =========== -->  
 <A NAME='var_inherited_summary'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Inherited Class Variable Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
         </TABLE>  
   
 <hr>  
 <!-- =========== METHOD SUMMARY =========== -->  
 <A NAME='method_summary'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span class="font12bold">Method Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/CSSBuilder.html#methodCSSBuilder'>void constructor CSSBuilder ( [$header_flag = FALSE] )</A></B></CODE>  
                         <BR>  
                         <blockquote> The CSSBuilder constructor </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/CSSBuilder.html#methodadd_entry'>void add_entry ( $name, $extends, $attributes )</A></B></CODE>  
                         <BR>  
                         <blockquote> This function adds a new class entry </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/CSSBuilder.html#methodrender'>string render ( [$indent_level = 1], [$output_debug = 0] )</A></B></CODE>  
                         <BR>  
                         <blockquote> The render method for compatibility  with the rest of the phphtmllib api </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/CSSBuilder.html#methodset_header_flag'>void set_header_flag ( $flag )</A></B></CODE>  
                         <BR>  
                         <blockquote> This is used to set/update the header  flag. </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/CSSBuilder.html#methodupdate_all_values'>void update_all_values ( $property, $search, $value )</A></B></CODE>  
                         <BR>  
                         <blockquote> This function is a macro for walking the entire </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/CSSBuilder.html#methodupdate_properties'>void update_properties ( $name, $extends, $properties )</A></B></CODE>  
                         <BR>  
                         <blockquote> This function updates a css property value  for a specific class/id </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/CSSBuilder.html#methodupdate_property'>void update_property ( $name, $extends, $property, $value )</A></B></CODE>  
                         <BR>  
                         <blockquote> This function updates a css property value  for a specific class/id </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/CSSBuilder.html#methoduser_setup'>void user_setup (  )</A></B></CODE>  
                         <BR>  
                         <blockquote> Call the child class' setup function </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/CSSBuilder.html#method_build_name'>the _build_name ( $class )</A></B></CODE>  
                         <BR>  
                         <blockquote> This function is used to construct the css name  declaration string. </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/CSSBuilder.html#method_build_properties'>string _build_properties ( $properties, $indent_str )</A></B></CODE>  
                         <BR>  
                         <blockquote> This function is used to construct the  property: value strings for the class </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/CSSBuilder.html#method_replace_value'>void _replace_value ( &$item, $key, $blah )</A></B></CODE>  
                         <BR>  
                         <blockquote> This function does the main work for update_all_values </blockquote>  
                 </TD>  
         </TR>  
         </TABLE>  
 <!-- =========== INHERITED METHOD SUMMARY =========== -->  
 <A NAME='functions_inherited'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Inherited Method Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
         </TABLE>  
 <hr>  
 <!-- ============ VARIABLE DETAIL =========== -->  
   
 <A NAME='variable_detail'></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Variable Detail</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
 </TABLE>  
   
 <A NAME='var$indent_flag'><!-- --></A><H3>$indent_flag</H3> (line <span class="linenumber">75</span>)<br />  
 <b>Data type:</b> boolean<br>Flag for pretty (indented) output  
 <br />  
   
 <UL>  
                 <LI><b>access</b> - <CODE>public</CODE></LI>  
         </UL>  
 <HR>  
 <A NAME='var$_entries'><!-- --></A><H3>$_entries</H3> (line <span class="linenumber">49</span>)<br />  
 <b>Data type:</b> array<br>This holds the entries for the css  
 <br />  
   
 <UL>  
         </UL>  
 <HR>  
 <A NAME='var$_header_flag'><!-- --></A><H3>$_header_flag</H3> (line <span class="linenumber">59</span>)<br />  
 <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");  
 <br />  
   
 <UL>  
         </UL>  
 <HR>  
 <hr>  
 <!-- ============ METHOD DETAIL =========== -->  
   
 <A NAME='method_detail'></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span class="font12bold">Method Detail</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
 </TABLE>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='methodCSSBuilder'><!-- --></A>  
 <SPAN CLASS="font12bold">Constructor CSSBuilder</SPAN> (line <span class="linenumber">86</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">CSSBuilder(  
 [boolean  
 $header_flag = FALSE])</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 The CSSBuilder constructor  
 <br />  
   
 <DL>  
         <DT class="font10bold">Function Parameters:</DT>  
                 <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>  
           
         <DT class="font10bold">Function Info:</DT>  
         </DL>  
 </DIV>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='methodadd_entry'><!-- --></A>  
 <SPAN CLASS="font12bold">add_entry</SPAN> (line <span class="linenumber">189</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">add_entry(  
 string  
 $name, string  
 $extends, array  
 $attributes)</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 This function adds a new class entry  
 <br />  
   
 <DL>  
         <DT class="font10bold">Function Parameters:</DT>  
                 <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>  
                 <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>  
                 <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>  
           
         <DT class="font10bold">Function Info:</DT>  
         </DL>  
 </DIV>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='methodrender'><!-- --></A>  
 <SPAN CLASS="font12bold">render</SPAN> (line <span class="linenumber">103</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">render(  
 [int  
 $indent_level = 1], int  
 $output_debug)</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 The render method for compatibility  with the rest of the phphtmllib api  
 <br />  
   
 <DL>  
         <DT class="font10bold">Function Parameters:</DT>  
                 <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>  
                 <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>  
           
         <DT class="font10bold">Function Info:</DT>  
                 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - the raw html output.</DD>  
         </DL>  
 </DIV>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='methodset_header_flag'><!-- --></A>  
 <SPAN CLASS="font12bold">set_header_flag</SPAN> (line <span class="linenumber">127</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">set_header_flag(  
 boolean  
 $flag)</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 This is used to set/update the header  flag.  
 <br />  
   
 <DL>  
         <DT class="font10bold">Function Parameters:</DT>  
                 <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>  
           
         <DT class="font10bold">Function Info:</DT>  
         </DL>  
 </DIV>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='methodupdate_all_values'><!-- --></A>  
 <SPAN CLASS="font12bold">update_all_values</SPAN> (line <span class="linenumber">244</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">update_all_values(  
 string  
 $property, string  
 $search, string  
 $value)</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 This function is a macro for walking the entire  
 <br />  
 <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>  
 <DL>  
         <DT class="font10bold">Function Parameters:</DT>  
                 <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>  
                 <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>  
                 <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>  
           
         <DT class="font10bold">Function Info:</DT>  
         </DL>  
 </DIV>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='methodupdate_properties'><!-- --></A>  
 <SPAN CLASS="font12bold">update_properties</SPAN> (line <span class="linenumber">219</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">update_properties(  
 string  
 $name, string  
 $extends, array  
 $properties)</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 This function updates a css property value  for a specific class/id  
 <br />  
   
 <DL>  
         <DT class="font10bold">Function Parameters:</DT>  
                 <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>  
                 <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>  
                 <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 =&gt; value ) pairs.</DD>  
           
         <DT class="font10bold">Function Info:</DT>  
         </DL>  
 </DIV>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='methodupdate_property'><!-- --></A>  
 <SPAN CLASS="font12bold">update_property</SPAN> (line <span class="linenumber">205</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">update_property(  
 string  
 $name, string  
 $extends, string  
 $property, string  
 $value)</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 This function updates a css property value  for a specific class/id  
 <br />  
   
 <DL>  
         <DT class="font10bold">Function Parameters:</DT>  
                 <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>  
                 <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>  
                 <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>  
                 <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>  
           
         <DT class="font10bold">Function Info:</DT>  
         </DL>  
 </DIV>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='methoduser_setup'><!-- --></A>  
 <SPAN CLASS="font12bold">user_setup</SPAN> (line <span class="linenumber">136</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">user_setup(  
 )</SPAN>  
 <BR>  
         <p>Overridden in child classes as:<br />  
                 <dl>  
         <dt><a href="../phpHtmlLib/FooterNavCSS.html#methoduser_setup">FooterNavCSS::user_setup()</a></dt>  
                 <dd></dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/ActiveTabCSS.html#methoduser_setup">ActiveTabCSS::user_setup()</a></dt>  
                 <dd></dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/InfoTableCSS.html#methoduser_setup">InfoTableCSS::user_setup()</a></dt>  
                 <dd></dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/NavTableCSS.html#methoduser_setup">NavTableCSS::user_setup()</a></dt>  
                 <dd></dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/TextNavCSS.html#methoduser_setup">TextNavCSS::user_setup()</a></dt>  
                 <dd></dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/TextCSSNavCSS.html#methoduser_setup">TextCSSNavCSS::user_setup()</a></dt>  
                 <dd></dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/ImageThumbnailWidgetCSS.html#methoduser_setup">ImageThumbnailWidgetCSS::user_setup()</a></dt>  
                 <dd></dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/RoundTitleTableCSS.html#methoduser_setup">RoundTitleTableCSS::user_setup()</a></dt>  
                 <dd></dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/DefaultGUIDataListCSS.html#methoduser_setup">DefaultGUIDataListCSS::user_setup()</a></dt>  
                 <dd></dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/VerticalCSSNavTableCSS.html#methoduser_setup">VerticalCSSNavTableCSS::user_setup()</a></dt>  
                 <dd></dd>  
         </dl>  
         </p>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 Call the child class' setup function  
 <br />  
 <p>to build the actual css classes and their  attributes</p>  
 <DL>  
   
         <DT class="font10bold">Function Info:</DT>  
         </DL>  
 </DIV>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='method_build_name'><!-- --></A>  
 <SPAN CLASS="font12bold">_build_name</SPAN> (line <span class="linenumber">154</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">the</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">_build_name(  
 string  
 $class)</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 This function is used to construct the css name  declaration string.  
 <br />  
 <p>ie #foo div,span {</p>  
 <DL>  
         <DT class="font10bold">Function Parameters:</DT>  
                 <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>  
           
         <DT class="font10bold">Function Info:</DT>  
                 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - css name declaration</DD>  
         </DL>  
 </DIV>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='method_build_properties'><!-- --></A>  
 <SPAN CLASS="font12bold">_build_properties</SPAN> (line <span class="linenumber">169</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">_build_properties(  
 array  
 $properties, array  
 $indent_str)</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 This function is used to construct the  property: value strings for the class  
 <br />  
   
 <DL>  
         <DT class="font10bold">Function Parameters:</DT>  
                 <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>  
                 <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>  
           
         <DT class="font10bold">Function Info:</DT>  
         </DL>  
 </DIV>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='method_replace_value'><!-- --></A>  
 <SPAN CLASS="font12bold">_replace_value</SPAN> (line <span class="linenumber">258</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">_replace_value(  
 mixed  
 &$item, mixed  
 $key, mixed  
 $blah)</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 This function does the main work for update_all_values  
 <br />  
   
 <DL>  
   
         <DT class="font10bold">Function Info:</DT>  
         </DL>  
 </DIV>  
 <BR>  
         <div id="credit">  
                 <hr>  
                 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>  
         </div>  
 </body>  
 </html>  
1    <?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 &lt;style&gt; 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> Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</li>
30                            </ul>
31                    <p class="notes">
32                            Located in <a class="field" href="_widgets_CSSBuilder_inc.html">/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/ButtonPanelCSS.html">ButtonPanelCSS</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/FooterNavCSS.html">FooterNavCSS</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/ImageThumbnailWidgetCSS.html">ImageThumbnailWidgetCSS</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/InfoTableCSS.html">InfoTableCSS</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/NavTableCSS.html">NavTableCSS</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/TabListCSS.html">TabListCSS</a></td>
101                                            <td>
102                                                                                            This class defines the css used by the  FooterNav Object.
103                                                                                    </td>
104                                    </tr>
105                                                                    <tr>
106                                            <td style="padding-right: 2em"><a href="../phpHtmlLib/TextCSSNavCSS.html">TextCSSNavCSS</a></td>
107                                            <td>
108                                                                                            This class defines the css used by the  FooterNav Object.
109                                                                                    </td>
110                                    </tr>
111                                                                    <tr>
112                                            <td style="padding-right: 2em"><a href="../phpHtmlLib/TextNavCSS.html">TextNavCSS</a></td>
113                                            <td>
114                                                                                            This class defines the css used by the  TextNav Object.
115                                                                                    </td>
116                                    </tr>
117                                                                    <tr>
118                                            <td style="padding-right: 2em"><a href="../phpHtmlLib/VerticalCSSNavTableCSS.html">VerticalCSSNavTableCSS</a></td>
119                                            <td>
120                                                                                            This class defines the css used by the  VerticalCSSNavTable Object.
121                                                                                    </td>
122                                    </tr>
123                                                                    <tr>
124                                            <td style="padding-right: 2em"><a href="../phpHtmlLib/DefaultGUIDataListCSS.html">DefaultGUIDataListCSS</a></td>
125                                            <td>
126                                                                                            This class defines the css used by the  FooterNav Object.
127                                                                                    </td>
128                                    </tr>
129                                                            </table>
130                    </div>
131            </div>
132    
133    
134            <a name="sec-var-summary"></a>
135            <div class="info-box">
136                    <div class="info-box-title">Variable Summary</span></div>
137                    <div class="nav-bar">
138                            <a href="#sec-description">Description</a> |
139                                                            <a href="#sec-descendents">Descendents</a> |
140                                                    <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
141                                                            |
142                                                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
143                                                            
144                                                                    </div>
145                    <div class="info-box-body">
146                            <div class="var-summary">
147                                                                    <div class="var-title">
148                                            <span class="var-type">boolean</span>
149                                            <a href="#$indent_flag" title="details" class="var-name">$indent_flag</a>
150                                    </div>
151                                                                    <div class="var-title">
152                                            <span class="var-type">array</span>
153                                            <a href="#$_entries" title="details" class="var-name">$_entries</a>
154                                    </div>
155                                                                    <div class="var-title">
156                                            <span class="var-type">boolean</span>
157                                            <a href="#$_header_flag" title="details" class="var-name">$_header_flag</a>
158                                    </div>
159                                                            </div>
160                    </div>
161            </div>
162    
163            <a name="sec-method-summary"></a>
164            <div class="info-box">
165                    <div class="info-box-title">Method Summary</span></div>
166                    <div class="nav-bar">
167                            <a href="#sec-description">Description</a> |
168                                                            <a href="#sec-descendents">Descendents</a> |
169                                                                                                                                                    <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
170                                    
171                                    |
172                                                    <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
173                    </div>
174                    <div class="info-box-body">                    
175                            <div class="method-summary">
176                                                                    
177                                    <div class="method-definition">
178                                                                                            <span class="method-result">CSSBuilder</span>
179                                                                                    <a href="#CSSBuilder" title="details" class="method-name">CSSBuilder</a>
180                                                                                            ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$header_flag</span> = <span class="var-default">FALSE</span>])
181                                                                            </div>
182                                                                    
183                                    <div class="method-definition">
184                                                                                            <span class="method-result">void</span>
185                                                                                    <a href="#add_entry" title="details" class="method-name">add_entry</a>
186                                                                                            (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$extends</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$attributes</span>)
187                                                                            </div>
188                                                                    
189                                    <div class="method-definition">
190                                                                                            <span class="method-result">string</span>
191                                                                                    <a href="#render" title="details" class="method-name">render</a>
192                                                                                            ([<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$output_debug</span>)
193                                                                            </div>
194                                                                    
195                                    <div class="method-definition">
196                                                                                            <span class="method-result">void</span>
197                                                                                    <a href="#set_header_flag" title="details" class="method-name">set_header_flag</a>
198                                                                                            (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span>)
199                                                                            </div>
200                                                                    
201                                    <div class="method-definition">
202                                                                                            <span class="method-result">void</span>
203                                                                                    <a href="#update_all_values" title="details" class="method-name">update_all_values</a>
204                                                                                            (<span class="var-type">string</span>&nbsp;<span class="var-name">$property</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$search</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
205                                                                            </div>
206                                                                    
207                                    <div class="method-definition">
208                                                                                            <span class="method-result">void</span>
209                                                                                    <a href="#update_properties" title="details" class="method-name">update_properties</a>
210                                                                                            (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$extends</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$properties</span>)
211                                                                            </div>
212                                                                    
213                                    <div class="method-definition">
214                                                                                            <span class="method-result">void</span>
215                                                                                    <a href="#update_property" title="details" class="method-name">update_property</a>
216                                                                                            (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$extends</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$property</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
217                                                                            </div>
218                                                                    
219                                    <div class="method-definition">
220                                                                                            <span class="method-result">void</span>
221                                                                                    <a href="#user_setup" title="details" class="method-name">user_setup</a>
222                                                                                    ()
223                                                                            </div>
224                                                                    
225                                    <div class="method-definition">
226                                                                                            <span class="method-result">the</span>
227                                                                                    <a href="#_build_name" title="details" class="method-name">_build_name</a>
228                                                                                            (<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span>)
229                                                                            </div>
230                                                                    
231                                    <div class="method-definition">
232                                                                                            <span class="method-result">string</span>
233                                                                                    <a href="#_build_properties" title="details" class="method-name">_build_properties</a>
234                                                                                            (<span class="var-type">array</span>&nbsp;<span class="var-name">$properties</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$indent_str</span>)
235                                                                            </div>
236                                                                    
237                                    <div class="method-definition">
238                                                                                            <span class="method-result">void</span>
239                                                                                    <a href="#_replace_value" title="details" class="method-name">_replace_value</a>
240                                                                                            (<span class="var-type">mixed</span>&nbsp;<span class="var-name">&$item</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$blah</span>)
241                                                                            </div>
242                                                            </div>
243                    </div>
244            </div>          
245    
246            <a name="sec-vars"></a>
247            <div class="info-box">
248                    <div class="info-box-title">Variables</div>
249                    <div class="nav-bar">
250                            <a href="#sec-description">Description</a> |
251                                                            <a href="#sec-descendents">Descendents</a> |
252                                                                                    <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
253                                                    
254                            
255                                                                                    |
256                                                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
257                                                            
258                                            </div>
259                    <div class="info-box-body">
260                            <a name="var$indent_flag" id="$indent_flag"><!-- --></A>
261    <div class="oddrow">
262    
263            <div class="var-header">
264                    <span class="var-title">
265                            <span class="var-type">boolean</span>
266                            <span class="var-name">$indent_flag</span>
267                             = <span class="var-default"> TRUE</span>                       (line <span class="line-number">75</span>)
268                    </span>
269            </div>
270    
271            <!-- ========== Info from phpDoc block ========= -->
272    <p class="short-description">Flag for pretty (indented) output</p>
273            <ul class="tags">
274                                    <li><span class="field">access:</span> public</li>
275                            </ul>
276            
277            
278                    
279                    
280    
281    </div>
282    <a name="var$_entries" id="$_entries"><!-- --></A>
283    <div class="evenrow">
284    
285            <div class="var-header">
286                    <span class="var-title">
287                            <span class="var-type">array</span>
288                            <span class="var-name">$_entries</span>
289                             = <span class="var-default">array()</span>                     (line <span class="line-number">49</span>)
290                    </span>
291            </div>
292    
293            <!-- ========== Info from phpDoc block ========= -->
294    <p class="short-description">This holds the entries for the css</p>
295            
296            
297                    
298                    
299    
300    </div>
301    <a name="var$_header_flag" id="$_header_flag"><!-- --></A>
302    <div class="oddrow">
303    
304            <div class="var-header">
305                    <span class="var-title">
306                            <span class="var-type">boolean</span>
307                            <span class="var-name">$_header_flag</span>
308                             = <span class="var-default"> FALSE</span>                      (line <span class="line-number">59</span>)
309                    </span>
310            </div>
311    
312            <!-- ========== Info from phpDoc block ========= -->
313    <p class="short-description">Flag to let us know if we should  output a header content-type value  header(&quot;Content-Type: text/css&quot;);</p>
314            
315            
316                    
317                    
318    
319    </div>
320                                                    
321                    </div>
322            </div>
323            
324            <a name="sec-methods"></a>
325            <div class="info-box">
326                    <div class="info-box-title">Methods</div>
327                    <div class="nav-bar">
328                            <a href="#sec-description">Description</a> |
329                                                            <a href="#sec-descendents">Descendents</a> |
330                                                                                                                            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
331                                                                                                                                            <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
332                                                    
333                    </div>
334                    <div class="info-box-body">
335                            <A NAME='method_detail'></A>
336    <a name="methodCSSBuilder" id="CSSBuilder"><!-- --></a>
337    <div class="evenrow">
338            
339            <div class="method-header">
340                    <span class="method-title">Constructor CSSBuilder</span> (line <span class="line-number">86</span>)
341            </div>
342            
343            <!-- ========== Info from phpDoc block ========= -->
344    <p class="short-description">The CSSBuilder constructor</p>
345            
346            <div class="method-signature">
347                    <span class="method-result">CSSBuilder</span>
348                    <span class="method-name">
349                            CSSBuilder
350                    </span>
351                                            ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$header_flag</span> = <span class="var-default">FALSE</span>])
352                            </div>
353            
354                            <ul class="parameters">
355                                            <li>
356                                    <span class="var-type">boolean</span>
357                                    <span class="var-name">$header_flag</span><span class="var-description">: - output the http header                   content type mime type                   or not.</span>                    </li>
358                                    </ul>
359                    
360                    
361            </div>
362    <a name="methodadd_entry" id="add_entry"><!-- --></a>
363    <div class="oddrow">
364            
365            <div class="method-header">
366                    <span class="method-title">add_entry</span> (line <span class="line-number">189</span>)
367            </div>
368            
369            <!-- ========== Info from phpDoc block ========= -->
370    <p class="short-description">This function adds a new class entry</p>
371            
372            <div class="method-signature">
373                    <span class="method-result">void</span>
374                    <span class="method-name">
375                            add_entry
376                    </span>
377                                            (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$extends</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$attributes</span>)
378                            </div>
379            
380                            <ul class="parameters">
381                                            <li>
382                                    <span class="var-type">string</span>
383                                    <span class="var-name">$name</span><span class="var-description">: - class/id name</span>                       </li>
384                                            <li>
385                                    <span class="var-type">string</span>
386                                    <span class="var-name">$extends</span><span class="var-description">: - the list of extends                  ie #foo div, a { }                  where &quot;div, a&quot; are the extends</span>                        </li>
387                                            <li>
388                                    <span class="var-type">array</span>
389                                    <span class="var-name">$attributes</span><span class="var-description">: - the attributes</span>                        </li>
390                                    </ul>
391                    
392                    
393            </div>
394    <a name="methodrender" id="render"><!-- --></a>
395    <div class="evenrow">
396            
397            <div class="method-header">
398                    <span class="method-title">render</span> (line <span class="line-number">103</span>)
399            </div>
400            
401            <!-- ========== Info from phpDoc block ========= -->
402    <p class="short-description">The render method for compatibility  with the rest of the phphtmllib api</p>
403            <ul class="tags">
404                                    <li><span class="field">return:</span> the raw html output.</li>
405                            </ul>
406            
407            <div class="method-signature">
408                    <span class="method-result">string</span>
409                    <span class="method-name">
410                            render
411                    </span>
412                                            ([<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$output_debug</span>)
413                            </div>
414            
415                            <ul class="parameters">
416                                            <li>
417                                    <span class="var-type">int</span>
418                                    <span class="var-name">$indent_level</span><span class="var-description">: - the indentation level for               the container.</span>                      </li>
419                                            <li>
420                                    <span class="var-type">int</span>
421                                    <span class="var-name">$output_debug</span><span class="var-description">: - the output debug flag to               maintain compatibility w/ the API.</span>                   </li>
422                                    </ul>
423                    
424                    
425            </div>
426    <a name="methodset_header_flag" id="set_header_flag"><!-- --></a>
427    <div class="oddrow">
428            
429            <div class="method-header">
430                    <span class="method-title">set_header_flag</span> (line <span class="line-number">127</span>)
431            </div>
432            
433            <!-- ========== Info from phpDoc block ========= -->
434    <p class="short-description">This is used to set/update the header  flag.</p>
435            
436            <div class="method-signature">
437                    <span class="method-result">void</span>
438                    <span class="method-name">
439                            set_header_flag
440                    </span>
441                                            (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span>)
442                            </div>
443            
444                            <ul class="parameters">
445                                            <li>
446                                    <span class="var-type">boolean</span>
447                                    <span class="var-name">$flag</span>                     </li>
448                                    </ul>
449                    
450                    
451            </div>
452    <a name="methodupdate_all_values" id="update_all_values"><!-- --></a>
453    <div class="evenrow">
454            
455            <div class="method-header">
456                    <span class="method-title">update_all_values</span> (line <span class="line-number">244</span>)
457            </div>
458            
459            <!-- ========== Info from phpDoc block ========= -->
460    <p class="short-description">This function is a macro for walking the entire</p>
461    <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>
462            
463            <div class="method-signature">
464                    <span class="method-result">void</span>
465                    <span class="method-name">
466                            update_all_values
467                    </span>
468                                            (<span class="var-type">string</span>&nbsp;<span class="var-name">$property</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$search</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
469                            </div>
470            
471                            <ul class="parameters">
472                                            <li>
473                                    <span class="var-type">string</span>
474                                    <span class="var-name">$property</span><span class="var-description">: - the property that the search lives in</span>                   </li>
475                                            <li>
476                                    <span class="var-type">string</span>
477                                    <span class="var-name">$search</span><span class="var-description">: - the original value to find</span>                        </li>
478                                            <li>
479                                    <span class="var-type">string</span>
480                                    <span class="var-name">$value</span><span class="var-description">: - the new value</span>                      </li>
481                                    </ul>
482                    
483                    
484            </div>
485    <a name="methodupdate_properties" id="update_properties"><!-- --></a>
486    <div class="oddrow">
487            
488            <div class="method-header">
489                    <span class="method-title">update_properties</span> (line <span class="line-number">219</span>)
490            </div>
491            
492            <!-- ========== Info from phpDoc block ========= -->
493    <p class="short-description">This function updates a css property value  for a specific class/id</p>
494            
495            <div class="method-signature">
496                    <span class="method-result">void</span>
497                    <span class="method-name">
498                            update_properties
499                    </span>
500                                            (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$extends</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$properties</span>)
501                            </div>
502            
503                            <ul class="parameters">
504                                            <li>
505                                    <span class="var-type">string</span>
506                                    <span class="var-name">$name</span><span class="var-description">: - the class/id name</span>                   </li>
507                                            <li>
508                                    <span class="var-type">string</span>
509                                    <span class="var-name">$extends</span><span class="var-description">: - the list of extends                  ie #foo div, a { }                  where &quot;div, a&quot; are the extends</span>                        </li>
510                                            <li>
511                                    <span class="var-type">array</span>
512                                    <span class="var-name">$properties</span><span class="var-description">: - the array of array(property =&gt; value ) pairs.</span>                      </li>
513                                    </ul>
514                    
515                    
516            </div>
517    <a name="methodupdate_property" id="update_property"><!-- --></a>
518    <div class="evenrow">
519            
520            <div class="method-header">
521                    <span class="method-title">update_property</span> (line <span class="line-number">205</span>)
522            </div>
523            
524            <!-- ========== Info from phpDoc block ========= -->
525    <p class="short-description">This function updates a css property value  for a specific class/id</p>
526            
527            <div class="method-signature">
528                    <span class="method-result">void</span>
529                    <span class="method-name">
530                            update_property
531                    </span>
532                                            (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$extends</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$property</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
533                            </div>
534            
535                            <ul class="parameters">
536                                            <li>
537                                    <span class="var-type">string</span>
538                                    <span class="var-name">$name</span><span class="var-description">: - the class/id name</span>                   </li>
539                                            <li>
540                                    <span class="var-type">string</span>
541                                    <span class="var-name">$extends</span><span class="var-description">: - the list of extends                  ie #foo div, a { }                  where &quot;div, a&quot; are the extends</span>                        </li>
542                                            <li>
543                                    <span class="var-type">string</span>
544                                    <span class="var-name">$property</span><span class="var-description">: - the property to adjust</span>                  </li>
545                                            <li>
546                                    <span class="var-type">string</span>
547                                    <span class="var-name">$value</span><span class="var-description">: - the value for the property</span>                 </li>
548                                    </ul>
549                    
550                    
551            </div>
552    <a name="methoduser_setup" id="user_setup"><!-- --></a>
553    <div class="oddrow">
554            
555            <div class="method-header">
556                    <span class="method-title">user_setup</span> (line <span class="line-number">136</span>)
557            </div>
558            
559            <!-- ========== Info from phpDoc block ========= -->
560    <p class="short-description">Call the child class' setup function</p>
561    <p class="description"><p>to build the actual css classes and their  attributes</p></p>
562            
563            <div class="method-signature">
564                    <span class="method-result">void</span>
565                    <span class="method-name">
566                            user_setup
567                    </span>
568                                    ()
569                            </div>
570            
571                    
572                    
573                            <hr class="separator" />
574                    <div class="notes">Redefined in descendants as:</div>
575                    <ul class="redefinitions">
576                                            <li>
577                                    <a href="../phpHtmlLib/ActiveTabCSS.html#methoduser_setup">ActiveTabCSS::user_setup()</a>
578                                                            </li>
579                                            <li>
580                                    <a href="../phpHtmlLib/ButtonPanelCSS.html#methoduser_setup">ButtonPanelCSS::user_setup()</a>
581                                                            </li>
582                                            <li>
583                                    <a href="../phpHtmlLib/FooterNavCSS.html#methoduser_setup">FooterNavCSS::user_setup()</a>
584                                                            </li>
585                                            <li>
586                                    <a href="../phpHtmlLib/ImageThumbnailWidgetCSS.html#methoduser_setup">ImageThumbnailWidgetCSS::user_setup()</a>
587                                                            </li>
588                                            <li>
589                                    <a href="../phpHtmlLib/InfoTableCSS.html#methoduser_setup">InfoTableCSS::user_setup()</a>
590                                                            </li>
591                                            <li>
592                                    <a href="../phpHtmlLib/NavTableCSS.html#methoduser_setup">NavTableCSS::user_setup()</a>
593                                                            </li>
594                                            <li>
595                                    <a href="../phpHtmlLib/RoundTitleTableCSS.html#methoduser_setup">RoundTitleTableCSS::user_setup()</a>
596                                                            </li>
597                                            <li>
598                                    <a href="../phpHtmlLib/TabListCSS.html#methoduser_setup">TabListCSS::user_setup()</a>
599                                                            </li>
600                                            <li>
601                                    <a href="../phpHtmlLib/TextCSSNavCSS.html#methoduser_setup">TextCSSNavCSS::user_setup()</a>
602                                                            </li>
603                                            <li>
604                                    <a href="../phpHtmlLib/TextNavCSS.html#methoduser_setup">TextNavCSS::user_setup()</a>
605                                                            </li>
606                                            <li>
607                                    <a href="../phpHtmlLib/VerticalCSSNavTableCSS.html#methoduser_setup">VerticalCSSNavTableCSS::user_setup()</a>
608                                                            </li>
609                                            <li>
610                                    <a href="../phpHtmlLib/DefaultGUIDataListCSS.html#methoduser_setup">DefaultGUIDataListCSS::user_setup()</a>
611                                                            </li>
612                                    </ul>
613            </div>
614    <a name="method_build_name" id="_build_name"><!-- --></a>
615    <div class="evenrow">
616            
617            <div class="method-header">
618                    <span class="method-title">_build_name</span> (line <span class="line-number">154</span>)
619            </div>
620            
621            <!-- ========== Info from phpDoc block ========= -->
622    <p class="short-description">This function is used to construct the css name  declaration string.</p>
623    <p class="description"><p>ie #foo div,span {</p></p>
624            <ul class="tags">
625                                    <li><span class="field">return:</span> css name declaration</li>
626                            </ul>
627            
628            <div class="method-signature">
629                    <span class="method-result">the</span>
630                    <span class="method-name">
631                            _build_name
632                    </span>
633                                            (<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span>)
634                            </div>
635            
636                            <ul class="parameters">
637                                            <li>
638                                    <span class="var-type">string</span>
639                                    <span class="var-name">$class</span><span class="var-description">: the name-extends string</span>                      </li>
640                                    </ul>
641                    
642                    
643            </div>
644    <a name="method_build_properties" id="_build_properties"><!-- --></a>
645    <div class="oddrow">
646            
647            <div class="method-header">
648                    <span class="method-title">_build_properties</span> (line <span class="line-number">169</span>)
649            </div>
650            
651            <!-- ========== Info from phpDoc block ========= -->
652    <p class="short-description">This function is used to construct the  property: value strings for the class</p>
653            
654            <div class="method-signature">
655                    <span class="method-result">string</span>
656                    <span class="method-name">
657                            _build_properties
658                    </span>
659                                            (<span class="var-type">array</span>&nbsp;<span class="var-name">$properties</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$indent_str</span>)
660                            </div>
661            
662                            <ul class="parameters">
663                                            <li>
664                                    <span class="var-type">array</span>
665                                    <span class="var-name">$properties</span><span class="var-description">: - the properties</span>                        </li>
666                                            <li>
667                                    <span class="var-type">array</span>
668                                    <span class="var-name">$indent_str</span><span class="var-description">: - the indent string.</span>                    </li>
669                                    </ul>
670                    
671                    
672            </div>
673    <a name="method_replace_value" id="_replace_value"><!-- --></a>
674    <div class="evenrow">
675            
676            <div class="method-header">
677                    <span class="method-title">_replace_value</span> (line <span class="line-number">258</span>)
678            </div>
679            
680            <!-- ========== Info from phpDoc block ========= -->
681    <p class="short-description">This function does the main work for update_all_values</p>
682            
683            <div class="method-signature">
684                    <span class="method-result">void</span>
685                    <span class="method-name">
686                            _replace_value
687                    </span>
688                                            (<span class="var-type">mixed</span>&nbsp;<span class="var-name">&$item</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$blah</span>)
689                            </div>
690            
691                    
692                    
693            </div>
694                                                    
695                    </div>
696            </div>
697    
698    
699            <p class="notes" id="credit">
700                    Documentation generated on Thu,  1 Apr 2004 09:38:08 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
701            </p>
702            </div></body>
703    </html>
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.4
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed