~ubuntu-branches/ubuntu/trusty/libstruts1.2-java/trusty-proposed

« back to all changes in this revision

Viewing changes to legacy/api-1.0/org/apache/struts/taglib/html/OptionsTag.html

  • Committer: Bazaar Package Importer
  • Author(s): Arnaud Vandyck
  • Date: 2004-11-19 15:35:25 UTC
  • Revision ID: james.westby@ubuntu.com-20041119153525-mdu08a76z4zo67xt
Tags: upstream-1.2.4
Import upstream version 1.2.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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 javadoc on Fri Jun 15 16:53:36 PDT 2001 -->
 
6
<TITLE>
 
7
Apache Struts API Documentation: Class  OptionsTag
 
8
</TITLE>
 
9
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
 
10
</HEAD>
 
11
<BODY BGCOLOR="white">
 
12
 
 
13
<!-- ========== START OF NAVBAR ========== -->
 
14
<A NAME="navbar_top"><!-- --></A>
 
15
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
 
16
<TR>
 
17
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 
18
<A NAME="navbar_top_firstrow"><!-- --></A>
 
19
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
 
20
  <TR ALIGN="center" VALIGN="top">
 
21
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 
22
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 
23
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 
24
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 
25
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 
26
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 
27
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 
28
  </TR>
 
29
</TABLE>
 
30
</TD>
 
31
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 
32
</EM>
 
33
</TD>
 
34
</TR>
 
35
 
 
36
<TR>
 
37
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
38
&nbsp;<A HREF="../../../../../org/apache/struts/taglib/html/MultiboxTag.html"><B>PREV CLASS</B></A>&nbsp;
 
39
&nbsp;<A HREF="../../../../../org/apache/struts/taglib/html/OptionTag.html"><B>NEXT CLASS</B></A></FONT></TD>
 
40
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
41
  <A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
 
42
&nbsp;<A HREF="OptionsTag.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
 
43
</TR>
 
44
<TR>
 
45
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
46
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 
47
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
48
DETAIL: &nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 
49
</TR>
 
50
</TABLE>
 
51
<!-- =========== END OF NAVBAR =========== -->
 
52
 
 
53
<HR>
 
54
<!-- ======== START OF CLASS DATA ======== -->
 
55
<H2>
 
56
<FONT SIZE="-1">
 
57
org.apache.struts.taglib.html</FONT>
 
58
<BR>
 
59
Class  OptionsTag</H2>
 
60
<PRE>
 
61
java.lang.Object
 
62
  |
 
63
  +--javax.servlet.jsp.tagext.TagSupport
 
64
        |
 
65
        +--<B>org.apache.struts.taglib.html.OptionsTag</B>
 
66
</PRE>
 
67
<DL>
 
68
<DT><B>All Implemented Interfaces:</B> <DD>javax.servlet.jsp.tagext.IterationTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag</DD>
 
69
</DL>
 
70
<HR>
 
71
<DL>
 
72
<DT>public class <B>OptionsTag</B><DT>extends javax.servlet.jsp.tagext.TagSupport</DL>
 
73
 
 
74
<P>
 
75
Tag for creating multiple &lt;select&gt; options from a collection.  The
 
76
 associated values displayed to the user may optionally be specified by a
 
77
 second collection, or will be the same as the values themselves.  Each
 
78
 collection may be an array of objects, a Collection, an Enumeration,
 
79
 an Iterator, or a Map.
 
80
 <b>NOTE</b> - This tag requires a Java2 (JDK 1.2 or later) platform.
 
81
<P>
 
82
<DL>
 
83
<DT><B>Author: </B><DD>Florent Carpentier, Craig McClanahan</DD>
 
84
<DT><B>See Also: </B><DD><A HREF="../../../../../serialized-form.html#org.apache.struts.taglib.html.OptionsTag">Serialized Form</A></DL>
 
85
<HR>
 
