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

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

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

revision 1.1 by jonen, Thu Jan 30 03:29:20 2003 UTC revision 1.2 by jonen, Sat Feb 22 20:56:15 2003 UTC
# Line 1  Line 1 
1  <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'>  <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'>
2  <!--NewPage-->  <!--NewPage-->
3  <HTML>  <HTML>
4  <HEAD>  <HEAD>
5          <!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:29 -0800' -->          <!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:22:32 -0800' -->
6          <TITLE>Docs For Class BaseWidget</TITLE>          <TITLE>Docs For Class BaseWidget</TITLE>
7  <LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'>  <LINK REL ='stylesheet' TYPE='text/css' HREF='../media/stylesheet.css' TITLE='Style'>
8  </HEAD>  </HEAD>
9  <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">  <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">
       
   
10  <!-- Links -->  <!-- Links -->
11  <a NAME="top"></A>  <a NAME="top"></A>
12  <table WIDTH="100%" class="links">  <table WIDTH="100%" class="links">
# Line 18  Line 16 
16        <A HREF="#children_summary" class="links" title="Classes extended from BaseWidget">Child Classes</A>        <A HREF="#children_summary" class="links" title="Classes extended from BaseWidget">Child Classes</A>
17        <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>        <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>        <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">Inerited Methods</A>        <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A>
20        <A HREF="#functions_summary" class="links" title="Method Summary">Methods</A>        <A HREF="#method_summary" class="links" title="Method Summary">Methods</A>
21        <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>        <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
22        <A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A>        <A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A>
23     </TD>     </TD>
24   </TR>   </TR>
25  </TABLE>  </TABLE>
26  <BR>  <BR>
   
27  <!-- Start of Class Data -->  <!-- Start of Class Data -->
28  <H2>  <H2>
29          Class BaseWidget          Class BaseWidget
30  </H2>  </H2> (line <span class="linenumber">21</span>)
   
31  <pre>  <pre>
32  <pre><a href="../phpHtmlLib/Container.html">Container</a>  <a href="../phpHtmlLib/Container.html">Container</a>
33     |     |
34     --BaseWidget</pre>     --BaseWidget</pre>
35  </pre>  <SPAN class="type">Classes extended from BaseWidget:</SPAN>
36                    <dl>
37  <A NAME="children_summary"</A>          <dt><a href="../phpHtmlLib/FooterNav.html">FooterNav</a></dt>
38  <H3>                  <dd>Use this class to render footer navigation that  is displayed at the bottom of a page.</dd>
39          Classes extended from BaseWidget: <A HREF="#top" CLASS="links">^TOP</A>          </dl>
40  </H3>                  <dl>
41  <a href="../phpHtmlLib/FooterNav.html">FooterNav</a>, <a href="../phpHtmlLib/ActiveTab.html">ActiveTab</a>, <a href="../phpHtmlLib/InfoTable.html">InfoTable</a>, <a href="../phpHtmlLib/NavTable.html">NavTable</a>, <a href="../phpHtmlLib/TextNav.html">TextNav</a>, <a href="../phpHtmlLib/TreeNav.html">TreeNav</a>, <a href="../phpHtmlLib/TextCSSNav.html">TextCSSNav</a>, <a href="../phpHtmlLib/VerticalCSSNavTable.html">VerticalCSSNavTable</a>, <a href="../phpHtmlLib/ImageThumbnailWidget.html">ImageThumbnailWidget</a>, <a href="../phpHtmlLib/DataList.html">DataList</a>          <dt><a href="../phpHtmlLib/ActiveTab.html">ActiveTab</a></dt>
42                    <dd>This class is used for creating a tab panel of content  where the tabs can be switched on the fly w/ JS, thereby  eliminating a page turn to see the other tab's content.</dd>
43            </dl>
44                    <dl>
45            <dt><a href="../phpHtmlLib/InfoTable.html">InfoTable</a></dt>
46                    <dd>This is a widget class that can build  and render data in a nicely formated table  with a title, column headers and data</dd>
47            </dl>
48                    <dl>
49            <dt><a href="../phpHtmlLib/NavTable.html">NavTable</a></dt>
50                    <dd>This builds a navigational table  widget that has a title, any #  of subtitles and then navigational  links.</dd>
51            </dl>
52                    <dl>
53            <dt><a href="../phpHtmlLib/TextNav.html">TextNav</a></dt>
54                    <dd>This class builds a simple text navigational  widget.</dd>
55            </dl>
56                    <dl>
57            <dt><a href="../phpHtmlLib/TreeNav.html">TreeNav</a></dt>
58                    <dd>This class tries to build a tree  navigational widget.</dd>
59            </dl>
60                    <dl>
61            <dt><a href="../phpHtmlLib/TextCSSNav.html">TextCSSNav</a></dt>
62                    <dd>This class builds a simple text navigational  widget.</dd>
63            </dl>
64                    <dl>
65            <dt><a href="../phpHtmlLib/ImageThumbnailWidget.html">ImageThumbnailWidget</a></dt>
66                    <dd>This widget creates a N by x visual table of  thumbnails.</dd>
67            </dl>
68                    <dl>
69            <dt><a href="../phpHtmlLib/RoundTitleTable.html">RoundTitleTable</a></dt>
70                    <dd>This builds a table  widget that has a nice rounded title,  a subtitle area and any amount of data.</dd>
71            </dl>
72                    <dl>
73            <dt><a href="../phpHtmlLib/DataList.html">DataList</a></dt>
74                    <dd>This object is the base class that can be</dd>
75            </dl>
76                    <dl>
77            <dt><a href="../phpHtmlLib/CSSContainer.html">CSSContainer</a></dt>
78                    <dd>This class is a container for CSSBuilder  objects.  It is meant to make the  theming of many CSSBuilder objects easy  to manage.</dd>
79            </dl>
80                    <dl>
81            <dt><a href="../phpHtmlLib/VerticalCSSNavTable.html">VerticalCSSNavTable</a></dt>
82                    <dd>This class builds a nice table  that conains clickable cells.</dd>
83            </dl>
84            </p>
85  <p>  <p>
86          <b><i>Located in File: Program_Root/widgets/BaseWidget.inc</i></b><br>          <b><i>Located in File: Program_Root/widgets/BaseWidget.inc</i></b><br>
87  </p>  </p>
88  <hr>  <hr>
89  <!-- ========== Info from phpDoc block ========= -->  this is the base widget class, that all widgets  are based off of.  It provides some basic  members and methods
90  this is the base widget class, that all widgets  <br />
 are based off of.  
 <BR>  
 It provides some basic  
 members and methods  
