📄 velocitynavigation.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:07 CET 2002 --><TITLE>jakarta-turbine-2 2.2 API: Class VelocityNavigation</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/VelocityNavigation.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/modules/navigations/TemplateNavigation.html"><B>PREV CLASS</B></A> <A HREF="../../../../../org/apache/turbine/modules/navigations/WebMacroSiteNavigation.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="VelocityNavigation.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.modules.navigations</FONT><BR>Class VelocityNavigation</H2><PRE>java.lang.Object | +--<A HREF="../../../../../org/apache/turbine/modules/Assembler.html">org.apache.turbine.modules.Assembler</A> | +--<A HREF="../../../../../org/apache/turbine/modules/Navigation.html">org.apache.turbine.modules.Navigation</A> | +--<A HREF="../../../../../org/apache/turbine/modules/navigations/TemplateNavigation.html">org.apache.turbine.modules.navigations.TemplateNavigation</A> | +--<B>org.apache.turbine.modules.navigations.VelocityNavigation</B></PRE><HR><DL><DT>public class <B>VelocityNavigation</B><DT>extends <A HREF="../../../../../org/apache/turbine/modules/navigations/TemplateNavigation.html">TemplateNavigation</A></DL><P>VelocityNavigation. This screen relies on the VelocityPage being set as the default page. The doBuildTemplate() assumes the user has put the template filename in the RunData parameter and set it to the value of the template file to execute. Specialized Navigations screens should extend this class and overide the doBuildTemplate( data , context) method.<P><DL><DT><B>Version: </B><DD>$Id: VelocityNavigation.java,v 1.1.1.1 2001/08/16 05:08:35 jvanzyl Exp $</DD><DT><B>Author: </B><DD><a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</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/modules/navigations/VelocityNavigation.html#VelocityNavigation()">VelocityNavigation</A></B>()</CODE><BR> </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> org.apache.ecs.ConcreteElement</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/modules/navigations/VelocityNavigation.html#buildTemplate(org.apache.turbine.util.RunData)">buildTemplate</A></B>(<A HREF="../../../../../org/apache/turbine/util/RunData.html">RunData</A> data)</CODE><BR> This Builds the Velocity template.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/modules/navigations/VelocityNavigation.html#doBuildTemplate(org.apache.turbine.util.RunData)">doBuildTemplate</A></B>(<A HREF="../../../../../org/apache/turbine/util/RunData.html">RunData</A> data)</CODE><BR> Needs to be implemented to make TemplateNavigation like us.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/apache/turbine/modules/navigations/VelocityNavigation.html#doBuildTemplate(org.apache.turbine.util.RunData, org.apache.velocity.context.Context)">doBuildTemplate</A></B>(<A HREF="../../../../../org/apache/turbine/util/RunData.html">RunData</A> data, org.apache.velocity.context.Context context)</CODE><BR> Velocity Navigations extending this class should overide this method to perform any particular business logic and add information to the context.</TD></TR></TABLE> <A NAME="methods_inherited_from_class_org.apache.turbine.modules.navigations.TemplateNavigation"><!-- --></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"><TD><B>Methods inherited from class org.apache.turbine.modules.navigations.<A HREF="../../../../../org/apache/turbine/modules/navigations/TemplateNavigation.html">TemplateNavigation</A></B></TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><A HREF="../../../../../org/apache/turbine/modules/navigations/TemplateNavigation.html#doBuild(org.apache.turbine.util.RunData)">doBuild</A></CODE></TD></TR></TABLE> <A NAME="methods_inherited_from_class_org.apache.turbine.modules.Navigation"><!-- --></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"><TD><B>Methods inherited from class org.apache.turbine.modules.<A HREF="../../../../../org/apache/turbine/modules/Navigation.html">Navigation</A></B></TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><A HREF="../../../../../org/apache/turbine/modules/Navigation.html#build(org.apache.turbine.util.RunData)">build</A>, <A HREF="../../../../../org/apache/turbine/modules/Navigation.html#prepareText(java.lang.String)">prepareText</A></CODE></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="VelocityNavigation()"><!-- --></A><H3>VelocityNavigation</H3><PRE>public <B>VelocityNavigation</B>()</PRE><DL></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="doBuildTemplate(org.apache.turbine.util.RunData, org.apache.velocity.context.Context)"><!-- --></A><H3>doBuildTemplate</H3><PRE>protected void <B>doBuildTemplate</B>(<A HREF="../../../../../org/apache/turbine/util/RunData.html">RunData</A> data, org.apache.velocity.context.Context context) throws java.lang.Exception</PRE><DL><DD>Velocity Navigations extending this class should overide this method to perform any particular business logic and add information to the context.<DD><DL><DT><B>Parameters:</B><DD><CODE>data</CODE> - Turbine information.<DD><CODE>context</CODE> - Context for web pages.<DT><B>Throws:</B><DD><CODE>Exception,</CODE> - a generic exception.</DL></DD></DL><HR><A NAME="doBuildTemplate(org.apache.turbine.util.RunData)"><!-- --></A><H3>doBuildTemplate</H3><PRE>protected void <B>doBuildTemplate</B>(<A HREF="../../../../../org/apache/turbine/util/RunData.html">RunData</A> data) throws java.lang.Exception</PRE><DL><DD>Needs to be implemented to make TemplateNavigation like us. The actual method that you should override is the one with the context in the parameter list.<DD><DL><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/turbine/modules/navigations/TemplateNavigation.html#doBuildTemplate(org.apache.turbine.util.RunData)">doBuildTemplate</A></CODE> in class <CODE><A HREF="../../../../../org/apache/turbine/modules/navigations/TemplateNavigation.html">TemplateNavigation</A></CODE></DL></DD><DD><DL><DT><B>Parameters:</B><DD><CODE>data</CODE> - Turbine information.<DT><B>Throws:</B><DD><CODE>Exception,</CODE> - a generic exception.</DL></DD></DL><HR><A NAME="buildTemplate(org.apache.turbine.util.RunData)"><!-- --></A><H3>buildTemplate</H3><PRE>public org.apache.ecs.ConcreteElement <B>buildTemplate</B>(<A HREF="../../../../../org/apache/turbine/util/RunData.html">RunData</A> data) throws java.lang.Exception</PRE><DL><DD>This Builds the Velocity template.<DD><DL><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/turbine/modules/navigations/TemplateNavigation.html#buildTemplate(org.apache.turbine.util.RunData)">buildTemplate</A></CODE> in class <CODE><A HREF="../../../../../org/apache/turbine/modules/navigations/TemplateNavigation.html">TemplateNavigation</A></CODE></DL></DD><DD><DL><DT><B>Parameters:</B><DD><CODE>data</CODE> - Turbine information.<DT><B>Returns:</B><DD>A ConcreteElement.<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> </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/VelocityNavigation.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/modules/navigations/TemplateNavigation.html"><B>PREV CLASS</B></A> <A HREF="../../../../../org/apache/turbine/modules/navigations/WebMacroSiteNavigation.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="VelocityNavigation.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 + -