86
 
 
87
<P>
 
88
<!-- ======== INNER CLASS SUMMARY ======== -->
 
89
 
 
90
 
 
91
<!-- =========== FIELD SUMMARY =========== -->
 
92
 
 
93
<A NAME="field_summary"><!-- --></A>
 
94
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
95
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
96
<TD COLSPAN=2><FONT SIZE="+2">
 
97
<B>Field Summary</B></FONT></TD>
 
98
</TR>
 
99
<TR BGCOLOR="white" CLASS="TableRowColor">
 
100
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
101
<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
 
102
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/OptionsTag.html#collection">collection</A></B></CODE>
 
103
 
 
104
<BR>
 
105
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The name of the collection containing beans that have properties to
 
106
 provide both the values and the labels (identified by the
 
107
 <code>property</code> and <code>labelProperty</code> attributes).</TD>
 
108
</TR>
 
109
<TR BGCOLOR="white" CLASS="TableRowColor">
 
110
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
111
<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
 
112
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/OptionsTag.html#labelName">labelName</A></B></CODE>
 
113
 
 
114
<BR>
 
115
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The name of the bean containing the labels collection.</TD>
 
116
</TR>
 
117
<TR BGCOLOR="white" CLASS="TableRowColor">
 
118
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
119
<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
 
120
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/OptionsTag.html#labelProperty">labelProperty</A></B></CODE>
 
121
 
 
122
<BR>
 
123
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The bean property containing the labels collection.</TD>
 
124
</TR>
 
125
<TR BGCOLOR="white" CLASS="TableRowColor">
 
126
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
127
<CODE>protected static&nbsp;<A HREF="../../../../../org/apache/struts/util/MessageResources.html">MessageResources</A></CODE></FONT></TD>
 
128
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/OptionsTag.html#messages">messages</A></B></CODE>
 
129
 
 
130
<BR>
 
131
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The message resources for this package.</TD>
 
132
</TR>
 
133
<TR BGCOLOR="white" CLASS="TableRowColor">
 
134
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
135
<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
 
136
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/OptionsTag.html#name">name</A></B></CODE>
 
137
 
 
138
<BR>
 
139
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The name of the bean containing the values collection.</TD>
 
140
</TR>
 
141
<TR BGCOLOR="white" CLASS="TableRowColor">
 
142
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
143
<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
 
144
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/OptionsTag.html#property">property</A></B></CODE>
 
145
 
 
146
<BR>
 
147
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The name of the property to use to build the values collection.</TD>
 
148
</TR>
 
149
</TABLE>
 
150
&nbsp;<A NAME="fields_inherited_from_class_javax.servlet.jsp.tagext.TagSupport"><!-- --></A>
 
151
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
152
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 
153
<TD><B>Fields inherited from class javax.servlet.jsp.tagext.TagSupport</B></TD>
 
154
</TR>
 
155
<TR BGCOLOR="white" CLASS="TableRowColor">
 
156
<TD><CODE>id, pageContext, parent, values</CODE></TD>
 
157
</TR>
 
158
</TABLE>
 
159
&nbsp;<A NAME="fields_inherited_from_class_javax.servlet.jsp.tagext.IterationTag"><!-- --></A>
 
160
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
161
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 
162
<TD><B>Fields inherited from interface javax.servlet.jsp.tagext.IterationTag</B></TD>
 
163
</TR>
 
164
<TR BGCOLOR="white" CLASS="TableRowColor">
 
165
<TD><CODE>EVAL_BODY_AGAIN</CODE></TD>
 
166
</TR>
 
167
</TABLE>
 
168
&nbsp;<A NAME="fields_inherited_from_class_javax.servlet.jsp.tagext.Tag"><!-- --></A>
 
169
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
170
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 
171
<TD><B>Fields inherited from interface javax.servlet.jsp.tagext.Tag</B></TD>
 
172
</TR>
 
173
<TR BGCOLOR="white" CLASS="TableRowColor">
 
174
<TD><CODE>EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE</CODE></TD>
 
175
</TR>
 
176
</TABLE>
 
177
&nbsp;
 
178
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
 
179
 
 
180
<A NAME="constructor_summary"><!-- --></A>
 
181
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
182
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
183
<TD COLSPAN=2><FONT SIZE="+2">
 
184
<B>Constructor Summary</B></FONT></TD>
 
185
</TR>
 
186
<TR BGCOLOR="white" CLASS="TableRowColor">
 
187
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/OptionsTag.html#OptionsTag()">OptionsTag</A></B>()</CODE>
 
188
 
 
189
<BR>
 
190
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 
191
</TR>
 
192
</TABLE>
 
193
&nbsp;
 
194
<!-- ========== METHOD SUMMARY =========== -->
 
195
 
 
196
<A NAME="method_summary"><!-- --></A>
 
197
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
198
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
199
<TD COLSPAN=2><FONT SIZE="+2">
 
200
<B>Method Summary</B></FONT></TD>
 
201
</TR>
 
202
<TR BGCOLOR="white" CLASS="TableRowColor">
 
203
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
204
<CODE>protected &nbsp;void</CODE></FONT></TD>
 
205
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/OptionsTag.html#addOption(java.lang.StringBuffer, java.lang.String, java.lang.String, boolean)">addOption</A></B>(java.lang.StringBuffer&nbsp;sb,
 
206
          java.lang.String&nbsp;value,
 
207
          java.lang.String&nbsp;label,
 
208
          boolean&nbsp;matched)</CODE>
 
209
 
 
210
<BR>
 
211
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add an option element to the specified StringBuffer based on the
 
212
 specified parameters.</TD>
 
213
</TR>
 
214
<TR BGCOLOR="white" CLASS="TableRowColor">
 
215
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
216
<CODE>&nbsp;int</CODE></FONT></TD>
 
217
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/OptionsTag.html#doEndTag()">doEndTag</A></B>()</CODE>
 
218
 
 
219
<BR>
 
220
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Process the end of this tag.</TD>
 
221
</TR>
 
222
<TR BGCOLOR="white" CLASS="TableRowColor">
 
223
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
224
<CODE>&nbsp;int</CODE></FONT></TD>
 
225
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/OptionsTag.html#doStartTag()">doStartTag</A></B>()</CODE>
 
226
 
 
227
<BR>
 
228
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Process the start of this tag.</TD>
 
229
</TR>
 
230
<TR BGCOLOR="white" CLASS="TableRowColor">
 
231
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
232
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
 
233
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/OptionsTag.html#getCollection()">getCollection</A></B>()</CODE>
 
234
 
 
235
<BR>
 
236
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 
237
</TR>
 
238
<TR BGCOLOR="white" CLASS="TableRowColor">
 
239
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
240
<CODE>protected &nbsp;java.util.Iterator</CODE></FONT></TD>
 
241
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/OptionsTag.html#getIterator(java.lang.String, java.lang.String)">getIterator</A></B>(java.lang.String&nbsp;name,
 
242
            java.lang.String&nbsp;property)</CODE>
 
243
 
 
244
<BR>
 
245
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return an iterator for the option labels or values, based on our
 
246
 configured properties.</TD>
 
247
</TR>
 
248
<TR BGCOLOR="white" CLASS="TableRowColor">
 
249
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
250
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
 
251
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/OptionsTag.html#getLabelName()">getLabelName</A></B>()</CODE>
 
252
 
 
253
<BR>
 
254
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 
255
</TR>
 
256
<TR BGCOLOR="white" CLASS="TableRowColor">
 
257
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
258
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
 
259
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/OptionsTag.html#getLabelProperty()">getLabelProperty</A></B>()</CODE>
 
260
 
 
261
<BR>
 
262
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 
263
</TR>
 
264
<TR BGCOLOR="white" CLASS="TableRowColor">
 
265
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
266
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
 
267
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/OptionsTag.html#getName()">getName</A></B>()</CODE>
 
268
 
 
269
<BR>
 
270
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 
271
</TR>
 
272
<TR BGCOLOR="white" CLASS="TableRowColor">
 
273
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
274
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
 
275
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/OptionsTag.html#getProperty()">getProperty</A></B>()</CODE>
 
276
 
 
277
<BR>
 
278
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 
279
</TR>
 
280
<TR BGCOLOR="white" CLASS="TableRowColor">
 
281
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
282
<CODE>&nbsp;void</CODE></FONT></TD>
 
283
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/OptionsTag.html#release()">release</A></B>()</CODE>
 
284
 
 
285
<BR>
 
286
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Release any acquired resources.</TD>
 
287
</TR>
 
288
<TR BGCOLOR="white" CLASS="TableRowColor">
 
289
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
290
<CODE>&nbsp;void</CODE></FONT></TD>
 
291
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/OptionsTag.html#setCollection(java.lang.String)">setCollection</A></B>(java.lang.String&nbsp;collection)</CODE>
 
292
 
 
293
<BR>
 
294
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 
295
</TR>
 
296
<TR BGCOLOR="white" CLASS="TableRowColor">
 
297
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
298
<CODE>&nbsp;void</CODE></FONT></TD>
 
299
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/OptionsTag.html#setLabelName(java.lang.String)">setLabelName</A></B>(java.lang.String&nbsp;labelName)</CODE>
 
300
 
 
301
<BR>
 
302
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 
303
</TR>
 
304
<TR BGCOLOR="white" CLASS="TableRowColor">
 
305
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
306
<CODE>&nbsp;void</CODE></FONT></TD>
 
307
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/OptionsTag.html#setLabelProperty(java.lang.String)">setLabelProperty</A></B>(java.lang.String&nbsp;labelProperty)</CODE>
 
308
 
 
309
<BR>
 
310
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 
311
</TR>
 
312
<TR BGCOLOR="white" CLASS="TableRowColor">
 
313
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
314
<CODE>&nbsp;void</CODE></FONT></TD>
 
315
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/OptionsTag.html#setName(java.lang.String)">setName</A></B>(java.lang.String&nbsp;name)</CODE>
 
316
 
 
317
<BR>
 
318
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 
319
</TR>
 
320
<TR BGCOLOR="white" CLASS="TableRowColor">
 
321
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
322
<CODE>&nbsp;void</CODE></FONT></TD>
 
323
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/OptionsTag.html#setProperty(java.lang.String)">setProperty</A></B>(java.lang.String&nbsp;property)</CODE>
 
324
 
 
325
<BR>
 
326
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 
327
</TR>
 
328
</TABLE>
 
329
&nbsp;<A NAME="methods_inherited_from_class_javax.servlet.jsp.tagext.TagSupport"><!-- --></A>
 
330
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
331
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 
332
<TD><B>Methods inherited from class javax.servlet.jsp.tagext.TagSupport</B></TD>
 
333
</TR>
 
334
<TR BGCOLOR="white" CLASS="TableRowColor">
 
335
<TD><CODE>doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue</CODE></TD>
 
336
</TR>
 
337
</TABLE>
 
338
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 
339
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
340
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 
341
<TD><B>Methods inherited from class java.lang.Object</B></TD>
 
342
</TR>
 
343
<TR BGCOLOR="white" CLASS="TableRowColor">
 
344
<TD><CODE><clinit>, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait</CODE></TD>
 
345
</TR>
 
346
</TABLE>
 
347
&nbsp;
 
348
<P>
 
349
 
 
350
<!-- ============ FIELD DETAIL =========== -->
 
351
 
 
352
<A NAME="field_detail"><!-- --></A>
 
353
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
354
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
355
<TD COLSPAN=1><FONT SIZE="+2">
 
356
<B>Field Detail</B></FONT></TD>
 
357
</TR>
 
358
</TABLE>
 
359
 
 
360
<A NAME="messages"><!-- --></A><H3>
 
361
messages</H3>
 
362
<PRE>
 
363
protected static <A HREF="../../../../../org/apache/struts/util/MessageResources.html">MessageResources</A> <B>messages</B></PRE>
 
364
<DL>
 
365
<DD>The message resources for this package.</DL>
 
366
<HR>
 
367
 
 
368
<A NAME="collection"><!-- --></A><H3>
 
369
collection</H3>
 
370
<PRE>
 
371
protected java.lang.String <B>collection</B></PRE>
 
372
<DL>
 
373
<DD>The name of the collection containing beans that have properties to
 
374
 provide both the values and the labels (identified by the
 
375
 <code>property</code> and <code>labelProperty</code> attributes).</DL>
 
376
<HR>
 
377
 
 
378
<A NAME="labelName"><!-- --></A><H3>
 
379
labelName</H3>
 
380
<PRE>
 
381
protected java.lang.String <B>labelName</B></PRE>
 
382
<DL>
 
383
<DD>The name of the bean containing the labels collection.</DL>
 
384
<HR>
 
385
 
 
386
<A NAME="labelProperty"><!-- --></A><H3>
 
387
labelProperty</H3>
 
388
<PRE>
 
389
protected java.lang.String <B>labelProperty</B></PRE>
 
390
<DL>
 
391
<DD>The bean property containing the labels collection.</DL>
 
392
<HR>
 
393
 
 
394
<A NAME="name"><!-- --></A><H3>
 
395
name</H3>
 
396
<PRE>
 
397
protected java.lang.String <B>name</B></PRE>
 
398
<DL>
 
399
<DD>The name of the bean containing the values collection.</DL>
 
400
<HR>
 
401
 
 
402
<A NAME="property"><!-- --></A><H3>
 
403
property</H3>
 
404
<PRE>
 
405
protected java.lang.String <B>property</B></PRE>
 
406
<DL>
 
407
<DD>The name of the property to use to build the values collection.</DL>
 
408
 
 
409
<!-- ========= CONSTRUCTOR DETAIL ======== -->
 
410
 
 
411
<A NAME="constructor_detail"><!-- --></A>
 
412
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
413
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
414
<TD COLSPAN=1><FONT SIZE="+2">
 
415
<B>Constructor Detail</B></FONT></TD>
 
416
</TR>
 
417
</TABLE>
 
418
 
 
419
<A NAME="OptionsTag()"><!-- --></A><H3>
 
420
OptionsTag</H3>
 
421
<PRE>
 
422
public <B>OptionsTag</B>()</PRE>
 
423
<DL>
 
424
</DL>
 
425
 
 
426
<!-- ============ METHOD DETAIL ========== -->
 
427
 
 
428
<A NAME="method_detail"><!-- --></A>
 
429
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
430
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
431
<TD COLSPAN=1><FONT SIZE="+2">
 
432
<B>Method Detail</B></FONT></TD>
 
433
</TR>
 
434
</TABLE>
 
435
 
 
436
<A NAME="getCollection()"><!-- --></A><H3>
 
437
getCollection</H3>
 
438
<PRE>
 
439
public java.lang.String <B>getCollection</B>()</PRE>
 
440
<DL>
 
441
</DL>
 
442
<HR>
 
443
 
 
444
<A NAME="setCollection(java.lang.String)"><!-- --></A><H3>
 
445
setCollection</H3>
 
446
<PRE>
 
447
public void <B>setCollection</B>(java.lang.String&nbsp;collection)</PRE>
 
448
<DL>
 
449
</DL>
 
450
<HR>
 
451
 
 
452
<A NAME="getLabelName()"><!-- --></A><H3>
 
453
getLabelName</H3>
 
454
<PRE>
 
455
public java.lang.String <B>getLabelName</B>()</PRE>
 
456
<DL>
 
457
</DL>
 
458
<HR>
 
459
 
 
460
<A NAME="setLabelName(java.lang.String)"><!-- --></A><H3>
 
461
setLabelName</H3>
 
462
<PRE>
 
463
public void <B>setLabelName</B>(java.lang.String&nbsp;labelName)</PRE>
 
464
<DL>
 
465
</DL>
 
466
<HR>
 
467
 
 
468
<A NAME="getLabelProperty()"><!-- --></A><H3>
 
469
getLabelProperty</H3>
 
470
<PRE>
 
471
public java.lang.String <B>getLabelProperty</B>()</PRE>
 
472
<DL>
 
473
</DL>
 
474
<HR>
 
475
 
 
476
<A NAME="setLabelProperty(java.lang.String)"><!-- --></A><H3>
 
477
setLabelProperty</H3>
 
478
<PRE>
 
479
public void <B>setLabelProperty</B>(java.lang.String&nbsp;labelProperty)</PRE>
 
480
<DL>
 
481
</DL>
 
482
<HR>
 
483
 
 
484
<A NAME="getName()"><!-- --></A><H3>
 
485
getName</H3>
 
486
<PRE>
 
487
public java.lang.String <B>getName</B>()</PRE>
 
488
<DL>
 
489
</DL>
 
490
<HR>
 
491
 
 
492
<A NAME="setName(java.lang.String)"><!-- --></A><H3>
 
493
setName</H3>
 
494
<PRE>
 
495
public void <B>setName</B>(java.lang.String&nbsp;name)</PRE>
 
496
<DL>
 
497
</DL>
 
498
<HR>
 
499
 
 
500
<A NAME="getProperty()"><!-- --></A><H3>
 
501
getProperty</H3>
 
502
<PRE>
 
503
public java.lang.String <B>getProperty</B>()</PRE>
 
504
<DL>
 
505
</DL>
 
506
<HR>
 
507
 
 
508
<A NAME="setProperty(java.lang.String)"><!-- --></A><H3>
 
509
setProperty</H3>
 
510
<PRE>
 
511
public void <B>setProperty</B>(java.lang.String&nbsp;property)</PRE>
 
512
<DL>
 
513
</DL>
 
514
<HR>
 
515
 
 
516
<A NAME="doStartTag()"><!-- --></A><H3>
 
517
doStartTag</H3>
 
518
<PRE>
 
519
public int <B>doStartTag</B>()
 
520
               throws javax.servlet.jsp.JspException</PRE>
 
521
<DL>
 
522
<DD>Process the start of this tag.<DD><DL>
 
523
<DT><B>Overrides:</B><DD><CODE>doStartTag</CODE> in class <CODE>javax.servlet.jsp.tagext.TagSupport</CODE></DL>
 
524
</DD>
 
525
<DD><DL>
 
526
<DT><B>Throws:</B><DD><CODE>javax.servlet.jsp.JspException</CODE> - if a JSP exception has occurred</DL>
 
527
</DD>
 
528
</DL>
 
529
<HR>
 
530
 
 
531
<A NAME="doEndTag()"><!-- --></A><H3>
 
532
doEndTag</H3>
 
533
<PRE>
 
534
public int <B>doEndTag</B>()
 
535
             throws javax.servlet.jsp.JspException</PRE>
 
536
<DL>
 
537
<DD>Process the end of this tag.<DD><DL>
 
538
<DT><B>Overrides:</B><DD><CODE>doEndTag</CODE> in class <CODE>javax.servlet.jsp.tagext.TagSupport</CODE></DL>
 
539
</DD>
 
540
<DD><DL>
 
541
<DT><B>Throws:</B><DD><CODE>javax.servlet.jsp.JspException</CODE> - if a JSP exception has occurred</DL>
 
542
</DD>
 
543
</DL>
 
544
<HR>
 
545
 
 
546
<A NAME="release()"><!-- --></A><H3>
 
547
release</H3>
 
548
<PRE>
 
549
public void <B>release</B>()</PRE>
 
550
<DL>
 
551
<DD>Release any acquired resources.<DD><DL>
 
552
<DT><B>Overrides:</B><DD><CODE>release</CODE> in class <CODE>javax.servlet.jsp.tagext.TagSupport</CODE></DL>
 
553
</DD>
 
554
</DL>
 
555
<HR>
 
556
 
 
557
<A NAME="addOption(java.lang.StringBuffer, java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
 
558
addOption</H3>
 
559
<PRE>
 
560
protected void <B>addOption</B>(java.lang.StringBuffer&nbsp;sb,
 
561
                         java.lang.String&nbsp;value,
 
562
                         java.lang.String&nbsp;label,
 
563
                         boolean&nbsp;matched)</PRE>
 
564
<DL>
 
565
<DD>Add an option element to the specified StringBuffer based on the
 
566
 specified parameters.<DD><DL>
 
567
<DT><B>Parameters:</B><DD><CODE>sb</CODE> - StringBuffer accumulating our results<DD><CODE>value</CODE> - Value to be returned to the server for this option<DD><CODE>label</CODE> - Value to be shown to the user for this option<DD><CODE>matched</CODE> - Should this value be marked as selected?</DL>
 
568
</DD>
 
569
</DL>
 
570
<HR>
 
571
 
 
572
<A NAME="getIterator(java.lang.String, java.lang.String)"><!-- --></A><H3>
 
573
getIterator</H3>
 
574
<PRE>
 
575
protected java.util.Iterator <B>getIterator</B>(java.lang.String&nbsp;name,
 
576
                                         java.lang.String&nbsp;property)
 
577
                                  throws javax.servlet.jsp.JspException</PRE>
 
578
<DL>
 
579
<DD>Return an iterator for the option labels or values, based on our
 
580
 configured properties.<DD><DL>
 
581
<DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of the bean attribute (if any)<DD><CODE>property</CODE> - Name of the bean property (if any)<DT><B>Throws:</B><DD><CODE>javax.servlet.jsp.JspException</CODE> - if an error occurs</DL>
 
582
</DD>
 
583
</DL>
 
584
<!-- ========= END OF CLASS DATA ========= -->
 
585
<HR>
 
586
 
 
587
<!-- ========== START OF NAVBAR ========== -->
 
588
<A NAME="navbar_bottom"><!-- --></A>
 
589
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
 
590
<TR>
 
591
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 
592
<A NAME="navbar_bottom_firstrow"><!-- --></A>
 
593
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
 
594
  <TR ALIGN="center" VALIGN="top">
 
595
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 
596
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 
597
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 
598
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 
599
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 
600
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 
601
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 
602
  </TR>
 
603
</TABLE>
 
604
</TD>
 
605
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 
606
</EM>
 
607
</TD>
 
608
</TR>
 
609
 
 
610
<TR>
 
611
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
612
&nbsp;<A HREF="../../../../../org/apache/struts/taglib/html/MultiboxTag.html"><B>PREV CLASS</B></A>&nbsp;
 
613
&nbsp;<A HREF="../../../../../org/apache/struts/taglib/html/OptionTag.html"><B>NEXT CLASS</B></A></FONT></TD>
 
614
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
615
  <A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
 
616
&nbsp;<A HREF="OptionsTag.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
 
617
</TR>
 
618
<TR>
 
619
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
620
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 
621
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
622
DETAIL: &nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 
623
</TR>
 
624
</TABLE>
 
625
<!-- =========== END OF NAVBAR =========== -->
 
626
 
 
627
<HR>
 
628
Copyright � 2000-2001 - Apache Software Foundation
 
629
</BODY>
 
630
</HTML>