91    
92  <UL>  <UL>
93                            <LI><b>author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</CODE></LI>
94          <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI>          </UL>
           
         <LI><b>Author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</CODE></LI>  
           
 </UL>  
   
95  <hr>  <hr>
96  <!-- =========== VAR SUMMARY =========== -->  <!-- =========== VAR SUMMARY =========== -->
97  <A NAME='var_summary'><!-- --></A>  <A NAME='var_summary'><!-- --></A>
# Line 73  members and methods Line 103  members and methods
103                  </TD>                  </TD>
104          </TR>          </TR>
105    
106                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
107          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
108                  <TD>                  <TD>
109                          <CODE><B><A HREF='BaseWidget.html#$title'>$title</A></B></CODE>                          <CODE><B><A HREF="../phpHtmlLib/BaseWidget.html#var$title">$title</A></B></CODE>
110                          <BR>                          <BR>
111                          <blockquote> The title of the table. </blockquote>                          <blockquote> The title of the table. </blockquote>
112                          <blockquote> Default Value: <CODE>-><-</CODE> </blockquote>                          <blockquote> Default Value: <CODE>->''<-</CODE> </blockquote>
113                  </TD>                  </TD>
114          </TR>          </TR>
115                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
116          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
117                  <TD>                  <TD>
118                          <CODE><B><A HREF='BaseWidget.html#$width'>$width</A></B></CODE>                          <CODE><B><A HREF="../phpHtmlLib/BaseWidget.html#var$width">$width</A></B></CODE>
119                          <BR>                          <BR>
120                          <blockquote> the width of the widget </blockquote>                          <blockquote> the width of the widget </blockquote>
121                          <blockquote> Default Value: <CODE>->100%<-</CODE> </blockquote>                          <blockquote> Default Value: <CODE>->"100%"<-</CODE> </blockquote>
122                  </TD>                  </TD>
123          </TR>          </TR>
124                    </TABLE>
 </TABLE>  
   
125  <hr>  <hr>
126  <!-- =========== VAR INHERITED SUMMARY =========== -->  <!-- =========== VAR INHERITED SUMMARY =========== -->
127  <A NAME='var_inherited_summary'><!-- --></A>  <A NAME='var_inherited_summary'><!-- --></A>
128  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
129          <TR CLASS='TableHeadingColor'>          <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
130                  <TD>                  <TD>
131                          <span CLASS="font12bold">Inherited Class Variable Summary</span>                          <span CLASS="font12bold">Inherited Class Variable Summary</span>
132              <A HREF="#top" CLASS="links">^TOP</A>              <A HREF="#top" CLASS="links">^TOP</A>
133                  </TD>                  </TD>
134          </TR>          </TR>
135    
136                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
137          <TR BGCOLOR='white'>          <TR BGCOLOR='white'>
138                  <TD>                  <TD>
139                          <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>                          <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
# Line 118  members and methods Line 143  members and methods
143                                  <th>Default Value</th>                                  <th>Default Value</th>
144                                  <th>Description</th>                                  <th>Description</th>
145                          </tr>                          </tr>
146                                                                                            <tr>
147                          <tr>                                  <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></td>
148                                  <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$indent_flag'>$indent_flag</A></td>                                  <td CLASS="font10" STYLE="white-space: nowrap">-> _NEWLINEAFTERCONTENT<-</td>
149                                  <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>                                  <td CLASS="font10">The flags that tell us</td>
                                 <td CLASS="font10">Flag for pretty (indented) output</td>  
                         </tr>  
                                   
                         <tr>  
                                 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>  
                                 <td CLASS="font10">Do we render a newline after the  
 contents has been rendered?</td>  
150                          </tr>                          </tr>
151                                                                                            </table>
                         </table>  
152              <BR>              <BR>
153          </TD>          </TD>
154          </TR>          </TR>
155                    </TABLE>
 </TABLE>  
156    
157  <hr>  <hr>
158  <!-- =========== INHERITED METHOD SUMMARY =========== -->  <!-- =========== METHOD SUMMARY =========== -->
159  <A NAME='functions_inherited'><!-- --></A>  <A NAME='method_summary'><!-- --></A>
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Inherited Method Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>  
             <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">  
                                 <tr CLASS="tableheadingcolor">  
                                         <th>Function</th>  
                                         <th>Description</th>  
                                 </tr>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#constructor Container'>constructor Container (  )</A></td>  
                                         <td CLASS="font10">The constructor.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add'>add (  )</A></td>  
                                         <td CLASS="font10">add content onto content stack</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add_reference'>add_reference ( &$content )</A></td>  
                                         <td CLASS="font10">Add content onto content stack  
 so you can change the item later.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#count_content'>count_content (  )</A></td>  
                                         <td CLASS="font10">counts the number of content objects</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#get_indent_flag'>get_indent_flag (  )</A></td>  
                                         <td CLASS="font10">This flag gets the current value  
 of the indent flag</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push'>push (  )</A></td>  
                                         <td CLASS="font10">Same as add().</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push_reference'>push_reference ( &$content )</A></td>  
                                         <td CLASS="font10">Same as add_reference  
 NOTE : only exists for compatibility with 1.1.x</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#render'>render ( [$indent_level = 1], [$output_debug = 0] )</A></td>  
                                         <td CLASS="font10">This function is compatible with the  
 rest of the phpHtmllib API spec.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#reset_content'>reset_content (  )</A></td>  
                                         <td CLASS="font10">destroy existing content and start with new content.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td>  
                                         <td CLASS="font10">This function turns on the collapse flag</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_indent_flag'>set_indent_flag ( $flag )</A></td>  
                                         <td CLASS="font10">function to set the indent flag</td>  
                                   
                         </table>  
             <br>                          
                 </TD>  
         </TR>  
           
 </TABLE>  
   
 <hr>  
 <!-- should have constructor at some point -->  
 <!-- =========== Method SUMMARY =========== -->  
 <A NAME='Method_summary'><!-- --></A>  
160  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
161          <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>          <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
162                  <TD>                  <TD>
# Line 228  rest of the phpHtmllib API spec.</td> Line 165  rest of the phpHtmllib API spec.</td>
165                  </TD>                  </TD>
166          </TR>          </TR>
167    
168                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
169          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
170                  <TD>                  <TD>
171                          <CODE><B><A HREF='BaseWidget.html#get_align'>string get_align (  )</A></B></CODE>                          <CODE><B><A HREF='../phpHtmlLib/BaseWidget.html#methodget_align'>string get_align (  )</A></B></CODE>
172                          <BR>                          <BR>
173                          <blockquote> This gets the alignment value                          <blockquote> This gets the alignment value  for the outer table </blockquote>
 for the outer table </blockquote>  
