| <!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> |
| TilesPlugin (Apache Struts API Documentation) |
| </TITLE> |
| <META NAME="keywords" CONTENT="org.apache.struts.tiles.TilesPlugin,TilesPlugin class"> |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| </HEAD> |
| <SCRIPT> |
| function asd() |
| { |
| parent.document.title="TilesPlugin (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/TilesPlugin.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/PathAttribute.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/struts/tiles/TilesRequestProcessor.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="TilesPlugin.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 TilesPlugin</H2> |
| <PRE> |
| java.lang.Object |
| | |
| +--<B>org.apache.struts.tiles.TilesPlugin</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/struts/action/PlugIn.html">PlugIn</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT>public class <B>TilesPlugin</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../org/apache/struts/action/PlugIn.html">PlugIn</A></DL> |
| |
| <P> |
| Tiles Plugin used to initialize Tiles. |
| This plugin is to be used with Struts 1.1 in association with |
| <A HREF="../../../../org/apache/struts/tiles/TilesRequestProcessor.html"><CODE>TilesRequestProcessor</CODE></A>. |
| <br> |
| This plugin creates one definition factory for each Struts-module. The definition factory |
| configuration is read first from 'web.xml' (backward compatibility), then it is |
| overloaded with values found in the plugin property values. |
| <br> |
| The plugin changes the Struts configuration by specifying a <A HREF="../../../../org/apache/struts/tiles/TilesRequestProcessor.html"><CODE>TilesRequestProcessor</CODE></A> as |
| request processor. If you want to use your own RequestProcessor, |
| it should subclass TilesRequestProcessor. |
| <br> |
| This plugin can also be used to create one single factory for all modules. |
| This behavior is enabled by specifying <code>moduleAware=false</code> in each |
| plugin properties. In this case, the definition factory |
| configuration file is read by the first Tiles plugin to be initialized. The order is |
| determined by the order of modules declaration in web.xml. The first module |
| is always the default one if it exists. |
| The plugin should be declared in each struts-config.xml file in order to |
| properly initialize the request processor. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| <DT><B>Author:</B></DT> |
| <DD>Cedric Dumoulin</DD> |
| </DL> |
| <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>protected <A HREF="../../../../org/apache/struts/config/PlugInConfig.html">PlugInConfig</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesPlugin.html#currentPlugInConfigObject">currentPlugInConfigObject</A></B></CODE> |
| |
| <BR> |
| The plugin config object provided by the ActionServlet initializing |
| this plugin.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactory.html">DefinitionsFactory</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesPlugin.html#definitionFactory">definitionFactory</A></B></CODE> |
| |
| <BR> |
| Associated definition factory</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/TilesPlugin.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 boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesPlugin.html#moduleAware">moduleAware</A></B></CODE> |
| |
| <BR> |
| Is the factory module aware ?</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesPlugin.html#tilesUtilImplClassname">tilesUtilImplClassname</A></B></CODE> |
| |
| <BR> |
| Tiles util implementation classname.</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/TilesPlugin.html#TilesPlugin()">TilesPlugin</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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesPlugin.html#destroy()">destroy</A></B>()</CODE> |
| |
| <BR> |
| End plugin.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.util.Map</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesPlugin.html#findStrutsPlugInConfigProperties(org.apache.struts.action.ActionServlet, org.apache.struts.config.ModuleConfig)">findStrutsPlugInConfigProperties</A></B>(<A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> servlet, |
| <A HREF="../../../../org/apache/struts/config/ModuleConfig.html">ModuleConfig</A> config)</CODE> |
| |
| <BR> |
| Find original properties set in the Struts PlugInConfig object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesPlugin.html#getTilesUtilImplClassname()">getTilesUtilImplClassname</A></B>()</CODE> |
| |
| <BR> |
| Get Tiles util implemention classname.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesPlugin.html#init(org.apache.struts.action.ActionServlet, org.apache.struts.config.ModuleConfig)">init</A></B>(<A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> servlet, |
| <A HREF="../../../../org/apache/struts/config/ModuleConfig.html">ModuleConfig</A> moduleConfig)</CODE> |
| |
| <BR> |
| Receive notification that the specified module is being |
| started up.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesPlugin.html#initRequestProcessorClass(org.apache.struts.config.ModuleConfig)">initRequestProcessorClass</A></B>(<A HREF="../../../../org/apache/struts/config/ModuleConfig.html">ModuleConfig</A> config)</CODE> |
| |
| <BR> |
| Set RequestProcessor to appropriate Tiles <A HREF="../../../../org/apache/struts/action/RequestProcessor.html"><CODE>RequestProcessor</CODE></A>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesPlugin.html#isModuleAware()">isModuleAware</A></B>()</CODE> |
| |
| <BR> |
| Get the module aware flag.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryConfig.html">DefinitionsFactoryConfig</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesPlugin.html#readFactoryConfig(org.apache.struts.action.ActionServlet, org.apache.struts.config.ModuleConfig)">readFactoryConfig</A></B>(<A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> servlet, |
| <A HREF="../../../../org/apache/struts/config/ModuleConfig.html">ModuleConfig</A> config)</CODE> |
| |
| <BR> |
| Create FactoryConfig and initialize it from web.xml and struts-config.xml.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesPlugin.html#setCurrentPlugInConfigObject(org.apache.struts.config.PlugInConfig)">setCurrentPlugInConfigObject</A></B>(<A HREF="../../../../org/apache/struts/config/PlugInConfig.html">PlugInConfig</A> plugInConfigObject)</CODE> |
| |
| <BR> |
| Method used by the ActionServlet initializing this plugin.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesPlugin.html#setModuleAware(boolean)">setModuleAware</A></B>(boolean moduleAware)</CODE> |
| |
| <BR> |
| Set the module aware flag.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesPlugin.html#setTilesUtilImplClassname(java.lang.String)">setTilesUtilImplClassname</A></B>(java.lang.String tilesUtilImplClassname)</CODE> |
| |
| <BR> |
| Set Tiles util implemention classname.</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="moduleAware"><!-- --></A><H3> |
| moduleAware</H3> |
| <PRE> |
| protected boolean <B>moduleAware</B></PRE> |
| <DL> |
| <DD>Is the factory module aware ? |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="tilesUtilImplClassname"><!-- --></A><H3> |
| tilesUtilImplClassname</H3> |
| <PRE> |
| protected java.lang.String <B>tilesUtilImplClassname</B></PRE> |
| <DL> |
| <DD>Tiles util implementation classname. This property can be set |
| by user in the plugin declaration |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="definitionFactory"><!-- --></A><H3> |
| definitionFactory</H3> |
| <PRE> |
| protected <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactory.html">DefinitionsFactory</A> <B>definitionFactory</B></PRE> |
| <DL> |
| <DD>Associated definition factory |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="currentPlugInConfigObject"><!-- --></A><H3> |
| currentPlugInConfigObject</H3> |
| <PRE> |
| protected <A HREF="../../../../org/apache/struts/config/PlugInConfig.html">PlugInConfig</A> <B>currentPlugInConfigObject</B></PRE> |
| <DL> |
| <DD>The plugin config object provided by the ActionServlet initializing |
| this plugin. |
| <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="TilesPlugin()"><!-- --></A><H3> |
| TilesPlugin</H3> |
| <PRE> |
| public <B>TilesPlugin</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="isModuleAware()"><!-- --></A><H3> |
| isModuleAware</H3> |
| <PRE> |
| public boolean <B>isModuleAware</B>()</PRE> |
| <DL> |
| <DD>Get the module aware flag. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code>: user wants a single factory instance, |
| <code>false:</code> user wants multiple factory instances (one per module with Struts)</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setModuleAware(boolean)"><!-- --></A><H3> |
| setModuleAware</H3> |
| <PRE> |
| public void <B>setModuleAware</B>(boolean moduleAware)</PRE> |
| <DL> |
| <DD>Set the module aware flag. |
| This flag is only meaningful if the property <code>tilesUtilImplClassname</code> is not |
| set. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>moduleAware</CODE> - <code>true</code>: user wants a single factory instance, |
| <code>false:</code> user wants multiple factory instances (one per module with Struts)</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="init(org.apache.struts.action.ActionServlet, org.apache.struts.config.ModuleConfig)"><!-- --></A><H3> |
| init</H3> |
| <PRE> |
| public void <B>init</B>(<A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> servlet, |
| <A HREF="../../../../org/apache/struts/config/ModuleConfig.html">ModuleConfig</A> moduleConfig) |
| throws javax.servlet.ServletException</PRE> |
| <DL> |
| <DD><p>Receive notification that the specified module is being |
| started up.</p> |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/action/PlugIn.html#init(org.apache.struts.action.ActionServlet, org.apache.struts.config.ModuleConfig)">init</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/action/PlugIn.html">PlugIn</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>servlet</CODE> - ActionServlet that is managing all the modules |
| in this web application.<DD><CODE>moduleConfig</CODE> - ModuleConfig for the module with which |
| this plugin is associated. |
| <DT><B>Throws:</B> |
| <DD><CODE>javax.servlet.ServletException</CODE> - if this <code>PlugIn</code> cannot |
| be successfully initialized.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="destroy()"><!-- --></A><H3> |
| destroy</H3> |
| <PRE> |
| public void <B>destroy</B>()</PRE> |
| <DL> |
| <DD>End plugin. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/struts/action/PlugIn.html#destroy()">destroy</A></CODE> in interface <CODE><A HREF="../../../../org/apache/struts/action/PlugIn.html">PlugIn</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="readFactoryConfig(org.apache.struts.action.ActionServlet, org.apache.struts.config.ModuleConfig)"><!-- --></A><H3> |
| readFactoryConfig</H3> |
| <PRE> |
| protected <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryConfig.html">DefinitionsFactoryConfig</A> <B>readFactoryConfig</B>(<A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> servlet, |
| <A HREF="../../../../org/apache/struts/config/ModuleConfig.html">ModuleConfig</A> config) |
| throws javax.servlet.ServletException</PRE> |
| <DL> |
| <DD>Create FactoryConfig and initialize it from web.xml and struts-config.xml. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>servlet</CODE> - ActionServlet that is managing all the modules |
| in this web application.<DD><CODE>config</CODE> - ModuleConfig for the module with which |
| this plugin is associated. |
| <DT><B>Throws:</B> |
| <DD><CODE>javax.servlet.ServletException</CODE> - if this <code>PlugIn</code> cannot |
| be successfully initialized.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findStrutsPlugInConfigProperties(org.apache.struts.action.ActionServlet, org.apache.struts.config.ModuleConfig)"><!-- --></A><H3> |
| findStrutsPlugInConfigProperties</H3> |
| <PRE> |
| protected java.util.Map <B>findStrutsPlugInConfigProperties</B>(<A HREF="../../../../org/apache/struts/action/ActionServlet.html">ActionServlet</A> servlet, |
| <A HREF="../../../../org/apache/struts/config/ModuleConfig.html">ModuleConfig</A> config) |
| throws javax.servlet.ServletException</PRE> |
| <DL> |
| <DD>Find original properties set in the Struts PlugInConfig object. |
| First, we need to find the index of this plugin. Then we retrieve the array of configs |
| and then the object for this plugin. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>servlet</CODE> - ActionServlet that is managing all the modules |
| in this web application.<DD><CODE>config</CODE> - ModuleConfig for the module with which |
| this plug in is associated. |
| <DT><B>Throws:</B> |
| <DD><CODE>javax.servlet.ServletException</CODE> - if this <code>PlugIn</code> cannot |
| be successfully initialized.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="initRequestProcessorClass(org.apache.struts.config.ModuleConfig)"><!-- --></A><H3> |
| initRequestProcessorClass</H3> |
| <PRE> |
| protected void <B>initRequestProcessorClass</B>(<A HREF="../../../../org/apache/struts/config/ModuleConfig.html">ModuleConfig</A> config) |
| throws javax.servlet.ServletException</PRE> |
| <DL> |
| <DD>Set RequestProcessor to appropriate Tiles <A HREF="../../../../org/apache/struts/action/RequestProcessor.html"><CODE>RequestProcessor</CODE></A>. |
| First, check if a RequestProcessor is specified. If yes, check if it extends |
| the appropriate <A HREF="../../../../org/apache/struts/tiles/TilesRequestProcessor.html"><CODE>TilesRequestProcessor</CODE></A> class. If not, set processor class to |
| TilesRequestProcessor. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>config</CODE> - ModuleConfig for the module with which |
| this plugin is associated. |
| <DT><B>Throws:</B> |
| <DD><CODE>javax.servlet.ServletException</CODE> - On errors.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setTilesUtilImplClassname(java.lang.String)"><!-- --></A><H3> |
| setTilesUtilImplClassname</H3> |
| <PRE> |
| public void <B>setTilesUtilImplClassname</B>(java.lang.String tilesUtilImplClassname)</PRE> |
| <DL> |
| <DD>Set Tiles util implemention classname. |
| If this property is set, the flag <code>moduleAware</code> will not be used anymore. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>tilesUtilImplClassname</CODE> - Classname.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTilesUtilImplClassname()"><!-- --></A><H3> |
| getTilesUtilImplClassname</H3> |
| <PRE> |
| public java.lang.String <B>getTilesUtilImplClassname</B>()</PRE> |
| <DL> |
| <DD>Get Tiles util implemention classname. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The classname or <code>null</code> if none is set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setCurrentPlugInConfigObject(org.apache.struts.config.PlugInConfig)"><!-- --></A><H3> |
| setCurrentPlugInConfigObject</H3> |
| <PRE> |
| public void <B>setCurrentPlugInConfigObject</B>(<A HREF="../../../../org/apache/struts/config/PlugInConfig.html">PlugInConfig</A> plugInConfigObject)</PRE> |
| <DL> |
| <DD>Method used by the ActionServlet initializing this plugin. |
| Set the plugin config object read from module config. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>plugInConfigObject</CODE> - PlugInConfig.</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/TilesPlugin.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/PathAttribute.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/struts/tiles/TilesRequestProcessor.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="TilesPlugin.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> |
