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

Annotation of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/OPTGROUPtag.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (hide annotations)
Thu Jan 30 03:29:25 2003 UTC (21 years, 6 months ago) by jonen
Branch: MAIN
Branch point for: no_vendor_tag
File MIME type: text/html 
Initial revision
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:27 -0800' -->
6     <TITLE>Docs For Class OPTGROUPtag</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 OPTGROUPtag">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 OPTGROUPtag
33     </H2>
34    
35     <pre>
36     <pre><a href="../phpHtmlLib/Container.html">Container</a>
37     |
38     --<a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a>
39     |
40     --<a href="../phpHtmlLib/HTMLTagClass.html">HTMLTagClass</a>
41     |
42     --OPTGROUPtag</pre>
43     </pre>
44    
45     <A NAME="children_summary"</A>
46     <H3>
47     Classes extended from OPTGROUPtag: <A HREF="#top" CLASS="links">^TOP</A>
48     </H3>
49    
50     <p>
51     <b><i>Located in File: Program_Root/tag_classes/ALLTAGS.inc</i></b><br>
52     </p>
53     <hr>
54     <!-- ========== Info from phpDoc block ========= -->
55     &lt;OPTGROUP&gt; tag class
56     <BR>
57     Defines an option group. This element allows
58     you to group choices. When you have a long list
59     of options, groups of related choices are easier
60     to handle.
61    
62     <UL>
63    
64     <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI>
65    
66     </UL>
67    
68     <hr>
69     <!-- =========== VAR SUMMARY =========== -->
70     <A NAME='var_summary'><!-- --></A>
71     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
72     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
73     <TD>
74     <span CLASS="font12bold">Class Variable Summary</span>
75     <A HREF="#top" CLASS="links">^TOP</A>
76     </TD>
77     </TR>
78    
79    
80     <!-- =========== Summary =========== -->
81     <TR BGCOLOR='white' CLASS='TableRowColor'>
82     <TD>
83     <CODE><B><A HREF='OPTGROUPtag.html#$_tag'>$_tag</A></B></CODE>
84     <BR>
85     <blockquote> </blockquote>
86     <blockquote> Default Value: <CODE>->optgroup<-</CODE> </blockquote>
87     </TD>
88     </TR>
89    
90     </TABLE>
91    
92     <hr>
93     <!-- =========== VAR INHERITED SUMMARY =========== -->
94     <A NAME='var_inherited_summary'><!-- --></A>
95     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
96     <TR CLASS='TableHeadingColor'>
97     <TD>
98     <span CLASS="font12bold">Inherited Class Variable Summary</span>
99     <A HREF="#top" CLASS="links">^TOP</A>
100     </TD>
101     </TR>
102    
103    
104     <!-- =========== Summary =========== -->
105     <TR BGCOLOR='white'>
106     <TD>
107     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/HTMLTagClass.html">HTMLTagClass</a></span>
108     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
109     <tr CLASS="tableheadingcolor">
110     <th>Variable</th>
111     <th>Default Value</th>
112     <th>Description</th>
113     </tr>
114    
115     <tr>
116     <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLTagClass.html#$_depricated'>$_depricated</A></td>
117     <td CLASS="font10" STYLE="white-space: nowrap">->FALSE<-</td>
118     <td CLASS="font10">Flag to denote that this tag is
119     depricated by the HTML standard.</td>
120     </tr>
121    
122     <tr>
123     <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLTagClass.html#$_no_finish_slash_xhtml'>$_no_finish_slash_xhtml</A></td>
124     <td CLASS="font10" STYLE="white-space: nowrap">->FALSE<-</td>
125     <td CLASS="font10">Flag to tell the renderer not to
126     place the /&gt; if we are in xhtml
127     compliant mode.</td>
128     </tr>
129    
130     <tr>
131     <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLTagClass.html#$_xhtml_strict_attributes'>$_xhtml_strict_attributes</A></td>
132     <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
133     <td CLASS="font10">The list of attributes not to render
134     if HTML_RENDER_TYPE is &quot;XHTML STRICT&quot;</td>
135     </tr>
136    
137     </table>
138     <BR>
139     </TD>
140     </TR>
141    
142     <!-- =========== Summary =========== -->
143     <TR BGCOLOR='white'>
144     <TD>
145     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></span>
146     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
147     <tr CLASS="tableheadingcolor">
148     <th>Variable</th>
149     <th>Default Value</th>
150     <th>Description</th>
151     </tr>
152    
153     <tr>
154     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#$newline_after_closetag'>$newline_after_closetag</A></td>
155     <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
156     <td CLASS="font10">Flag to place a newline after close tag.</td>
157     </tr>
158    
159     <tr>
160     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#$newline_after_opentag'>$newline_after_opentag</A></td>
161     <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
162     <td CLASS="font10">Flag to place a newline after open tag.</td>
163     </tr>
164    
165     <tr>
166     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#$_cdata_content_wrap'>$_cdata_content_wrap</A></td>
167     <td CLASS="font10" STYLE="white-space: nowrap">->FALSE<-</td>
168     <td CLASS="font10">Automatically wrap ALL content</td>
169     </tr>
170    
171     <tr>
172     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#$_tag_postfix'>$_tag_postfix</A></td>
173     <td CLASS="font10" STYLE="white-space: nowrap">->&gt;<-</td>
174     <td CLASS="font10">holds the tag postfix</td>
175     </tr>
176    
177     <tr>
178     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#$_tag_prefix'>$_tag_prefix</A></td>
179     <td CLASS="font10" STYLE="white-space: nowrap">->&lt;<-</td>
180     <td CLASS="font10">holds the tag prefix</td>
181     </tr>
182    
183     </table>
184     <BR>
185     </TD>
186     </TR>
187    
188     <!-- =========== Summary =========== -->
189     <TR BGCOLOR='white'>
190     <TD>
191     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
192     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
193     <tr CLASS="tableheadingcolor">
194     <th>Variable</th>
195     <th>Default Value</th>
196     <th>Description</th>
197     </tr>
198    
199     <tr>
200     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$indent_flag'>$indent_flag</A></td>
201     <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
202     <td CLASS="font10">Flag for pretty (indented) output</td>
203     </tr>
204    
205     <tr>
206     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></td>
207     <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
208     <td CLASS="font10">Do we render a newline after the
209     contents has been rendered?</td>
210     </tr>
211    
212     </table>
213     <BR>
214     </TD>
215     </TR>
216    
217     </TABLE>
218    
219     <hr>
220     <!-- =========== INHERITED METHOD SUMMARY =========== -->
221     <A NAME='functions_inherited'><!-- --></A>
222     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
223     <TR CLASS='TableHeadingColor'>
224     <TD>
225     <span CLASS="font12bold">Inherited Method Summary</span>
226     <A HREF="#top" CLASS="links">^TOP</A>
227     </TD>
228     </TR>
229    
230    
231     <!-- =========== Summary =========== -->
232     <TR BGCOLOR='white' CLASS='TableRowColor'>
233     <TD>
234     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/HTMLTagClass.html">HTMLTagClass</a></span>
235     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
236     <tr CLASS="tableheadingcolor">
237     <th>Function</th>
238     <th>Description</th>
239     </tr>
240    
241     <tr>
242     <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLTagClass.html#constructor HTMLTagClass'>constructor HTMLTagClass ( [$attributes = NULL] )</A></td>
243     <td CLASS="font10">Class Constructor</td>
244    
245     <tr>
246     <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLTagClass.html#render'>render ( [$indent_level = NULL], [$output_debug = 0] )</A></td>
247     <td CLASS="font10">Renders the tag, attributes, content and close tag.</td>
248    
249     <tr>
250     <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLTagClass.html#set_class'>set_class ( $value )</A></td>
251     <td CLASS="font10">This function is a shorthand helper
252     to setting the class attribute on a
253     tag.</td>
254    
255     <tr>
256     <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLTagClass.html#set_id'>set_id ( $value )</A></td>
257     <td CLASS="font10">This function is a shorthand helper
258     to setting the id attribute on a
259     tag.</td>
260    
261     <tr>
262     <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLTagClass.html#set_style'>set_style ( $value )</A></td>
263     <td CLASS="font10">This function is a shorthand helper
264     to setting the style attribute on a
265     tag.</td>
266    
267     <tr>
268     <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLTagClass.html#_build_attribute_string'>_build_attribute_string ( $name, $value, [$debug = 0] )</A></td>
269     <td CLASS="font10">this builds an attribute for a tag.</td>
270    
271     <tr>
272     <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLTagClass.html#_render_tag_debug'>_render_tag_debug ( $indent_level )</A></td>
273     <td CLASS="font10">This renders that open tag in debug mode.</td>
274    
275     </table>
276     <br>
277     </TD>
278     </TR>
279    
280     <!-- =========== Summary =========== -->
281     <TR BGCOLOR='white' CLASS='TableRowColor'>
282     <TD>
283     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></span>
284     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
285     <tr CLASS="tableheadingcolor">
286     <th>Function</th>
287     <th>Description</th>
288     </tr>
289    
290     <tr>
291     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#constructor XMLTagClass'>constructor XMLTagClass ( [$name = ], [$attributes = array()] )</A></td>
292     <td CLASS="font10">The constructor</td>
293    
294     <tr>
295     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#get_tag'>get_tag ( )</A></td>
296     <td CLASS="font10">This returns the tag declared for this class.</td>
297    
298     <tr>
299     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#get_tag_name'>get_tag_name ( )</A></td>
300     <td CLASS="font10">This method gets the name of the tag</td>
301    
302     <tr>
303     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#render'>render ( [$indent_level = 0] )</A></td>
304     <td CLASS="font10">This function is responsible</td>
305    
306     <tr>
307     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#reset_attributes'>reset_attributes ( [$attributes = array()] )</A></td>
308     <td CLASS="font10">clear all attributes and start with new attributes</td>
309    
310     <tr>
311     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td>
312     <td CLASS="font10">This function turns on the collapse flag</td>
313    
314     <tr>
315     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_newline_after_closetag'>set_newline_after_closetag ( $flag )</A></td>
316     <td CLASS="font10">set the newline_after_content flag</td>
317    
318     <tr>
319     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_newline_after_opentag'>set_newline_after_opentag ( $flag )</A></td>
320     <td CLASS="font10">set the newline_after_opentag flag</td>
321    
322     <tr>
323     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_tag_attribute'>set_tag_attribute ( $name, [$value = NULL] )</A></td>
324     <td CLASS="font10">add a single attribute (name=&quot;value&quot;)</td>
325    
326     <tr>
327     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_tag_attributes'>set_tag_attributes ( [$attributes = array()] )</A></td>
328     <td CLASS="font10">add multiple attributes (name=&quot;value&quot;)</td>
329    
330     <tr>
331     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_tag_name'>set_tag_name ( $name )</A></td>
332     <td CLASS="font10">This method sets the name of the tag</td>
333    
334     <tr>
335     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_build_attribute_string'>_build_attribute_string ( $name, $value )</A></td>
336     <td CLASS="font10">this builds an attribute for an XML tag.</td>
337    
338     <tr>
339     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_get_element'>_get_element ( $cell )</A></td>
340     <td CLASS="font10">get the nth element from content array</td>
341    
342     <tr>
343     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_prepare_flags'>_prepare_flags ( )</A></td>
344     <td CLASS="font10">This function checks to see if</td>
345    
346     <tr>
347     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_render_close_tag'>_render_close_tag ( $indent_level )</A></td>
348     <td CLASS="font10">this function is reposnsible for
349     rendering the closing tag (if any)</td>
350    
351     <tr>
352     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_render_content'>_render_content ( $indent_level, [$output_debug = 0] )</A></td>
353     <td CLASS="font10">this function is reponsible for</td>
354    
355     <tr>
356     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_render_open_tag'>_render_open_tag ( $indent_level, [$finish_slash = TRUE] )</A></td>
357     <td CLASS="font10">this function is responsible for
358     rendering the open tag.</td>
359    
360     </table>
361     <br>
362     </TD>
363     </TR>
364    
365     <!-- =========== Summary =========== -->
366     <TR BGCOLOR='white' CLASS='TableRowColor'>
367     <TD>
368     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
369     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
370     <tr CLASS="tableheadingcolor">
371     <th>Function</th>
372     <th>Description</th>
373     </tr>
374    
375     <tr>
376     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#constructor Container'>constructor Container ( )</A></td>
377     <td CLASS="font10">The constructor.</td>
378    
379     <tr>
380     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add'>add ( )</A></td>
381     <td CLASS="font10">add content onto content stack</td>
382    
383     <tr>
384     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add_reference'>add_reference ( &$content )</A></td>
385     <td CLASS="font10">Add content onto content stack
386     so you can change the item later.</td>
387    
388     <tr>
389     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#count_content'>count_content ( )</A></td>
390     <td CLASS="font10">counts the number of content objects</td>
391    
392     <tr>
393     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#get_indent_flag'>get_indent_flag ( )</A></td>
394     <td CLASS="font10">This flag gets the current value
395     of the indent flag</td>
396    
397     <tr>
398     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push'>push ( )</A></td>
399     <td CLASS="font10">Same as add().</td>
400    
401     <tr>
402     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push_reference'>push_reference ( &$content )</A></td>
403     <td CLASS="font10">Same as add_reference
404     NOTE : only exists for compatibility with 1.1.x</td>
405    
406     <tr>
407     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#render'>render ( [$indent_level = 1], [$output_debug = 0] )</A></td>
408     <td CLASS="font10">This function is compatible with the
409     rest of the phpHtmllib API spec.</td>
410    
411     <tr>
412     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#reset_content'>reset_content ( )</A></td>
413     <td CLASS="font10">destroy existing content and start with new content.</td>
414    
415     <tr>
416     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td>
417     <td CLASS="font10">This function turns on the collapse flag</td>
418    
419     <tr>
420     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_indent_flag'>set_indent_flag ( $flag )</A></td>
421     <td CLASS="font10">function to set the indent flag</td>
422    
423     </table>
424     <br>
425     </TD>
426     </TR>
427    
428     </TABLE>
429    
430     <hr>
431     <!-- should have constructor at some point -->
432     <!-- =========== Method SUMMARY =========== -->
433     <A NAME='Method_summary'><!-- --></A>
434     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
435     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
436     <TD>
437     <span class="font12bold">Method Summary</span>
438     <A HREF="#top" CLASS="links">^TOP</A>
439     </TD>
440     </TR>
441    
442    
443     </TABLE>
444    
445     <hr>
446     <!-- ============ VARIABLE DETAIL =========== -->
447    
448     <A NAME='variable_detail'></A>
449     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
450     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
451     <TD>
452     <span CLASS="font12bold">Variable Detail</span>
453     <A HREF="#top" CLASS="links">^TOP</A>
454     </TD>
455     </TR>
456     </TABLE>
457    
458    
459     <A NAME='$_tag'><!-- --></A><H3>$_tag</H3>
460     <b>Data type:</b> mixed<br>
461     <!-- ========== Info from phpDoc block ========= -->
462    
463     <BR>
464    
465    
466     <UL>
467    
468     </UL>
469    
470     <HR>
471    
472    
473     <hr>
474     <!-- ============ FUNCTION DETAIL =========== -->
475    
476     <A NAME='function_detail'></A>
477     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
478     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
479     <TD>
480     <span class="font12bold">Method Detail</span>
481     <A HREF="#top" CLASS="links">^TOP</A>
482     </TD>
483     </TR>
484     </TABLE>
485     <BR>
486    
487    
488     <hr>
489     </HTML>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed