| 1 | jonen | 1.1 | <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'> | 
| 2 |  |  | <!--NewPage--> | 
| 3 |  |  | <HTML> | 
| 4 |  |  | <HEAD> | 
| 5 |  |  | <!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:29 -0800' --> | 
| 6 |  |  | <TITLE>Docs For Class ContainerWidget</TITLE> | 
| 7 |  |  | <LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'> | 
| 8 |  |  | </HEAD> | 
| 9 |  |  | <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> | 
| 10 |  |  |  | 
| 11 |  |  |  | 
| 12 |  |  | <!-- Links --> | 
| 13 |  |  | <a NAME="top"></A> | 
| 14 |  |  | <table WIDTH="100%" class="links"> | 
| 15 |  |  | <TR> | 
| 16 |  |  | <TD class="font10"> | 
| 17 |  |  | Links: | 
| 18 |  |  | <A HREF="#children_summary" class="links" title="Classes extended from ContainerWidget">Child Classes</A> | 
| 19 |  |  | <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A> | 
| 20 |  |  | <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A> | 
| 21 |  |  | <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inerited Methods</A> | 
| 22 |  |  | <A HREF="#functions_summary" class="links" title="Method Summary">Methods</A> | 
| 23 |  |  | <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A> | 
| 24 |  |  | <A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A> | 
| 25 |  |  | </TD> | 
| 26 |  |  | </TR> | 
| 27 |  |  | </TABLE> | 
| 28 |  |  | <BR> | 
| 29 |  |  |  | 
| 30 |  |  | <!-- Start of Class Data --> | 
| 31 |  |  | <H2> | 
| 32 |  |  | Class ContainerWidget | 
| 33 |  |  | </H2> | 
| 34 |  |  |  | 
| 35 |  |  | <pre> | 
| 36 |  |  | <pre><a href="../phpHtmlLib/Container.html">Container</a> | 
| 37 |  |  | | | 
| 38 |  |  | --ContainerWidget</pre> | 
| 39 |  |  | </pre> | 
| 40 |  |  |  | 
| 41 |  |  | <A NAME="children_summary"</A> | 
| 42 |  |  | <H3> | 
| 43 |  |  | Classes extended from ContainerWidget: <A HREF="#top" CLASS="links">^TOP</A> | 
| 44 |  |  | </H3> | 
| 45 |  |  |  | 
| 46 |  |  | <p> | 
| 47 |  |  | <b><i>Located in File: Program_Root/widgets/ContainerWidget.inc</i></b><br> | 
| 48 |  |  | </p> | 
| 49 |  |  | <hr> | 
| 50 |  |  | <!-- ========== Info from phpDoc block ========= --> | 
| 51 |  |  | This is just to maintain | 
| 52 |  |  | <BR> | 
| 53 |  |  | compatibility with the | 
| 54 |  |  | 1.1.0 release of phphtmllib | 
| 55 |  |  |  | 
| 56 |  |  | <UL> | 
| 57 |  |  |  | 
| 58 |  |  | <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI> | 
| 59 |  |  |  | 
| 60 |  |  | <LI><b>Deprecated</b> - <CODE></CODE></LI> | 
| 61 |  |  |  | 
| 62 |  |  | <LI><b>Author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></CODE></LI> | 
| 63 |  |  |  | 
| 64 |  |  | </UL> | 
| 65 |  |  |  | 
| 66 |  |  | <hr> | 
| 67 |  |  | <!-- =========== VAR SUMMARY =========== --> | 
| 68 |  |  | <A NAME='var_summary'><!-- --></A> | 
| 69 |  |  | <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> | 
| 70 |  |  | <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> | 
| 71 |  |  | <TD> | 
| 72 |  |  | <span CLASS="font12bold">Class Variable Summary</span> | 
| 73 |  |  | <A HREF="#top" CLASS="links">^TOP</A> | 
| 74 |  |  | </TD> | 
| 75 |  |  | </TR> | 
| 76 |  |  |  | 
| 77 |  |  |  | 
| 78 |  |  | </TABLE> | 
| 79 |  |  |  | 
| 80 |  |  | <hr> | 
| 81 |  |  | <!-- =========== VAR INHERITED SUMMARY =========== --> | 
| 82 |  |  | <A NAME='var_inherited_summary'><!-- --></A> | 
| 83 |  |  | <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> | 
| 84 |  |  | <TR CLASS='TableHeadingColor'> | 
| 85 |  |  | <TD> | 
| 86 |  |  | <span CLASS="font12bold">Inherited Class Variable Summary</span> | 
| 87 |  |  | <A HREF="#top" CLASS="links">^TOP</A> | 
| 88 |  |  | </TD> | 
| 89 |  |  | </TR> | 
| 90 |  |  |  | 
| 91 |  |  |  | 
| 92 |  |  | <!-- =========== Summary =========== --> | 
| 93 |  |  | <TR BGCOLOR='white'> | 
| 94 |  |  | <TD> | 
| 95 |  |  | <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> | 
| 96 |  |  | <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> | 
| 97 |  |  | <tr CLASS="tableheadingcolor"> | 
| 98 |  |  | <th>Variable</th> | 
| 99 |  |  | <th>Default Value</th> | 
| 100 |  |  | <th>Description</th> | 
| 101 |  |  | </tr> | 
| 102 |  |  |  | 
| 103 |  |  | <tr> | 
| 104 |  |  | <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$indent_flag'>$indent_flag</A></td> | 
| 105 |  |  | <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td> | 
| 106 |  |  | <td CLASS="font10">Flag for pretty (indented) output</td> | 
| 107 |  |  | </tr> | 
| 108 |  |  |  | 
| 109 |  |  | <tr> | 
| 110 |  |  | <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></td> | 
| 111 |  |  | <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td> | 
| 112 |  |  | <td CLASS="font10">Do we render a newline after the | 
| 113 |  |  | contents has been rendered?</td> | 
| 114 |  |  | </tr> | 
| 115 |  |  |  | 
| 116 |  |  | </table> | 
| 117 |  |  | <BR> | 
| 118 |  |  | </TD> | 
| 119 |  |  | </TR> | 
| 120 |  |  |  | 
| 121 |  |  | </TABLE> | 
| 122 |  |  |  | 
| 123 |  |  | <hr> | 
| 124 |  |  | <!-- =========== INHERITED METHOD SUMMARY =========== --> | 
| 125 |  |  | <A NAME='functions_inherited'><!-- --></A> | 
| 126 |  |  | <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> | 
| 127 |  |  | <TR CLASS='TableHeadingColor'> | 
| 128 |  |  | <TD> | 
| 129 |  |  | <span CLASS="font12bold">Inherited Method Summary</span> | 
| 130 |  |  | <A HREF="#top" CLASS="links">^TOP</A> | 
| 131 |  |  | </TD> | 
| 132 |  |  | </TR> | 
| 133 |  |  |  | 
| 134 |  |  |  | 
| 135 |  |  | <!-- =========== Summary =========== --> | 
| 136 |  |  | <TR BGCOLOR='white' CLASS='TableRowColor'> | 
| 137 |  |  | <TD> | 
| 138 |  |  | <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> | 
| 139 |  |  | <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> | 
| 140 |  |  | <tr CLASS="tableheadingcolor"> | 
| 141 |  |  | <th>Function</th> | 
| 142 |  |  | <th>Description</th> | 
| 143 |  |  | </tr> | 
| 144 |  |  |  | 
| 145 |  |  | <tr> | 
| 146 |  |  | <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#constructor Container'>constructor Container (  )</A></td> | 
| 147 |  |  | <td CLASS="font10">The constructor.</td> | 
| 148 |  |  |  | 
| 149 |  |  | <tr> | 
| 150 |  |  | <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add'>add (  )</A></td> | 
| 151 |  |  | <td CLASS="font10">add content onto content stack</td> | 
| 152 |  |  |  | 
| 153 |  |  | <tr> | 
| 154 |  |  | <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add_reference'>add_reference ( &$content )</A></td> | 
| 155 |  |  | <td CLASS="font10">Add content onto content stack | 
| 156 |  |  | so you can change the item later.</td> | 
| 157 |  |  |  | 
| 158 |  |  | <tr> | 
| 159 |  |  | <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#count_content'>count_content (  )</A></td> | 
| 160 |  |  | <td CLASS="font10">counts the number of content objects</td> | 
| 161 |  |  |  | 
| 162 |  |  | <tr> | 
| 163 |  |  | <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#get_indent_flag'>get_indent_flag (  )</A></td> | 
| 164 |  |  | <td CLASS="font10">This flag gets the current value | 
| 165 |  |  | of the indent flag</td> | 
| 166 |  |  |  | 
| 167 |  |  | <tr> | 
| 168 |  |  | <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push'>push (  )</A></td> | 
| 169 |  |  | <td CLASS="font10">Same as add().</td> | 
| 170 |  |  |  | 
| 171 |  |  | <tr> | 
| 172 |  |  | <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push_reference'>push_reference ( &$content )</A></td> | 
| 173 |  |  | <td CLASS="font10">Same as add_reference | 
| 174 |  |  | NOTE : only exists for compatibility with 1.1.x</td> | 
| 175 |  |  |  | 
| 176 |  |  | <tr> | 
| 177 |  |  | <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#render'>render ( [$indent_level = 1], [$output_debug = 0] )</A></td> | 
| 178 |  |  | <td CLASS="font10">This function is compatible with the | 
| 179 |  |  | rest of the phpHtmllib API spec.</td> | 
| 180 |  |  |  | 
| 181 |  |  | <tr> | 
| 182 |  |  | <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#reset_content'>reset_content (  )</A></td> | 
| 183 |  |  | <td CLASS="font10">destroy existing content and start with new content.</td> | 
| 184 |  |  |  | 
| 185 |  |  | <tr> | 
| 186 |  |  | <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td> | 
| 187 |  |  | <td CLASS="font10">This function turns on the collapse flag</td> | 
| 188 |  |  |  | 
| 189 |  |  | <tr> | 
| 190 |  |  | <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_indent_flag'>set_indent_flag ( $flag )</A></td> | 
| 191 |  |  | <td CLASS="font10">function to set the indent flag</td> | 
| 192 |  |  |  | 
| 193 |  |  | </table> | 
| 194 |  |  | <br> | 
| 195 |  |  | </TD> | 
| 196 |  |  | </TR> | 
| 197 |  |  |  | 
| 198 |  |  | </TABLE> | 
| 199 |  |  |  | 
| 200 |  |  | <hr> | 
| 201 |  |  | <!-- should have constructor at some point --> | 
| 202 |  |  | <!-- =========== Method SUMMARY =========== --> | 
| 203 |  |  | <A NAME='Method_summary'><!-- --></A> | 
| 204 |  |  | <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> | 
| 205 |  |  | <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> | 
| 206 |  |  | <TD> | 
| 207 |  |  | <span class="font12bold">Method Summary</span> | 
| 208 |  |  | <A HREF="#top" CLASS="links">^TOP</A> | 
| 209 |  |  | </TD> | 
| 210 |  |  | </TR> | 
| 211 |  |  |  | 
| 212 |  |  |  | 
| 213 |  |  | </TABLE> | 
| 214 |  |  |  | 
| 215 |  |  | <hr> | 
| 216 |  |  | <!-- ============ VARIABLE DETAIL =========== --> | 
| 217 |  |  |  | 
| 218 |  |  | <A NAME='variable_detail'></A> | 
| 219 |  |  | <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> | 
| 220 |  |  | <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> | 
| 221 |  |  | <TD> | 
| 222 |  |  | <span CLASS="font12bold">Variable Detail</span> | 
| 223 |  |  | <A HREF="#top" CLASS="links">^TOP</A> | 
| 224 |  |  | </TD> | 
| 225 |  |  | </TR> | 
| 226 |  |  | </TABLE> | 
| 227 |  |  |  | 
| 228 |  |  |  | 
| 229 |  |  |  | 
| 230 |  |  | <hr> | 
| 231 |  |  | <!-- ============ FUNCTION DETAIL =========== --> | 
| 232 |  |  |  | 
| 233 |  |  | <A NAME='function_detail'></A> | 
| 234 |  |  | <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> | 
| 235 |  |  | <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> | 
| 236 |  |  | <TD> | 
| 237 |  |  | <span class="font12bold">Method Detail</span> | 
| 238 |  |  | <A HREF="#top" CLASS="links">^TOP</A> | 
| 239 |  |  | </TD> | 
| 240 |  |  | </TR> | 
| 241 |  |  | </TABLE> | 
| 242 |  |  | <BR> | 
| 243 |  |  |  | 
| 244 |  |  |  | 
| 245 |  |  | <hr> | 
| 246 |  |  | </HTML> |