📄 tilesplugin.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Thu Mar 09 15:31:25 GMT 2006 -->
<TITLE>
Apache Struts API Documentation: Class TilesPlugin
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 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></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | <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>
<DL>
<DT><B>Since: </B><DD>Struts 1.1</DD>
</DL>
<HR>
<P>
<!-- ======== INNER 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>private void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesPlugin.html#initDefinitionsFactory(javax.servlet.ServletContext, org.apache.struts.config.ModuleConfig, org.apache.struts.tiles.DefinitionsFactoryConfig)">initDefinitionsFactory</A></B>(javax.servlet.ServletContext servletContext, <A HREF="../../../../org/apache/struts/config/ModuleConfig.html">ModuleConfig</A> moduleConfig, <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryConfig.html">DefinitionsFactoryConfig</A> factoryConfig)</CODE>
<BR>
Initialize the DefinitionsFactory this module will use.</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>private void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/TilesPlugin.html#initTilesUtil()">initTilesUtil</A></B>()</CODE>
<BR>
Set TilesUtil implementation according to properties 'tilesUtilImplClassname' and 'moduleAware'.</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><clinit>, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, 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>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -