turbinetemplateservice.html

turbine教程

<DL>
<DD>Find the default layout module name for the given request.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/template/TemplateService.html#getDefaultLayoutName(org.apache.turbine.util.RunData)">getDefaultLayoutName</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/services/template/TemplateService.html">TemplateService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>data</CODE> - The encapsulation of the request to retrieve the
             default layout for.<DT><B>Returns:</B><DD>The default layout module name.</DL>
</DD>
</DL>
<HR>

<A NAME="getScreenName(java.lang.String)"><!-- --></A><H3>
getScreenName</H3>
<PRE>
public java.lang.String <B>getScreenName</B>(java.lang.String&nbsp;template)
                               throws java.lang.Exception</PRE>
<DL>
<DD>Locate and return the name of the screen module to be used
 with the named screen template.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/template/TemplateService.html#getScreenName(java.lang.String)">getScreenName</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/services/template/TemplateService.html">TemplateService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>template</CODE> - The screen template name.<DT><B>Returns:</B><DD>The found screen module name.<DT><B>Throws:</B><DD><CODE>Exception,</CODE> - a generic exception.</DL>
</DD>
</DL>
<HR>

<A NAME="getLayoutName(java.lang.String)"><!-- --></A><H3>
getLayoutName</H3>
<PRE>
public java.lang.String <B>getLayoutName</B>(java.lang.String&nbsp;template)
                               throws java.lang.Exception</PRE>
<DL>
<DD>Locate and return the name of the layout module to be used
 with the named layout template.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/template/TemplateService.html#getLayoutName(java.lang.String)">getLayoutName</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/services/template/TemplateService.html">TemplateService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>template</CODE> - The layout template name.<DT><B>Returns:</B><DD>The found layout module name.<DT><B>Throws:</B><DD><CODE>Exception,</CODE> - a generic exception.</DL>
</DD>
</DL>
<HR>

<A NAME="getNavigationName(java.lang.String)"><!-- --></A><H3>
getNavigationName</H3>
<PRE>
public java.lang.String <B>getNavigationName</B>(java.lang.String&nbsp;template)
                                   throws java.lang.Exception</PRE>
<DL>
<DD>Locate and return the name of the navigation module to be used
 with the named navigation template.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/template/TemplateService.html#getNavigationName(java.lang.String)">getNavigationName</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/services/template/TemplateService.html">TemplateService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>template</CODE> - The navigation template name.<DT><B>Returns:</B><DD>The found navigation module name.<DT><B>Throws:</B><DD><CODE>Exception,</CODE> - a generic exception.</DL>
</DD>
</DL>
<HR>

<A NAME="getScreenTemplateName(java.lang.String)"><!-- --></A><H3>
getScreenTemplateName</H3>
<PRE>
public java.lang.String <B>getScreenTemplateName</B>(java.lang.String&nbsp;template)
                                       throws java.lang.Exception</PRE>
<DL>
<DD>Locate and return the name of the screen template corresponding
 to the given template name parameter.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/template/TemplateService.html#getScreenTemplateName(java.lang.String)">getScreenTemplateName</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/services/template/TemplateService.html">TemplateService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>template</CODE> - The template name parameter.<DT><B>Returns:</B><DD>The found screen template name.<DT><B>Throws:</B><DD><CODE>Exception,</CODE> - a generic exception.</DL>
</DD>
</DL>
<HR>

<A NAME="getLayoutTemplateName(java.lang.String)"><!-- --></A><H3>
getLayoutTemplateName</H3>
<PRE>
public java.lang.String <B>getLayoutTemplateName</B>(java.lang.String&nbsp;template)
                                       throws java.lang.Exception</PRE>
<DL>
<DD>Locate and return the name of the layout template corresponding
 to the given screen template name parameter.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/template/TemplateService.html#getLayoutTemplateName(java.lang.String)">getLayoutTemplateName</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/services/template/TemplateService.html">TemplateService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>template</CODE> - The template name parameter.<DT><B>Returns:</B><DD>The found screen template name.<DT><B>Throws:</B><DD><CODE>Exception,</CODE> - a generic exception.</DL>
</DD>
</DL>
<HR>

<A NAME="translateTemplatePaths(java.lang.String[])"><!-- --></A><H3>
translateTemplatePaths</H3>
<PRE>
public java.lang.String[] <B>translateTemplatePaths</B>(java.lang.String[]&nbsp;templatePaths)</PRE>
<DL>
<DD>Translates the supplied template paths into their Turbine-canonical
 equivalent (probably absolute paths).<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/template/TemplateService.html#translateTemplatePaths(java.lang.String[])">translateTemplatePaths</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/services/template/TemplateService.html">TemplateService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>templatePaths</CODE> - An array of template paths.<DT><B>Returns:</B><DD>An array of translated template paths.</DL>
</DD>
</DL>
<HR>

<A NAME="templateExists(java.lang.String, java.lang.String[])"><!-- --></A><H3>
templateExists</H3>
<PRE>
public boolean <B>templateExists</B>(java.lang.String&nbsp;template,
                              java.lang.String[]&nbsp;templatePaths)</PRE>
<DL>
<DD>Delegates to the appropriate <A HREF="../../../../../org/apache/turbine/services/template/TemplateEngineService.html"><CODE>TemplateEngineService</CODE></A> to
 check the existance of the specified template.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/template/TemplateService.html#templateExists(java.lang.String, java.lang.String[])">templateExists</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/services/template/TemplateService.html">TemplateService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>template</CODE> - The template to check for the existance of.<DD><CODE>templatePaths</CODE> - The paths to check for the template.</DL>
</DD>
</DL>
<HR>

<A NAME="registerTemplateEngineService(org.apache.turbine.services.template.TemplateEngineService)"><!-- --></A><H3>
registerTemplateEngineService</H3>
<PRE>
public void <B>registerTemplateEngineService</B>(<A HREF="../../../../../org/apache/turbine/services/template/TemplateEngineService.html">TemplateEngineService</A>&nbsp;service)</PRE>
<DL>
<DD>Registers the provided template engine for use by the
 <code>TemplateService</code>.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../../org/apache/turbine/services/template/TemplateService.html#registerTemplateEngineService(org.apache.turbine.services.template.TemplateEngineService)">registerTemplateEngineService</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/turbine/services/template/TemplateService.html">TemplateService</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>service</CODE> - The <code>TemplateEngineService</code> to register.</DL>
</DD>
</DL>
<HR>

<A NAME="getTemplateEngineService(java.lang.String)"><!-- --></A><H3>
getTemplateEngineService</H3>
<PRE>
protected <A HREF="../../../../../org/apache/turbine/services/template/TemplateEngineService.html">TemplateEngineService</A> <B>getTemplateEngineService</B>(java.lang.String&nbsp;template)</PRE>
<DL>
<DD>The <A HREF="../../../../../org/apache/turbine/services/template/TemplateEngineService.html"><CODE>TemplateEngineService</CODE></A>
 associated with the specified template's file extension.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>template</CODE> - The template name.<DT><B>Returns:</B><DD>The template engine service.</DL>
</DD>
</DL>
<HR>

<A NAME="getDefaultModuleName(java.lang.String, int)"><!-- --></A><H3>
getDefaultModuleName</H3>
<PRE>
protected java.lang.String <B>getDefaultModuleName</B>(java.lang.String&nbsp;template,
                                                int&nbsp;key)</PRE>
<DL>
<DD>Get the default module name of the template engine
 service corresponding to the template name extension of
 the named template.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>template</CODE> - The template name.<DD><CODE>key</CODE> - The module type key.<DT><B>Returns:</B><DD>The default page module name.</DL>
</DD>
</DL>
<HR>

<A NAME="getCachedName(java.lang.String, int)"><!-- --></A><H3>
getCachedName</H3>
<PRE>
protected java.lang.String <B>getCachedName</B>(java.lang.String&nbsp;template,
                                         int&nbsp;key)
                                  throws java.lang.Exception</PRE>
<DL>
<DD>Get the cached template object name.
 If caching is not in use or the name is not in the cache,
 try to find the name from the template directories.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>template</CODE> - The template name.<DD><CODE>key</CODE> - The object type key.<DT><B>Returns:</B><DD>The cached name.<DT><B>Throws:</B><DD><CODE>Exception,</CODE> - a generic exception.</DL>
</DD>
</DL>
<HR>

<A NAME="getParsedModuleName(java.lang.String, int)"><!-- --></A><H3>
getParsedModuleName</H3>
<PRE>
protected java.lang.String <B>getParsedModuleName</B>(java.lang.String&nbsp;template,
                                               int&nbsp;key)
                                        throws java.lang.Exception</PRE>
<DL>
<DD>Get the parsed module name for the specified template.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>template</CODE> - The template name.<DD><CODE>key</CODE> - The module type key.<DT><B>Returns:</B><DD>The parsed module name.<DT><B>Throws:</B><DD><CODE>Exception,</CODE> - a generaic exception.</DL>
</DD>
</DL>
<HR>

<A NAME="getParsedScreenTemplateName(java.lang.String)"><!-- --></A><H3>
getParsedScreenTemplateName</H3>
<PRE>
protected java.lang.String <B>getParsedScreenTemplateName</B>(java.lang.String&nbsp;template)
                                                throws java.lang.Exception</PRE>
<DL>
<DD>Get the parsed screen template name for the specified template.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>template</CODE> - The template name.<DT><B>Returns:</B><DD>The parsed screen template name.<DT><B>Throws:</B><DD><CODE>Exception,</CODE> - a generic exception.</DL>
</DD>
</DL>
<HR>

<A NAME="getParsedLayoutTemplateName(java.lang.String)"><!-- --></A><H3>
getParsedLayoutTemplateName</H3>
<PRE>
protected java.lang.String <B>getParsedLayoutTemplateName</B>(java.lang.String&nbsp;template)
                                                throws java.lang.Exception</PRE>
<DL>
<DD>Get the parsed layout template name for the specified template.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>template</CODE> - The template name.<DT><B>Returns:</B><DD>The parsed layout template name.<DT><B>Throws:</B><DD><CODE>Exception,</CODE> - a generic exception.</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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/TurbineTemplateService.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/turbine/services/template/TurbineTemplate.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="TurbineTemplateService.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>
Copyright &copy; 2000-2002 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>