/[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.2 by jonen, Sat Feb 22 20:56:15 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 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.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: 'Thu, 20 Feb 2003 16:22:32 -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='../media/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  <!-- Links -->                  <body>
11  <a NAME="top"></A>                          <div class="page-body">                
12  <table WIDTH="100%" class="links">  <h2 class="class-name">Class BaseWidget</h2>
13   <TR>  
14     <TD class="font10">  <a name="sec-description"></a>
15        Links:  <div class="info-box">
16        <A HREF="#children_summary" class="links" title="Classes extended from BaseWidget">Child Classes</A>          <div class="info-box-title">Description</div>
17        <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>          <div class="nav-bar">
18        <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>                                          <span class="disabled">Description</span> |
19        <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A>                                                          <a href="#sec-descendents">Descendents</a>
20        <A HREF="#method_summary" class="links" title="Method Summary">Methods</A>                          |                                                                                       <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
21        <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>                                                  |                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
22        <A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A>                                                  
23     </TD>                          </div>
24   </TR>          <div class="info-box-body">
25  </TABLE>                  <!-- ========== Info from phpDoc block ========= -->
26  <BR>  <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  <!-- Start of Class Data -->          <ul class="tags">
28  <H2>                                  <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          Class BaseWidget                          </ul>
30  </H2> (line <span class="linenumber">21</span>)                  <p class="notes">
31  <pre>                          Located in <a class="field" href="_widgets_BaseWidget_inc.html">Program_Root/widgets/BaseWidget.inc</a> (line <span class="field">21</span>)
32  <a href="../phpHtmlLib/Container.html">Container</a>                  </p>
33                    
34                            
35                    <pre><a href="../phpHtmlLib/Container.html">Container</a>
36     |     |
37     --BaseWidget</pre>     --BaseWidget</pre>
38  <SPAN class="type">Classes extended from BaseWidget:</SPAN>          
39                  <dl>                          </div>
40          <dt><a href="../phpHtmlLib/FooterNav.html">FooterNav</a></dt>  </div>
41                  <dd>Use this class to render footer navigation that  is displayed at the bottom of a page.</dd>  
42          </dl>          <a name="sec-descendents"></a>
43                  <dl>          <div class="info-box">
44          <dt><a href="../phpHtmlLib/ActiveTab.html">ActiveTab</a></dt>                  <div class="info-box-title">Direct descendents</div>
45                  <dd>This class is used for creating a tab panel of content  where the tabs can be switched on the fly w/ JS, thereby  eliminating a page turn to see the other tab's content.</dd>                  <div class="nav-bar">
46          </dl>                          <a href="#sec-description">Description</a> |
47                  <dl>                          <span class="disabled">Descendents</span>
48          <dt><a href="../phpHtmlLib/InfoTable.html">InfoTable</a></dt>                          |                                                                                               <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
49                  <dd>This is a widget class that can build  and render data in a nicely formated table  with a title, column headers and data</dd>                                                                  |                                                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
50          </dl>                                                          
51                  <dl>                                          </div>
52          <dt><a href="../phpHtmlLib/NavTable.html">NavTable</a></dt>                  <div class="info-box-body">
53                  <dd>This builds a navigational table  widget that has a title, any #  of subtitles and then navigational  links.</dd>                          <table cellpadding="2" cellspacing="0" class="class-table">
54          </dl>                                  <tr>
55                  <dl>                                          <th class="class-table-header">Class</th>
56          <dt><a href="../phpHtmlLib/TextNav.html">TextNav</a></dt>                                          <th class="class-table-header">Description</th>
57                  <dd>This class builds a simple text navigational  widget.</dd>                                  </tr>
58          </dl>                                                                  <tr>
59                  <dl>                                          <td style="padding-right: 2em"><a href="../phpHtmlLib/ActiveTab.html">ActiveTab</a></td>
60          <dt><a href="../phpHtmlLib/TreeNav.html">TreeNav</a></dt>                                          <td>
61                  <dd>This class tries to build a tree  navigational widget.</dd>                                                                                          This class is used for creating a tab panel of content  where the tabs can be switched on the fly w/ JS, thereby  eliminating a page turn to see the other tab's content.
62          </dl>                                                                                  </td>
63                  <dl>                                  </tr>
64          <dt><a href="../phpHtmlLib/TextCSSNav.html">TextCSSNav</a></dt>                                                                  <tr>
65                  <dd>This class builds a simple text navigational  widget.</dd>                                          <td style="padding-right: 2em"><a href="../phpHtmlLib/FooterNav.html">FooterNav</a></td>
66          </dl>                                          <td>
67                  <dl>                                                                                          Use this class to render footer navigation that  is displayed at the bottom of a page.
68          <dt><a href="../phpHtmlLib/ImageThumbnailWidget.html">ImageThumbnailWidget</a></dt>                                                                                  </td>
69                  <dd>This widget creates a N by x visual table of  thumbnails.</dd>                                  </tr>
70          </dl>                                                                  <tr>
71                  <dl>                                          <td style="padding-right: 2em"><a href="../phpHtmlLib/ImageThumbnailWidget.html">ImageThumbnailWidget</a></td>
72          <dt><a href="../phpHtmlLib/RoundTitleTable.html">RoundTitleTable</a></dt>                                          <td>
73                  <dd>This builds a table  widget that has a nice rounded title,  a subtitle area and any amount of data.</dd>                                                                                          This widget creates a N by x visual table of  thumbnails.
74          </dl>                                                                                  </td>
75                  <dl>                                  </tr>
         <dt><a href="../phpHtmlLib/DataList.html">DataList</a></dt>  
                 <dd>This object is the base class that can be</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/CSSContainer.html">CSSContainer</a></dt>  
                 <dd>This class is a container for CSSBuilder  objects.  It is meant to make the  theming of many CSSBuilder objects easy  to manage.</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/VerticalCSSNavTable.html">VerticalCSSNavTable</a></dt>  
                 <dd>This class builds a nice table  that conains clickable cells.</dd>  
         </dl>  
         </p>  
 <p>  
         <b><i>Located in File: Program_Root/widgets/BaseWidget.inc</i></b><br>  
 </p>  
 <hr>  
 this is the base widget class, that all widgets  are based off of.  It provides some basic  members and methods  
 <br />  
   
 <UL>  
                 <LI><b>author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</CODE></LI>  
         </UL>  
 <hr>  
 <!-- =========== VAR SUMMARY =========== -->  
 <A NAME='var_summary'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Class Variable Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF="../phpHtmlLib/BaseWidget.html#var$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="../phpHtmlLib/BaseWidget.html#var$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 BGCOLOR='#CCCCFF' 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#var$_flags">Container::$_flags</a></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">-> _NEWLINEAFTERCONTENT<-</td>  
                                 <td CLASS="font10">The flags that tell us</td>  
                         </tr>  
                                                         </table>  
             <BR>  
         </TD>  
         </TR>  
         </TABLE>  
   
 <hr>  
 <!-- =========== METHOD SUMMARY =========== -->  
 <A NAME='method_summary'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span class="font12bold">Method Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/BaseWidget.html#methodget_align'>string get_align (  )</A></B></CODE>  
                         <BR>  
                         <blockquote> This gets the alignment value  for the outer table </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/BaseWidget.html#methodget_css'>string get_css (  )</A></B></CODE>  
                         <BR>  
                         <blockquote> This function provides the  mechanism to build and return  the css needed by this widget </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/BaseWidget.html#methodget_javascript'>string get_javascript (  )</A></B></CODE>  
                         <BR>  
                         <blockquote> Function for returning the raw javascript  that is required for this widget. </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/BaseWidget.html#methodget_title'>string get_title (  )</A></B></CODE>  
                         <BR>  
                         <blockquote> Function for accessing the  title of this widget </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/BaseWidget.html#methodget_width'>string get_width (  )</A></B></CODE>  
                         <BR>  
                         <blockquote> Function for getting the current  widget width setting. </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/BaseWidget.html#methodset_align'>void set_align ( $align )</A></B></CODE>  
                         <BR>  
                         <blockquote> This function sets the align attribute  for the outer table. </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/BaseWidget.html#methodset_title'>void set_title ( $title )</A></B></CODE>  
                         <BR>  
                         <blockquote> Set the title for the widget. </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/BaseWidget.html#methodset_width'>void set_width ( $width )</A></B></CODE>  
                         <BR>  
                         <blockquote> Set the width for the widget. </blockquote>  
                 </TD>  
         </TR>  
         </TABLE>  
 <!-- =========== INHERITED METHOD SUMMARY =========== -->  
 <A NAME='functions_inherited'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Inherited Method Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
                 <!-- =========== 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#methodContainer">Container::Container()</a></td>  
                                         <td CLASS="font10">The constructor.</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></td>  
                                         <td CLASS="font10">add content onto content stack</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</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#methodcount_content">Container::count_content()</a></td>  
                                         <td CLASS="font10">counts the number of content objects</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></td>  
                                         <td CLASS="font10">This flag gets the current value  of the indent flag</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></td>  
                                         <td CLASS="font10">Same as add().</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></td>  
                                         <td CLASS="font10">Same as add_reference  NOTE : only exists for compatibility with 1.1.x</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></td>  
                                         <td CLASS="font10">This function is compatible with the  rest of the phpHtmllib API spec.</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></td>  
                                         <td CLASS="font10">destroy existing content and start with new content.</td>  
76                                                                  <tr>                                                                  <tr>
77                                          <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></td>                                          <td style="padding-right: 2em"><a href="../phpHtmlLib/InfoTable.html">InfoTable</a></td>
78                                          <td CLASS="font10">This function turns on the collapse 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                                                                                    </td>
81                                    </tr>
82                                                                    <tr>
83                                            <td style="padding-right: 2em"><a href="../phpHtmlLib/NavTable.html">NavTable</a></td>
84                                            <td>
85                                                                                            This builds a navigational table  widget that has a title, any #  of subtitles and then navigational  links.
86                                                                                    </td>
87                                    </tr>
88                                                                  <tr>                                                                  <tr>
89                                          <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></td>                                          <td style="padding-right: 2em"><a href="../phpHtmlLib/TextCSSNav.html">TextCSSNav</a></td>
90                                          <td CLASS="font10">function to set the indent flag</td>                                          <td>
91                                                                                            This class builds a simple text navigational  widget.
92                                                                                    </td>
93                                    </tr>
94                                                                    <tr>
95                                            <td style="padding-right: 2em"><a href="../phpHtmlLib/SVG/SVGGraph.html">SVGGraph</a></td>
96                                            <td>
97                                                                                            This is the base Graph class for doing  SVG graphs
98                                                                                    </td>
99                                    </tr>
100                                                                  <tr>                                                                  <tr>
101                                          <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></td>                                          <td style="padding-right: 2em"><a href="../phpHtmlLib/RoundTitleTable.html">RoundTitleTable</a></td>
102                                          <td CLASS="font10">This method is used to set the bitmask  flags for this tag.  It tells the  class how to render the tag.</td>                                          <td>
103                                                                                            This builds a table  widget that has a nice rounded title,  a subtitle area and any amount of data.
104                                                                                    </td>
105                                    </tr>
106                                                                    <tr>
107                                            <td style="padding-right: 2em"><a href="../phpHtmlLib/TextNav.html">TextNav</a></td>
108                                            <td>
109                                                                                            This class builds a simple text navigational  widget.
110                                                                                    </td>
111                                    </tr>
112                                                                    <tr>
113                                            <td style="padding-right: 2em"><a href="../phpHtmlLib/TreeNav.html">TreeNav</a></td>
114                                            <td>
115                                                                                            This class tries to build a tree  navigational widget.
116                                                                                    </td>
117                                    </tr>
118                                                                    <tr>
119                                            <td style="padding-right: 2em"><a href="../phpHtmlLib/VerticalCSSNavTable.html">VerticalCSSNavTable</a></td>
120                                            <td>
121                                                                                            This class builds a nice table  that conains clickable cells.
122                                                                                    </td>
123                                    </tr>
124                                                                    <tr>
125                                            <td style="padding-right: 2em"><a href="../phpHtmlLib/DataList.html">DataList</a></td>
126                                            <td>
127                                                                                            This object is the base class that can be
128                                                                                    </td>
129                                    </tr>
130                                                                    <tr>
131                                            <td style="padding-right: 2em"><a href="../phpHtmlLib/CSSContainer.html">CSSContainer</a></td>
132                                            <td>
133                                                                                            This class is a container for CSSBuilder  objects.  It is meant to make the  theming of many CSSBuilder objects easy  to manage.
134                                                                                    </td>
135                                    </tr>
136                                                          </table>                                                          </table>
137              <br>                                          </div>
138                  </TD>          </div>
         </TR>  
         </TABLE>  
 <hr>  
 <!-- ============ VARIABLE DETAIL =========== -->  
   
 <A NAME='variable_detail'></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Variable Detail</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
 </TABLE>  
   
 <A NAME='var$title'><!-- --></A><H3>$title</H3> (line <span class="linenumber">35</span>)<br />  
 <b>Data type:</b> string<br>The title of the table.  
 <br />  
   
 <UL>  
                 <LI><b>access</b> - <CODE>public</CODE></LI>  
         </UL>  
 <HR>  
 <A NAME='var$width'><!-- --></A><H3>$width</H3> (line <span class="linenumber">42</span>)<br />  
 <b>Data type:</b> string<br>the width of the widget  
 <br />  
   
 <UL>  
                 <LI><b>access</b> - <CODE>public</CODE></LI>  
         </UL>  
 <HR>  
 <hr>  
 <!-- ============ METHOD DETAIL =========== -->  
   
 <A NAME='method_detail'></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span class="font12bold">Method Detail</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
 </TABLE>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='methodget_align'><!-- --></A>  
 <SPAN CLASS="font12bold">get_align</SPAN> (line <span class="linenumber">145</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">get_align(  
 )</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 This gets the alignment value  for the outer table  
 <br />  
   
 <DL>  
   
         <DT class="font10bold">Function Info:</DT>  
                 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the alignment</DD>  
         </DL>  
 </DIV>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='methodget_css'><!-- --></A>  
 <SPAN CLASS="font12bold">get_css</SPAN> (line <span class="linenumber">80</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">get_css(  
 )</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 This function provides the  mechanism to build and return  the css needed by this widget  
 <br />  
   
 <DL>  
   
         <DT class="font10bold">Function Info:</DT>  
                 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - the raw css</DD>  
         </DL>  
 </DIV>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='methodget_javascript'><!-- --></A>  
 <SPAN CLASS="font12bold">get_javascript</SPAN> (line <span class="linenumber">69</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">get_javascript(  
 )</SPAN>  
 <BR>  
         <p>Overridden in child classes as:<br />  
                 <dl>  
         <dt><a href="../phpHtmlLib/ActiveTab.html#methodget_javascript">ActiveTab::get_javascript()</a></dt>  
                 <dd>This function MUST be called AFTER ALL content  has been added, in order for the js to work properly</dd>  
         </dl>  
         </p>  
139    
140  <BR>          <a name="sec-var-summary"></a>
141  <SPAN CLASS="font10bold">Description : </SPAN>          <div class="info-box">
142  Function for returning the raw javascript  that is required for this widget.                  <div class="info-box-title">Variable Summary</span></div>
143  <br />                  <div class="nav-bar">
144                            <a href="#sec-description">Description</a> |
145  <DL>                                                          <a href="#sec-descendents">Descendents</a> |
146                                                    <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
147          <DT class="font10bold">Function Info:</DT>                                                          |
148                  <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the raw javascript</DD>                                                                          <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
149          </DL>                                                          
150  </DIV>                                          </div>
151  <BR>                  <div class="info-box-body">
152  <DIV CLASS="function">                          <div class="var-summary">
153  <A NAME='methodget_title'><!-- --></A>                                                                  <div class="var-title">
154  <SPAN CLASS="font12bold">get_title</SPAN> (line <span class="linenumber">102</span>)                                          <span class="var-type">string</span>
155  <BR>                                          <a href="#$title" title="details" class="var-name">$title</a>
156  <SPAN CLASS="font10bold">Usage : </SPAN>                                  </div>
157  <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;                                                                  <div class="var-title">
158  <span class="font10bold" style="color: #0000FF">get_title(                                          <span class="var-type">string</span>
159  )</SPAN>                                          <a href="#$width" title="details" class="var-name">$width</a>
160  <BR>                                  </div>
161                                                            </div>
162  <BR>                  </div>
163  <SPAN CLASS="font10bold">Description : </SPAN>          </div>
164  Function for accessing the  title of this widget  
165  <br />          <a name="sec-method-summary"></a>
166            <div class="info-box">
167  <DL>                  <div class="info-box-title">Method Summary</span></div>
168                    <div class="nav-bar">
169          <DT class="font10bold">Function Info:</DT>                          <a href="#sec-description">Description</a> |
170                  <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the title</DD>                                                          <a href="#sec-descendents">Descendents</a> |
171          </DL>                                                                                                                          <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
172  </DIV>                                  
173  <BR>                                  |
174  <DIV CLASS="function">                                                  <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
175  <A NAME='methodget_width'><!-- --></A>                  </div>
176  <SPAN CLASS="font12bold">get_width</SPAN> (line <span class="linenumber">125</span>)                  <div class="info-box-body">                    
177  <BR>                          <div class="method-summary">
178  <SPAN CLASS="font10bold">Usage : </SPAN>                                                                  
179  <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;                                  <div class="method-definition">
180  <span class="font10bold" style="color: #0000FF">get_width(                                                                                          <span class="method-result">string</span>
181  )</SPAN>                                                                                  <a href="#get_align" title="details" class="method-name">get_align</a>
182  <BR>                                                                                  ()
183                                                                            </div>
184  <BR>                                                                  
185  <SPAN CLASS="font10bold">Description : </SPAN>                                  <div class="method-definition">
186  Function for getting the current  widget width setting.                                                                                          <span class="method-result">string</span>
187  <br />                                                                                  <a href="#get_css" title="details" class="method-name">get_css</a>
188                                                                                    ()
189  <DL>                                                                          </div>
190                                                                    
191          <DT class="font10bold">Function Info:</DT>                                  <div class="method-definition">
192                  <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the width</DD>                                                                                          <span class="method-result">string</span>
193          </DL>                                                                                  <a href="#get_javascript" title="details" class="method-name">get_javascript</a>
194  </DIV>                                                                                  ()
195  <BR>                                                                          </div>
196  <DIV CLASS="function">                                                                  
197  <A NAME='methodset_align'><!-- --></A>                                  <div class="method-definition">
198  <SPAN CLASS="font12bold">set_align</SPAN> (line <span class="linenumber">135</span>)                                                                                          <span class="method-result">string</span>
199  <BR>                                                                                  <a href="#get_title" title="details" class="method-name">get_title</a>
200  <SPAN CLASS="font10bold">Usage : </SPAN>                                                                                  ()
201  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;                                                                          </div>
202  <span class="font10bold" style="color: #0000FF">set_align(                                                                  
203  string                                  <div class="method-definition">
204  $align)</SPAN>                                                                                          <span class="method-result">string</span>
205  <BR>                                                                                  <a href="#get_width" title="details" class="method-name">get_width</a>
206                                                                                    ()
207  <BR>                                                                          </div>
208  <SPAN CLASS="font10bold">Description : </SPAN>                                                                  
209  This function sets the align attribute  for the outer table.                                  <div class="method-definition">
210  <br />                                                                                          <span class="method-result">void</span>
211                                                                                    <a href="#set_align" title="details" class="method-name">set_align</a>
212  <DL>                                                                                          (<span class="var-type">string</span>&nbsp;<span class="var-name">$align</span>)
213          <DT class="font10bold">Function Parameters:</DT>                                                                          </div>
214                  <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$align</SPAN></SPAN> - $align - the align value</DD>                                                                  
215                                            <div class="method-definition">
216          <DT class="font10bold">Function Info:</DT>                                                                                          <span class="method-result">void</span>
217          </DL>                                                                                  <a href="#set_title" title="details" class="method-name">set_title</a>
218  </DIV>                                                                                          (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>)
219  <BR>                                                                          </div>
220  <DIV CLASS="function">                                                                  
221  <A NAME='methodset_title'><!-- --></A>                                  <div class="method-definition">
222  <SPAN CLASS="font12bold">set_title</SPAN> (line <span class="linenumber">92</span>)                                                                                          <span class="method-result">void</span>
223  <BR>                                                                                  <a href="#set_width" title="details" class="method-name">set_width</a>
224  <SPAN CLASS="font10bold">Usage : </SPAN>                                                                                          (<span class="var-type">string</span>&nbsp;<span class="var-name">$width</span>)
225  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;                                                                          </div>
226  <span class="font10bold" style="color: #0000FF">set_title(                                                          </div>
227  string                  </div>
228  $title)</SPAN>          </div>          
229  <BR>  
230            <a name="sec-vars"></a>
231  <BR>          <div class="info-box">
232  <SPAN CLASS="font10bold">Description : </SPAN>                  <div class="info-box-title">Variables</div>
233  Set the title for the widget.                  <div class="nav-bar">
234  <br />                          <a href="#sec-description">Description</a> |
235  <p>this is just a generic title string  that can be used however the child class  wants to use it.</p>                                                          <a href="#sec-descendents">Descendents</a> |
236  <DL>                                                                                  <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
237          <DT class="font10bold">Function Parameters:</DT>                                                  
238                  <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$title</SPAN></SPAN> - $title</DD>                          
239                                                                    |
240          <DT class="font10bold">Function Info:</DT>                                                                          <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
241          </DL>                                                          
242  </DIV>                                          </div>
243  <BR>                  <div class="info-box-body">
244  <DIV CLASS="function">                          <a name="var$title" id="$title"><!-- --></A>
245  <A NAME='methodset_width'><!-- --></A>  <div class="evenrow">
246  <SPAN CLASS="font12bold">set_width</SPAN> (line <span class="linenumber">115</span>)  
247  <BR>          <div class="var-header">
248  <SPAN CLASS="font10bold">Usage : </SPAN>                  <span class="var-title">
249  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;                          <span class="var-type">string</span>
250  <span class="font10bold" style="color: #0000FF">set_width(                          <span class="var-name">$title</span>
251  string                           = <span class="var-default">''</span>                  (line <span class="line-number">35</span>)
252  $width)</SPAN>                  </span>
253  <BR>          </div>
254    
255  <BR>          <!-- ========== Info from phpDoc block ========= -->
256  <SPAN CLASS="font10bold">Description : </SPAN>  <p class="short-description">The title of the table.</p>
257  Set the width for the widget.          <ul class="tags">
258  <br />                                  <li><span class="field">access:</span> public</li>
259  <p>this is meant to be the overall  width expected to be used to  control the generated html.</p>                          </ul>
260  <DL>          
261          <DT class="font10bold">Function Parameters:</DT>          
262                  <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$width</SPAN></SPAN> - $width (ie. 80, 100%)</DD>                  
263                            
264          <DT class="font10bold">Function Info:</DT>  
265          </DL>  </div>
266  </DIV>  <a name="var$width" id="$width"><!-- --></A>
267  <BR>  <div class="oddrow">
268          <div id="credit">  
269                  <hr>          <div class="var-header">
270                  Documention generated on Thu, 20 Feb 2003 16:22:32 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a>                  <span class="var-title">
271                            <span class="var-type">string</span>
272                            <span class="var-name">$width</span>
273                             = <span class="var-default">&quot;100%&quot;</span>                    (line <span class="line-number">42</span>)
274                    </span>
275            </div>
276    
277            <!-- ========== Info from phpDoc block ========= -->
278    <p class="short-description">the width of the widget</p>
279            <ul class="tags">
280                                    <li><span class="field">access:</span> public</li>
281                            </ul>
282            
283            
284                    
285                    
286    
287    </div>
288                                                            <h4>Inherited Variables</h4>
289                                    <A NAME='inherited_vars'><!-- --></A>
290                                                                            <p>Inherited from <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p>
291                                            <blockquote>
292                                                                                                            <span class="var-title">
293                                                                    <span class="var-name"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></span><br>
294                                                            </span>
295                                                                                            </blockquote>
296                                                                                    
297                    </div>
298            </div>
299            
300            <a name="sec-methods"></a>
301            <div class="info-box">
302                    <div class="info-box-title">Methods</div>
303                    <div class="nav-bar">
304                            <a href="#sec-description">Description</a> |
305                                                            <a href="#sec-descendents">Descendents</a> |
306                                                                                                                            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
307                                                                                                                    <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
308                                                    
309                    </div>
310                    <div class="info-box-body">
311                            <A NAME='method_detail'></A>
312    <a name="methodget_align" id="get_align"><!-- --></a>
313    <div class="evenrow">
314            
315            <div class="method-header">
316                    <span class="method-title">get_align</span> (line <span class="line-number">145</span>)
317            </div>
318            
319            <!-- ========== Info from phpDoc block ========= -->
320    <p class="short-description">This gets the alignment value  for the outer table</p>
321            <ul class="tags">
322                                    <li><span class="field">return:</span> <p>- the alignment</p></li>
323                            </ul>
324            
325            <div class="method-signature">
326                    <span class="method-result">string</span>
327                    <span class="method-name">
328                            get_align
329                    </span>
330                                    ()
331                            </div>
332            
333                    
334                    
335            </div>
336    <a name="methodget_css" id="get_css"><!-- --></a>
337    <div class="oddrow">
338            
339            <div class="method-header">
340                    <span class="method-title">get_css</span> (line <span class="line-number">80</span>)
341            </div>
342            
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            <ul class="tags">
346                                    <li><span class="field">return:</span> <p>the raw css</p></li>
347                            </ul>
348            
349            <div class="method-signature">
350                    <span class="method-result">string</span>
351                    <span class="method-name">
352                            get_css
353                    </span>
354                                    ()
355                            </div>
356            
357                    
358                    
359            </div>
360    <a name="methodget_javascript" id="get_javascript"><!-- --></a>
361    <div class="evenrow">
362            
363            <div class="method-header">
364                    <span class="method-title">get_javascript</span> (line <span class="line-number">69</span>)
365            </div>
366            
367            <!-- ========== Info from phpDoc block ========= -->
368    <p class="short-description">Function for returning the raw javascript  that is required for this widget.</p>
369            <ul class="tags">
370                                    <li><span class="field">return:</span> <p>- the raw javascript</p></li>
371                            </ul>
372            
373            <div class="method-signature">
374                    <span class="method-result">string</span>
375                    <span class="method-name">
376                            get_javascript
377                    </span>
378                                    ()
379                            </div>
380            
381                    
382                    
383                            <hr class="separator" />
384                    <div class="notes">Redefined in descendants as:</div>
385                    <ul class="redefinitions">
386                                            <li>
387                                    <a href="../phpHtmlLib/ActiveTab.html#methodget_javascript">ActiveTab::get_javascript()</a>
388                                                                    : This function MUST be called AFTER ALL content  has been added, in order for the js to work properly
389                                                            </li>
390                                    </ul>
391          </div>          </div>
392  </body>  <a name="methodget_title" id="get_title"><!-- --></a>
393    <div class="oddrow">
394            
395            <div class="method-header">
396                    <span class="method-title">get_title</span> (line <span class="line-number">102</span>)
397            </div>
398            
399            <!-- ========== Info from phpDoc block ========= -->
400    <p class="short-description">Function for accessing the  title of this widget</p>
401            <ul class="tags">
402                                    <li><span class="field">return:</span> <p>- the title</p></li>
403                            </ul>
404            
405            <div class="method-signature">
406                    <span class="method-result">string</span>
407                    <span class="method-name">
408                            get_title
409                    </span>
410                                    ()
411                            </div>
412            
413                    
414                    
415            </div>
416    <a name="methodget_width" id="get_width"><!-- --></a>
417    <div class="evenrow">
418            
419            <div class="method-header">
420                    <span class="method-title">get_width</span> (line <span class="line-number">125</span>)
421            </div>
422            
423            <!-- ========== Info from phpDoc block ========= -->
424    <p class="short-description">Function for getting the current  widget width setting.</p>
425            <ul class="tags">
426                                    <li><span class="field">return:</span> <p>- the width</p></li>
427                            </ul>
428            
429            <div class="method-signature">
430                    <span class="method-result">string</span>
431                    <span class="method-name">
432                            get_width
433                    </span>
434                                    ()
435                            </div>
436            
437                    
438                    
439            </div>
440    <a name="methodset_align" id="set_align"><!-- --></a>
441    <div class="oddrow">
442            
443            <div class="method-header">
444                    <span class="method-title">set_align</span> (line <span class="line-number">135</span>)
445            </div>
446            
447            <!-- ========== Info from phpDoc block ========= -->
448    <p class="short-description">This function sets the align attribute  for the outer table.</p>
449            
450            <div class="method-signature">
451                    <span class="method-result">void</span>
452                    <span class="method-name">
453                            set_align
454                    </span>
455                                            (<span class="var-type">string</span>&nbsp;<span class="var-name">$align</span>)
456                            </div>
457            
458                            <ul class="parameters">
459                                            <li>
460                                    <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                                    </ul>
463                    
464                    
465                            <hr class="separator" />
466                    <div class="notes">Redefined in descendants as:</div>
467                    <ul class="redefinitions">
468                                            <li>
469                                    <a href="../phpHtmlLib/DefaultGUIDatalist.html#methodset_align">DefaultGUIDatalist::set_align()</a>
470                                                                    : this function is used to set the overall alignment  of the widget
471                                                            </li>
472                                            <li>
473                                    <a href="../phpHtmlLib/ListAction.html#methodset_align">ListAction::set_align()</a>
474                                                                    : 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>  </html>
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.3
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed