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