| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
| <!--NewPage--> | |
| <HTML> | |
| <HEAD> | |
| <!-- Generated by javadoc (build 1.5.0_02) on Mon Nov 26 08:08:47 PST 2007 --> | |
| <TITLE> | |
| org.apache.velocity.tools.view.tools (VelocityTools 1.4 Documentation) | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools package"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="org.apache.velocity.tools.view.tools (VelocityTools 1.4 Documentation)"; | |
| } | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| </NOSCRIPT> | |
| </HEAD> | |
| <BODY BGCOLOR="white" onload="windowTitle();"> | |
| <!-- ========= START OF TOP NAVBAR ======= --> | |
| <A NAME="navbar_top"><!-- --></A> | |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
| <TR> | |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
| <A NAME="navbar_top_firstrow"><!-- --></A> | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
| <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="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </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/velocity/tools/view/servlet/package-summary.html"><B>PREV PACKAGE</B></A> | |
| NEXT PACKAGE</FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../../index.html?org/apache/velocity/tools/view/tools/package-summary.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> | |
| <SCRIPT type="text/javascript"> | |
| <!-- | |
| if(window==top) { | |
| document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
| } | |
| //--> | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
| </NOSCRIPT> | |
| </FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_top"></A> | |
| <!-- ========= END OF TOP NAVBAR ========= --> | |
| <HR> | |
| <H2> | |
| Package org.apache.velocity.tools.view.tools | |
| </H2> | |
| Provides the ViewTool and Configurable interfaces, as well as a number | |
| of useful implementing classes. | |
| <P> | |
| <B>See:</B> | |
| <BR> | |
| <A HREF="#package_description"><B>Description</B></A> | |
| <P> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
| <B>Interface Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/Configurable.html" title="interface in org.apache.velocity.tools.view.tools">Configurable</A></B></TD> | |
| <TD><B>Deprecated.</B> <I>Your tools now only need to have a configure(Map) method.</I></TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A></B></TD> | |
| <TD><B>Deprecated.</B> <I>Your tools now only need to have an init(Object) method.</I></TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <P> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
| <B>Class Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/AbstractPagerTool.html" title="class in org.apache.velocity.tools.view.tools">AbstractPagerTool</A></B></TD> | |
| <TD>Abstract view tool for doing request-based pagination of | |
| items in an a list.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/AbstractSearchTool.html" title="class in org.apache.velocity.tools.view.tools">AbstractSearchTool</A></B></TD> | |
| <TD>Abstract view tool for doing "searching" and robust | |
| pagination of search results.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/BrowserSnifferTool.html" title="class in org.apache.velocity.tools.view.tools">BrowserSnifferTool</A></B></TD> | |
| <TD>browser-sniffing tool (session or request scope requested, session scope advised).</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html" title="class in org.apache.velocity.tools.view.tools">ContextTool</A></B></TD> | |
| <TD>View tool for convenient access to <A HREF="../../../../../../org/apache/velocity/tools/view/context/ViewContext.html" title="interface in org.apache.velocity.tools.view.context"><CODE>ViewContext</CODE></A> data and | |
| meta-data.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/CookieTool.html" title="class in org.apache.velocity.tools.view.tools">CookieTool</A></B></TD> | |
| <TD>View tool for convenient cookie access and creation.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ImportTool.html" title="class in org.apache.velocity.tools.view.tools">ImportTool</A></B></TD> | |
| <TD>General-purpose text-importing view tool for templates.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A></B></TD> | |
| <TD>View tool to make building URIs pleasant and fun!</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html" title="class in org.apache.velocity.tools.view.tools">ParameterParser</A></B></TD> | |
| <TD>Utility class for easy parsing of <CODE>ServletRequest</CODE> parameters.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewRenderTool.html" title="class in org.apache.velocity.tools.view.tools">ViewRenderTool</A></B></TD> | |
| <TD>This tool expose methods to evaluate the given | |
| strings as VTL (Velocity Template Language) | |
| and automatically using the current context.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD WIDTH="15%"><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewResourceTool.html" title="class in org.apache.velocity.tools.view.tools">ViewResourceTool</A></B></TD> | |
| <TD>Tool for accessing ResourceBundles and formatting messages therein.</TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <P> | |
| <A NAME="package_description"><!-- --></A><H2> | |
| Package org.apache.velocity.tools.view.tools Description | |
| </H2> | |
| <P> | |
| <p>Provides the ViewTool and Configurable interfaces, as well as a number | |
| of useful implementing classes. These are tools specifically meant for use | |
| in a web application.</p> | |
| <!-- | |
| ##### THIS IS THE TEMPLATE FOR THE PACKAGE DOC COMMENTS. ##### | |
| ##### TYPE YOUR PACKAGE COMMENTS HERE. BEGIN WITH A ##### | |
| ##### ONE-SENTENCE SUMMARY STARTING WITH A VERB LIKE: ##### | |
| Provides for.... | |
| --> | |
| <h2>Package Specification</h2> | |
| <!-- | |
| ##### FILL IN ANY SPECS NEEDED BY JAVA COMPATIBILITY KIT ##### | |
| <ul> | |
| <li><a href="">##### REFER TO ANY FRAMEMAKER SPECIFICATION HERE #####</a> | |
| </ul> | |
| --> | |
| <h2>Related Documentation</h2> | |
| <!-- | |
| For overviews, tutorials, examples, guides, and tool documentation, please see: | |
| <ul> | |
| <li><a href="">##### REFER TO NON-SPEC DOCUMENTATION HERE #####</a> | |
| </ul> | |
| --> | |
| <!-- Put @see and @since tags down here. --> | |
| <P> | |
| <P> | |
| <DL> | |
| </DL> | |
| <HR> | |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> | |
| <A NAME="navbar_bottom"><!-- --></A> | |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
| <TR> | |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
| <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="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </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/velocity/tools/view/servlet/package-summary.html"><B>PREV PACKAGE</B></A> | |
| NEXT PACKAGE</FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../../index.html?org/apache/velocity/tools/view/tools/package-summary.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> | |
| <SCRIPT type="text/javascript"> | |
| <!-- | |
| if(window==top) { | |
| document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
| } | |
| //--> | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
| </NOSCRIPT> | |
| </FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_bottom"></A> | |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> | |
| <HR> | |
| Copyright (c) 2003-2007 Apache Software Foundation | |
| </BODY> | |
| </HTML> |