174                  </TD>                  </TD>
175          </TR>          </TR>
176                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
177          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
178                  <TD>                  <TD>
179                          <CODE><B><A HREF='BaseWidget.html#get_css'>string get_css (  )</A></B></CODE>                          <CODE><B><A HREF='../phpHtmlLib/BaseWidget.html#methodget_css'>string get_css (  )</A></B></CODE>
180                          <BR>                          <BR>
181                          <blockquote> This function provides the </blockquote>                          <blockquote> This function provides the  mechanism to build and return  the css needed by this widget </blockquote>
182                  </TD>                  </TD>
183          </TR>          </TR>
184                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
185          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
186                  <TD>                  <TD>
187                          <CODE><B><A HREF='BaseWidget.html#get_javascript'>string get_javascript (  )</A></B></CODE>                          <CODE><B><A HREF='../phpHtmlLib/BaseWidget.html#methodget_javascript'>string get_javascript (  )</A></B></CODE>
188                          <BR>                          <BR>
189                          <blockquote> Function for returning the raw javascript                          <blockquote> Function for returning the raw javascript  that is required for this widget. </blockquote>
 that is required for this widget. </blockquote>  
190                  </TD>                  </TD>
191          </TR>          </TR>
192                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
193          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
194                  <TD>                  <TD>
195                          <CODE><B><A HREF='BaseWidget.html#get_title'>string get_title (  )</A></B></CODE>                          <CODE><B><A HREF='../phpHtmlLib/BaseWidget.html#methodget_title'>string get_title (  )</A></B></CODE>
196                          <BR>                          <BR>
197                          <blockquote> Function for accessing the                          <blockquote> Function for accessing the  title of this widget </blockquote>
 title of this widget </blockquote>  
198                  </TD>                  </TD>
199          </TR>          </TR>
200                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
201          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
202                  <TD>                  <TD>
203                          <CODE><B><A HREF='BaseWidget.html#get_width'>string get_width (  )</A></B></CODE>                          <CODE><B><A HREF='../phpHtmlLib/BaseWidget.html#methodget_width'>string get_width (  )</A></B></CODE>
204                          <BR>                          <BR>
205                          <blockquote> Function for getting the current                          <blockquote> Function for getting the current  widget width setting. </blockquote>
 widget width setting. </blockquote>  
206                  </TD>                  </TD>
207          </TR>          </TR>
208                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
209          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
210                  <TD>                  <TD>
211                          <CODE><B><A HREF='BaseWidget.html#set_align'>void set_align ( $align )</A></B></CODE>                          <CODE><B><A HREF='../phpHtmlLib/BaseWidget.html#methodset_align'>void set_align ( $align )</A></B></CODE>
212                          <BR>                          <BR>
213                          <blockquote> This function sets the align attribute                          <blockquote> This function sets the align attribute  for the outer table. </blockquote>
 for the outer table. </blockquote>  
214                  </TD>                  </TD>
215          </TR>          </TR>
216                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
217          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
218                  <TD>                  <TD>
219                          <CODE><B><A HREF='BaseWidget.html#set_title'>void set_title ( $title )</A></B></CODE>                          <CODE><B><A HREF='../phpHtmlLib/BaseWidget.html#methodset_title'>void set_title ( $title )</A></B></CODE>
220                          <BR>                          <BR>
221                          <blockquote> Set the title for the widget. </blockquote>                          <blockquote> Set the title for the widget. </blockquote>
222                  </TD>                  </TD>
223          </TR>          </TR>
224                            <!-- =========== Summary =========== -->
         <!-- =========== Summary =========== -->  
225          <TR BGCOLOR='white' CLASS='TableRowColor'>          <TR BGCOLOR='white' CLASS='TableRowColor'>
226                  <TD>                  <TD>
227                          <CODE><B><A HREF='BaseWidget.html#set_width'>void set_width ( $width )</A></B></CODE>                          <CODE><B><A HREF='../phpHtmlLib/BaseWidget.html#methodset_width'>void set_width ( $width )</A></B></CODE>
228                          <BR>                          <BR>
229                          <blockquote> Set the width for the widget. </blockquote>                          <blockquote> Set the width for the widget. </blockquote>
230                  </TD>                  </TD>
231          </TR>          </TR>
232                    </TABLE>
233  </TABLE>  <!-- =========== INHERITED METHOD SUMMARY =========== -->
234    <A NAME='functions_inherited'><!-- --></A>
235    <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
236            <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
237                    <TD>
238                            <span CLASS="font12bold">Inherited Method Summary</span>
239                <A HREF="#top" CLASS="links">^TOP</A>
240                    </TD>
241            </TR>
242    
243                    <!-- =========== Summary =========== -->
244            <TR BGCOLOR='white' CLASS='TableRowColor'>
245                    <TD>
246                            <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
247                <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
248                                    <tr CLASS="tableheadingcolor">
249                                            <th>Function</th>
250                                            <th>Description</th>
251                                    </tr>
252                                                                    <tr>
253                                            <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></td>
254                                            <td CLASS="font10">The constructor.</td>
255                                                                    <tr>
256                                            <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></td>
257                                            <td CLASS="font10">add content onto content stack</td>
258                                                                    <tr>
259                                            <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></td>
260                                            <td CLASS="font10">Add content onto content stack  so you can change the item later.</td>
261                                                                    <tr>
262                                            <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></td>
263                                            <td CLASS="font10">counts the number of content objects</td>
264                                                                    <tr>
265                                            <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></td>
266                                            <td CLASS="font10">This flag gets the current value  of the indent flag</td>
267                                                                    <tr>
268                                            <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></td>
269                                            <td CLASS="font10">Same as add().</td>
270                                                                    <tr>
271                                            <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></td>
272                                            <td CLASS="font10">Same as add_reference  NOTE : only exists for compatibility with 1.1.x</td>
273                                                                    <tr>
274                                            <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></td>
275                                            <td CLASS="font10">This function is compatible with the  rest of the phpHtmllib API spec.</td>
276                                                                    <tr>
277                                            <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></td>
278                                            <td CLASS="font10">destroy existing content and start with new content.</td>
279                                                                    <tr>
280                                            <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></td>
281                                            <td CLASS="font10">This function turns on the collapse flag</td>
282                                                                    <tr>
283                                            <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></td>
284                                            <td CLASS="font10">function to set the indent flag</td>
285                                                                    <tr>
286                                            <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></td>
287                                            <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>
288                                                            </table>
289                <br>                        
290                    </TD>
291            </TR>
292            </TABLE>
293  <hr>  <hr>
294  <!-- ============ VARIABLE DETAIL =========== -->  <!-- ============ VARIABLE DETAIL =========== -->
295    
# Line 321  for the outer table. </blockquote> Line 303  for the outer table. </blockquote>
303          </TR>          </TR>
304  </TABLE>  </TABLE>
305    
306    <A NAME='var$title'><!-- --></A><H3>$title</H3> (line <span class="linenumber">35</span>)<br />
307  <A NAME='$title'><!-- --></A><H3>$title</H3>  <b>Data type:</b> string<br>The title of the table.
308  <b>Data type:</b> string<br>  <br />
 <!-- ========== Info from phpDoc block ========= -->  
 The title of the table.  
 <BR>  
   
309    
310  <UL>  <UL>
311                            <LI><b>access</b> - <CODE>public</CODE></LI>
312          <LI><b>Access</b> - <CODE>public</CODE></LI>          </UL>
           
 </UL>  
   
313  <HR>  <HR>
314    <A NAME='var$width'><!-- --></A><H3>$width</H3> (line <span class="linenumber">42</span>)<br />
315  <A NAME='$width'><!-- --></A><H3>$width</H3>  <b>Data type:</b> string<br>the width of the widget
316  <b>Data type:</b> string<br>  <br />
 <!-- ========== Info from phpDoc block ========= -->  
 the width of the widget  
 <BR>  
   
317    
318  <UL>  <UL>
319                            <LI><b>access</b> - <CODE>public</CODE></LI>
320          <LI><b>Access</b> - <CODE>public</CODE></LI>          </UL>
           
 </UL>  
   
321  <HR>  <HR>
   
   
322  <hr>  <hr>
323  <!-- ============ FUNCTION DETAIL =========== -->  <!-- ============ METHOD DETAIL =========== -->
324    
325  <A NAME='function_detail'></A>  <A NAME='method_detail'></A>
326  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
327          <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>          <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
328                  <TD>                  <TD>
# Line 366  the width of the widget Line 332  the width of the widget
332          </TR>          </TR>
333  </TABLE>  </TABLE>
334  <BR>  <BR>
   
335  <DIV CLASS="function">  <DIV CLASS="function">
336  <A NAME='get_align'><!-- --></A>  <A NAME='methodget_align'><!-- --></A>
337  <SPAN CLASS="font12bold">get_align</SPAN>  <SPAN CLASS="font12bold">get_align</SPAN> (line <span class="linenumber">145</span>)
338  <BR>  <BR>
339  <SPAN CLASS="font10bold">Useage : </SPAN>  <SPAN CLASS="font10bold">Usage : </SPAN>
340  <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;  <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
341  <span class="font10bold" style="color: #0000FF">get_align (  )</SPAN>  <span class="font10bold" style="color: #0000FF">get_align(
342    )</SPAN>
343  <BR>  <BR>
344    
345  <BR>  <BR>
346  <SPAN CLASS="font10bold">Description : </SPAN>  <SPAN CLASS="font10bold">Description : </SPAN>
347  <!-- ========== Info from phpDoc block ========= -->  This gets the alignment value  for the outer table
348  This gets the alignment value  <br />
 for the outer table  
 <BR>  
349    
350  <DL>  <DL>
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
   <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the alignment</DD>  
     
 </DL>  
351    
352            <DT class="font10bold">Function Info:</DT>
353                    <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the alignment</DD>
354            </DL>
355  </DIV>  </DIV>
356  <BR>  <BR>
   
357  <DIV CLASS="function">  <DIV CLASS="function">
358  <A NAME='get_css'><!-- --></A>  <A NAME='methodget_css'><!-- --></A>
359  <SPAN CLASS="font12bold">get_css</SPAN>  <SPAN CLASS="font12bold">get_css</SPAN> (line <span class="linenumber">80</span>)
360  <BR>  <BR>
361  <SPAN CLASS="font10bold">Useage : </SPAN>  <SPAN CLASS="font10bold">Usage : </SPAN>
362  <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;  <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
363  <span class="font10bold" style="color: #0000FF">get_css (  )</SPAN>  <span class="font10bold" style="color: #0000FF">get_css(
364    )</SPAN>
365  <BR>  <BR>
366    
367  <BR>  <BR>
368  <SPAN CLASS="font10bold">Description : </SPAN>  <SPAN CLASS="font10bold">Description : </SPAN>
369  <!-- ========== Info from phpDoc block ========= -->  This function provides the  mechanism to build and return  the css needed by this widget
370  This function provides the  <br />
 <BR>  
 mechanism to build and return  
 the css needed by this widget  
 <DL>  
   <DT class="font10bold">Function Parameters:</DT>  
     
371    
372    <DT class="font10bold">Function Info:</DT>  <DL>
     
   <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the raw css</DD>  
     
 </DL>  
373    
374            <DT class="font10bold">Function Info:</DT>
375                    <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - the raw css</DD>
376            </DL>
377  </DIV>  </DIV>
378  <BR>  <BR>
   
379  <DIV CLASS="function">  <DIV CLASS="function">
380  <A NAME='get_javascript'><!-- --></A>  <A NAME='methodget_javascript'><!-- --></A>
381  <SPAN CLASS="font12bold">get_javascript</SPAN>  <SPAN CLASS="font12bold">get_javascript</SPAN> (line <span class="linenumber">69</span>)
382  <BR>  <BR>
383  <SPAN CLASS="font10bold">Useage : </SPAN>  <SPAN CLASS="font10bold">Usage : </SPAN>
384  <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;  <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
385  <span class="font10bold" style="color: #0000FF">get_javascript (  )</SPAN>  <span class="font10bold" style="color: #0000FF">get_javascript(
386    )</SPAN>
387  <BR>  <BR>
388  Overridden in child class(es) as: <a href="../phpHtmlLib/ActiveTab.html#get_javascript">ActiveTab::get_javascript()</a><br>          <p>Overridden in child classes as:<br />
389                    <dl>
390            <dt><a href="../phpHtmlLib/ActiveTab.html#methodget_javascript">ActiveTab::get_javascript()</a></dt>
391                    <dd>This function MUST be called AFTER ALL content  has been added, in order for the js to work properly</dd>
392            </dl>
393            </p>
394    
395  <BR>  <BR>
396  <SPAN CLASS="font10bold">Description : </SPAN>  <SPAN CLASS="font10bold">Description : </SPAN>
397  <!-- ========== Info from phpDoc block ========= -->  Function for returning the raw javascript  that is required for this widget.
398  Function for returning the raw javascript  <br />
 that is required for this widget.  
 <BR>  
