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 InsertTag
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/template/GetTag.html"><B>PREV CLASS</B></A>
39
<A HREF="../../../../../org/apache/struts/taglib/template/PutTag.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="InsertTag.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.template</FONT>
63
+--javax.servlet.jsp.tagext.TagSupport
65
+--<B>org.apache.struts.taglib.template.InsertTag</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>InsertTag</B><DT>extends javax.servlet.jsp.tagext.TagSupport</DL>
75
This is the tag handler for <template:insert>, which includes
76
a template. The tag's body content consists of <template:put>
77
tags, which are accessed by <template:get> in the template.
80
<DT><B>Version: </B><DD>$Revision: 1.1 $ $Date: 2001/09/17 20:11:40 $</DD>
81
<DT><B>Author: </B><DD>David Geary</DD>
82
<DT><B>See Also: </B><DD><A HREF="../../../../../serialized-form.html#org.apache.struts.taglib.template.InsertTag">Serialized Form</A></DL>
86
<!-- ======== INNER CLASS SUMMARY ======== -->
89
<!-- =========== FIELD SUMMARY =========== -->
91
<A NAME="field_summary"><!-- --></A>
92
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
93
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
94
<TD COLSPAN=2><FONT SIZE="+2">
95
<B>Field Summary</B></FONT></TD>
97
<TR BGCOLOR="white" CLASS="TableRowColor">
98
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
99
<CODE>private <A HREF="../../../../../org/apache/struts/taglib/template/util/ContentMap.html">ContentMap</A></CODE></FONT></TD>
100
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/template/InsertTag.html#map">map</A></B></CODE>
103
Each insert tag has a map of content.</TD>
105
<TR BGCOLOR="white" CLASS="TableRowColor">
106
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
107
<CODE>private java.lang.String</CODE></FONT></TD>
108
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/template/InsertTag.html#template">template</A></B></CODE>
111
The URI of the template.</TD>
114
<A NAME="fields_inherited_from_class_javax.servlet.jsp.tagext.TagSupport"><!-- --></A>
115
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
116
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
117
<TD><B>Fields inherited from class javax.servlet.jsp.tagext.TagSupport</B></TD>
119
<TR BGCOLOR="white" CLASS="TableRowColor">
120
<TD><CODE>id, pageContext, parent, values</CODE></TD>
123
<A NAME="fields_inherited_from_class_javax.servlet.jsp.tagext.IterationTag"><!-- --></A>
124
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
125
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
126
<TD><B>Fields inherited from interface javax.servlet.jsp.tagext.IterationTag</B></TD>
128
<TR BGCOLOR="white" CLASS="TableRowColor">
129
<TD><CODE>EVAL_BODY_AGAIN</CODE></TD>
132
<A NAME="fields_inherited_from_class_javax.servlet.jsp.tagext.Tag"><!-- --></A>
133
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
134
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
135
<TD><B>Fields inherited from interface javax.servlet.jsp.tagext.Tag</B></TD>
137
<TR BGCOLOR="white" CLASS="TableRowColor">
138
<TD><CODE>EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE</CODE></TD>
142
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
144
<A NAME="constructor_summary"><!-- --></A>
145
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
146
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
147
<TD COLSPAN=2><FONT SIZE="+2">
148
<B>Constructor Summary</B></FONT></TD>
150
<TR BGCOLOR="white" CLASS="TableRowColor">
151
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/template/InsertTag.html#InsertTag()">InsertTag</A></B>()</CODE>
154
</TD>
158
<!-- ========== METHOD SUMMARY =========== -->
160
<A NAME="method_summary"><!-- --></A>
161
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
162
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
163
<TD COLSPAN=2><FONT SIZE="+2">
164
<B>Method Summary</B></FONT></TD>
166
<TR BGCOLOR="white" CLASS="TableRowColor">
167
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168
<CODE> int</CODE></FONT></TD>
169
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/template/InsertTag.html#doEndTag()">doEndTag</A></B>()</CODE>
172
Process the end tag by including the template.</TD>
174
<TR BGCOLOR="white" CLASS="TableRowColor">
175
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
176
<CODE> int</CODE></FONT></TD>
177
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/template/InsertTag.html#doStartTag()">doStartTag</A></B>()</CODE>
180
Process the start tag by pushing this tag's map onto the
181
content map stack.</TD>
183
<TR BGCOLOR="white" CLASS="TableRowColor">
184
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
185
<CODE> <A HREF="../../../../../org/apache/struts/taglib/template/util/ContentMap.html">ContentMap</A></CODE></FONT></TD>
186
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/template/InsertTag.html#getContentMap()">getContentMap</A></B>()</CODE>
189
Get the map attribute.</TD>
191
<TR BGCOLOR="white" CLASS="TableRowColor">
192
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
193
<CODE> java.lang.String</CODE></FONT></TD>
194
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/template/InsertTag.html#getTemplate()">getTemplate</A></B>()</CODE>
197
Get the template attribute.</TD>
199
<TR BGCOLOR="white" CLASS="TableRowColor">
200
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
201
<CODE> void</CODE></FONT></TD>
202
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/template/InsertTag.html#put(java.lang.String, org.apache.struts.taglib.template.util.Content)">put</A></B>(java.lang.String name,
203
<A HREF="../../../../../org/apache/struts/taglib/template/util/Content.html">Content</A> content)</CODE>
206
This method is a convenience for <template:put> tags for
207
putting content into the map.</TD>
209
<TR BGCOLOR="white" CLASS="TableRowColor">
210
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
211
<CODE> void</CODE></FONT></TD>
212
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/template/InsertTag.html#release()">release</A></B>()</CODE>
215
Reset member values for reuse.</TD>
217
<TR BGCOLOR="white" CLASS="TableRowColor">
218
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
219
<CODE>private void</CODE></FONT></TD>
220
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/template/InsertTag.html#saveException(java.lang.Throwable)">saveException</A></B>(java.lang.Throwable exception)</CODE>
223
Save the specified exception in request scope if there is not already
226
<TR BGCOLOR="white" CLASS="TableRowColor">
227
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
228
<CODE> void</CODE></FONT></TD>
229
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/template/InsertTag.html#setTemplate(java.lang.String)">setTemplate</A></B>(java.lang.String template)</CODE>
232
Set the template attribute.</TD>
235
<A NAME="methods_inherited_from_class_javax.servlet.jsp.tagext.TagSupport"><!-- --></A>
236
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
237
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
238
<TD><B>Methods inherited from class javax.servlet.jsp.tagext.TagSupport</B></TD>
240
<TR BGCOLOR="white" CLASS="TableRowColor">
241
<TD><CODE>doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue</CODE></TD>
244
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
245
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
246
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
247
<TD><B>Methods inherited from class java.lang.Object</B></TD>
249
<TR BGCOLOR="white" CLASS="TableRowColor">
250
<TD><CODE><clinit>, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait</CODE></TD>
256
<!-- ============ FIELD DETAIL =========== -->
258
<A NAME="field_detail"><!-- --></A>
259
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
260
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
261
<TD COLSPAN=1><FONT SIZE="+2">
262
<B>Field Detail</B></FONT></TD>
266
<A NAME="map"><!-- --></A><H3>
269
private <A HREF="../../../../../org/apache/struts/taglib/template/util/ContentMap.html">ContentMap</A> <B>map</B></PRE>
271
<DD>Each insert tag has a map of content.</DL>
274
<A NAME="template"><!-- --></A><H3>
277
private java.lang.String <B>template</B></PRE>
279
<DD>The URI of the template.</DL>
281
<!-- ========= CONSTRUCTOR DETAIL ======== -->
283
<A NAME="constructor_detail"><!-- --></A>
284
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
285
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
286
<TD COLSPAN=1><FONT SIZE="+2">
287
<B>Constructor Detail</B></FONT></TD>
291
<A NAME="InsertTag()"><!-- --></A><H3>
294
public <B>InsertTag</B>()</PRE>
298
<!-- ============ METHOD DETAIL ========== -->
300
<A NAME="method_detail"><!-- --></A>
301
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
302
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
303
<TD COLSPAN=1><FONT SIZE="+2">
304
<B>Method Detail</B></FONT></TD>
308
<A NAME="setTemplate(java.lang.String)"><!-- --></A><H3>
311
public void <B>setTemplate</B>(java.lang.String template)</PRE>
313
<DD>Set the template attribute.</DL>
316
<A NAME="getTemplate()"><!-- --></A><H3>
319
public java.lang.String <B>getTemplate</B>()</PRE>
321
<DD>Get the template attribute.</DL>
324
<A NAME="getContentMap()"><!-- --></A><H3>
327
public <A HREF="../../../../../org/apache/struts/taglib/template/util/ContentMap.html">ContentMap</A> <B>getContentMap</B>()</PRE>
329
<DD>Get the map attribute.</DL>
332
<A NAME="doStartTag()"><!-- --></A><H3>
335
public int <B>doStartTag</B>()
336
throws javax.servlet.jsp.JspException</PRE>
338
<DD>Process the start tag by pushing this tag's map onto the
340
See org.apache.struts.taglib.template.util.ContentMapStack.<DD><DL>
341
<DT><B>Overrides:</B><DD><CODE>doStartTag</CODE> in class <CODE>javax.servlet.jsp.tagext.TagSupport</CODE></DL>
346
<A NAME="doEndTag()"><!-- --></A><H3>
349
public int <B>doEndTag</B>()
350
throws javax.servlet.jsp.JspException</PRE>
352
<DD>Process the end tag by including the template.<DD><DL>
353
<DT><B>Overrides:</B><DD><CODE>doEndTag</CODE> in class <CODE>javax.servlet.jsp.tagext.TagSupport</CODE></DL>
358
<A NAME="put(java.lang.String, org.apache.struts.taglib.template.util.Content)"><!-- --></A><H3>
361
public void <B>put</B>(java.lang.String name,
362
<A HREF="../../../../../org/apache/struts/taglib/template/util/Content.html">Content</A> content)</PRE>
364
<DD>This method is a convenience for <template:put> tags for
365
putting content into the map.</DL>
368
<A NAME="release()"><!-- --></A><H3>
371
public void <B>release</B>()</PRE>
373
<DD>Reset member values for reuse. This method calls super.release(),
374
which invokes TagSupport.release(), which typically does nothing.<DD><DL>
375
<DT><B>Overrides:</B><DD><CODE>release</CODE> in class <CODE>javax.servlet.jsp.tagext.TagSupport</CODE></DL>
380
<A NAME="saveException(java.lang.Throwable)"><!-- --></A><H3>
383
private void <B>saveException</B>(java.lang.Throwable exception)</PRE>
385
<DD>Save the specified exception in request scope if there is not already
387
<DT><B>Parameters:</B><DD><CODE>exception</CODE> - Exception to be conditionally saved</DL>
390
<!-- ========= END OF CLASS DATA ========= -->
393
<!-- ========== START OF NAVBAR ========== -->
394
<A NAME="navbar_bottom"><!-- --></A>
395
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
397
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
398
<A NAME="navbar_bottom_firstrow"><!-- --></A>
399
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
400
<TR ALIGN="center" VALIGN="top">
401
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
402
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
403
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
404
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
405
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
406
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
407
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
411
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
417
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
418
<A HREF="../../../../../org/apache/struts/taglib/template/GetTag.html"><B>PREV CLASS</B></A>
419
<A HREF="../../../../../org/apache/struts/taglib/template/PutTag.html"><B>NEXT CLASS</B></A></FONT></TD>
420
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
421
<A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
422
<A HREF="InsertTag.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
425
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
426
SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
427
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
428
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
431
<!-- =========== END OF NAVBAR =========== -->
434
Copyright � 2000-2001 - Apache Software Foundation