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