| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc on Fri Aug 22 03:44:00 EDT 2003 --> |
| <TITLE> |
| TilesUtil (Apache Struts API Documentation) |
| </TITLE> |
| <META NAME="keywords" CONTENT="org.apache.struts.tiles.TilesUtil,TilesUtil class"> |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| </HEAD> |
| <SCRIPT> |
| function asd() |
| { |
| parent.document.title="TilesUtil (Apache Struts API Documentation)"; |
| } |
| </SCRIPT> |
| <BODY BGCOLOR="white" onload="asd();"> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_top"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/TilesUtil.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/struts/tiles/TilesServlet.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/struts/tiles/TilesUtilImpl.html"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="TilesUtil.html" TARGET="_top"><B>NO FRAMES</B></A> |
| |
| <SCRIPT> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> |
| </NOSCRIPT> |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.struts.tiles</FONT> |
| <BR> |
| Class TilesUtil</H2> |
| <PRE> |
| java.lang.Object |
| | |
| +--<B>org.apache.struts.tiles.TilesUtil</B> |
| </PRE> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/struts/tiles/DefinitionsUtil.html">DefinitionsUtil</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT>public class <B>TilesUtil</B><DT>extends java.lang.Object</DL> |
| |
| <P> |
| Class containing utility methods for Tiles. |
| Methods of this class are static and thereby accessible from anywhere. |
| The underlying implementation can be changed with |
| <A HREF="../../../../org/apache/struts/tiles/TilesUtil.html#setTilesUtil(org.apache.struts.tiles.TilesUtilImpl)"><CODE>setTilesUtil(TilesUtilImpl)</CODE></A>. |
| <br> |
| Real implementation classes should derive from the <A HREF="../../../../org/apache/struts/tiles/TilesUtilImpl.html"><CODE>TilesUtilImpl</CODE></A> class. |
| <br> |
| Some methods are specified to throw the <code>UnsupportedOperationException</code> |
| if the underlying implementation doesn't support the operation. |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private static boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtil.html#implAlreadySet">implAlreadySet</A></B></CODE> |
| |
| <BR> |
| Flag to know if internal implementation has been set by the setter method</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected static org.apache.commons.logging.Log</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtil.html#log">log</A></B></CODE> |
| |
| <BR> |
| Commons Logging instance.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected static <A HREF="../../../../org/apache/struts/tiles/TilesUtilImpl.html">TilesUtilImpl</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtil.html#tilesUtilImpl">tilesUtilImpl</A></B></CODE> |
| |
| <BR> |
| The implementation of tilesUtilImpl</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtil.html#TilesUtil()">TilesUtil</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.Class</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtil.html#applicationClass(java.lang.String)">applicationClass</A></B>(java.lang.String className)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Use RequestUtils.applicationClass() instead.</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactory.html">DefinitionsFactory</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtil.html#createDefinitionsFactory(javax.servlet.ServletContext, org.apache.struts.tiles.DefinitionsFactoryConfig)">createDefinitionsFactory</A></B>(javax.servlet.ServletContext servletContext, |
| <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryConfig.html">DefinitionsFactoryConfig</A> factoryConfig)</CODE> |
| |
| <BR> |
| Create Definition factory from specified configuration object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtil.html#doForward(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.ServletContext)">doForward</A></B>(java.lang.String uri, |
| javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response, |
| javax.servlet.ServletContext servletContext)</CODE> |
| |
| <BR> |
| Do a forward using request dispatcher.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtil.html#doInclude(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.ServletContext)">doInclude</A></B>(java.lang.String uri, |
| javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response, |
| javax.servlet.ServletContext servletContext)</CODE> |
| |
| <BR> |
| Do an include using request dispatcher.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtil.html#doInclude(java.lang.String, javax.servlet.jsp.PageContext)">doInclude</A></B>(java.lang.String uri, |
| javax.servlet.jsp.PageContext pageContext)</CODE> |
| |
| <BR> |
| Do an include using PageContext.include().</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../org/apache/struts/tiles/ComponentDefinition.html">ComponentDefinition</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtil.html#getDefinition(java.lang.String, javax.servlet.ServletRequest, javax.servlet.ServletContext)">getDefinition</A></B>(java.lang.String definitionName, |
| javax.servlet.ServletRequest request, |
| javax.servlet.ServletContext servletContext)</CODE> |
| |
| <BR> |
| Get a definition by its name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactory.html">DefinitionsFactory</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtil.html#getDefinitionsFactory(javax.servlet.ServletRequest, javax.servlet.ServletContext)">getDefinitionsFactory</A></B>(javax.servlet.ServletRequest request, |
| javax.servlet.ServletContext servletContext)</CODE> |
| |
| <BR> |
| Get definition factory from appropriate servlet context.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../org/apache/struts/tiles/TilesUtilImpl.html">TilesUtilImpl</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtil.html#getTilesUtil()">getTilesUtil</A></B>()</CODE> |
| |
| <BR> |
| Get the real implementation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>(package private) static boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtil.html#isTilesUtilImplSet()">isTilesUtilImplSet</A></B>()</CODE> |
| |
| <BR> |
| Getter to know if the underlying implementation is already set to another |
| value than the default value.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtil.html#setTilesUtil(org.apache.struts.tiles.TilesUtilImpl)">setTilesUtil</A></B>(<A HREF="../../../../org/apache/struts/tiles/TilesUtilImpl.html">TilesUtilImpl</A> tilesUtil)</CODE> |
| |
| <BR> |
| Set the real implementation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesUtil.html#testReset()">testReset</A></B>()</CODE> |
| |
| <BR> |
| Reset internal state.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from class java.lang.Object</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="log"><!-- --></A><H3> |
| log</H3> |
| <PRE> |
| protected static org.apache.commons.logging.Log <B>log</B></PRE> |
| <DL> |
| <DD>Commons Logging instance. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="tilesUtilImpl"><!-- --></A><H3> |
| tilesUtilImpl</H3> |
| <PRE> |
| protected static <A HREF="../../../../org/apache/struts/tiles/TilesUtilImpl.html">TilesUtilImpl</A> <B>tilesUtilImpl</B></PRE> |
| <DL> |
| <DD>The implementation of tilesUtilImpl |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="implAlreadySet"><!-- --></A><H3> |
| implAlreadySet</H3> |
| <PRE> |
| private static boolean <B>implAlreadySet</B></PRE> |
| <DL> |
| <DD>Flag to know if internal implementation has been set by the setter method |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="TilesUtil()"><!-- --></A><H3> |
| TilesUtil</H3> |
| <PRE> |
| public <B>TilesUtil</B>()</PRE> |
| <DL> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getTilesUtil()"><!-- --></A><H3> |
| getTilesUtil</H3> |
| <PRE> |
| public static <A HREF="../../../../org/apache/struts/tiles/TilesUtilImpl.html">TilesUtilImpl</A> <B>getTilesUtil</B>()</PRE> |
| <DL> |
| <DD>Get the real implementation. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The underlying implementation object.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setTilesUtil(org.apache.struts.tiles.TilesUtilImpl)"><!-- --></A><H3> |
| setTilesUtil</H3> |
| <PRE> |
| public static void <B>setTilesUtil</B>(<A HREF="../../../../org/apache/struts/tiles/TilesUtilImpl.html">TilesUtilImpl</A> tilesUtil)</PRE> |
| <DL> |
| <DD>Set the real implementation. |
| This method should be called only once. |
| Successive calls have no effect. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>tilesUtil</CODE> - The implementaion.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isTilesUtilImplSet()"><!-- --></A><H3> |
| isTilesUtilImplSet</H3> |
| <PRE> |
| static boolean <B>isTilesUtilImplSet</B>()</PRE> |
| <DL> |
| <DD>Getter to know if the underlying implementation is already set to another |
| value than the default value. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code> if <A HREF="../../../../org/apache/struts/tiles/TilesUtil.html#setTilesUtil(org.apache.struts.tiles.TilesUtilImpl)"><CODE>setTilesUtil(org.apache.struts.tiles.TilesUtilImpl)</CODE></A> has already been called.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="doForward(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.ServletContext)"><!-- --></A><H3> |
| doForward</H3> |
| <PRE> |
| public static void <B>doForward</B>(java.lang.String uri, |
| javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response, |
| javax.servlet.ServletContext servletContext) |
| throws java.io.IOException, |
| javax.servlet.ServletException</PRE> |
| <DL> |
| <DD>Do a forward using request dispatcher. |
| |
| This method is used by the Tiles package anytime a forward is required. |
| <P> |
| <DD><DL> |
| <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. |
| <DD><CODE>java.io.IOException</CODE> |
| <DD><CODE>javax.servlet.ServletException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="doInclude(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.ServletContext)"><!-- --></A><H3> |
| doInclude</H3> |
| <PRE> |
| public static void <B>doInclude</B>(java.lang.String uri, |
| javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response, |
| javax.servlet.ServletContext servletContext) |
| throws java.io.IOException, |
| javax.servlet.ServletException</PRE> |
| <DL> |
| <DD>Do an include using request dispatcher. |
| |
| This method is used by the Tiles package when an include is required. |
| The Tiles package can use indifferently any form of this method. |
| <P> |
| <DD><DL> |
| <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. |
| <DD><CODE>java.io.IOException</CODE> |
| <DD><CODE>javax.servlet.ServletException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="doInclude(java.lang.String, javax.servlet.jsp.PageContext)"><!-- --></A><H3> |
| doInclude</H3> |
| <PRE> |
| public static void <B>doInclude</B>(java.lang.String uri, |
| javax.servlet.jsp.PageContext pageContext) |
| throws java.io.IOException, |
| javax.servlet.ServletException</PRE> |
| <DL> |
| <DD>Do an include using PageContext.include(). |
| |
| This method is used by the Tiles package when an include is required. |
| The Tiles package can use indifferently any form of this method. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>uri</CODE> - Uri or Definition name to forward. |
| <DD><CODE>java.io.IOException</CODE> |
| <DD><CODE>javax.servlet.ServletException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDefinitionsFactory(javax.servlet.ServletRequest, javax.servlet.ServletContext)"><!-- --></A><H3> |
| getDefinitionsFactory</H3> |
| <PRE> |
| public static <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactory.html">DefinitionsFactory</A> <B>getDefinitionsFactory</B>(javax.servlet.ServletRequest request, |
| javax.servlet.ServletContext servletContext)</PRE> |
| <DL> |
| <DD>Get definition factory from appropriate servlet context. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Definitions factory or <code>null</code> if not found.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createDefinitionsFactory(javax.servlet.ServletContext, org.apache.struts.tiles.DefinitionsFactoryConfig)"><!-- --></A><H3> |
| createDefinitionsFactory</H3> |
| <PRE> |
| public static <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactory.html">DefinitionsFactory</A> <B>createDefinitionsFactory</B>(javax.servlet.ServletContext servletContext, |
| <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryConfig.html">DefinitionsFactoryConfig</A> factoryConfig) |
| throws <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></PRE> |
| <DL> |
| <DD>Create Definition factory from specified configuration object. |
| Create a ConfigurableDefinitionsFactory and initialize it with the configuration |
| object. This later can contain the factory classname to use. |
| Factory is made accessible from tags. |
| <p> |
| Fallback of several factory creation methods. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>servletContext</CODE> - Servlet Context passed to newly created factory.<DD><CODE>factoryConfig</CODE> - Configuration object passed to factory. |
| <DT><B>Returns:</B><DD>newly created factory of type ConfigurableDefinitionsFactory. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></CODE> - If an error occur while initializing factory</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDefinition(java.lang.String, javax.servlet.ServletRequest, javax.servlet.ServletContext)"><!-- --></A><H3> |
| getDefinition</H3> |
| <PRE> |
| public static <A HREF="../../../../org/apache/struts/tiles/ComponentDefinition.html">ComponentDefinition</A> <B>getDefinition</B>(java.lang.String definitionName, |
| javax.servlet.ServletRequest request, |
| javax.servlet.ServletContext servletContext) |
| throws <A HREF="../../../../org/apache/struts/tiles/FactoryNotFoundException.html">FactoryNotFoundException</A>, |
| <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></PRE> |
| <DL> |
| <DD>Get a definition by its name. |
| First, retrieve definition factory and then get requested definition. |
| Throw appropriate exception if definition or definition factory is not found. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>definitionName</CODE> - Name of requested definition.<DD><CODE>request</CODE> - Current servelet request.<DD><CODE>servletContext</CODE> - current servlet context. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/struts/tiles/FactoryNotFoundException.html">FactoryNotFoundException</A></CODE> - Can't find definition factory. |
| <DD><CODE><A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></CODE> - General error in factory while getting definition. |
| <DD><CODE><A HREF="../../../../org/apache/struts/tiles/NoSuchDefinitionException.html">NoSuchDefinitionException</A></CODE> - No definition found for specified name</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="applicationClass(java.lang.String)"><!-- --></A><H3> |
| applicationClass</H3> |
| <PRE> |
| public static java.lang.Class <B>applicationClass</B>(java.lang.String className) |
| throws java.lang.ClassNotFoundException</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Use RequestUtils.applicationClass() instead.</I> |
| <P> |
| <DD>Return the <code>Class</code> object for the specified fully qualified |
| class name from the underlying class loader. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>className</CODE> - Fully qualified class name to be loaded. |
| <DT><B>Returns:</B><DD>Class object. |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.ClassNotFoundException</CODE> - if the class cannot be found</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="testReset()"><!-- --></A><H3> |
| testReset</H3> |
| <PRE> |
| protected static void <B>testReset</B>()</PRE> |
| <DL> |
| <DD>Reset internal state. |
| This method is used by test suites to reset the class to its original state. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/TilesUtil.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/struts/tiles/TilesServlet.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/struts/tiles/TilesUtilImpl.html"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="TilesUtil.html" TARGET="_top"><B>NO FRAMES</B></A> |
| |
| <SCRIPT> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A> |
| </NOSCRIPT> |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| Copyright © 2000-2003 - Apache Software Foundation |
| </BODY> |
| </HTML> |
