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