📄 turbinewebmacro.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd"><!--NewPage--><HTML><HEAD><!-- Generated by javadoc on Fri Dec 06 19:57:09 CET 2002 --><TITLE>jakarta-turbine-2 2.2 API: Class TurbineWebMacro</TITLE><LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"></HEAD><BODY BGCOLOR="white"><!-- ========== START OF NAVBAR ========== --><A NAME="navbar_top"><!-- --></A><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"><TR><TD COLSPAN=2 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/TurbineWebMacro.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/turbine/services/webmacro/TurbineTemplateProvider.html"><B>PREV CLASS</B></A> <A HREF="../../../../../org/apache/turbine/services/webmacro/TurbineWebMacroService.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="TurbineWebMacro.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD></TR><TR><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: FIELD | <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.turbine.services.webmacro</FONT><BR>Class TurbineWebMacro</H2><PRE>java.lang.Object | +--<B>org.apache.turbine.services.webmacro.TurbineWebMacro</B></PRE><HR><P><DL><DT>public abstract class <B>TurbineWebMacro</B><DT>extends java.lang.Object</DL><P>This is a simple static accessor to common WebMacro tasks such as getting an instance of a context as well as handling a request for processing a template. It uses the TurbineWebMacroService to obtain an instance of WebMacro. WebContext context = WebMacro.getContext(data); context.put("message", "Hello from Turbine!"); String results = WebMacro.handleRequest(context,"helloWorld.wm"); data.getPage().getBody().addElement(results);<P><DL><DT><B>Version: </B><DD>$Id: TurbineWebMacro.java,v 1.2 2002/07/11 16:53:23 mpoeschl Exp $</DD><DT><B>Author: </B><DD><a href="mailto:jon@latchkey.com">Jon S. Stevens</a>, <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a></DD></DL><HR><P><!-- ======== INNER CLASS SUMMARY ======== --><!-- =========== FIELD SUMMARY =========== --><!-- ======== 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/turbine/services/webmacro/TurbineWebMacro.html#TurbineWebMacro()">TurbineWebMacro</A></B>()</CODE><BR> <B>Deprecated.</B> </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 org.webmacro.servlet.WebContext</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/webmacro/TurbineWebMacro.html#getContext()">getContext</A></B>()</CODE><BR> <B>Deprecated.</B> This method returns a blank WebContext object.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static org.webmacro.servlet.WebContext</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/webmacro/TurbineWebMacro.html#getContext(org.apache.turbine.util.RunData)">getContext</A></B>(<A HREF="../../../../../org/apache/turbine/util/RunData.html">RunData</A> data)</CODE><BR> <B>Deprecated.</B> This returns a WebContext that you can pass into handleRequest once you have populated it with information that the template will know about.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected static <A HREF="../../../../../org/apache/turbine/services/webmacro/WebMacroService.html">WebMacroService</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/webmacro/TurbineWebMacro.html#getService()">getService</A></B>()</CODE><BR> <B>Deprecated.</B> Utility method for accessing the service implementation.</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/turbine/services/webmacro/TurbineWebMacro.html#handleRequest(org.webmacro.servlet.WebContext, java.lang.String)">handleRequest</A></B>(org.webmacro.servlet.WebContext context, java.lang.String templateFilePath)</CODE><BR> <B>Deprecated.</B> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/services/webmacro/TurbineWebMacro.html#handleRequest(org.webmacro.servlet.WebContext, java.lang.String, java.io.OutputStream)">handleRequest</A></B>(org.webmacro.servlet.WebContext context, java.lang.String filename, java.io.OutputStream out)</CODE><BR> <B>Deprecated.</B> </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, toString, wait, wait, wait</CODE></TD></TR></TABLE> <P><!-- ============ FIELD DETAIL =========== --><!-- ========= 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="TurbineWebMacro()"><!-- --></A><H3>TurbineWebMacro</H3><PRE>public <B>TurbineWebMacro</B>()</PRE><DL><DD><B>Deprecated.</B> </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="getService()"><!-- --></A><H3>getService</H3><PRE>protected static final <A HREF="../../../../../org/apache/turbine/services/webmacro/WebMacroService.html">WebMacroService</A> <B>getService</B>()</PRE><DL><DD><B>Deprecated.</B> <DD>Utility method for accessing the service implementation.<DD><DL><DT><B>Returns:</B><DD>A WebMacroService implementation instance.</DL></DD></DL><HR><A NAME="handleRequest(org.webmacro.servlet.WebContext, java.lang.String, java.io.OutputStream)"><!-- --></A><H3>handleRequest</H3><PRE>public static void <B>handleRequest</B>(org.webmacro.servlet.WebContext context, java.lang.String filename, java.io.OutputStream out) throws java.lang.Exception</PRE><DL><DD><B>Deprecated.</B> <DD><DL><DT><B>See Also: </B><DD><A HREF="../../../../../org/apache/turbine/services/webmacro/WebMacroService.html#handleRequest(org.webmacro.servlet.WebContext, java.lang.String)"><CODE>WebMacroService.handleRequest(org.webmacro.servlet.WebContext, java.lang.String)</CODE></A></DL></DD></DL><HR><A NAME="handleRequest(org.webmacro.servlet.WebContext, java.lang.String)"><!-- --></A><H3>handleRequest</H3><PRE>public static java.lang.String <B>handleRequest</B>(org.webmacro.servlet.WebContext context, java.lang.String templateFilePath) throws java.lang.Exception</PRE><DL><DD><B>Deprecated.</B> <DD><DL><DT><B>See Also: </B><DD><A HREF="../../../../../org/apache/turbine/services/webmacro/WebMacroService.html#handleRequest(org.webmacro.servlet.WebContext, java.lang.String)"><CODE>WebMacroService.handleRequest(org.webmacro.servlet.WebContext, java.lang.String)</CODE></A></DL></DD></DL><HR><A NAME="getContext(org.apache.turbine.util.RunData)"><!-- --></A><H3>getContext</H3><PRE>public static org.webmacro.servlet.WebContext <B>getContext</B>(<A HREF="../../../../../org/apache/turbine/util/RunData.html">RunData</A> data)</PRE><DL><DD><B>Deprecated.</B> <DD>This returns a WebContext that you can pass into handleRequest once you have populated it with information that the template will know about.<DD><DL><DT><B>Parameters:</B><DD><CODE>data</CODE> - A Turbine RunData.<DT><B>Returns:</B><DD>A WebContext.</DL></DD></DL><HR><A NAME="getContext()"><!-- --></A><H3>getContext</H3><PRE>public static org.webmacro.servlet.WebContext <B>getContext</B>()</PRE><DL><DD><B>Deprecated.</B> <DD>This method returns a blank WebContext object.<DD><DL><DT><B>Returns:</B><DD>A WebContext.</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/TurbineWebMacro.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/turbine/services/webmacro/TurbineTemplateProvider.html"><B>PREV CLASS</B></A> <A HREF="../../../../../org/apache/turbine/services/webmacro/TurbineWebMacroService.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="TurbineWebMacro.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD></TR><TR><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD></TR></TABLE><!-- =========== END OF NAVBAR =========== --><HR>Copyright © 2000-2002 Apache Software Foundation. All Rights Reserved.</BODY></HTML>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -