freemarkerservice.html

turbine教程

<!-- ============ 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="SERVICE_NAME"><!-- --></A><H3>
SERVICE_NAME</H3>
<PRE>
public static final java.lang.String <B>SERVICE_NAME</B></PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>The name used to specify this service in
 TurbineResources.properties.</DL>
<HR>

<A NAME="CONTEXT"><!-- --></A><H3>
CONTEXT</H3>
<PRE>
public static final java.lang.String <B>CONTEXT</B></PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>The name used as a key in TurbineInfo when storing the
 Context.</DL>

<!-- ========= 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="getContext()"><!-- --></A><H3>
getContext</H3>
<PRE>
public freemarker.template.SimpleHash <B>getContext</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Create a context needed by the FreeMarker template.  This
 method just returns an SimpleHash with the request parameters
 copied into a model called request.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>SimpleHash which can be used as the model for a
 template.</DL>
</DD>
</DL>
<HR>

<A NAME="getContext(javax.servlet.ServletRequest)"><!-- --></A><H3>
getContext</H3>
<PRE>
public freemarker.template.SimpleHash <B>getContext</B>(javax.servlet.ServletRequest&nbsp;req)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Create a context needed by the FreeMarker template.  This
 method just returns an SimpleHash with the request parameters
 copied into a model called request.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>req</CODE> - A ServletRequest.<DT><B>Returns:</B><DD>SimpleHash which can be used as the model for a
 template.</DL>
</DD>
</DL>
<HR>

<A NAME="getContext(org.apache.turbine.util.RunData)"><!-- --></A><H3>
getContext</H3>
<PRE>
public freemarker.template.SimpleHash <B>getContext</B>(<A HREF="../../../../../org/apache/turbine/util/RunData.html">RunData</A>&nbsp;data)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Create a context from the RunData object.  Values found in
 RunData are copied into the modelRoot under similar names as
 they can be found in RunData. e.g. data.serverName,
 data.parameters.form_field_name
 data.acl.permissions.can_write_file.  Some default links are
 also made available under links.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>data</CODE> - The Turbine RunData object.<DT><B>Returns:</B><DD>a SimpleHash populated with RunData data.</DL>
</DD>
</DL>
<HR>

<A NAME="handleRequest(freemarker.template.SimpleHash, java.lang.String, boolean)"><!-- --></A><H3>
handleRequest</H3>
<PRE>
public java.lang.String <B>handleRequest</B>(freemarker.template.SimpleHash&nbsp;context,
                                      java.lang.String&nbsp;templateName,
                                      boolean&nbsp;cache)
                               throws <A HREF="../../../../../org/apache/turbine/util/TurbineException.html">TurbineException</A></PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Process the request and fill in the template with the values
 you set in the WebContext.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>context</CODE> - A SimpleHash with the context.<DD><CODE>templateName</CODE> - A String with the filename of the template.<DD><CODE>cache</CODE> - True if the parsed template should be cached.<DT><B>Returns:</B><DD>The processed template as a String.<DT><B>Throws:</B><DD><CODE><A HREF="../../../../../org/apache/turbine/util/TurbineException.html">TurbineException</A></CODE> - Any exception trown while processing will be
         wrapped into a TurbineException and rethrown.</DL>
</DD>
</DL>
<HR>

<A NAME="getBasePath()"><!-- --></A><H3>
getBasePath</H3>
<PRE>
public java.lang.String <B>getBasePath</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Gets the base path for the FreeMarker templates.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The base path for the FreeMarker templates.</DL>
</DD>
</DL>
<HR>

<A NAME="getNonCachedTemplate(java.lang.String)"><!-- --></A><H3>
getNonCachedTemplate</H3>
<PRE>
public freemarker.template.Template <B>getNonCachedTemplate</B>(java.lang.String&nbsp;templateName)
                                                  throws java.io.IOException</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Return a FreeMarker template. It will not be added to the
 cache.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>templateName</CODE> - A String with the name of the template.<DT><B>Returns:</B><DD>A Template.<DT><B>Throws:</B><DD><CODE>IOException,</CODE> - if there was an I/O problem.</DL>
</DD>
</DL>
<HR>

<A NAME="getCachedTemplate(java.lang.String)"><!-- --></A><H3>
getCachedTemplate</H3>
<PRE>
public freemarker.template.Template <B>getCachedTemplate</B>(java.lang.String&nbsp;templateName)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<DD>Return a FreeMarker template from the cache.  If the template
 has not been cached yet, it will be added to the cache.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>templateName</CODE> - A String with the name of the template.<DT><B>Returns:</B><DD>A Template.</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/FreeMarkerService.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;PREV CLASS&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="FreeMarkerService.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;CONSTR&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;CONSTR&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>