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

« back to all changes in this revision

Viewing changes to legacy/api-1.1/org/apache/struts/tiles/TilesUtilImpl.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 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
 
2
<!--NewPage-->
 
3
<HTML>
 
4
<HEAD>
 
5
<!-- Generated by javadoc on Fri Aug 22 03:44:00 EDT 2003 -->
 
6
<TITLE>
 
7
TilesUtilImpl (Apache Struts API Documentation)
 
8
</TITLE>
 
9
<META NAME="keywords" CONTENT="org.apache.struts.tiles.TilesUtilImpl,TilesUtilImpl class">
 
10
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
 
11
</HEAD>
 
12
<SCRIPT>
 
13
function asd()
 
14
{
 
15
parent.document.title="TilesUtilImpl (Apache Struts API Documentation)";
 
16
}
 
17
</SCRIPT>
 
18
<BODY BGCOLOR="white" onload="asd();">
 
19
 
 
20
<!-- ========== START OF NAVBAR ========== -->
 
21
<A NAME="navbar_top"><!-- --></A>
 
22
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
 
23
<TR>
 
24
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 
25
<A NAME="navbar_top_firstrow"><!-- --></A>
 
26
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
 
27
  <TR ALIGN="center" VALIGN="top">
 
28
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 
29
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 
30
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 
31
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/TilesUtilImpl.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 
32
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 
33
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 
34
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 
35
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 
36
  </TR>
 
37
</TABLE>
 
38
</TD>
 
39
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 
40
</EM>
 
41
</TD>
 
42
</TR>
 
43
 
 
44
<TR>
 
45
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
46
&nbsp;<A HREF="../../../../org/apache/struts/tiles/TilesUtil.html"><B>PREV CLASS</B></A>&nbsp;
 
47
&nbsp;<A HREF="../../../../org/apache/struts/tiles/TilesUtilStrutsImpl.html"><B>NEXT CLASS</B></A></FONT></TD>
 
48
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
49
  <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
 
50
&nbsp;<A HREF="TilesUtilImpl.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
 
51
&nbsp;
 
52
<SCRIPT>
 
53
  <!--
 
54
  if(window==top) {
 
55
    document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
 
56
  }
 
57
  //-->
 
58
</SCRIPT>
 
59
<NOSCRIPT>
 
60
<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
 
61
</NOSCRIPT>
 
62
</FONT></TD>
 
63
</TR>
 
64
<TR>
 
65
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
66
  SUMMARY:&nbsp;NESTED&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>
 
67
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
68
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>
 
69
</TR>
 
70
</TABLE>
 
71
<!-- =========== END OF NAVBAR =========== -->
 
72
 
 
73
<HR>
 
74
<!-- ======== START OF CLASS DATA ======== -->
 
75
<H2>
 
76
<FONT SIZE="-1">
 
77
org.apache.struts.tiles</FONT>
 
78
<BR>
 
79
Class TilesUtilImpl</H2>
 
80
<PRE>
 
81
java.lang.Object
 
82
  |
 
83
  +--<B>org.apache.struts.tiles.TilesUtilImpl</B>
 
84
</PRE>
 
85
<DL>
 
86
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
 
87
</DL>
 
88
<DL>
 
89
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/struts/tiles/TilesUtilStrutsImpl.html">TilesUtilStrutsImpl</A></DD>
 
90
</DL>
 
91
<HR>
 
92
<DL>
 
93
<DT>public class <B>TilesUtilImpl</B><DT>extends java.lang.Object<DT>implements java.io.Serializable</DL>
 
94
 
 
95
<P>
 
96
Default implementation of TilesUtil.
 
97
 This class contains default implementation of utilities. This implementation
 
98
 is intended to be used without Struts.
 
99
<P>
 
100
 
 
101
<P>
 
102
<DL>
 
103
<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html" TARGET="org.apache.struts.tiles.TilesUtilImpl">Serialized Form</A></DL>
 
104
<HR>
 
105
 
 
106
<P>
 
107
<!-- ======== NESTED CLASS SUMMARY ======== -->
 
108
 
 
109
 
 
110
<!-- =========== FIELD SUMMARY =========== -->
 
111
 
 
112
<A NAME="field_summary"><!-- --></A>
 
113
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
114
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
115
<TD COLSPAN=2><FONT SIZE="+2">
 
116
<B>Field Summary</B></FONT></TD>
 
117
</TR>
 
118
<TR BGCOLOR="white" CLASS="TableRowColor">
 
119
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
120
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
 
121
<TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtilImpl.html#DEFINITIONS_FACTORY">DEFINITIONS_FACTORY</A></B></CODE>
 
122
 
 
123
<BR>
 
124
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constant name used to store factory in servlet context</TD>
 
125
</TR>
 
126
<TR BGCOLOR="white" CLASS="TableRowColor">
 
127
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
128
<CODE>protected &nbsp;org.apache.commons.logging.Log</CODE></FONT></TD>
 
129
<TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtilImpl.html#log">log</A></B></CODE>
 
130
 
 
131
<BR>
 
132
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Commons Logging instance.</TD>
 
133
</TR>
 
134
</TABLE>
 
135
&nbsp;
 
136
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
 
137
 
 
138
<A NAME="constructor_summary"><!-- --></A>
 
139
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
140
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
141
<TD COLSPAN=2><FONT SIZE="+2">
 
142
<B>Constructor Summary</B></FONT></TD>
 
143
</TR>
 
144
<TR BGCOLOR="white" CLASS="TableRowColor">
 
145
<TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtilImpl.html#TilesUtilImpl()">TilesUtilImpl</A></B>()</CODE>
 
146
 
 
147
<BR>
 
148
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 
149
</TR>
 
150
</TABLE>
 
151
&nbsp;
 
152
<!-- ========== METHOD SUMMARY =========== -->
 
153
 
 
154
<A NAME="method_summary"><!-- --></A>
 
155
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
156
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
157
<TD COLSPAN=2><FONT SIZE="+2">
 
158
<B>Method Summary</B></FONT></TD>
 
159
</TR>
 
160
<TR BGCOLOR="white" CLASS="TableRowColor">
 
161
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
162
<CODE>&nbsp;java.lang.Class</CODE></FONT></TD>
 
163
<TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtilImpl.html#applicationClass(java.lang.String)">applicationClass</A></B>(java.lang.String&nbsp;className)</CODE>
 
164
 
 
165
<BR>
 
166
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Use RequestUtils.applicationClass() instead.</I></TD>
 
167
</TR>
 
168
<TR BGCOLOR="white" CLASS="TableRowColor">
 
169
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
170
<CODE>protected &nbsp;<A HREF="../../../../org/apache/struts/tiles/DefinitionsFactory.html">DefinitionsFactory</A></CODE></FONT></TD>
 
171
<TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtilImpl.html#createDefinitionFactoryInstance(java.lang.String)">createDefinitionFactoryInstance</A></B>(java.lang.String&nbsp;classname)</CODE>
 
172
 
 
173
<BR>
 
174
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create Definition factory of specified classname.</TD>
 
175
</TR>
 
176
<TR BGCOLOR="white" CLASS="TableRowColor">
 
177
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
178
<CODE>&nbsp;<A HREF="../../../../org/apache/struts/tiles/DefinitionsFactory.html">DefinitionsFactory</A></CODE></FONT></TD>
 
179
<TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtilImpl.html#createDefinitionsFactory(javax.servlet.ServletContext, org.apache.struts.tiles.DefinitionsFactoryConfig)">createDefinitionsFactory</A></B>(javax.servlet.ServletContext&nbsp;servletContext,
 
180
                         <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryConfig.html">DefinitionsFactoryConfig</A>&nbsp;factoryConfig)</CODE>
 
181
 
 
182
<BR>
 
183
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create Definition factory from specified configuration object.</TD>
 
184
</TR>
 
185
<TR BGCOLOR="white" CLASS="TableRowColor">
 
186
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
187
<CODE>&nbsp;void</CODE></FONT></TD>
 
188
<TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtilImpl.html#doForward(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.ServletContext)">doForward</A></B>(java.lang.String&nbsp;uri,
 
189
          javax.servlet.http.HttpServletRequest&nbsp;request,
 
190
          javax.servlet.http.HttpServletResponse&nbsp;response,
 
191
          javax.servlet.ServletContext&nbsp;servletContext)</CODE>
 
192
 
 
193
<BR>
 
194
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Do a forward using request dispatcher.</TD>
 
195
</TR>
 
196
<TR BGCOLOR="white" CLASS="TableRowColor">
 
197
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
198
<CODE>&nbsp;void</CODE></FONT></TD>
 
199
<TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtilImpl.html#doInclude(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.ServletContext)">doInclude</A></B>(java.lang.String&nbsp;uri,
 
200
          javax.servlet.http.HttpServletRequest&nbsp;request,
 
201
          javax.servlet.http.HttpServletResponse&nbsp;response,
 
202
          javax.servlet.ServletContext&nbsp;servletContext)</CODE>
 
203
 
 
204
<BR>
 
205
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Do an include using request dispatcher.</TD>
 
206
</TR>
 
207
<TR BGCOLOR="white" CLASS="TableRowColor">
 
208
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
209
<CODE>static&nbsp;void</CODE></FONT></TD>
 
210
<TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtilImpl.html#doInclude(java.lang.String, javax.servlet.jsp.PageContext)">doInclude</A></B>(java.lang.String&nbsp;uri,
 
211
          javax.servlet.jsp.PageContext&nbsp;pageContext)</CODE>
 
212
 
 
213
<BR>
 
214
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Do an include using PageContext.include().</TD>
 
215
</TR>
 
216
<TR BGCOLOR="white" CLASS="TableRowColor">
 
217
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
218
<CODE>&nbsp;<A HREF="../../../../org/apache/struts/tiles/DefinitionsFactory.html">DefinitionsFactory</A></CODE></FONT></TD>
 
219
<TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtilImpl.html#getDefinitionsFactory(javax.servlet.ServletRequest, javax.servlet.ServletContext)">getDefinitionsFactory</A></B>(javax.servlet.ServletRequest&nbsp;request,
 
220
                      javax.servlet.ServletContext&nbsp;servletContext)</CODE>
 
221
 
 
222
<BR>
 
223
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get definition factory from appropriate servlet context.</TD>
 
224
</TR>
 
225
<TR BGCOLOR="white" CLASS="TableRowColor">
 
226
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
227
<CODE>protected &nbsp;void</CODE></FONT></TD>
 
228
<TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtilImpl.html#makeDefinitionsFactoryAccessible(org.apache.struts.tiles.DefinitionsFactory, javax.servlet.ServletContext)">makeDefinitionsFactoryAccessible</A></B>(<A HREF="../../../../org/apache/struts/tiles/DefinitionsFactory.html">DefinitionsFactory</A>&nbsp;factory,
 
229
                                 javax.servlet.ServletContext&nbsp;servletContext)</CODE>
 
230
 
 
231
<BR>
 
232
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Make definition factory accessible to Tags.</TD>
 
233
</TR>
 
234
</TABLE>
 
235
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 
236
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
237
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 
238
<TD><B>Methods inherited from class java.lang.Object</B></TD>
 
239
</TR>
 
240
<TR BGCOLOR="white" CLASS="TableRowColor">
 
241
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
 
242
</TR>
 
243
</TABLE>
 
244
&nbsp;
 
245
<P>
 
246
 
 
247
<!-- ============ FIELD DETAIL =========== -->
 
248
 
 
249
<A NAME="field_detail"><!-- --></A>
 
250
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
251
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
252
<TD COLSPAN=1><FONT SIZE="+2">
 
253
<B>Field Detail</B></FONT></TD>
 
254
</TR>
 
255
</TABLE>
 
256
 
 
257
<A NAME="log"><!-- --></A><H3>
 
258
log</H3>
 
259
<PRE>
 
260
protected org.apache.commons.logging.Log <B>log</B></PRE>
 
261
<DL>
 
262
<DD>Commons Logging instance.
 
263
<P>
 
264
<DL>
 
265
</DL>
 
266
</DL>
 
267
<HR>
 
268
 
 
269
<A NAME="DEFINITIONS_FACTORY"><!-- --></A><H3>
 
270
DEFINITIONS_FACTORY</H3>
 
271
<PRE>
 
272
public static final java.lang.String <B>DEFINITIONS_FACTORY</B></PRE>
 
273
<DL>
 
274
<DD>Constant name used to store factory in servlet context
 
275
<P>
 
276
<DL>
 
277
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.struts.tiles.TilesUtilImpl.DEFINITIONS_FACTORY">Constant Field Values</A></DL>
 
278
</DL>
 
279
 
 
280
<!-- ========= CONSTRUCTOR DETAIL ======== -->
 
281
 
 
282
<A NAME="constructor_detail"><!-- --></A>
 
283
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
284
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
285
<TD COLSPAN=1><FONT SIZE="+2">
 
286
<B>Constructor Detail</B></FONT></TD>
 
287
</TR>
 
288
</TABLE>
 
289
 
 
290
<A NAME="TilesUtilImpl()"><!-- --></A><H3>
 
291
TilesUtilImpl</H3>
 
292
<PRE>
 
293
public <B>TilesUtilImpl</B>()</PRE>
 
294
<DL>
 
295
</DL>
 
296
 
 
297
<!-- ============ METHOD DETAIL ========== -->
 
298
 
 
299
<A NAME="method_detail"><!-- --></A>
 
300
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 
301
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
302
<TD COLSPAN=1><FONT SIZE="+2">
 
303
<B>Method Detail</B></FONT></TD>
 
304
</TR>
 
305
</TABLE>
 
306
 
 
307
<A NAME="doForward(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.ServletContext)"><!-- --></A><H3>
 
308
doForward</H3>
 
309
<PRE>
 
310
public void <B>doForward</B>(java.lang.String&nbsp;uri,
 
311
                      javax.servlet.http.HttpServletRequest&nbsp;request,
 
312
                      javax.servlet.http.HttpServletResponse&nbsp;response,
 
313
                      javax.servlet.ServletContext&nbsp;servletContext)
 
314
               throws java.io.IOException,
 
315
                      javax.servlet.ServletException</PRE>
 
316
<DL>
 
317
<DD>Do a forward using request dispatcher.
 
318
 
 
319
 This method is used by the Tiles package anytime a forward is required.
 
320
<P>
 
321
<DD><DL>
 
322
</DL>
 
323
</DD>
 
324
<DD><DL>
 
325
<DT><B>Parameters:</B><DD><CODE>uri</CODE> - Uri or Definition name to forward.<DD><CODE>request</CODE> - Current page request.<DD><CODE>servletContext</CODE> - Current servlet context.
 
326
<DD><CODE>java.io.IOException</CODE>
 
327
<DD><CODE>javax.servlet.ServletException</CODE></DL>
 
328
</DD>
 
329
</DL>
 
330
<HR>
 
331
 
 
332
<A NAME="doInclude(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.ServletContext)"><!-- --></A><H3>
 
333
doInclude</H3>
 
334
<PRE>
 
335
public void <B>doInclude</B>(java.lang.String&nbsp;uri,
 
336
                      javax.servlet.http.HttpServletRequest&nbsp;request,
 
337
                      javax.servlet.http.HttpServletResponse&nbsp;response,
 
338
                      javax.servlet.ServletContext&nbsp;servletContext)
 
339
               throws java.io.IOException,
 
340
                      javax.servlet.ServletException</PRE>
 
341
<DL>
 
342
<DD>Do an include using request dispatcher.
 
343
 
 
344
 This method is used by the Tiles package when an include is required.
 
345
 The Tiles package can use indifferently any form of this method.
 
346
<P>
 
347
<DD><DL>
 
348
</DL>
 
349
</DD>
 
350
<DD><DL>
 
351
<DT><B>Parameters:</B><DD><CODE>uri</CODE> - Uri or Definition name to forward.<DD><CODE>request</CODE> - Current page request.<DD><CODE>response</CODE> - Current page response.<DD><CODE>servletContext</CODE> - Current servlet context.
 
352
<DD><CODE>java.io.IOException</CODE>
 
353
<DD><CODE>javax.servlet.ServletException</CODE></DL>
 
354
</DD>
 
355
</DL>
 
356
<HR>
 
357
 
 
358
<A NAME="doInclude(java.lang.String, javax.servlet.jsp.PageContext)"><!-- --></A><H3>
 
359
doInclude</H3>
 
360
<PRE>
 
361
public static void <B>doInclude</B>(java.lang.String&nbsp;uri,
 
362
                             javax.servlet.jsp.PageContext&nbsp;pageContext)
 
363
                      throws java.io.IOException,
 
364
                             javax.servlet.ServletException</PRE>
 
365
<DL>
 
366
<DD>Do an include using PageContext.include().
 
367
 
 
368
 This method is used by the Tiles package when an include is required.
 
369
 The Tiles package can use indifferently any form of this method.
 
370
<P>
 
371
<DD><DL>
 
372
</DL>
 
373
</DD>
 
374
<DD><DL>
 
375
<DT><B>Parameters:</B><DD><CODE>uri</CODE> - Uri or Definition name to forward.
 
376
<DD><CODE>java.io.IOException</CODE>
 
377
<DD><CODE>javax.servlet.ServletException</CODE></DL>
 
378
</DD>
 
379
</DL>
 
380
<HR>
 
381
 
 
382
<A NAME="getDefinitionsFactory(javax.servlet.ServletRequest, javax.servlet.ServletContext)"><!-- --></A><H3>
 
383
getDefinitionsFactory</H3>
 
384
<PRE>
 
385
public <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactory.html">DefinitionsFactory</A> <B>getDefinitionsFactory</B>(javax.servlet.ServletRequest&nbsp;request,
 
386
                                                javax.servlet.ServletContext&nbsp;servletContext)</PRE>
 
387
<DL>
 
388
<DD>Get definition factory from appropriate servlet context.
 
389
<P>
 
390
<DD><DL>
 
391
</DL>
 
392
</DD>
 
393
<DD><DL>
 
394
 
 
395
<DT><B>Returns:</B><DD>Definitions factory or <code>null</code> if not found.</DL>
 
396
</DD>
 
397
</DL>
 
398
<HR>
 
399
 
 
400
<A NAME="createDefinitionsFactory(javax.servlet.ServletContext, org.apache.struts.tiles.DefinitionsFactoryConfig)"><!-- --></A><H3>
 
401
createDefinitionsFactory</H3>
 
402
<PRE>
 
403
public <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactory.html">DefinitionsFactory</A> <B>createDefinitionsFactory</B>(javax.servlet.ServletContext&nbsp;servletContext,
 
404
                                                   <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryConfig.html">DefinitionsFactoryConfig</A>&nbsp;factoryConfig)
 
405
                                            throws <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></PRE>
 
406
<DL>
 
407
<DD>Create Definition factory from specified configuration object.
 
408
 Create an instance of the factory with the class specified in the config
 
409
 object. Then, initialize this factory and finally store the factory in
 
410
 appropriate context by calling
 
411
 <A HREF="../../../../org/apache/struts/tiles/TilesUtilImpl.html#makeDefinitionsFactoryAccessible(org.apache.struts.tiles.DefinitionsFactory, javax.servlet.ServletContext)"><CODE>makeDefinitionsFactoryAccessible(DefinitionsFactory, ServletContext)</CODE></A>.
 
412
 Factory creation is done by <A HREF="../../../../org/apache/struts/tiles/TilesUtilImpl.html#createDefinitionFactoryInstance(java.lang.String)"><CODE>createDefinitionFactoryInstance(String)</CODE></A>.
 
413
 <p>
 
414
<P>
 
415
<DD><DL>
 
416
</DL>
 
417
</DD>
 
418
<DD><DL>
 
419
<DT><B>Parameters:</B><DD><CODE>servletContext</CODE> - Servlet Context passed to newly created factory.<DD><CODE>factoryConfig</CODE> - Configuration object passed to factory.
 
420
<DT><B>Returns:</B><DD>newly created factory of type specified in the config object.
 
421
<DT><B>Throws:</B>
 
422
<DD><CODE><A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></CODE> - If an error occur while initializing factory</DL>
 
423
</DD>
 
424
</DL>
 
425
<HR>
 
426
 
 
427
<A NAME="createDefinitionFactoryInstance(java.lang.String)"><!-- --></A><H3>
 
428
createDefinitionFactoryInstance</H3>
 
429
<PRE>
 
430
protected <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactory.html">DefinitionsFactory</A> <B>createDefinitionFactoryInstance</B>(java.lang.String&nbsp;classname)
 
431
                                                      throws <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></PRE>
 
432
<DL>
 
433
<DD>Create Definition factory of specified classname.
 
434
 Factory class must extend the <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactory.html"><CODE>DefinitionsFactory</CODE></A> class.
 
435
 The factory is wrapped appropriately with <A HREF="../../../../org/apache/struts/tiles/definition/ComponentDefinitionsFactoryWrapper.html"><CODE>ComponentDefinitionsFactoryWrapper</CODE></A>
 
436
 if it is an instance of the deprecated ComponentDefinitionsFactory class.
 
437
<P>
 
438
<DD><DL>
 
439
</DL>
 
440
</DD>
 
441
<DD><DL>
 
442
<DT><B>Parameters:</B><DD><CODE>classname</CODE> - Class name of the factory to create.
 
443
<DT><B>Returns:</B><DD>newly created factory.
 
444
<DT><B>Throws:</B>
 
445
<DD><CODE><A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></CODE> - If an error occur while initializing factory</DL>
 
446
</DD>
 
447
</DL>
 
448
<HR>
 
449
 
 
450
<A NAME="makeDefinitionsFactoryAccessible(org.apache.struts.tiles.DefinitionsFactory, javax.servlet.ServletContext)"><!-- --></A><H3>
 
451
makeDefinitionsFactoryAccessible</H3>
 
452
<PRE>
 
453
protected void <B>makeDefinitionsFactoryAccessible</B>(<A HREF="../../../../org/apache/struts/tiles/DefinitionsFactory.html">DefinitionsFactory</A>&nbsp;factory,
 
454
                                                javax.servlet.ServletContext&nbsp;servletContext)</PRE>
 
455
<DL>
 
456
<DD>Make definition factory accessible to Tags.
 
457
 Factory is stored in servlet context.
 
458
<P>
 
459
<DD><DL>
 
460
</DL>
 
461
</DD>
 
462
<DD><DL>
 
463
<DT><B>Parameters:</B><DD><CODE>factory</CODE> - Factory to be made accessible.<DD><CODE>servletContext</CODE> - Current servlet context.</DL>
 
464
</DD>
 
465
</DL>
 
466
<HR>
 
467
 
 
468
<A NAME="applicationClass(java.lang.String)"><!-- --></A><H3>
 
469
applicationClass</H3>
 
470
<PRE>
 
471
public java.lang.Class <B>applicationClass</B>(java.lang.String&nbsp;className)
 
472
                                 throws java.lang.ClassNotFoundException</PRE>
 
473
<DL>
 
474
<DD><B>Deprecated.</B>&nbsp;<I>Use RequestUtils.applicationClass() instead.</I>
 
475
<P>
 
476
<DD>Return the <code>Class</code> object for the specified fully qualified
 
477
 class name from the underlying class loader.
 
478
<P>
 
479
<DD><DL>
 
480
</DL>
 
481
</DD>
 
482
<DD><DL>
 
483
<DT><B>Parameters:</B><DD><CODE>className</CODE> - Fully qualified class name to be loaded.
 
484
<DT><B>Returns:</B><DD>Class object.
 
485
<DT><B>Throws:</B>
 
486
<DD><CODE>java.lang.ClassNotFoundException</CODE> - if the class cannot be found</DL>
 
487
</DD>
 
488
</DL>
 
489
<!-- ========= END OF CLASS DATA ========= -->
 
490
<HR>
 
491
 
 
492
<!-- ========== START OF NAVBAR ========== -->
 
493
<A NAME="navbar_bottom"><!-- --></A>
 
494
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
 
495
<TR>
 
496
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 
497
<A NAME="navbar_bottom_firstrow"><!-- --></A>
 
498
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
 
499
  <TR ALIGN="center" VALIGN="top">
 
500
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 
501
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 
502
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 
503
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/TilesUtilImpl.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 
504
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 
505
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 
506
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 
507
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 
508
  </TR>
 
509
</TABLE>
 
510
</TD>
 
511
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 
512
</EM>
 
513
</TD>
 
514
</TR>
 
515
 
 
516
<TR>
 
517
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
518
&nbsp;<A HREF="../../../../org/apache/struts/tiles/TilesUtil.html"><B>PREV CLASS</B></A>&nbsp;
 
519
&nbsp;<A HREF="../../../../org/apache/struts/tiles/TilesUtilStrutsImpl.html"><B>NEXT CLASS</B></A></FONT></TD>
 
520
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
521
  <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
 
522
&nbsp;<A HREF="TilesUtilImpl.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
 
523
&nbsp;
 
524
<SCRIPT>
 
525
  <!--
 
526
  if(window==top) {
 
527
    document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
 
528
  }
 
529
  //-->
 
530
</SCRIPT>
 
531
<NOSCRIPT>
 
532
<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
 
533
</NOSCRIPT>
 
534
</FONT></TD>
 
535
</TR>
 
536
<TR>
 
537
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
538
  SUMMARY:&nbsp;NESTED&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>
 
539
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
540
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>
 
541
</TR>
 
542
</TABLE>
 
543
<!-- =========== END OF NAVBAR =========== -->
 
544
 
 
545
<HR>
 
546
Copyright � 2000-2003 - Apache Software Foundation
 
547
</BODY>
 
548
</HTML>