/[cvs]/nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/TextNav.html
ViewVC logotype

Diff of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/TextNav.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.3 by jonen, Sat Sep 20 00:24:04 2003 UTC revision 1.4 by jonen, Thu May 6 16:24:24 2004 UTC
# Line 1  Line 1 
1  <?xml version="1.0" encoding="iso-8859-1"?>  <?xml version="1.0" encoding="iso-8859-1"?>
2  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3    <html xmlns="http://www.w3.org/1999/xhtml">    <html xmlns="http://www.w3.org/1999/xhtml">
4                  <head>                  <head>
5                          <!-- template designed by Marco Von Ballmoos -->                          <!-- template designed by Marco Von Ballmoos -->
6                          <title>Docs For Class TextNav</title>                          <title>Docs For Class TextNav</title>
7                          <link rel="stylesheet" href="../media/stylesheet.css" />                          <link rel="stylesheet" href="../media/stylesheet.css" />
8                          <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>                          <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9                  </head>                  </head>
10                  <body>                  <body>
11                          <div class="page-body">                                          <div class="page-body">                
12  <h2 class="class-name">Class TextNav</h2>  <h2 class="class-name">Class TextNav</h2>
13    
14  <a name="sec-description"></a>  <a name="sec-description"></a>
15  <div class="info-box">  <div class="info-box">
16          <div class="info-box-title">Description</div>          <div class="info-box-title">Description</div>
17          <div class="nav-bar">          <div class="nav-bar">
18                                          <span class="disabled">Description</span> |                                          <span class="disabled">Description</span> |
19                                                                                                          <a href="#sec-vars">Vars</a>                                                                                                          <a href="#sec-vars">Vars</a>
20                                                  |                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)                                                  |                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
21                                                                                                    
22                          </div>                                          </div>
23          <div class="info-box-body">          <div class="info-box-body">
24                  <!-- ========== Info from phpDoc block ========= -->                          <!-- ========== Info from phpDoc block ========= -->
25  <p class="short-description">This class builds a simple text navigational  widget.</p>  <p class="short-description">This class builds a simple text navigational  widget.</p>
26          <ul class="tags">          <ul class="tags">
27                                  <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>                                  <li><span class="field">author:</span> Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</li>
28                          </ul>                          </ul>
29                  <p class="notes">                  <p class="notes">
30                          Located in <a class="field" href="_widgets_TextNav_inc.html">Program_Root/widgets/TextNav.inc</a> (line <span class="field">24</span>)                          Located in <a class="field" href="_widgets_TextNav_inc.html">/widgets/TextNav.inc</a> (line <span class="field">24</span>)
31                  </p>                  </p>
32                                    
33                                                            
34                  <pre><a href="../phpHtmlLib/Container.html">Container</a>                  <pre><a href="../phpHtmlLib/Container.html">Container</a>
35     |     |
36     --<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a>     --<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a>
37        |        |
       --TextNav</pre>  
           
                         </div>  
 </div>  
   
   
   
         <a name="sec-method-summary"></a>  
         <div class="info-box">  
                 <div class="info-box-title">Method Summary</span></div>  
                 <div class="nav-bar">  
                         <a href="#sec-description">Description</a> |  
                                                                                                                         <a href="#sec-vars">Vars</a>  
                                   
                                 |  
                                                 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)  
                 </div>  
                 <div class="info-box-body">                      
                         <div class="method-summary">  
                                                                   
                                 <div class="method-definition">  
                                                                                         <span class="method-result">void</span>  
                                                                                 <a href="#TextNav" title="details" class="method-name">TextNav</a>  
                                                                                         ([<span class="var-type">int</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">760</span>])  
                                                                         </div>  
                                                                   
                                 <div class="method-definition">  
                                                                                         <span class="method-result">void</span>  
                                                                                 <a href="#add" title="details" class="method-name">add</a>  
                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">100</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$target</span> = <span class="var-default">NULL</span>])  
                                                                         </div>  
                                                                   
                                 <div class="method-definition">  
                                                                                         <span class="method-result">void</span>  
                                                                                 <a href="#add_blank" title="details" class="method-name">add_blank</a>  
                                                                                         ([<span class="var-type">int</span>&nbsp;<span class="var-name">$num</span> = <span class="var-default">1</span>])  
                                                                         </div>  
                                                                   
                                 <div class="method-definition">  
                                                                                         <span class="method-result">void</span>  
                                                                                 <a href="#add_text" title="details" class="method-name">add_text</a>  
                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>)  
                                                                         </div>  
                                                                   
                                 <div class="method-definition">  
                                                                                         <span class="method-result">void</span>  
                                                                                 <a href="#build_img_td" title="details" class="method-name">build_img_td</a>  
                                                                                 ()  
                                                                         </div>  
                                                                   
                                 <div class="method-definition">  
                                                                                         <span class="method-result">void</span>  
                                                                                 <a href="#build_nav_td" title="details" class="method-name">build_nav_td</a>  
                                                                                         (<span class="var-type">array</span>&nbsp;<span class="var-name">$nav</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$count</span>)  
                                                                         </div>  
                                                                   
                                 <div class="method-definition">  
                                                                                         <span class="method-result">void</span>  
                                                                                 <a href="#push" title="details" class="method-name">push</a>  
                                                                                         (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">100</span>])  
                                                                         </div>  
                                                                   
                                 <div class="method-definition">  
                                                                                         <span class="method-result">void</span>  
                                                                                 <a href="#push_blank" title="details" class="method-name">push_blank</a>  
                                                                                         ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$num</span> = <span class="var-default">1</span>])  
                                                                         </div>  
                                                                   
                                 <div class="method-definition">  
                                                                                         <span class="method-result">void</span>  
                                                                                 <a href="#push_text" title="details" class="method-name">push_text</a>  
                                                                                         (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$text</span>)  
                                                                         </div>  
                                                                   
                                 <div class="method-definition">  
                                                                                         <span class="method-result">string</span>  
                                                                                 <a href="#render" title="details" class="method-name">render</a>  
                                                                                         ([<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$output_debug</span>)  
                                                                         </div>  
                                                         </div>  
                 </div>  
         </div>            
   
         <a name="sec-vars"></a>  
         <div class="info-box">  
                 <div class="info-box-title">Variables</div>  
                 <div class="nav-bar">  
                         <a href="#sec-description">Description</a> |  
                                                                                 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)  
                                                   
                           
                                                         |  
                                                                         <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)  
                                                           
                                         </div>  
                 <div class="info-box-body">  
                                                                                 <h4>Inherited Variables</h4>  
                                 <A NAME='inherited_vars'><!-- --></A>  
                                                                         <p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>  
                                         <blockquote>  
                                                                                                         <span class="var-title">  
                                                                 <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br>  
                                                         </span>  
                                                                                                         <span class="var-title">  
                                                                 <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br>  
                                                         </span>  
                                                                                         </blockquote>  
                                                                         <p>Inherited from <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p>  
                                         <blockquote>  
                                                                                                         <span class="var-title">  
                                                                 <span class="var-name"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></span><br>  
                                                         </span>  
                                                                                         </blockquote>  
                                                                                   
                 </div>  
         </div>  
           
         <a name="sec-methods"></a>  
         <div class="info-box">  
                 <div class="info-box-title">Methods</div>  
                 <div class="nav-bar">  
                         <a href="#sec-description">Description</a> |  
                                                                                                                         <a href="#sec-vars">Vars</a>  
                                                                                                                 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)  
                                                   
                 </div>  
                 <div class="info-box-body">  
                         <A NAME='method_detail'></A>  
 <a name="methodTextNav" id="TextNav"><!-- --></a>  
 <div class="evenrow">  
           
         <div class="method-header">  
                 <span class="method-title">Constructor TextNav</span> (line <span class="line-number">34</span>)  
         </div>  
           
         <!-- ========== Info from phpDoc block ========= -->  
 <p class="short-description">Constructor for this class  It just sets the width for the  widget.</p>  
           
         <div class="method-signature">  
                 <span class="method-result">void</span>  
                 <span class="method-name">  
                         TextNav  
                 </span>  
                                         ([<span class="var-type">int</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">760</span>])  
                         </div>  
           
                         <ul class="parameters">  
                                         <li>  
                                 <span class="var-type">int</span>  
                                 <span class="var-name">$width</span><span class="var-description">: <p>- the width of the widget</p></span>                     </li>  
                                 </ul>  
                   
                   
         </div>  
 <a name="methodadd" id="add"><!-- --></a>  
 <div class="oddrow">  
           
         <div class="method-header">  
                 <span class="method-title">add</span> (line <span class="line-number">86</span>)  
         </div>  
           
         <!-- ========== Info from phpDoc block ========= -->  
 <p class="short-description">this function adds a clickable link.</p>  
 <p class="description"><p>It automatically adds the link based on $url,  with $text as the viewable text.</p></p>  
           
         <div class="method-signature">  
                 <span class="method-result">void</span>  
                 <span class="method-name">  
                         add  
                 </span>  
                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">100</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$target</span> = <span class="var-default">NULL</span>])  
                         </div>  
           
                         <ul class="parameters">  
                                         <li>  
                                 <span class="var-type">string</span>  
                                 <span class="var-name">$url</span><span class="var-description">: <p>- the url for the link</p></span>                  </li>  
                                         <li>  
                                 <span class="var-type">string</span>  
                                 <span class="var-name">$text</span><span class="var-description">: <p>- the link text</p></span>                        </li>  
                                         <li>  
                                 <span class="var-type">string</span>  
                                 <span class="var-name">$width</span><span class="var-description">: <p>- the width of the cell</p></span>                       </li>  
                                         <li>  
                                 <span class="var-type">string</span>  
                                 <span class="var-name">$target</span><span class="var-description">: <p>- the target for the url</p></span>                     </li>  
                                 </ul>  
                   
                         <hr class="separator" />  
                 <div class="notes">Redefinition of:</div>  
                 <dl>  
                         <dt><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></dt>  
                                                 <dd>add content onto content stack</dd>  
                                         </dl>  
                   
         </div>  
 <a name="methodadd_blank" id="add_blank"><!-- --></a>  
 <div class="evenrow">  
           
         <div class="method-header">  
                 <span class="method-title">add_blank</span> (line <span class="line-number">107</span>)  
         </div>  
           
         <!-- ========== Info from phpDoc block ========= -->  
 <p class="short-description">This lets you add a blank entry  between 2 links</p>  
           
         <div class="method-signature">  
                 <span class="method-result">void</span>  
                 <span class="method-name">  
                         add_blank  
                 </span>  
                                         ([<span class="var-type">int</span>&nbsp;<span class="var-name">$num</span> = <span class="var-default">1</span>])  
                         </div>  
           
                         <ul class="parameters">  
                                         <li>  
                                 <span class="var-type">int</span>  
                                 <span class="var-name">$num</span><span class="var-description">: <p>- the # of blank lines to insert</p></span>                        </li>  
                                 </ul>  
                   
                   
         </div>  
 <a name="methodadd_text" id="add_text"><!-- --></a>  
 <div class="oddrow">  
           
         <div class="method-header">  
                 <span class="method-title">add_text</span> (line <span class="line-number">126</span>)  
         </div>  
           
         <!-- ========== Info from phpDoc block ========= -->  
 <p class="short-description">this adds a text item in the nav</p>  
           
         <div class="method-signature">  
                 <span class="method-result">void</span>  
                 <span class="method-name">  
                         add_text  
                 </span>  
                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>)  
                         </div>  
           
                         <ul class="parameters">  
                                         <li>  
                                 <span class="var-type">string</span>  
                                 <span class="var-name">$text</span><span class="var-description">: <p>- the text to display</p></span>                  </li>  
                                 </ul>  
                   
                   
         </div>  
 <a name="methodbuild_img_td" id="build_img_td"><!-- --></a>  
 <div class="evenrow">  
           
         <div class="method-header">  
                 <span class="method-title">build_img_td</span> (line <span class="line-number">174</span>)  
         </div>  
           
         <!-- ========== Info from phpDoc block ========= -->  
 <p class="short-description">build the image seperator td</p>  
           
         <div class="method-signature">  
                 <span class="method-result">void</span>  
                 <span class="method-name">  
                         build_img_td  
                 </span>  
                                 ()  
                         </div>  
           
                   
                   
         </div>  
 <a name="methodbuild_nav_td" id="build_nav_td"><!-- --></a>  
 <div class="oddrow">  
           
         <div class="method-header">  
                 <span class="method-title">build_nav_td</span> (line <span class="line-number">147</span>)  
         </div>  
           
         <!-- ========== Info from phpDoc block ========= -->  
 <p class="short-description">build a td for the link.</p>  
           
         <div class="method-signature">  
                 <span class="method-result">void</span>  
                 <span class="method-name">  
                         build_nav_td  
                 </span>  
                                         (<span class="var-type">array</span>&nbsp;<span class="var-name">$nav</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$count</span>)  
                         </div>  
           
                         <ul class="parameters">  
                                         <li>  
                                 <span class="var-type">array</span>  
                                 <span class="var-name">$nav</span><span class="var-description">: <p>- the nav array entry</p></span>                   </li>  
                                         <li>  
                                 <span class="var-type">int</span>  
                                 <span class="var-name">$count</span><span class="var-description">: <p>- the column # this entry is</p></span>                  </li>  
                                 </ul>  
                   
                   
         </div>  
 <a name="methodpush" id="push"><!-- --></a>  
 <div class="evenrow">  
           
         <div class="method-header">  
                 <span class="method-title">push</span> (line <span class="line-number">97</span>)  
         </div>  
           
         <!-- ========== Info from phpDoc block ========= -->  
 <p class="short-description">depricated version of add()</p>  
         <ul class="tags">  
                                 <li><span class="field">deprecated:</span> <p>- use add() instead</p></li>  
                         </ul>  
           
         <div class="method-signature">  
                 <span class="method-result">void</span>  
                 <span class="method-name">  
                         push  
                 </span>  
                                         (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">100</span>])  
                         </div>  
           
                   
                         <hr class="separator" />  
                 <div class="notes">Redefinition of:</div>  
                 <dl>  
                         <dt><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></dt>  
                                                 <dd>Same as add().</dd>  
                                         </dl>  
                   
         </div>  
 <a name="methodpush_blank" id="push_blank"><!-- --></a>  
 <div class="oddrow">  
           
         <div class="method-header">  
                 <span class="method-title">push_blank</span> (line <span class="line-number">117</span>)  
         </div>  
           
         <!-- ========== Info from phpDoc block ========= -->  
 <p class="short-description">depricated version of add_blank()</p>  
         <ul class="tags">  
                                 <li><span class="field">deprecated:</span> <p>- use add_blank() instead</p></li>  
                         </ul>  
           
         <div class="method-signature">  
                 <span class="method-result">void</span>  
                 <span class="method-name">  
                         push_blank  
                 </span>  
                                         ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$num</span> = <span class="var-default">1</span>])  
                         </div>  
           
                   
                   
         </div>  
 <a name="methodpush_text" id="push_text"><!-- --></a>  
 <div class="evenrow">  
           
         <div class="method-header">  
                 <span class="method-title">push_text</span> (line <span class="line-number">135</span>)  
         </div>  
           
         <!-- ========== Info from phpDoc block ========= -->  
 <p class="short-description">depricated version of add_text()</p>  
         <ul class="tags">  
                                 <li><span class="field">deprecated:</span> <p>- use add_text() instead</p></li>  
                         </ul>  
           
         <div class="method-signature">  
                 <span class="method-result">void</span>  
                 <span class="method-name">  
                         push_text  
                 </span>  
                                         (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$text</span>)  
                         </div>  
           
                   
                   
         </div>  
 <a name="methodrender" id="render"><!-- --></a>  
 <div class="oddrow">  
           
         <div class="method-header">  
                 <span class="method-title">render</span> (line <span class="line-number">50</span>)  
         </div>  
           
         <!-- ========== Info from phpDoc block ========= -->  
 <p class="short-description">function that will render the widget.</p>  
         <ul class="tags">  
                                 <li><span class="field">return:</span> <p>the raw html output.</p></li>  
                         </ul>  
           
         <div class="method-signature">  
                 <span class="method-result">string</span>  
                 <span class="method-name">  
                         render  
                 </span>  
                                         ([<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$output_debug</span>)  
                         </div>  
           
                         <ul class="parameters">  
                                         <li>  
                                 <span class="var-type">int</span>  
                                 <span class="var-name">$indent_level</span><span class="var-description">: <p>- the indentation level for               the container.</p></span>                       </li>  
                                         <li>  
                                 <span class="var-type">int</span>  
                                 <span class="var-name">$output_debug</span><span class="var-description">: <p>- the output debug flag to               maintain compatibility w/ the API.</p></span>                    </li>  
                                 </ul>  
                   
                         <hr class="separator" />  
                 <div class="notes">Redefinition of:</div>  
                 <dl>  
                         <dt><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt>  
                                                 <dd>This function is compatible with the  rest of the phpHtmllib API spec.</dd>  
                                         </dl>  
                   
         </div>  
                                                         <h4>Inherited Methods</h4>  
                                 <a name='inherited_methods'><!-- --></a>          
                                                                         <!-- =========== Summary =========== -->  
                                         <p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>  
                                         <blockquote>  
                                                                                                         <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br>  
                                                                                                         <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br>  
                                                                                                         <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br>  
                                                                                                         <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br>  
                                                                                                         <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br>  
                                                                                                         <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br>  
                                                                                                         <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br>  
                                                                                                         <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br>  
                                                                                         </blockquote>  
                                                                         <!-- =========== Summary =========== -->  
                                         <p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p>  
                                         <blockquote>  
                                                                                                         <span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br>  
                                                                                                         <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br>  
                                                                                                         <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br>  
                                                                                                         <span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br>  
                                                                                                         <span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br>  
                                                                                                         <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br>  
                                                                                                         <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br>  
                                                                                                         <span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br>  
                                                                                                         <span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br>  
                                                                                                         <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br>  
                                                                                                         <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br>  
                                                                                                         <span class="method-name"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></span><br>  
                                                                                         </blockquote>  
                                                                                   
                 </div>  
         </div>  
           
         <p class="notes" id="credit">  
                 Documention generated on Thu, 31 Jul 2003 18:33:51 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>  
         </p>  
         </div></body>  
 </html>  
38          --TextNav</pre>
39            
40                            </div>
41    </div>
42    
43    
44    
45    
46            <a name="sec-method-summary"></a>
47            <div class="info-box">
48                    <div class="info-box-title">Method Summary</span></div>
49                    <div class="nav-bar">
50                            <a href="#sec-description">Description</a> |
51                                                                                                                                                    <a href="#sec-vars">Vars</a>
52                                    
53                                    |
54                                                    <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
55                    </div>
56                    <div class="info-box-body">                    
57                            <div class="method-summary">
58                                                                    
59                                    <div class="method-definition">
60                                                                                            <span class="method-result">TextNav</span>
61                                                                                    <a href="#TextNav" title="details" class="method-name">TextNav</a>
62                                                                                            ([<span class="var-type">int</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">760</span>])
63                                                                            </div>
64                                                                    
65                                    <div class="method-definition">
66                                                                                            <span class="method-result">void</span>
67                                                                                    <a href="#add" title="details" class="method-name">add</a>
68                                                                                            (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">100</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$target</span> = <span class="var-default">NULL</span>])
69                                                                            </div>
70                                                                    
71                                    <div class="method-definition">
72                                                                                            <span class="method-result">void</span>
73                                                                                    <a href="#add_blank" title="details" class="method-name">add_blank</a>
74                                                                                            ([<span class="var-type">int</span>&nbsp;<span class="var-name">$num</span> = <span class="var-default">1</span>])
75                                                                            </div>
76                                                                    
77                                    <div class="method-definition">
78                                                                                            <span class="method-result">void</span>
79                                                                                    <a href="#add_text" title="details" class="method-name">add_text</a>
80                                                                                            (<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>)
81                                                                            </div>
82                                                                    
83                                    <div class="method-definition">
84                                                                                            <span class="method-result">void</span>
85                                                                                    <a href="#build_img_td" title="details" class="method-name">build_img_td</a>
86                                                                                    ()
87                                                                            </div>
88                                                                    
89                                    <div class="method-definition">
90                                                                                            <span class="method-result">void</span>
91                                                                                    <a href="#build_nav_td" title="details" class="method-name">build_nav_td</a>
92                                                                                            (<span class="var-type">array</span>&nbsp;<span class="var-name">$nav</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$count</span>)
93                                                                            </div>
94                                                                    
95                                    <div class="method-definition">
96                                                                                            <span class="method-result">void</span>
97                                                                                    <a href="#push" title="details" class="method-name">push</a>
98                                                                                            (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">100</span>])
99                                                                            </div>
100                                                                    
101                                    <div class="method-definition">
102                                                                                            <span class="method-result">void</span>
103                                                                                    <a href="#push_blank" title="details" class="method-name">push_blank</a>
104                                                                                            ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$num</span> = <span class="var-default">1</span>])
105                                                                            </div>
106                                                                    
107                                    <div class="method-definition">
108                                                                                            <span class="method-result">void</span>
109                                                                                    <a href="#push_text" title="details" class="method-name">push_text</a>
110                                                                                            (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$text</span>)
111                                                                            </div>
112                                                                    
113                                    <div class="method-definition">
114                                                                                            <span class="method-result">string</span>
115                                                                                    <a href="#render" title="details" class="method-name">render</a>
116                                                                                            ([<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$output_debug</span>)
117                                                                            </div>
118                                                            </div>
119                    </div>
120            </div>          
121    
122            <a name="sec-vars"></a>
123            <div class="info-box">
124                    <div class="info-box-title">Variables</div>
125                    <div class="nav-bar">
126                            <a href="#sec-description">Description</a> |
127                                                                                    <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
128                                                    
129                            
130                                                                                    |
131                                                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
132                                                            
133                                            </div>
134                    <div class="info-box-body">
135                                                                                    <h4>Inherited Variables</h4>
136                                    <A NAME='inherited_vars'><!-- --></A>
137                                                                            <p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>
138                                            <blockquote>
139                                                                                                            <span class="var-title">
140                                                                    <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br>
141                                                            </span>
142                                                                                                            <span class="var-title">
143                                                                    <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br>
144                                                            </span>
145                                                                                            </blockquote>
146                                                                                    
147                    </div>
148            </div>
149            
150            <a name="sec-methods"></a>
151            <div class="info-box">
152                    <div class="info-box-title">Methods</div>
153                    <div class="nav-bar">
154                            <a href="#sec-description">Description</a> |
155                                                                                                                            <a href="#sec-vars">Vars</a>
156                                                                                                                                            <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
157                                                    
158                    </div>
159                    <div class="info-box-body">
160                            <A NAME='method_detail'></A>
161    <a name="methodTextNav" id="TextNav"><!-- --></a>
162    <div class="oddrow">
163            
164            <div class="method-header">
165                    <span class="method-title">Constructor TextNav</span> (line <span class="line-number">34</span>)
166            </div>
167            
168            <!-- ========== Info from phpDoc block ========= -->
169    <p class="short-description">Constructor for this class  It just sets the width for the  widget.</p>
170            
171            <div class="method-signature">
172                    <span class="method-result">TextNav</span>
173                    <span class="method-name">
174                            TextNav
175                    </span>
176                                            ([<span class="var-type">int</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">760</span>])
177                            </div>
178            
179                            <ul class="parameters">
180                                            <li>
181                                    <span class="var-type">int</span>
182                                    <span class="var-name">$width</span><span class="var-description">: - the width of the widget</span>                    </li>
183                                    </ul>
184                    
185                    
186            </div>
187    <a name="methodadd" id="add"><!-- --></a>
188    <div class="evenrow">
189            
190            <div class="method-header">
191                    <span class="method-title">add</span> (line <span class="line-number">86</span>)
192            </div>
193            
194            <!-- ========== Info from phpDoc block ========= -->
195    <p class="short-description">this function adds a clickable link.</p>
196    <p class="description"><p>It automatically adds the link based on $url,  with $text as the viewable text.</p></p>
197            
198            <div class="method-signature">
199                    <span class="method-result">void</span>
200                    <span class="method-name">
201                            add
202                    </span>
203                                            (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">100</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$target</span> = <span class="var-default">NULL</span>])
204                            </div>
205            
206                            <ul class="parameters">
207                                            <li>
208                                    <span class="var-type">string</span>
209                                    <span class="var-name">$url</span><span class="var-description">: - the url for the link</span>                 </li>
210                                            <li>
211                                    <span class="var-type">string</span>
212                                    <span class="var-name">$text</span><span class="var-description">: - the link text</span>                       </li>
213                                            <li>
214                                    <span class="var-type">string</span>
215                                    <span class="var-name">$width</span><span class="var-description">: - the width of the cell</span>                      </li>
216                                            <li>
217                                    <span class="var-type">string</span>
218                                    <span class="var-name">$target</span><span class="var-description">: - the target for the url</span>                    </li>
219                                    </ul>
220                    
221                            <hr class="separator" />
222                    <div class="notes">Redefinition of:</div>
223                    <dl>
224                            <dt><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></dt>
225                                                    <dd>add content onto content stack</dd>
226                                            </dl>
227                    
228            </div>
229    <a name="methodadd_blank" id="add_blank"><!-- --></a>
230    <div class="oddrow">
231            
232            <div class="method-header">
233                    <span class="method-title">add_blank</span> (line <span class="line-number">107</span>)
234            </div>
235            
236            <!-- ========== Info from phpDoc block ========= -->
237    <p class="short-description">This lets you add a blank entry  between 2 links</p>
238            
239            <div class="method-signature">
240                    <span class="method-result">void</span>
241                    <span class="method-name">
242                            add_blank
243                    </span>
244                                            ([<span class="var-type">int</span>&nbsp;<span class="var-name">$num</span> = <span class="var-default">1</span>])
245                            </div>
246            
247                            <ul class="parameters">
248                                            <li>
249                                    <span class="var-type">int</span>
250                                    <span class="var-name">$num</span><span class="var-description">: - the # of blank lines to insert</span>                       </li>
251                                    </ul>
252                    
253                    
254            </div>
255    <a name="methodadd_text" id="add_text"><!-- --></a>
256    <div class="evenrow">
257            
258            <div class="method-header">
259                    <span class="method-title">add_text</span> (line <span class="line-number">126</span>)
260            </div>
261            
262            <!-- ========== Info from phpDoc block ========= -->
263    <p class="short-description">this adds a text item in the nav</p>
264            
265            <div class="method-signature">
266                    <span class="method-result">void</span>
267                    <span class="method-name">
268                            add_text
269                    </span>
270                                            (<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>)
271                            </div>
272            
273                            <ul class="parameters">
274                                            <li>
275                                    <span class="var-type">string</span>
276                                    <span class="var-name">$text</span><span class="var-description">: - the text to display</span>                 </li>
277                                    </ul>
278                    
279                    
280            </div>
281    <a name="methodbuild_img_td" id="build_img_td"><!-- --></a>
282    <div class="oddrow">
283            
284            <div class="method-header">
285                    <span class="method-title">build_img_td</span> (line <span class="line-number">174</span>)
286            </div>
287            
288            <!-- ========== Info from phpDoc block ========= -->
289    <p class="short-description">build the image seperator td</p>
290            
291            <div class="method-signature">
292                    <span class="method-result">void</span>
293                    <span class="method-name">
294                            build_img_td
295                    </span>
296                                    ()
297                            </div>
298            
299                    
300                    
301            </div>
302    <a name="methodbuild_nav_td" id="build_nav_td"><!-- --></a>
303    <div class="evenrow">
304            
305            <div class="method-header">
306                    <span class="method-title">build_nav_td</span> (line <span class="line-number">147</span>)
307            </div>
308            
309            <!-- ========== Info from phpDoc block ========= -->
310    <p class="short-description">build a td for the link.</p>
311            
312            <div class="method-signature">
313                    <span class="method-result">void</span>
314                    <span class="method-name">
315                            build_nav_td
316                    </span>
317                                            (<span class="var-type">array</span>&nbsp;<span class="var-name">$nav</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$count</span>)
318                            </div>
319            
320                            <ul class="parameters">
321                                            <li>
322                                    <span class="var-type">array</span>
323                                    <span class="var-name">$nav</span><span class="var-description">: - the nav array entry</span>                  </li>
324                                            <li>
325                                    <span class="var-type">int</span>
326                                    <span class="var-name">$count</span><span class="var-description">: - the column # this entry is</span>                 </li>
327                                    </ul>
328                    
329                    
330            </div>
331    <a name="methodpush" id="push"><!-- --></a>
332    <div class="oddrow">
333            
334            <div class="method-header">
335                    <span class="method-title">push</span> (line <span class="line-number">97</span>)
336            </div>
337            
338            <!-- ========== Info from phpDoc block ========= -->
339    <p class="short-description">depricated version of add()</p>
340            <ul class="tags">
341                                    <li><span class="field">deprecated:</span> - use add() instead</li>
342                            </ul>
343            
344            <div class="method-signature">
345                    <span class="method-result">void</span>
346                    <span class="method-name">
347                            push
348                    </span>
349                                            (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">100</span>])
350                            </div>
351            
352                    
353                            <hr class="separator" />
354                    <div class="notes">Redefinition of:</div>
355                    <dl>
356                            <dt><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></dt>
357                                                    <dd>Same as add().</dd>
358                                            </dl>
359                    
360            </div>
361    <a name="methodpush_blank" id="push_blank"><!-- --></a>
362    <div class="evenrow">
363            
364            <div class="method-header">
365                    <span class="method-title">push_blank</span> (line <span class="line-number">117</span>)
366            </div>
367            
368            <!-- ========== Info from phpDoc block ========= -->
369    <p class="short-description">depricated version of add_blank()</p>
370            <ul class="tags">
371                                    <li><span class="field">deprecated:</span> - use add_blank() instead</li>
372                            </ul>
373            
374            <div class="method-signature">
375                    <span class="method-result">void</span>
376                    <span class="method-name">
377                            push_blank
378                    </span>
379                                            ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$num</span> = <span class="var-default">1</span>])
380                            </div>
381            
382                    
383                    
384            </div>
385    <a name="methodpush_text" id="push_text"><!-- --></a>
386    <div class="oddrow">
387            
388            <div class="method-header">
389                    <span class="method-title">push_text</span> (line <span class="line-number">135</span>)
390            </div>
391            
392            <!-- ========== Info from phpDoc block ========= -->
393    <p class="short-description">depricated version of add_text()</p>
394            <ul class="tags">
395                                    <li><span class="field">deprecated:</span> - use add_text() instead</li>
396                            </ul>
397            
398            <div class="method-signature">
399                    <span class="method-result">void</span>
400                    <span class="method-name">
401                            push_text
402                    </span>
403                                            (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$text</span>)
404                            </div>
405            
406                    
407                    
408            </div>
409    <a name="methodrender" id="render"><!-- --></a>
410    <div class="evenrow">
411            
412            <div class="method-header">
413                    <span class="method-title">render</span> (line <span class="line-number">50</span>)
414            </div>
415            
416            <!-- ========== Info from phpDoc block ========= -->
417    <p class="short-description">function that will render the widget.</p>
418            <ul class="tags">
419                                    <li><span class="field">return:</span> the raw html output.</li>
420                            </ul>
421            
422            <div class="method-signature">
423                    <span class="method-result">string</span>
424                    <span class="method-name">
425                            render
426                    </span>
427                                            ([<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$output_debug</span>)
428                            </div>
429            
430                            <ul class="parameters">
431                                            <li>
432                                    <span class="var-type">int</span>
433                                    <span class="var-name">$indent_level</span><span class="var-description">: - the indentation level for               the container.</span>                      </li>
434                                            <li>
435                                    <span class="var-type">int</span>
436                                    <span class="var-name">$output_debug</span><span class="var-description">: - the output debug flag to               maintain compatibility w/ the API.</span>                   </li>
437                                    </ul>
438                    
439                            <hr class="separator" />
440                    <div class="notes">Redefinition of:</div>
441                    <dl>
442                            <dt><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt>
443                                                    <dd>This function is compatible with the  rest of the phpHtmllib API spec.</dd>
444                                            </dl>
445                    
446            </div>
447                                                            <h4>Inherited Methods</h4>
448                                    <a name='inherited_methods'><!-- --></a>        
449                                                                            <!-- =========== Summary =========== -->
450                                            <p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>
451                                            <blockquote>
452                                                                                                            <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br>
453                                                                                                            <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br>
454                                                                                                            <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br>
455                                                                                                            <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br>
456                                                                                                            <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br>
457                                                                                                            <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br>
458                                                                                                            <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br>
459                                                                                                            <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br>
460                                                                                            </blockquote>
461                                                                            <!-- =========== Summary =========== -->
462                                            <p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p>
463                                            <blockquote>
464                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br>
465                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br>
466                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br>
467                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br>
468                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_element">Container::get_element()</a></span><br>
469                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br>
470                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br>
471                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br>
472                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br>
473                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br>
474                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br>
475                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br>
476                                                                                            </blockquote>
477                                                                                    
478                    </div>
479            </div>
480    
481    
482            <p class="notes" id="credit">
483                    Documentation generated on Thu,  1 Apr 2004 09:40:10 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
484            </p>
485            </div></body>
486    </html>
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.4
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed