| <!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:43:59 EDT 2003 --> |
| <TITLE> |
| DefinitionsFactory (Apache Struts API Documentation) |
| </TITLE> |
| <META NAME="keywords" CONTENT="org.apache.struts.tiles.DefinitionsFactory,DefinitionsFactory interface"> |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| </HEAD> |
| <SCRIPT> |
| function asd() |
| { |
| parent.document.title="DefinitionsFactory (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/DefinitionsFactory.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/Controller.html"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="DefinitionsFactory.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <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> |
| Interface DefinitionsFactory</H2> |
| <DL> |
| <DT><B>All Superinterfaces:</B> <DD>java.io.Serializable</DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/struts/tiles/definition/ComponentDefinitionsFactoryWrapper.html">ComponentDefinitionsFactoryWrapper</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT>public interface <B>DefinitionsFactory</B><DT>extends java.io.Serializable</DL> |
| |
| <P> |
| Tiles Definition factory. |
| This interface replace old ComponentDefinitionsFactory. |
| Main method getDefinition() is exactly the same. Initialization method change. |
| This interface allows to retrieve a definition by its name, independently of |
| the factory implementation. |
| Object life cycle is as follow: |
| <ul> |
| <li>Constructor: create object</li> |
| <li>setConfig: set config and initialize factory. After first call to this |
| method, factory is operational.</li> |
| <li>destroy: factory is being shutdown.</li> |
| </ul> |
| Implementation must be Serializable, in order to be compliant with web Container |
| having this constraint (Weblogic 6.x). |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| |
| <!-- ========== 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/DefinitionsFactory.html#destroy()">destroy</A></B>()</CODE> |
| |
| <BR> |
| Receive notification that the factory is being |
| shut down.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryConfig.html">DefinitionsFactoryConfig</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/DefinitionsFactory.html#getConfig()">getConfig</A></B>()</CODE> |
| |
| <BR> |
| Get factory configuration.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/struts/tiles/ComponentDefinition.html">ComponentDefinition</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/DefinitionsFactory.html#getDefinition(java.lang.String, javax.servlet.ServletRequest, javax.servlet.ServletContext)">getDefinition</A></B>(java.lang.String name, |
| 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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/DefinitionsFactory.html#init(org.apache.struts.tiles.DefinitionsFactoryConfig, javax.servlet.ServletContext)">init</A></B>(<A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryConfig.html">DefinitionsFactoryConfig</A> config, |
| javax.servlet.ServletContext servletContext)</CODE> |
| |
| <BR> |
| Init definition factory.</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/DefinitionsFactory.html#setConfig(org.apache.struts.tiles.DefinitionsFactoryConfig, javax.servlet.ServletContext)">setConfig</A></B>(<A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryConfig.html">DefinitionsFactoryConfig</A> config, |
| javax.servlet.ServletContext servletContext)</CODE> |
| |
| <BR> |
| Set factory configuration.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| |
| <!-- ============ 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="getDefinition(java.lang.String, javax.servlet.ServletRequest, javax.servlet.ServletContext)"><!-- --></A><H3> |
| getDefinition</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/tiles/ComponentDefinition.html">ComponentDefinition</A> <B>getDefinition</B>(java.lang.String name, |
| javax.servlet.ServletRequest request, |
| javax.servlet.ServletContext servletContext) |
| throws <A HREF="../../../../org/apache/struts/tiles/NoSuchDefinitionException.html">NoSuchDefinitionException</A>, |
| <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></PRE> |
| <DL> |
| <DD>Get a definition by its name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</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/DefinitionsFactoryException.html">DefinitionsFactoryException</A></CODE> - An error occur while getting definition. |
| <DD><CODE><A HREF="../../../../org/apache/struts/tiles/NoSuchDefinitionException.html">NoSuchDefinitionException</A></CODE> - No definition found for specified name |
| Implementation can throw more accurate exception as a subclass of this exception</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="init(org.apache.struts.tiles.DefinitionsFactoryConfig, javax.servlet.ServletContext)"><!-- --></A><H3> |
| init</H3> |
| <PRE> |
| public void <B>init</B>(<A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryConfig.html">DefinitionsFactoryConfig</A> config, |
| javax.servlet.ServletContext servletContext) |
| throws <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></PRE> |
| <DL> |
| <DD>Init definition factory. |
| This method is called immediately after factory creation, and prior any call |
| to setConfig(). |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>config</CODE> - Configuration object used to set factory configuration.<DD><CODE>servletContext</CODE> - Servlet Context passed to factory. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></CODE> - An error occur during initialization.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="destroy()"><!-- --></A><H3> |
| destroy</H3> |
| <PRE> |
| public void <B>destroy</B>()</PRE> |
| <DL> |
| <DD><p>Receive notification that the factory is being |
| shut down.</p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setConfig(org.apache.struts.tiles.DefinitionsFactoryConfig, javax.servlet.ServletContext)"><!-- --></A><H3> |
| setConfig</H3> |
| <PRE> |
| public void <B>setConfig</B>(<A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryConfig.html">DefinitionsFactoryConfig</A> config, |
| javax.servlet.ServletContext servletContext) |
| throws <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></PRE> |
| <DL> |
| <DD>Set factory configuration. |
| This method is used to change factory configuration. |
| This method is optional, and can send an exception if implementation |
| doesn't allow change in configuration. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>config</CODE> - Configuration object used to set factory configuration.<DD><CODE>servletContext</CODE> - Servlet Context passed to factory. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryException.html">DefinitionsFactoryException</A></CODE> - An error occur during initialization.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getConfig()"><!-- --></A><H3> |
| getConfig</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/tiles/DefinitionsFactoryConfig.html">DefinitionsFactoryConfig</A> <B>getConfig</B>()</PRE> |
| <DL> |
| <DD>Get factory configuration. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>TilesConfig</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/DefinitionsFactory.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/Controller.html"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="DefinitionsFactory.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| Copyright © 2000-2003 - Apache Software Foundation |
| </BODY> |
| </HTML> |
