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