| <!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> |
| ComponentDefinition (Apache Struts API Documentation) |
| </TITLE> |
| <META NAME="keywords" CONTENT="org.apache.struts.tiles.ComponentDefinition,ComponentDefinition class"> |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| </HEAD> |
| <SCRIPT> |
| function asd() |
| { |
| parent.document.title="ComponentDefinition (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/ComponentDefinition.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/ComponentContext.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/struts/tiles/ControllerSupport.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="ComponentDefinition.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 ComponentDefinition</H2> |
| <PRE> |
| java.lang.Object |
| | |
| +--<B>org.apache.struts.tiles.ComponentDefinition</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD> |
| </DL> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/struts/tiles/xmlDefinition/XmlDefinition.html">XmlDefinition</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT>public class <B>ComponentDefinition</B><DT>extends java.lang.Object<DT>implements java.io.Serializable</DL> |
| |
| <P> |
| Definition of a template / component attributes. |
| Attributes of a component can be defined with the help of this class. |
| An instance of this class can be used as a bean, and passed to 'insert' tag. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html" TARGET="org.apache.struts.tiles.ComponentDefinition">Serialized Form</A></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>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/ComponentDefinition.html#ACTION">ACTION</A></B></CODE> |
| |
| <BR> |
| Controller name type</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/ComponentDefinition.html#attributes">attributes</A></B></CODE> |
| |
| <BR> |
| Attributes defined for the component.</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/ComponentDefinition.html#controller">controller</A></B></CODE> |
| |
| <BR> |
| Associated Controller URL or classname, if defined</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/ComponentDefinition.html#CONTROLLER">CONTROLLER</A></B></CODE> |
| |
| <BR> |
| Controller name type</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private <A HREF="../../../../org/apache/struts/tiles/Controller.html">Controller</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/ComponentDefinition.html#controllerInstance">controllerInstance</A></B></CODE> |
| |
| <BR> |
| Controller associated to Definition.</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/ComponentDefinition.html#controllerType">controllerType</A></B></CODE> |
| |
| <BR> |
| Associated Controller typename, if controllerName defined.</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/ComponentDefinition.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 java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/ComponentDefinition.html#name">name</A></B></CODE> |
| |
| <BR> |
| Definition name</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/ComponentDefinition.html#path">path</A></B></CODE> |
| |
| <BR> |
| Component / template path (URL).</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/ComponentDefinition.html#role">role</A></B></CODE> |
| |
| <BR> |
| role associated to definition</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/ComponentDefinition.html#URL">URL</A></B></CODE> |
| |
| <BR> |
| Controller name type</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/ComponentDefinition.html#ComponentDefinition()">ComponentDefinition</A></B>()</CODE> |
| |
| <BR> |
| Constructor.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/ComponentDefinition.html#ComponentDefinition(org.apache.struts.tiles.ComponentDefinition)">ComponentDefinition</A></B>(<A HREF="../../../../org/apache/struts/tiles/ComponentDefinition.html">ComponentDefinition</A> definition)</CODE> |
| |
| <BR> |
| Copy Constructor.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/ComponentDefinition.html#ComponentDefinition(java.lang.String, java.lang.String, java.util.Map)">ComponentDefinition</A></B>(java.lang.String name, |
| java.lang.String path, |
| java.util.Map attributes)</CODE> |
| |
| <BR> |
| Constructor.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/ComponentDefinition.html#ComponentDefinition(org.apache.struts.tiles.xmlDefinition.XmlDefinition)">ComponentDefinition</A></B>(<A HREF="../../../../org/apache/struts/tiles/xmlDefinition/XmlDefinition.html">XmlDefinition</A> definition)</CODE> |
| |
| <BR> |
| Constructor.</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 <A HREF="../../../../org/apache/struts/tiles/Controller.html">Controller</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/ComponentDefinition.html#createController(java.lang.String, java.lang.String)">createController</A></B>(java.lang.String name, |
| java.lang.String controllerType)</CODE> |
| |
| <BR> |
| Create a new instance of controller named in parameter.</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/Controller.html">Controller</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/ComponentDefinition.html#createControllerFromClassname(java.lang.String)">createControllerFromClassname</A></B>(java.lang.String classname)</CODE> |
| |
| <BR> |
| Create a controller from specified classname</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Object</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/ComponentDefinition.html#getAttribute(java.lang.String)">getAttribute</A></B>(java.lang.String key)</CODE> |
| |
| <BR> |
| Returns the value of the named attribute as an Object, or null if no |
| attribute of the given name exists.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Map</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/ComponentDefinition.html#getAttributes()">getAttributes</A></B>()</CODE> |
| |
| <BR> |
| Access method for the attributes property.</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/ComponentDefinition.html#getController()">getController</A></B>()</CODE> |
| |
| <BR> |
| Get associated controller local URL.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/struts/tiles/Controller.html">Controller</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/ComponentDefinition.html#getControllerInstance()">getControllerInstance</A></B>()</CODE> |
| |
| <BR> |
| Get controller instance.</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/ComponentDefinition.html#getControllerType()">getControllerType</A></B>()</CODE> |
| |
| <BR> |
| Get associated controller type.</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/ComponentDefinition.html#getName()">getName</A></B>()</CODE> |
| |
| <BR> |
| Access method for the name property.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/struts/tiles/Controller.html">Controller</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/struts/tiles/ComponentDefinition.html#getOrCreateController()">getOrCreateController</A></B>()</CODE> |
| |
| <BR> |
| Get or create controller.</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/ComponentDefinition.html#getPage()">getPage</A></B>()</CODE> |
| |
| <BR> |
| Access method for the path property.</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/ComponentDefinition.html#getPath()">getPath</A></B>()</CODE> |
| |
| <BR> |
| Access method for the path property.</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/ComponentDefinition.html#getRole()">getRole</A></B>()</CODE> |
| |
| <BR> |
| Access method for the role property.</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/ComponentDefinition.html#getTemplate()">getTemplate</A></B>()</CODE> |
| |
| <BR> |
| Access method for the template property.</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/ComponentDefinition.html#put(java.lang.String, java.lang.Object)">put</A></B>(java.lang.String name, |
| java.lang.Object content)</CODE> |
| |
| <BR> |
| Put an attribute in component / template definition.</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/ComponentDefinition.html#put(java.lang.String, java.lang.Object, boolean)">put</A></B>(java.lang.String name, |
| java.lang.Object content, |
| boolean direct)</CODE> |
| |
| <BR> |
| Put an attribute in template definition.</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/ComponentDefinition.html#put(java.lang.String, java.lang.Object, boolean, java.lang.String)">put</A></B>(java.lang.String name, |
| java.lang.Object content, |
| boolean direct, |
| java.lang.String role)</CODE> |
| |
| <BR> |
| Put an attribute in template definition.</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/ComponentDefinition.html#put(java.lang.String, java.lang.Object, java.lang.String, java.lang.String)">put</A></B>(java.lang.String name, |
| java.lang.Object content, |
| java.lang.String type, |
| java.lang.String role)</CODE> |
| |
| <BR> |
| Put an attribute in template definition.</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/ComponentDefinition.html#putAttribute(java.lang.String, java.lang.Object)">putAttribute</A></B>(java.lang.String key, |
| java.lang.Object value)</CODE> |
| |
| <BR> |
| Put a new attribute in this component</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/ComponentDefinition.html#setController(java.lang.String)">setController</A></B>(java.lang.String url)</CODE> |
| |
| <BR> |
| Set associated controller URL.</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/ComponentDefinition.html#setControllerClass(java.lang.String)">setControllerClass</A></B>(java.lang.String controller)</CODE> |
| |
| <BR> |
| Set associated controller name as a classtype, and controller |
| type as "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/ComponentDefinition.html#setControllerInstance(org.apache.struts.tiles.Controller)">setControllerInstance</A></B>(<A HREF="../../../../org/apache/struts/tiles/Controller.html">Controller</A> controller)</CODE> |
| |
| <BR> |
| Set controller.</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/ComponentDefinition.html#setControllerType(java.lang.String)">setControllerType</A></B>(java.lang.String controllerType)</CODE> |
| |
| <BR> |
| Set associated controller type.</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/ComponentDefinition.html#setControllerUrl(java.lang.String)">setControllerUrl</A></B>(java.lang.String controller)</CODE> |
| |
| <BR> |
| Set associated controller name as an url, and controller |
| type as "url".</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/ComponentDefinition.html#setName(java.lang.String)">setName</A></B>(java.lang.String aName)</CODE> |
| |
| <BR> |
| Sets the value of the name property.</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/ComponentDefinition.html#setPage(java.lang.String)">setPage</A></B>(java.lang.String page)</CODE> |
| |
| <BR> |
| Sets the value of the path property.</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/ComponentDefinition.html#setPath(java.lang.String)">setPath</A></B>(java.lang.String aPath)</CODE> |
| |
| <BR> |
| Sets the value of the path property.</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/ComponentDefinition.html#setRole(java.lang.String)">setRole</A></B>(java.lang.String role)</CODE> |
| |
| <BR> |
| Sets the value of the role property.</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/ComponentDefinition.html#setTemplate(java.lang.String)">setTemplate</A></B>(java.lang.String template)</CODE> |
| |
| <BR> |
| Sets the value of the template property.</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/ComponentDefinition.html#toString()">toString</A></B>()</CODE> |
| |
| <BR> |
| </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, 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="name"><!-- --></A><H3> |
| name</H3> |
| <PRE> |
| protected java.lang.String <B>name</B></PRE> |
| <DL> |
| <DD>Definition name |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="path"><!-- --></A><H3> |
| path</H3> |
| <PRE> |
| protected java.lang.String <B>path</B></PRE> |
| <DL> |
| <DD>Component / template path (URL). |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="attributes"><!-- --></A><H3> |
| attributes</H3> |
| <PRE> |
| protected java.util.Map <B>attributes</B></PRE> |
| <DL> |
| <DD>Attributes defined for the component. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="role"><!-- --></A><H3> |
| role</H3> |
| <PRE> |
| protected java.lang.String <B>role</B></PRE> |
| <DL> |
| <DD>role associated to definition |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="controller"><!-- --></A><H3> |
| controller</H3> |
| <PRE> |
| protected java.lang.String <B>controller</B></PRE> |
| <DL> |
| <DD>Associated Controller URL or classname, if defined |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="controllerType"><!-- --></A><H3> |
| controllerType</H3> |
| <PRE> |
| protected java.lang.String <B>controllerType</B></PRE> |
| <DL> |
| <DD>Associated Controller typename, if controllerName defined. |
| Can be CONTROLLER, ACTION or URL, or null |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="URL"><!-- --></A><H3> |
| URL</H3> |
| <PRE> |
| public static final java.lang.String <B>URL</B></PRE> |
| <DL> |
| <DD>Controller name type |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.struts.tiles.ComponentDefinition.URL">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="CONTROLLER"><!-- --></A><H3> |
| CONTROLLER</H3> |
| <PRE> |
| public static final java.lang.String <B>CONTROLLER</B></PRE> |
| <DL> |
| <DD>Controller name type |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.struts.tiles.ComponentDefinition.CONTROLLER">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="ACTION"><!-- --></A><H3> |
| ACTION</H3> |
| <PRE> |
| public static final java.lang.String <B>ACTION</B></PRE> |
| <DL> |
| <DD>Controller name type |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.struts.tiles.ComponentDefinition.ACTION">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="controllerInstance"><!-- --></A><H3> |
| controllerInstance</H3> |
| <PRE> |
| private <A HREF="../../../../org/apache/struts/tiles/Controller.html">Controller</A> <B>controllerInstance</B></PRE> |
| <DL> |
| <DD>Controller associated to Definition. |
| Lazy creation : only on first request |
| <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="ComponentDefinition()"><!-- --></A><H3> |
| ComponentDefinition</H3> |
| <PRE> |
| public <B>ComponentDefinition</B>()</PRE> |
| <DL> |
| <DD>Constructor. |
| <P> |
| </DL> |
| <HR> |
| |
| <A NAME="ComponentDefinition(org.apache.struts.tiles.ComponentDefinition)"><!-- --></A><H3> |
| ComponentDefinition</H3> |
| <PRE> |
| public <B>ComponentDefinition</B>(<A HREF="../../../../org/apache/struts/tiles/ComponentDefinition.html">ComponentDefinition</A> definition)</PRE> |
| <DL> |
| <DD>Copy Constructor. |
| Create a new definition initialized with parent definition. |
| Do a shallow copy : attributes are shared between copies, but not the Map |
| containing attributes. |
| <P> |
| </DL> |
| <HR> |
| |
| <A NAME="ComponentDefinition(org.apache.struts.tiles.xmlDefinition.XmlDefinition)"><!-- --></A><H3> |
| ComponentDefinition</H3> |
| <PRE> |
| public <B>ComponentDefinition</B>(<A HREF="../../../../org/apache/struts/tiles/xmlDefinition/XmlDefinition.html">XmlDefinition</A> definition)</PRE> |
| <DL> |
| <DD>Constructor. |
| Create a new definition initialized from a RawDefinition. |
| Raw definitions are used to read definition from a data source (xml file, db, ...). |
| A RawDefinition mainly contains properties of type String, while Definition |
| contains more complex type (ex : Controller). |
| Do a shallow copy : attributes are shared between objects, but not the Map |
| containing attributes. |
| OO Design issues : Actually RawDefinition (XmlDefinition) extends ComponentDefinition. |
| This must not be the case. I have do it because I am lazy. |
| <P> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.InstantiationException</CODE> - if an error occur while instanciating Controller : |
| (classname can't be instanciated, Illegal access with instanciated class, |
| Error while instanciating class, classname can't be instanciated.</DL> |
| <HR> |
| |
| <A NAME="ComponentDefinition(java.lang.String, java.lang.String, java.util.Map)"><!-- --></A><H3> |
| ComponentDefinition</H3> |
| <PRE> |
| public <B>ComponentDefinition</B>(java.lang.String name, |
| java.lang.String path, |
| java.util.Map attributes)</PRE> |
| <DL> |
| <DD>Constructor. |
| <P> |
| </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="getName()"><!-- --></A><H3> |
| getName</H3> |
| <PRE> |
| public java.lang.String <B>getName</B>()</PRE> |
| <DL> |
| <DD>Access method for the name property. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the current value of the name property</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setName(java.lang.String)"><!-- --></A><H3> |
| setName</H3> |
| <PRE> |
| public void <B>setName</B>(java.lang.String aName)</PRE> |
| <DL> |
| <DD>Sets the value of the name property. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>aName</CODE> - the new value of the name property</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPage()"><!-- --></A><H3> |
| getPage</H3> |
| <PRE> |
| public java.lang.String <B>getPage</B>()</PRE> |
| <DL> |
| <DD>Access method for the path property. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the current value of the path property</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPage(java.lang.String)"><!-- --></A><H3> |
| setPage</H3> |
| <PRE> |
| public void <B>setPage</B>(java.lang.String page)</PRE> |
| <DL> |
| <DD>Sets the value of the path property. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getPath()"><!-- --></A><H3> |
| getPath</H3> |
| <PRE> |
| public java.lang.String <B>getPath</B>()</PRE> |
| <DL> |
| <DD>Access method for the path property. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the current value of the path property</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setPath(java.lang.String)"><!-- --></A><H3> |
| setPath</H3> |
| <PRE> |
| public void <B>setPath</B>(java.lang.String aPath)</PRE> |
| <DL> |
| <DD>Sets the value of the path property. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>aPath</CODE> - the new value of the path property</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTemplate()"><!-- --></A><H3> |
| getTemplate</H3> |
| <PRE> |
| public java.lang.String <B>getTemplate</B>()</PRE> |
| <DL> |
| <DD>Access method for the template property. |
| Same as getPath() |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the current value of the template property</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setTemplate(java.lang.String)"><!-- --></A><H3> |
| setTemplate</H3> |
| <PRE> |
| public void <B>setTemplate</B>(java.lang.String template)</PRE> |
| <DL> |
| <DD>Sets the value of the template property. |
| Same as setPath() |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>template</CODE> - the new value of the path property</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getRole()"><!-- --></A><H3> |
| getRole</H3> |
| <PRE> |
| public java.lang.String <B>getRole</B>()</PRE> |
| <DL> |
| <DD>Access method for the role property. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the current value of the role property</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setRole(java.lang.String)"><!-- --></A><H3> |
| setRole</H3> |
| <PRE> |
| public void <B>setRole</B>(java.lang.String role)</PRE> |
| <DL> |
| <DD>Sets the value of the role property. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>role</CODE> - the new value of the path property</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAttributes()"><!-- --></A><H3> |
| getAttributes</H3> |
| <PRE> |
| public java.util.Map <B>getAttributes</B>()</PRE> |
| <DL> |
| <DD>Access method for the attributes property. |
| If there is no attributes, return an empty map. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the current value of the attributes property</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAttribute(java.lang.String)"><!-- --></A><H3> |
| getAttribute</H3> |
| <PRE> |
| public java.lang.Object <B>getAttribute</B>(java.lang.String key)</PRE> |
| <DL> |
| <DD>Returns the value of the named attribute as an Object, or null if no |
| attribute of the given name exists. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>requested attribute or null if not found</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="putAttribute(java.lang.String, java.lang.Object)"><!-- --></A><H3> |
| putAttribute</H3> |
| <PRE> |
| public void <B>putAttribute</B>(java.lang.String key, |
| java.lang.Object value)</PRE> |
| <DL> |
| <DD>Put a new attribute in this component |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - String key for attribute<DD><CODE>value</CODE> - Attibute value.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="put(java.lang.String, java.lang.Object)"><!-- --></A><H3> |
| put</H3> |
| <PRE> |
| public void <B>put</B>(java.lang.String name, |
| java.lang.Object content)</PRE> |
| <DL> |
| <DD>Put an attribute in component / template definition. |
| Attribute can be used as content for tag get. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - Attribute name<DD><CODE>content</CODE> - Attribute value</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="put(java.lang.String, java.lang.Object, boolean)"><!-- --></A><H3> |
| put</H3> |
| <PRE> |
| public void <B>put</B>(java.lang.String name, |
| java.lang.Object content, |
| boolean direct)</PRE> |
| <DL> |
| <DD>Put an attribute in template definition. |
| Attribute can be used as content for tag get. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - Attribute name<DD><CODE>content</CODE> - Attribute value µ<DD><CODE>direct</CODE> - Determines how content is handled by get tag: true means content is printed directly; false, the default, means content is included</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="put(java.lang.String, java.lang.Object, boolean, java.lang.String)"><!-- --></A><H3> |
| put</H3> |
| <PRE> |
| public void <B>put</B>(java.lang.String name, |
| java.lang.Object content, |
| boolean direct, |
| java.lang.String role)</PRE> |
| <DL> |
| <DD>Put an attribute in template definition. |
| Attribute can be used as content for tag get. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - Attribute name<DD><CODE>content</CODE> - Attribute value<DD><CODE>direct</CODE> - Determines how content is handled by get tag: true means content is printed directly; false, the default, means content is included<DD><CODE>role</CODE> - Determine if content is used by get tag. If user is in role, content is used.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="put(java.lang.String, java.lang.Object, java.lang.String, java.lang.String)"><!-- --></A><H3> |
| put</H3> |
| <PRE> |
| public void <B>put</B>(java.lang.String name, |
| java.lang.Object content, |
| java.lang.String type, |
| java.lang.String role)</PRE> |
| <DL> |
| <DD>Put an attribute in template definition. |
| Attribute can be used as content for tag get. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - Attribute name<DD><CODE>content</CODE> - Attribute value<DD><CODE>type</CODE> - attribute type: template, string, definition<DD><CODE>role</CODE> - Determine if content is used by get tag. If user is in role, content is used.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="toString()"><!-- --></A><H3> |
| toString</H3> |
| <PRE> |
| public java.lang.String <B>toString</B>()</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getControllerType()"><!-- --></A><H3> |
| getControllerType</H3> |
| <PRE> |
| public java.lang.String <B>getControllerType</B>()</PRE> |
| <DL> |
| <DD>Get associated controller type. |
| Type denote a fully qualified classname. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setControllerType(java.lang.String)"><!-- --></A><H3> |
| setControllerType</H3> |
| <PRE> |
| public void <B>setControllerType</B>(java.lang.String controllerType)</PRE> |
| <DL> |
| <DD>Set associated controller type. |
| Type denote a fully qualified classname. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>controllerType</CODE> - Typeof associated controller</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setControllerUrl(java.lang.String)"><!-- --></A><H3> |
| setControllerUrl</H3> |
| <PRE> |
| public void <B>setControllerUrl</B>(java.lang.String controller)</PRE> |
| <DL> |
| <DD>Set associated controller name as an url, and controller |
| type as "url". |
| Name must be an url (not checked). |
| Convenience method. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>controller</CODE> - Controller url</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setControllerClass(java.lang.String)"><!-- --></A><H3> |
| setControllerClass</H3> |
| <PRE> |
| public void <B>setControllerClass</B>(java.lang.String controller)</PRE> |
| <DL> |
| <DD>Set associated controller name as a classtype, and controller |
| type as "classname". |
| Name denote a fully qualified classname |
| Convenience method. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>controller</CODE> - Controller classname.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getController()"><!-- --></A><H3> |
| getController</H3> |
| <PRE> |
| public java.lang.String <B>getController</B>()</PRE> |
| <DL> |
| <DD>Get associated controller local URL. |
| URL should be local to webcontainer in order to allow request context followup. |
| URL comes as a string. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setController(java.lang.String)"><!-- --></A><H3> |
| setController</H3> |
| <PRE> |
| public void <B>setController</B>(java.lang.String url)</PRE> |
| <DL> |
| <DD>Set associated controller URL. |
| URL should be local to webcontainer in order to allow request context followup. |
| URL is specified as a string. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>url</CODE> - Url called locally</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getControllerInstance()"><!-- --></A><H3> |
| getControllerInstance</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/tiles/Controller.html">Controller</A> <B>getControllerInstance</B>()</PRE> |
| <DL> |
| <DD>Get controller instance. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>controller instance.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getOrCreateController()"><!-- --></A><H3> |
| getOrCreateController</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/struts/tiles/Controller.html">Controller</A> <B>getOrCreateController</B>() |
| throws java.lang.InstantiationException</PRE> |
| <DL> |
| <DD>Get or create controller. |
| Get controller, create it if necessary. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>controller if controller or controllerType is set, null otherwise. |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.InstantiationException</CODE> - if an error occur while instanciating Controller : |
| (classname can't be instanciated, Illegal access with instanciated class, |
| Error while instanciating class, classname can't be instanciated.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setControllerInstance(org.apache.struts.tiles.Controller)"><!-- --></A><H3> |
| setControllerInstance</H3> |
| <PRE> |
| public void <B>setControllerInstance</B>(<A HREF="../../../../org/apache/struts/tiles/Controller.html">Controller</A> controller)</PRE> |
| <DL> |
| <DD>Set controller. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createController(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| createController</H3> |
| <PRE> |
| public static <A HREF="../../../../org/apache/struts/tiles/Controller.html">Controller</A> <B>createController</B>(java.lang.String name, |
| java.lang.String controllerType) |
| throws java.lang.InstantiationException</PRE> |
| <DL> |
| <DD>Create a new instance of controller named in parameter. |
| If controllerType is specified, create controller accordingly. |
| Otherwise, if name denote a classname, create an instance of it. If class is |
| subclass of org.apache.struts.action.Action, wrap controller |
| appropriately. |
| Otherwise, consider name as an url. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - Controller name (classname, url, ...)<DD><CODE>controllerType</CODE> - Expected Controller type |
| <DT><B>Returns:</B><DD>org.apache.struts.tiles.Controller |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.InstantiationException</CODE> - if an error occur while instanciating Controller : |
| (classname can't be instanciated, Illegal access with instanciated class, |
| Error while instanciating class, classname can't be instanciated.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createControllerFromClassname(java.lang.String)"><!-- --></A><H3> |
| createControllerFromClassname</H3> |
| <PRE> |
| public static <A HREF="../../../../org/apache/struts/tiles/Controller.html">Controller</A> <B>createControllerFromClassname</B>(java.lang.String classname) |
| throws java.lang.InstantiationException</PRE> |
| <DL> |
| <DD>Create a controller from specified classname |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>classname</CODE> - Controller classname. |
| <DT><B>Returns:</B><DD>org.apache.struts.tiles.Controller |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.InstantiationException</CODE> - if an error occur while instanciating Controller : |
| (classname can't be instanciated, Illegal access with instanciated class, |
| Error while instanciating class, classname can't be instanciated.</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/ComponentDefinition.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/ComponentContext.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/struts/tiles/ControllerSupport.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="ComponentDefinition.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> |
