📄 tilesplugin.html
字号:
<DD>Commons Logging instance.</DL>
<HR>
<A NAME="moduleAware"><!-- --></A><H3>
moduleAware</H3>
<PRE>
protected boolean <B>moduleAware</B></PRE>
<DL>
<DD>Is the factory module aware?</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.</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.</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.</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.<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.<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><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="initTilesUtil()"><!-- --></A><H3>
initTilesUtil</H3>
<PRE>
private void <B>initTilesUtil</B>() throws javax.servlet.ServletException</PRE>
<DL>
<DD>Set TilesUtil implementation according to properties 'tilesUtilImplClassname' and 'moduleAware'. These properties are taken into account only once. A side effect is that only the values set in the first initialized plugin are effectively taken into account.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B><DD><CODE>javax.servlet.ServletException</CODE> - </DL>
</DD>
</DL>
<HR>
<A NAME="initDefinitionsFactory(javax.servlet.ServletContext, org.apache.struts.config.ModuleConfig, org.apache.struts.tiles.DefinitionsFactoryConfig)"><!-- --></A><H3>
initDefinitionsFactory</H3>
<PRE>
private void <B>initDefinitionsFactory</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) throws javax.servlet.ServletException</PRE>
<DL>
<DD>Initialize the DefinitionsFactory this module will use.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>servletContext</CODE> - <DD><CODE>moduleConfig</CODE> - <DD><CODE>factoryConfig</CODE> - <DT><B>Throws:</B><DD><CODE>javax.servlet.ServletException</CODE> - </DL>
</DD>
</DL>
<HR>
<A NAME="destroy()"><!-- --></A><H3>
destroy</H3>
<PRE>
public void <B>destroy</B>()</PRE>
<DL>
<DD>End plugin.<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>
</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.<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.<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.<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.<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.<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.<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=2 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></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>
Copyright ⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -