1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
5
<!-- Generated by javadoc on Fri Jun 15 16:53:36 PDT 2001 -->
7
Apache Struts API Documentation: Class StrutsTag
9
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
11
<BODY BGCOLOR="white">
13
<!-- ========== START OF NAVBAR ========== -->
14
<A NAME="navbar_top"><!-- --></A>
15
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
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> </TD>
22
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
23
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
24
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
25
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
26
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
27
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
31
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
37
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
38
<A HREF="../../../../../org/apache/struts/taglib/bean/SizeTei.html"><B>PREV CLASS</B></A>
39
<A HREF="../../../../../org/apache/struts/taglib/bean/StrutsTei.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>
42
<A HREF="StrutsTag.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
45
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
46
SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
47
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
48
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
51
<!-- =========== END OF NAVBAR =========== -->
54
<!-- ======== START OF CLASS DATA ======== -->
57
org.apache.struts.taglib.bean</FONT>
63
+--javax.servlet.jsp.tagext.TagSupport
65
+--<B>org.apache.struts.taglib.bean.StrutsTag</B>
68
<DT><B>All Implemented Interfaces:</B> <DD>javax.servlet.jsp.tagext.IterationTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag</DD>
72
<DT>public class <B>StrutsTag</B><DT>extends javax.servlet.jsp.tagext.TagSupport</DL>
75
Define a scripting variable that exposes the requested Struts
76
internal configuraton object.
79
<DT><B>Version: </B><DD>$Revision: 1.1 $ $Date: 2001/09/17 20:08:02 $</DD>
80
<DT><B>Author: </B><DD>Craig R. McClanahan</DD>
81
<DT><B>See Also: </B><DD><A HREF="../../../../../serialized-form.html#org.apache.struts.taglib.bean.StrutsTag">Serialized Form</A></DL>
85
<!-- ======== INNER CLASS SUMMARY ======== -->
88
<!-- =========== FIELD SUMMARY =========== -->
90
<A NAME="field_summary"><!-- --></A>
91
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
92
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
93
<TD COLSPAN=2><FONT SIZE="+2">
94
<B>Field Summary</B></FONT></TD>
96
<TR BGCOLOR="white" CLASS="TableRowColor">
97
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
98
<CODE>protected java.lang.String</CODE></FONT></TD>
99
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/bean/StrutsTag.html#formBean">formBean</A></B></CODE>
102
The name of the <code>ActionFormBean</code> object to be exposed.</TD>
104
<TR BGCOLOR="white" CLASS="TableRowColor">
105
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
106
<CODE>protected java.lang.String</CODE></FONT></TD>
107
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/bean/StrutsTag.html#forward">forward</A></B></CODE>
110
The name of the <code>ActionForward</code> object to be exposed.</TD>
112
<TR BGCOLOR="white" CLASS="TableRowColor">
113
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
114
<CODE>protected java.lang.String</CODE></FONT></TD>
115
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/bean/StrutsTag.html#id">id</A></B></CODE>
118
The name of the scripting variable that will be exposed as a page
119
scope attribute.</TD>
121
<TR BGCOLOR="white" CLASS="TableRowColor">
122
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
123
<CODE>protected java.lang.String</CODE></FONT></TD>
124
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/bean/StrutsTag.html#mapping">mapping</A></B></CODE>
127
The name of the <code>ActionMapping</code> object to be exposed.</TD>
129
<TR BGCOLOR="white" CLASS="TableRowColor">
130
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
131
<CODE>protected static <A HREF="../../../../../org/apache/struts/util/MessageResources.html">MessageResources</A></CODE></FONT></TD>
132
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/bean/StrutsTag.html#messages">messages</A></B></CODE>
135
The message resources for this package.</TD>
138
<A NAME="fields_inherited_from_class_javax.servlet.jsp.tagext.TagSupport"><!-- --></A>
139
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
140
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
141
<TD><B>Fields inherited from class javax.servlet.jsp.tagext.TagSupport</B></TD>
143
<TR BGCOLOR="white" CLASS="TableRowColor">
144
<TD><CODE>pageContext, parent, values</CODE></TD>
147
<A NAME="fields_inherited_from_class_javax.servlet.jsp.tagext.IterationTag"><!-- --></A>
148
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
149
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
150
<TD><B>Fields inherited from interface javax.servlet.jsp.tagext.IterationTag</B></TD>
152
<TR BGCOLOR="white" CLASS="TableRowColor">
153
<TD><CODE>EVAL_BODY_AGAIN</CODE></TD>
156
<A NAME="fields_inherited_from_class_javax.servlet.jsp.tagext.Tag"><!-- --></A>
157
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
158
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
159
<TD><B>Fields inherited from interface javax.servlet.jsp.tagext.Tag</B></TD>
161
<TR BGCOLOR="white" CLASS="TableRowColor">
162
<TD><CODE>EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE</CODE></TD>
166
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
168
<A NAME="constructor_summary"><!-- --></A>
169
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
170
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
171
<TD COLSPAN=2><FONT SIZE="+2">
172
<B>Constructor Summary</B></FONT></TD>
174
<TR BGCOLOR="white" CLASS="TableRowColor">
175
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/bean/StrutsTag.html#StrutsTag()">StrutsTag</A></B>()</CODE>
178
</TD>
182
<!-- ========== METHOD SUMMARY =========== -->
184
<A NAME="method_summary"><!-- --></A>
185
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
186
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
187
<TD COLSPAN=2><FONT SIZE="+2">
188
<B>Method Summary</B></FONT></TD>
190
<TR BGCOLOR="white" CLASS="TableRowColor">
191
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
192
<CODE> int</CODE></FONT></TD>
193
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/bean/StrutsTag.html#doStartTag()">doStartTag</A></B>()</CODE>
196
Retrieve the required configuration object and expose it as a
197
scripting variable.</TD>
199
<TR BGCOLOR="white" CLASS="TableRowColor">
200
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
201
<CODE> java.lang.String</CODE></FONT></TD>
202
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/bean/StrutsTag.html#getFormBean()">getFormBean</A></B>()</CODE>
205
</TD>
207
<TR BGCOLOR="white" CLASS="TableRowColor">
208
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
209
<CODE> java.lang.String</CODE></FONT></TD>
210
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/bean/StrutsTag.html#getForward()">getForward</A></B>()</CODE>
213
</TD>
215
<TR BGCOLOR="white" CLASS="TableRowColor">
216
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
217
<CODE> java.lang.String</CODE></FONT></TD>
218
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/bean/StrutsTag.html#getId()">getId</A></B>()</CODE>
221
</TD>
223
<TR BGCOLOR="white" CLASS="TableRowColor">
224
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
225
<CODE> java.lang.String</CODE></FONT></TD>
226
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/bean/StrutsTag.html#getMapping()">getMapping</A></B>()</CODE>
229
</TD>
231
<TR BGCOLOR="white" CLASS="TableRowColor">
232
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
233
<CODE> void</CODE></FONT></TD>
234
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/bean/StrutsTag.html#release()">release</A></B>()</CODE>
237
Release all allocated resources.</TD>
239
<TR BGCOLOR="white" CLASS="TableRowColor">
240
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
241
<CODE> void</CODE></FONT></TD>
242
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/bean/StrutsTag.html#setFormBean(java.lang.String)">setFormBean</A></B>(java.lang.String formBean)</CODE>
245
</TD>
247
<TR BGCOLOR="white" CLASS="TableRowColor">
248
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
249
<CODE> void</CODE></FONT></TD>
250
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/bean/StrutsTag.html#setForward(java.lang.String)">setForward</A></B>(java.lang.String forward)</CODE>
253
</TD>
255
<TR BGCOLOR="white" CLASS="TableRowColor">
256
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
257
<CODE> void</CODE></FONT></TD>
258
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/bean/StrutsTag.html#setId(java.lang.String)">setId</A></B>(java.lang.String id)</CODE>
261
</TD>
263
<TR BGCOLOR="white" CLASS="TableRowColor">
264
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
265
<CODE> void</CODE></FONT></TD>
266
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/bean/StrutsTag.html#setMapping(java.lang.String)">setMapping</A></B>(java.lang.String mapping)</CODE>
269
</TD>
272
<A NAME="methods_inherited_from_class_javax.servlet.jsp.tagext.TagSupport"><!-- --></A>
273
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
274
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
275
<TD><B>Methods inherited from class javax.servlet.jsp.tagext.TagSupport</B></TD>
277
<TR BGCOLOR="white" CLASS="TableRowColor">
278
<TD><CODE>doAfterBody, doEndTag, findAncestorWithClass, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue</CODE></TD>
281
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
282
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
283
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
284
<TD><B>Methods inherited from class java.lang.Object</B></TD>
286
<TR BGCOLOR="white" CLASS="TableRowColor">
287
<TD><CODE><clinit>, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait</CODE></TD>
293
<!-- ============ FIELD DETAIL =========== -->
295
<A NAME="field_detail"><!-- --></A>
296
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
297
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
298
<TD COLSPAN=1><FONT SIZE="+2">
299
<B>Field Detail</B></FONT></TD>
303
<A NAME="id"><!-- --></A><H3>
306
protected java.lang.String <B>id</B></PRE>
308
<DD>The name of the scripting variable that will be exposed as a page
309
scope attribute.</DL>
312
<A NAME="messages"><!-- --></A><H3>
315
protected static <A HREF="../../../../../org/apache/struts/util/MessageResources.html">MessageResources</A> <B>messages</B></PRE>
317
<DD>The message resources for this package.</DL>
320
<A NAME="formBean"><!-- --></A><H3>
323
protected java.lang.String <B>formBean</B></PRE>
325
<DD>The name of the <code>ActionFormBean</code> object to be exposed.</DL>
328
<A NAME="forward"><!-- --></A><H3>
331
protected java.lang.String <B>forward</B></PRE>
333
<DD>The name of the <code>ActionForward</code> object to be exposed.</DL>
336
<A NAME="mapping"><!-- --></A><H3>
339
protected java.lang.String <B>mapping</B></PRE>
341
<DD>The name of the <code>ActionMapping</code> object to be exposed.</DL>
343
<!-- ========= CONSTRUCTOR DETAIL ======== -->
345
<A NAME="constructor_detail"><!-- --></A>
346
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
347
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
348
<TD COLSPAN=1><FONT SIZE="+2">
349
<B>Constructor Detail</B></FONT></TD>
353
<A NAME="StrutsTag()"><!-- --></A><H3>
356
public <B>StrutsTag</B>()</PRE>
360
<!-- ============ METHOD DETAIL ========== -->
362
<A NAME="method_detail"><!-- --></A>
363
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
364
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
365
<TD COLSPAN=1><FONT SIZE="+2">
366
<B>Method Detail</B></FONT></TD>
370
<A NAME="getId()"><!-- --></A><H3>
373
public java.lang.String <B>getId</B>()</PRE>
376
<DT><B>Overrides:</B><DD><CODE>getId</CODE> in class <CODE>javax.servlet.jsp.tagext.TagSupport</CODE></DL>
381
<A NAME="setId(java.lang.String)"><!-- --></A><H3>
384
public void <B>setId</B>(java.lang.String id)</PRE>
387
<DT><B>Overrides:</B><DD><CODE>setId</CODE> in class <CODE>javax.servlet.jsp.tagext.TagSupport</CODE></DL>
392
<A NAME="getFormBean()"><!-- --></A><H3>
395
public java.lang.String <B>getFormBean</B>()</PRE>
400
<A NAME="setFormBean(java.lang.String)"><!-- --></A><H3>
403
public void <B>setFormBean</B>(java.lang.String formBean)</PRE>
408
<A NAME="getForward()"><!-- --></A><H3>
411
public java.lang.String <B>getForward</B>()</PRE>
416
<A NAME="setForward(java.lang.String)"><!-- --></A><H3>
419
public void <B>setForward</B>(java.lang.String forward)</PRE>
424
<A NAME="getMapping()"><!-- --></A><H3>
427
public java.lang.String <B>getMapping</B>()</PRE>
432
<A NAME="setMapping(java.lang.String)"><!-- --></A><H3>
435
public void <B>setMapping</B>(java.lang.String mapping)</PRE>
440
<A NAME="doStartTag()"><!-- --></A><H3>
443
public int <B>doStartTag</B>()
444
throws javax.servlet.jsp.JspException</PRE>
446
<DD>Retrieve the required configuration object and expose it as a
447
scripting variable.<DD><DL>
448
<DT><B>Overrides:</B><DD><CODE>doStartTag</CODE> in class <CODE>javax.servlet.jsp.tagext.TagSupport</CODE></DL>
451
<DT><B>Throws:</B><DD><CODE>javax.servlet.jsp.JspException</CODE> - if a JSP exception has occurred</DL>
456
<A NAME="release()"><!-- --></A><H3>
459
public void <B>release</B>()</PRE>
461
<DD>Release all allocated resources.<DD><DL>
462
<DT><B>Overrides:</B><DD><CODE>release</CODE> in class <CODE>javax.servlet.jsp.tagext.TagSupport</CODE></DL>
465
<!-- ========= END OF CLASS DATA ========= -->
468
<!-- ========== START OF NAVBAR ========== -->
469
<A NAME="navbar_bottom"><!-- --></A>
470
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
472
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
473
<A NAME="navbar_bottom_firstrow"><!-- --></A>
474
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
475
<TR ALIGN="center" VALIGN="top">
476
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
477
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
478
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
479
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
480
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
481
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
482
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
486
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
492
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
493
<A HREF="../../../../../org/apache/struts/taglib/bean/SizeTei.html"><B>PREV CLASS</B></A>
494
<A HREF="../../../../../org/apache/struts/taglib/bean/StrutsTei.html"><B>NEXT CLASS</B></A></FONT></TD>
495
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
496
<A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
497
<A HREF="StrutsTag.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
500
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
501
SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
502
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
503
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
506
<!-- =========== END OF NAVBAR =========== -->
509
Copyright � 2000-2001 - Apache Software Foundation