399    
400  <DL>  <DL>
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
   <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the raw javascript</DD>  
     
 </DL>  
401    
402            <DT class="font10bold">Function Info:</DT>
403                    <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the raw javascript</DD>
404            </DL>
405  </DIV>  </DIV>
406  <BR>  <BR>
   
407  <DIV CLASS="function">  <DIV CLASS="function">
408  <A NAME='get_title'><!-- --></A>  <A NAME='methodget_title'><!-- --></A>
409  <SPAN CLASS="font12bold">get_title</SPAN>  <SPAN CLASS="font12bold">get_title</SPAN> (line <span class="linenumber">102</span>)
410  <BR>  <BR>
411  <SPAN CLASS="font10bold">Useage : </SPAN>  <SPAN CLASS="font10bold">Usage : </SPAN>
412  <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;  <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
413  <span class="font10bold" style="color: #0000FF">get_title (  )</SPAN>  <span class="font10bold" style="color: #0000FF">get_title(
414    )</SPAN>
415  <BR>  <BR>
416    
417  <BR>  <BR>
418  <SPAN CLASS="font10bold">Description : </SPAN>  <SPAN CLASS="font10bold">Description : </SPAN>
419  <!-- ========== Info from phpDoc block ========= -->  Function for accessing the  title of this widget
420  Function for accessing the  <br />
 title of this widget  
 <BR>  
421    
422  <DL>  <DL>
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
   <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the title</DD>  
     
 </DL>  
423    
424            <DT class="font10bold">Function Info:</DT>
425                    <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the title</DD>
426            </DL>
427  </DIV>  </DIV>
428  <BR>  <BR>
   
429  <DIV CLASS="function">  <DIV CLASS="function">
430  <A NAME='get_width'><!-- --></A>  <A NAME='methodget_width'><!-- --></A>
431  <SPAN CLASS="font12bold">get_width</SPAN>  <SPAN CLASS="font12bold">get_width</SPAN> (line <span class="linenumber">125</span>)
432  <BR>  <BR>
433  <SPAN CLASS="font10bold">Useage : </SPAN>  <SPAN CLASS="font10bold">Usage : </SPAN>
434  <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;  <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
435  <span class="font10bold" style="color: #0000FF">get_width (  )</SPAN>  <span class="font10bold" style="color: #0000FF">get_width(
436    )</SPAN>
437  <BR>  <BR>
438    
439  <BR>  <BR>
440  <SPAN CLASS="font10bold">Description : </SPAN>  <SPAN CLASS="font10bold">Description : </SPAN>
441  <!-- ========== Info from phpDoc block ========= -->  Function for getting the current  widget width setting.
442  Function for getting the current  <br />
 widget width setting.  
 <BR>  
443    
444  <DL>  <DL>
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
   <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the width</DD>  
     
 </DL>  
445    
446            <DT class="font10bold">Function Info:</DT>
447                    <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the width</DD>
448            </DL>
449  </DIV>  </DIV>
450  <BR>  <BR>
   
451  <DIV CLASS="function">  <DIV CLASS="function">
452  <A NAME='set_align'><!-- --></A>  <A NAME='methodset_align'><!-- --></A>
453  <SPAN CLASS="font12bold">set_align</SPAN>  <SPAN CLASS="font12bold">set_align</SPAN> (line <span class="linenumber">135</span>)
454  <BR>  <BR>
455  <SPAN CLASS="font10bold">Useage : </SPAN>  <SPAN CLASS="font10bold">Usage : </SPAN>
456  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
457  <span class="font10bold" style="color: #0000FF">set_align ( $align )</SPAN>  <span class="font10bold" style="color: #0000FF">set_align(
458    string
459    $align)</SPAN>
460  <BR>  <BR>
461    
462  <BR>  <BR>
463  <SPAN CLASS="font10bold">Description : </SPAN>  <SPAN CLASS="font10bold">Description : </SPAN>
464  <!-- ========== Info from phpDoc block ========= -->  This function sets the align attribute  for the outer table.
465  This function sets the align attribute  <br />
 for the outer table.  
 <BR>  
466    
467  <DL>  <DL>
468    <DT class="font10bold">Function Parameters:</DT>          <DT class="font10bold">Function Parameters:</DT>
469                      <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">$align</SPAN></SPAN> - $align - the align value</DD>
470    <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">$align</SPAN></SPAN> -  - the align value</DD>          
471              <DT class="font10bold">Function Info:</DT>
472            </DL>
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
   
473  </DIV>  </DIV>
474  <BR>  <BR>
   
475  <DIV CLASS="function">  <DIV CLASS="function">
476  <A NAME='set_title'><!-- --></A>  <A NAME='methodset_title'><!-- --></A>
477  <SPAN CLASS="font12bold">set_title</SPAN>  <SPAN CLASS="font12bold">set_title</SPAN> (line <span class="linenumber">92</span>)
478  <BR>  <BR>
479  <SPAN CLASS="font10bold">Useage : </SPAN>  <SPAN CLASS="font10bold">Usage : </SPAN>
480  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
481  <span class="font10bold" style="color: #0000FF">set_title ( $title )</SPAN>  <span class="font10bold" style="color: #0000FF">set_title(
482    string
483    $title)</SPAN>
484  <BR>  <BR>
485    
486  <BR>  <BR>
487  <SPAN CLASS="font10bold">Description : </SPAN>  <SPAN CLASS="font10bold">Description : </SPAN>
 <!-- ========== Info from phpDoc block ========= -->  
488  Set the title for the widget.  Set the title for the widget.
489  <BR>  <br />
490  this is just a generic title string  <p>this is just a generic title string  that can be used however the child class  wants to use it.</p>
 that can be used however the child class  
 wants to use it.  
491  <DL>  <DL>
492    <DT class="font10bold">Function Parameters:</DT>          <DT class="font10bold">Function Parameters:</DT>
493                      <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">$title</SPAN></SPAN> - $title</DD>
494    <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">$title</SPAN></SPAN> -</DD>          
495              <DT class="font10bold">Function Info:</DT>
496            </DL>
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
   
497  </DIV>  </DIV>
498  <BR>  <BR>
   
499  <DIV CLASS="function">  <DIV CLASS="function">
500  <A NAME='set_width'><!-- --></A>  <A NAME='methodset_width'><!-- --></A>
501  <SPAN CLASS="font12bold">set_width</SPAN>  <SPAN CLASS="font12bold">set_width</SPAN> (line <span class="linenumber">115</span>)
502  <BR>  <BR>
503  <SPAN CLASS="font10bold">Useage : </SPAN>  <SPAN CLASS="font10bold">Usage : </SPAN>
504  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
505  <span class="font10bold" style="color: #0000FF">set_width ( $width )</SPAN>  <span class="font10bold" style="color: #0000FF">set_width(
506    string
507    $width)</SPAN>
508  <BR>  <BR>
509    
510  <BR>  <BR>
511  <SPAN CLASS="font10bold">Description : </SPAN>  <SPAN CLASS="font10bold">Description : </SPAN>
 <!-- ========== Info from phpDoc block ========= -->  
512  Set the width for the widget.  Set the width for the widget.
513  <BR>  <br />
514  this is meant to be the overall  <p>this is meant to be the overall  width expected to be used to  control the generated html.</p>
 width expected to be used to  
 control the generated html.  
515  <DL>  <DL>
516    <DT class="font10bold">Function Parameters:</DT>          <DT class="font10bold">Function Parameters:</DT>
517                      <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">$width</SPAN></SPAN> - $width (ie. 80, 100%)</DD>
518    <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">$width</SPAN></SPAN> -  (ie. 80, 100%)</DD>          
519              <DT class="font10bold">Function Info:</DT>
520            </DL>
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
   
521  </DIV>  </DIV>
522  <BR>  <BR>
523            <div id="credit">
524                    <hr>
525  <hr>                  Documention generated on Thu, 20 Feb 2003 16:22:32 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a>
526  </HTML>          </div>
527    </body>
528    </html>
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.2
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed