You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@velocity.apache.org by nb...@apache.org on 2005/10/20 20:36:27 UTC
svn commit: r326968 [20/21] - in /jakarta/velocity/tools/trunk/docs/javadoc:
./ org/apache/velocity/tools/generic/
org/apache/velocity/tools/generic/log/ org/apache/velocity/tools/struts/
org/apache/velocity/tools/view/ org/apache/velocity/tools/view/c...
Modified: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ParameterParser.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ParameterParser.html?rev=326968&r1=326967&r2=326968&view=diff
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ParameterParser.html (original)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ParameterParser.html Thu Oct 20 11:34:40 2005
@@ -2,9 +2,9 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.4.2_01) on Fri Mar 12 02:01:06 GMT 2004 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Oct 20 10:35:35 PDT 2005 -->
<TITLE>
-ParameterParser (Velocity Tools 1.1-dev Documentation)
+ParameterParser (Velocity Tools 1.2 Documentation)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools.ParameterParser class">
@@ -14,9 +14,11 @@
<SCRIPT type="text/javascript">
function windowTitle()
{
- parent.document.title="ParameterParser (Velocity Tools 1.1-dev Documentation)";
+ parent.document.title="ParameterParser (Velocity Tools 1.2 Documentation)";
}
</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
</HEAD>
@@ -28,7 +30,7 @@
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
-<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<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">
@@ -52,7 +54,7 @@
<A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.QueryPair.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>
<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewRenderTool.html" title="class in org.apache.velocity.tools.view.tools"><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="../../../../../../index.html?org/apache/velocity/tools/view/tools/ParameterParser.html" target="_top"><B>FRAMES</B></A>
<A HREF="ParameterParser.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
@@ -65,6 +67,7 @@
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
+
</FONT></TD>
</TR>
<TR>
@@ -86,27 +89,29 @@
Class ParameterParser</H2>
<PRE>
java.lang.Object
- <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.velocity.tools.view.tools.ParameterParser</B>
+ <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">org.apache.velocity.tools.generic.ValueParser</A>
+ <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.view.tools.ParameterParser</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A></DD>
</DL>
<HR>
<DL>
-<DT>public class <B>ParameterParser</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A></DL>
+<DT><PRE>public class <B>ParameterParser</B><DT>extends <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A><DT>implements <A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A></DL>
+</PRE>
<P>
<p>Utility class for easy parsing of <CODE>ServletRequest</CODE> parameters.</p>
<p><pre>
Template example(s):
- $pp.foo -> bar
- $pp.getNumber('baz') -> 12.6
- $pp.getInt('baz') -> 12
- $pp.getNumbers('foo') -> [12.6]
+ $params.foo -> bar
+ $params.getNumber('baz') -> 12.6
+ $params.getInt('baz') -> 12
+ $params.getNumbers('foo') -> [12.6]
Toolbox configuration:
<tool>
- <key>pp</key>
+ <key>params</key>
<scope>request</scope>
<class>org.apache.velocity.tools.view.tools.ParameterParser</class>
</tool>
@@ -120,23 +125,20 @@
<P>
<DL>
<DT><B>Version:</B></DT>
- <DD>$Revision: 1.8 $ $Date: 2004/03/12 02:07:22 $</DD>
+ <DD>$Revision$ $Date$</DD>
<DT><B>Author:</B></DT>
<DD><a href="mailto:nathan@esha.com">Nathan Bubna</a></DD>
</DL>
<HR>
<P>
-<!-- ======== NESTED CLASS SUMMARY ======== -->
-
-
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=2><FONT SIZE="+2">
-<B>Field Summary</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -153,8 +155,8 @@
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=2><FONT SIZE="+2">
-<B>Constructor Summary</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#ParameterParser()">ParameterParser</A></B>()</CODE>
@@ -175,110 +177,8 @@
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<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> boolean</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#exists(java.lang.String)">exists</A></B>(java.lang.String key)</CODE>
-
-<BR>
- Convenience method for checking whether a certain parameter exists.</TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> java.lang.String</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#get(java.lang.String)">get</A></B>(java.lang.String key)</CODE>
-
-<BR>
- Convenience method for use in Velocity templates.
- </TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> java.lang.Boolean</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#getBoolean(java.lang.String)">getBoolean</A></B>(java.lang.String key)</CODE>
-
-<BR>
- </TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> boolean</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#getBoolean(java.lang.String, boolean)">getBoolean</A></B>(java.lang.String key,
- boolean alternate)</CODE>
-
-<BR>
- </TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> java.lang.Boolean</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#getBoolean(java.lang.String, java.lang.Boolean)">getBoolean</A></B>(java.lang.String key,
- java.lang.Boolean alternate)</CODE>
-
-<BR>
- </TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> double</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#getDouble(java.lang.String, double)">getDouble</A></B>(java.lang.String key,
- double alternate)</CODE>
-
-<BR>
- </TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> double[]</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#getDoubles(java.lang.String)">getDoubles</A></B>(java.lang.String key)</CODE>
-
-<BR>
- </TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> int</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#getInt(java.lang.String, int)">getInt</A></B>(java.lang.String key,
- int alternate)</CODE>
-
-<BR>
- </TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> int[]</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#getInts(java.lang.String)">getInts</A></B>(java.lang.String key)</CODE>
-
-<BR>
- </TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> java.lang.Number</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#getNumber(java.lang.String)">getNumber</A></B>(java.lang.String key)</CODE>
-
-<BR>
- </TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> java.lang.Number</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#getNumber(java.lang.String, java.lang.Number)">getNumber</A></B>(java.lang.String key,
- java.lang.Number alternate)</CODE>
-
-<BR>
- </TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> java.lang.Number[]</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#getNumbers(java.lang.String)">getNumbers</A></B>(java.lang.String key)</CODE>
-
-<BR>
- </TD>
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -290,20 +190,22 @@
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> java.lang.String</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#getString(java.lang.String)">getString</A></B>(java.lang.String key)</CODE>
+<CODE>protected java.util.Map</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#getSource()">getSource</A></B>()</CODE>
<BR>
- </TD>
+ Overrides ValueParser.getSource() to return the result
+ of getRequest().getParameterMap() if Servlet 2.3 or above
+ is being used.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#getString(java.lang.String, java.lang.String)">getString</A></B>(java.lang.String key,
- java.lang.String alternate)</CODE>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#getString(java.lang.String)">getString</A></B>(java.lang.String key)</CODE>
<BR>
- </TD>
+ Overrides ValueParser.getString(String key) to retrieve the
+ String from the ServletRequest instead of an arbitrary Map.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -311,7 +213,8 @@
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#getStrings(java.lang.String)">getStrings</A></B>(java.lang.String key)</CODE>
<BR>
- </TD>
+ Overrides ValueParser.getString(String key) to retrieve
+ Strings from the ServletRequest instead of an arbitrary Map.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -323,26 +226,36 @@
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE>protected java.lang.Number</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#parseNumber(java.lang.String)">parseNumber</A></B>(java.lang.String value)</CODE>
+<CODE>protected void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#setRequest(javax.servlet.ServletRequest)">setRequest</A></B>(javax.servlet.ServletRequest request)</CODE>
<BR>
- Converts a parameter value into a <CODE>Number</CODE>
- This is used as the base for all numeric parsing methods. </TD>
+ Sets the current <CODE>ServletRequest</CODE></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/velocity/tools/view/tools/ParameterParser.html#setRequest(javax.servlet.ServletRequest)">setRequest</A></B>(javax.servlet.ServletRequest request)</CODE>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#setSource(java.util.Map)">setSource</A></B>(java.util.Map source)</CODE>
<BR>
- Sets the current <CODE>ServletRequest</CODE></TD>
+ Overrides ValueParser.setSource(Map source) to throw an
+ UnsupportedOperationException, because this class uses
+ a servlet request as its source, not a Map.</TD>
+</TR>
+</TABLE>
+ <A NAME="methods_inherited_from_class_org.apache.velocity.tools.generic.ValueParser"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class org.apache.velocity.tools.generic.<A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A></B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#exists(java.lang.String)">exists</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#get(java.lang.String)">get</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getBoolean(java.lang.String)">getBoolean</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getBoolean(java.lang.String, boolean)">getBoolean</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getBoolean(java.lang.String, java.lang.Boolean)">getBoolean</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getBooleans(java.lang.String)">getBooleans</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getDouble(java.lang.String, double)">getDouble</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getDoubles(java.lang.String)">getDoubles</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getInt(java.lang.String, int)">getInt</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getInts(java.lang.String)">getInts</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getNumber(java.lang.String)">getNumber</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getNumber(java.lang.String, java.lang.Number)">getNumber</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getNumbers(java.lang.String)">getNumbers</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getString(java.lang.String, java.lang.String)">getString</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#parseBoolean(java.lang.String)">parseBoolean</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#parseNumber(java.lang.String)">parseNumber</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
-<TD><B>Methods inherited from class java.lang.Object</B></TD>
+<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
@@ -356,8 +269,8 @@
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=1><FONT SIZE="+2">
-<B>Field Detail</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
@@ -375,8 +288,8 @@
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=1><FONT SIZE="+2">
-<B>Constructor Detail</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
@@ -397,6 +310,8 @@
<DL>
<DD>Constructs a new instance using the specified request.
<P>
+<DL>
+<DT><B>Parameters:</B><DD><CODE>request</CODE> - the <CODE>ServletRequest</CODE> to be parsed</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
@@ -404,8 +319,8 @@
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=1><FONT SIZE="+2">
-<B>Method Detail</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
@@ -422,7 +337,7 @@
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>obj</CODE> - the current ViewContext or ServletRequest
<DT><B>Throws:</B>
-<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the param is not a
+<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the param is not a
ViewContext or ServletRequest</DL>
</DD>
</DL>
@@ -439,7 +354,7 @@
</DL>
</DD>
<DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>request</CODE> - the <CODE>ServletRequest</CODE> to be parsed</DL>
</DD>
</DL>
<HR>
@@ -463,53 +378,16 @@
</DL>
<HR>
-<A NAME="exists(java.lang.String)"><!-- --></A><H3>
-exists</H3>
-<PRE>
-public boolean <B>exists</B>(java.lang.String key)</PRE>
-<DL>
-<DD>Convenience method for checking whether a certain parameter exists.
-<P>
-<DD><DL>
-</DL>
-</DD>
-<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>key</CODE> - the parameter's key
-<DT><B>Returns:</B><DD><code>true</code> if a parameter exists for the specified
- key; otherwise, returns <code>false</code>.</DL>
-</DD>
-</DL>
-<HR>
-
-<A NAME="get(java.lang.String)"><!-- --></A><H3>
-get</H3>
-<PRE>
-public java.lang.String <B>get</B>(java.lang.String key)</PRE>
-<DL>
-<DD>Convenience method for use in Velocity templates.
- This allows for easy "dot" access to parameters.
-
- e.g. $params.foo instead of $params.getString('foo')
-<P>
-<DD><DL>
-</DL>
-</DD>
-<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>key</CODE> - the parameter's key
-<DT><B>Returns:</B><DD>parameter matching the specified key or
- <code>null</code> if there is no matching
- parameter</DL>
-</DD>
-</DL>
-<HR>
-
<A NAME="getString(java.lang.String)"><!-- --></A><H3>
getString</H3>
<PRE>
public java.lang.String <B>getString</B>(java.lang.String key)</PRE>
<DL>
+<DD>Overrides ValueParser.getString(String key) to retrieve the
+ String from the ServletRequest instead of an arbitrary Map.
+<P>
<DD><DL>
-</DL>
+<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getString(java.lang.String)">getString</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>key</CODE> - the parameter's key
@@ -520,151 +398,19 @@
</DL>
<HR>
-<A NAME="getString(java.lang.String, java.lang.String)"><!-- --></A><H3>
-getString</H3>
-<PRE>
-public java.lang.String <B>getString</B>(java.lang.String key,
- java.lang.String alternate)</PRE>
-<DL>
-<DD><DL>
-</DL>
-</DD>
-<DD><DL>
-
-<DT><B>Returns:</B><DD>parameter matching the specified key or the
- specified alternate String if there is no matching
- parameter</DL>
-</DD>
-</DL>
-<HR>
-
-<A NAME="getBoolean(java.lang.String)"><!-- --></A><H3>
-getBoolean</H3>
-<PRE>
-public java.lang.Boolean <B>getBoolean</B>(java.lang.String key)</PRE>
-<DL>
-<DD><DL>
-</DL>
-</DD>
-<DD><DL>
-
-<DT><B>Returns:</B><DD>a <CODE>Boolean</CODE> object for the specified key or
- <code>null</code> if no matching parameter is found</DL>
-</DD>
-</DL>
-<HR>
-
-<A NAME="getBoolean(java.lang.String, boolean)"><!-- --></A><H3>
-getBoolean</H3>
-<PRE>
-public boolean <B>getBoolean</B>(java.lang.String key,
- boolean alternate)</PRE>
-<DL>
-<DD><DL>
-</DL>
-</DD>
-<DD><DL>
-
-<DT><B>Returns:</B><DD>boolean value for the specified key or the
- alternate boolean is no value is found</DL>
-</DD>
-</DL>
-<HR>
-
-<A NAME="getBoolean(java.lang.String, java.lang.Boolean)"><!-- --></A><H3>
-getBoolean</H3>
-<PRE>
-public java.lang.Boolean <B>getBoolean</B>(java.lang.String key,
- java.lang.Boolean alternate)</PRE>
-<DL>
-<DD><DL>
-</DL>
-</DD>
-<DD><DL>
-
-<DT><B>Returns:</B><DD>a <CODE>Boolean</CODE> for the specified key or the specified
- alternate if no matching parameter is found</DL>
-</DD>
-</DL>
-<HR>
-
-<A NAME="getNumber(java.lang.String)"><!-- --></A><H3>
-getNumber</H3>
-<PRE>
-public java.lang.Number <B>getNumber</B>(java.lang.String key)</PRE>
-<DL>
-<DD><DL>
-</DL>
-</DD>
-<DD><DL>
-
-<DT><B>Returns:</B><DD>a <CODE>Number</CODE> for the specified key or
- <code>null</code> if no matching parameter is found</DL>
-</DD>
-</DL>
-<HR>
-
-<A NAME="getNumber(java.lang.String, java.lang.Number)"><!-- --></A><H3>
-getNumber</H3>
-<PRE>
-public java.lang.Number <B>getNumber</B>(java.lang.String key,
- java.lang.Number alternate)</PRE>
-<DL>
-<DD><DL>
-</DL>
-</DD>
-<DD><DL>
-
-<DT><B>Returns:</B><DD>a Number for the specified key or the specified
- alternate if no matching parameter is found</DL>
-</DD>
-</DL>
-<HR>
-
-<A NAME="getInt(java.lang.String, int)"><!-- --></A><H3>
-getInt</H3>
-<PRE>
-public int <B>getInt</B>(java.lang.String key,
- int alternate)</PRE>
-<DL>
-<DD><DL>
-</DL>
-</DD>
-<DD><DL>
-
-<DT><B>Returns:</B><DD>the int value for the specified key or the specified
- alternate value if no matching parameter is found</DL>
-</DD>
-</DL>
-<HR>
-
-<A NAME="getDouble(java.lang.String, double)"><!-- --></A><H3>
-getDouble</H3>
-<PRE>
-public double <B>getDouble</B>(java.lang.String key,
- double alternate)</PRE>
-<DL>
-<DD><DL>
-</DL>
-</DD>
-<DD><DL>
-
-<DT><B>Returns:</B><DD>the double value for the specified key or the specified
- alternate value if no matching parameter is found</DL>
-</DD>
-</DL>
-<HR>
-
<A NAME="getStrings(java.lang.String)"><!-- --></A><H3>
getStrings</H3>
<PRE>
public java.lang.String[] <B>getStrings</B>(java.lang.String key)</PRE>
<DL>
+<DD>Overrides ValueParser.getString(String key) to retrieve
+ Strings from the ServletRequest instead of an arbitrary Map.
+<P>
<DD><DL>
-</DL>
+<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getStrings(java.lang.String)">getStrings</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A></CODE></DL>
</DD>
<DD><DL>
-
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - the key for the desired parameter
<DT><B>Returns:</B><DD>an array of String objects containing all of the values
the given request parameter has, or <code>null</code>
if the parameter does not exist</DL>
@@ -672,76 +418,40 @@
</DL>
<HR>
-<A NAME="getNumbers(java.lang.String)"><!-- --></A><H3>
-getNumbers</H3>
+<A NAME="setSource(java.util.Map)"><!-- --></A><H3>
+setSource</H3>
<PRE>
-public java.lang.Number[] <B>getNumbers</B>(java.lang.String key)</PRE>
+protected void <B>setSource</B>(java.util.Map source)</PRE>
<DL>
+<DD>Overrides ValueParser.setSource(Map source) to throw an
+ UnsupportedOperationException, because this class uses
+ a servlet request as its source, not a Map.
+<P>
<DD><DL>
-</DL>
-</DD>
-<DD><DL>
-
-<DT><B>Returns:</B><DD>an array of Number objects for the specified key or
- <code>null</code> if the parameter does not exist or the
- parameter does not contain Numbers.</DL>
-</DD>
-</DL>
-<HR>
-
-<A NAME="getInts(java.lang.String)"><!-- --></A><H3>
-getInts</H3>
-<PRE>
-public int[] <B>getInts</B>(java.lang.String key)</PRE>
-<DL>
-<DD><DL>
-</DL>
-</DD>
-<DD><DL>
-
-<DT><B>Returns:</B><DD>an array of int values for the specified key or
- <code>null</code> if the parameter does not exist or the
- parameter does not contain ints.</DL>
+<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#setSource(java.util.Map)">setSource</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A></CODE></DL>
</DD>
-</DL>
-<HR>
-
-<A NAME="getDoubles(java.lang.String)"><!-- --></A><H3>
-getDoubles</H3>
-<PRE>
-public double[] <B>getDoubles</B>(java.lang.String key)</PRE>
-<DL>
<DD><DL>
</DL>
</DD>
-<DD><DL>
-
-<DT><B>Returns:</B><DD>an array of double values for the specified key or
- <code>null</code> if the parameter does not exist or the
- parameter does not contain doubles.</DL>
-</DD>
</DL>
<HR>
-<A NAME="parseNumber(java.lang.String)"><!-- --></A><H3>
-parseNumber</H3>
+<A NAME="getSource()"><!-- --></A><H3>
+getSource</H3>
<PRE>
-protected java.lang.Number <B>parseNumber</B>(java.lang.String value)
- throws java.lang.NumberFormatException</PRE>
+protected java.util.Map <B>getSource</B>()</PRE>
<DL>
-<DD>Converts a parameter value into a <CODE>Number</CODE>
- This is used as the base for all numeric parsing methods. So,
- sub-classes can override to allow for customized number parsing.
- (e.g. to handle fractions, compound numbers, etc.)
+<DD>Overrides ValueParser.getSource() to return the result
+ of getRequest().getParameterMap() if Servlet 2.3 or above
+ is being used. Otherwise, this throws an
+ UnsupportedOperationException, because the class uses a
+ servlet request as its source, not a Map.
<P>
<DD><DL>
-</DL>
+<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getSource()">getSource</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>value</CODE> - the string to be parsed
-<DT><B>Returns:</B><DD>the value as a <CODE>Number</CODE>
-<DT><B>Throws:</B>
-<DD><CODE>java.lang.NumberFormatException</CODE></DL>
+</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
@@ -753,7 +463,7 @@
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
-<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<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">
@@ -777,7 +487,7 @@
<A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.QueryPair.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>
<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewRenderTool.html" title="class in org.apache.velocity.tools.view.tools"><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="../../../../../../index.html?org/apache/velocity/tools/view/tools/ParameterParser.html" target="_top"><B>FRAMES</B></A>
<A HREF="ParameterParser.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
@@ -789,6 +499,7 @@
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
+
</FONT></TD>
</TR>
Modified: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ViewRenderTool.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ViewRenderTool.html?rev=326968&r1=326967&r2=326968&view=diff
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ViewRenderTool.html (original)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ViewRenderTool.html Thu Oct 20 11:34:40 2005
@@ -2,9 +2,9 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.4.2_01) on Fri Mar 12 02:01:08 GMT 2004 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Oct 20 10:35:35 PDT 2005 -->
<TITLE>
-ViewRenderTool (Velocity Tools 1.1-dev Documentation)
+ViewRenderTool (Velocity Tools 1.2 Documentation)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools.ViewRenderTool class">
@@ -14,9 +14,11 @@
<SCRIPT type="text/javascript">
function windowTitle()
{
- parent.document.title="ViewRenderTool (Velocity Tools 1.1-dev Documentation)";
+ parent.document.title="ViewRenderTool (Velocity Tools 1.2 Documentation)";
}
</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
</HEAD>
@@ -28,7 +30,7 @@
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
-<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<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">
@@ -50,9 +52,9 @@
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>
- NEXT CLASS</FONT></TD>
+ <A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools"><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="../../../../../../index.html?org/apache/velocity/tools/view/tools/ViewRenderTool.html" target="_top"><B>FRAMES</B></A>
<A HREF="ViewRenderTool.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
@@ -65,6 +67,7 @@
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
+
</FONT></TD>
</TR>
<TR>
@@ -86,21 +89,22 @@
Class ViewRenderTool</H2>
<PRE>
java.lang.Object
- <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html" title="class in org.apache.velocity.tools.generic">org.apache.velocity.tools.generic.RenderTool</A>
- <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.velocity.tools.view.tools.ViewRenderTool</B>
+ <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html" title="class in org.apache.velocity.tools.generic">org.apache.velocity.tools.generic.RenderTool</A>
+ <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.view.tools.ViewRenderTool</B>
</PRE>
<DL>
-<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A></DD>
+<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../org/apache/velocity/tools/view/tools/Configurable.html" title="interface in org.apache.velocity.tools.view.tools">Configurable</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A></DD>
</DL>
<HR>
<DL>
-<DT>public class <B>ViewRenderTool</B><DT>extends <A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html" title="class in org.apache.velocity.tools.generic">RenderTool</A><DT>implements <A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A></DL>
+<DT><PRE>public class <B>ViewRenderTool</B><DT>extends <A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html" title="class in org.apache.velocity.tools.generic">RenderTool</A><DT>implements <A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/tools/Configurable.html" title="interface in org.apache.velocity.tools.view.tools">Configurable</A></DL>
+</PRE>
<P>
This tool expose methods to evaluate the given
strings as VTL (Velocity Template Language)
- and automatically using the current context.<br>
-
+ and automatically using the current context.
+ <br />
<pre>
Example of eval():
Input
@@ -113,7 +117,7 @@
Output
------
3
-
+
Example of recurse():
Input
-----
@@ -132,6 +136,7 @@
<key>render</key>
<scope>request</scope>
<class>org.apache.velocity.tools.view.tools.ViewRenderTool</class>
+ <parameter name="parse.depth" value="10"/>
</tool>
</pre>
@@ -147,23 +152,20 @@
<P>
<DL>
<DT><B>Version:</B></DT>
- <DD>$Revision: 1.8 $ $Date: 2004/03/12 02:07:22 $</DD>
+ <DD>$Revision$ $Date$</DD>
<DT><B>Author:</B></DT>
<DD><a href="mailto:nathan@esha.com">Nathan Bubna</a></DD>
</DL>
<HR>
<P>
-<!-- ======== NESTED CLASS SUMMARY ======== -->
-
-
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=2><FONT SIZE="+2">
-<B>Field Summary</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -173,14 +175,22 @@
<BR>
</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/velocity/tools/view/tools/ViewRenderTool.html#KEY_PARSE_DEPTH">KEY_PARSE_DEPTH</A></B></CODE>
+
+<BR>
+ </TD>
+</TR>
</TABLE>
<A NAME="fields_inherited_from_class_org.apache.velocity.tools.generic.RenderTool"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
-<TD><B>Fields inherited from class org.apache.velocity.tools.generic.<A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html" title="class in org.apache.velocity.tools.generic">RenderTool</A></B></TD>
+<TH ALIGN="left"><B>Fields inherited from class org.apache.velocity.tools.generic.<A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html" title="class in org.apache.velocity.tools.generic">RenderTool</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE></CODE></TD>
+<TD><CODE><A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html#DEFAULT_PARSE_DEPTH">DEFAULT_PARSE_DEPTH</A></CODE></TD>
</TR>
</TABLE>
@@ -189,8 +199,8 @@
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=2><FONT SIZE="+2">
-<B>Constructor Summary</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewRenderTool.html#ViewRenderTool()">ViewRenderTool</A></B>()</CODE>
@@ -205,8 +215,16 @@
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=2><FONT SIZE="+2">
-<B>Method Summary</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewRenderTool.html#configure(java.util.Map)">configure</A></B>(java.util.Map params)</CODE>
+
+<BR>
+ Configures this tool using the specified parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -215,7 +233,7 @@
<BR>
Evaluates a String containing VTL using the current context,
- and returns the result as a String. </TD>
+ and returns the result as a String.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -232,22 +250,22 @@
<BR>
Recursively evaluates a String containing VTL using the
- current context, and returns the result as a String. </TD>
+ current context, and returns the result as a String.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.apache.velocity.tools.generic.RenderTool"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
-<TD><B>Methods inherited from class org.apache.velocity.tools.generic.<A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html" title="class in org.apache.velocity.tools.generic">RenderTool</A></B></TD>
+<TH ALIGN="left"><B>Methods inherited from class org.apache.velocity.tools.generic.<A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html" title="class in org.apache.velocity.tools.generic">RenderTool</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE><A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html#eval(org.apache.velocity.context.Context, java.lang.String)">eval</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html#recurse(org.apache.velocity.context.Context, java.lang.String)">recurse</A></CODE></TD>
+<TD><CODE><A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html#eval(org.apache.velocity.context.Context, java.lang.String)">eval</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html#getParseDepth()">getParseDepth</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html#internalRecurse(org.apache.velocity.context.Context, java.lang.String, int)">internalRecurse</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html#recurse(org.apache.velocity.context.Context, java.lang.String)">recurse</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html#setParseDepth(int)">setParseDepth</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html#setVelocityEngine(org.apache.velocity.app.VelocityEngine)">setVelocityEngine</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
-<TD><B>Methods inherited from class java.lang.Object</B></TD>
+<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
@@ -261,11 +279,21 @@
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=1><FONT SIZE="+2">
-<B>Field Detail</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
+<A NAME="KEY_PARSE_DEPTH"><!-- --></A><H3>
+KEY_PARSE_DEPTH</H3>
+<PRE>
+public static final java.lang.String <B>KEY_PARSE_DEPTH</B></PRE>
+<DL>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.velocity.tools.view.tools.ViewRenderTool.KEY_PARSE_DEPTH">Constant Field Values</A></DL>
+</DL>
+<HR>
+
<A NAME="context"><!-- --></A><H3>
context</H3>
<PRE>
@@ -280,8 +308,8 @@
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=1><FONT SIZE="+2">
-<B>Constructor Detail</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
@@ -299,8 +327,8 @@
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=1><FONT SIZE="+2">
-<B>Method Detail</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
@@ -320,6 +348,26 @@
</DL>
<HR>
+<A NAME="configure(java.util.Map)"><!-- --></A><H3>
+configure</H3>
+<PRE>
+public void <B>configure</B>(java.util.Map params)</PRE>
+<DL>
+<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/velocity/tools/view/tools/Configurable.html#configure(java.util.Map)">Configurable</A></CODE></B></DD>
+<DD>Configures this tool using the specified parameters. The
+ map of parameters passed in is guaranteed not to be null.
+ If there are no parameters specified for this tool in your
+ toolbox definition, then this method will NOT be called at all.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/velocity/tools/view/tools/Configurable.html#configure(java.util.Map)">configure</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/velocity/tools/view/tools/Configurable.html" title="interface in org.apache.velocity.tools.view.tools">Configurable</A></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>params</CODE> - the configuration data for this tool</DL>
+</DD>
+</DL>
+<HR>
+
<A NAME="eval(java.lang.String)"><!-- --></A><H3>
eval</H3>
<PRE>
@@ -327,7 +375,7 @@
throws java.lang.Exception</PRE>
<DL>
<DD><p>Evaluates a String containing VTL using the current context,
- and returns the result as a String. If this fails, then
+ and returns the result as a String. If this fails, then
<code>null</code> will be returned. This evaluation is not
recursive.</p>
<P>
@@ -354,8 +402,6 @@
will continue to re-evaluate the output of the last
evaluation until an evaluation returns the same code
that was fed into it.</p>
-
- TODO? add a parse-depth to prevent infinite recursion?
<P>
<DD><DL>
</DL>
@@ -376,7 +422,7 @@
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
-<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<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">
@@ -398,9 +444,9 @@
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>
- NEXT CLASS</FONT></TD>
+ <A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools"><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="../../../../../../index.html?org/apache/velocity/tools/view/tools/ViewRenderTool.html" target="_top"><B>FRAMES</B></A>
<A HREF="ViewRenderTool.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
@@ -412,6 +458,7 @@
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
+
</FONT></TD>
</TR>
Modified: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ViewTool.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ViewTool.html?rev=326968&r1=326967&r2=326968&view=diff
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ViewTool.html (original)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ViewTool.html Thu Oct 20 11:34:40 2005
@@ -2,9 +2,9 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.4.2_01) on Fri Mar 12 02:01:06 GMT 2004 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Oct 20 10:35:35 PDT 2005 -->
<TITLE>
-ViewTool (Velocity Tools 1.1-dev Documentation)
+ViewTool (Velocity Tools 1.2 Documentation)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools.ViewTool interface">
@@ -14,9 +14,11 @@
<SCRIPT type="text/javascript">
function windowTitle()
{
- parent.document.title="ViewTool (Velocity Tools 1.1-dev Documentation)";
+ parent.document.title="ViewTool (Velocity Tools 1.2 Documentation)";
}
</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
</HEAD>
@@ -28,7 +30,7 @@
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
-<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<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">
@@ -49,10 +51,10 @@
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- PREV CLASS
+ <A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewRenderTool.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="../../../../../../index.html?org/apache/velocity/tools/view/tools/ViewTool.html" target="_top"><B>FRAMES</B></A>
<A HREF="ViewTool.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
@@ -65,6 +67,7 @@
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
+
</FONT></TD>
</TR>
<TR>
@@ -85,46 +88,39 @@
<BR>
Interface ViewTool</H2>
<DL>
-<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../org/apache/velocity/tools/view/tools/AbstractSearchTool.html" title="class in org.apache.velocity.tools.view.tools">AbstractSearchTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/tools/CookieTool.html" title="class in org.apache.velocity.tools.view.tools">CookieTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/struts/FormTool.html" title="class in org.apache.velocity.tools.struts">FormTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/tools/ImportTool.html" title="class in org.apache.velocity.tools.view.tools">ImportTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/struts/MessageResourcesTool.html" title="class in org.apache.velocity.tools.struts">MessageResourcesTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/i18n/MultiViewsTool.html" title="class in org.apache.velocity.tools.view.i18n">MultiViewsTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html" title="class in org.apache.velocity.tools.view.tools">ParameterParser</A>, <A HREF="../../../../../../org/apache/velocity/tools/struts/TilesTool.html" title="class in org.apache.velocity.tools.struts">TilesTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/struts/ValidatorTool.html" title="class in org.apache.velocity.tools.struts">ValidatorTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/struts/ValidatorUtils.html" title="class in org.apache.velocity.tools.struts">ValidatorUtils</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewRenderTool.html" title="class in org.apache.velocity.tools.view.tools">ViewRenderTool</A></DD>
+<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../org/apache/velocity/tools/view/tools/AbstractPagerTool.html" title="class in org.apache.velocity.tools.view.tools">AbstractPagerTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/tools/AbstractSearchTool.html" title="class in org.apache.velocity.tools.view.tools">AbstractSearchTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/struts/ActionMessagesTool.html" title="class in org.apache.velocity.tools.struts">ActionMessagesTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/tools/BrowserSnifferTool.html" title="class in org.apache.velocity.tools.view.tools">BrowserSnifferTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/tools/CookieTool.html" title="class in org.apache.velocity.tools.view.tools">CookieTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/struts/ErrorsTool.html" title="class in org.apache.velocity.tools.struts">ErrorsTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/struts/FormTool.html" title="class in org.apache.velocity.tools.struts">FormTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/tools/ImportTool.html" title="class in org.apache.velocity.tools.view.tools">ImportTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/struts/MessageResourcesTool.html" title="class in org.apache.velocity.tools.struts">MessageResourcesTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/struts/MessageTool.html" title="class in org.apache.velocity.tools.struts">MessageTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/i18n/MultiViewsTool.html" title="class in org.apache.velocity.tools.view.i18n">MultiViewsTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html" title="class in org.apache.velocity.tools.view.tools">ParameterParser</A>, <A HREF="../../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html" title="class in org.apache.velocity.tools.struts">SecureLinkTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/struts/StrutsLinkTool.html" title="class in org.apache.velocity.tools.struts">StrutsLinkTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/struts/TilesTool.html" title="class in org.apache.velocity.tools.struts">TilesTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/struts/ValidatorTool.html" title="class in org.apache.velocity.tools.struts">ValidatorTool</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewRenderTool.html" title="class in org.apache.velocity.tools.view.tools">ViewRenderTool</A></DD>
</DL>
<HR>
<DL>
-<DT>public interface <B>ViewTool</B></DL>
+<DT><PRE>public interface <B>ViewTool</B></DL>
+</PRE>
<P>
Generic view tool interface to assist in tool management.
- This interface provides the <A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html#init(java.lang.Object)"><CODE>init(Object initData)</CODE></A> method
+ This interface provides the <A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html#init(java.lang.Object)"><CODE>init(Object initData)</CODE></A> method
as a hook for ToolboxManager implementations to pass data in to
- tools to initialize them. See
+ tools to initialize them. See
<A HREF="../../../../../../org/apache/velocity/tools/view/ViewToolInfo.html" title="class in org.apache.velocity.tools.view"><CODE>ViewToolInfo</CODE></A> for more on this.
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
- <DD>$Id: ViewTool.html,v 1.8 2004/03/12 02:07:22 marino Exp $</DD>
+ <DD>$Id$</DD>
<DT><B>Author:</B></DT>
<DD><a href="mailto:nathan@esha.com">Nathan Bubna</a></DD>
</DL>
<HR>
<P>
-<!-- ======== NESTED CLASS SUMMARY ======== -->
-
-
-<!-- =========== FIELD SUMMARY =========== -->
-
-
-<!-- ======== CONSTRUCTOR SUMMARY ======== -->
-
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=2><FONT SIZE="+2">
-<B>Method Summary</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -138,26 +134,20 @@
<P>
-<!-- ============ FIELD DETAIL =========== -->
-
-
-<!-- ========= CONSTRUCTOR DETAIL ======== -->
-
-
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=1><FONT SIZE="+2">
-<B>Method Detail</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="init(java.lang.Object)"><!-- --></A><H3>
init</H3>
<PRE>
-public void <B>init</B>(java.lang.Object initData)</PRE>
+void <B>init</B>(java.lang.Object initData)</PRE>
<DL>
<DD>Initializes this instance using the given data
<P>
@@ -174,7 +164,7 @@
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
-<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<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">
@@ -195,10 +185,10 @@
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- PREV CLASS
+ <A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewRenderTool.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="../../../../../../index.html?org/apache/velocity/tools/view/tools/ViewTool.html" target="_top"><B>FRAMES</B></A>
<A HREF="ViewTool.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
@@ -210,6 +200,7 @@
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
+
</FONT></TD>
</TR>
Modified: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/package-frame.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/package-frame.html?rev=326968&r1=326967&r2=326968&view=diff
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/package-frame.html (original)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/package-frame.html Thu Oct 20 11:34:40 2005
@@ -2,9 +2,9 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.4.2_01) on Fri Mar 12 02:01:01 GMT 2004 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Oct 20 10:35:35 PDT 2005 -->
<TITLE>
-org.apache.velocity.tools.view.tools (Velocity Tools 1.1-dev Documentation)
+org.apache.velocity.tools.view.tools (Velocity Tools 1.2 Documentation)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools package">
@@ -23,6 +23,8 @@
Interfaces</FONT>
<FONT CLASS="FrameItemFont">
<BR>
+<A HREF="Configurable.html" title="interface in org.apache.velocity.tools.view.tools" target="classFrame"><I>Configurable</I></A>
+<BR>
<A HREF="ViewTool.html" title="interface in org.apache.velocity.tools.view.tools" target="classFrame"><I>ViewTool</I></A></FONT></TD>
</TR>
</TABLE>
@@ -34,7 +36,11 @@
Classes</FONT>
<FONT CLASS="FrameItemFont">
<BR>
+<A HREF="AbstractPagerTool.html" title="class in org.apache.velocity.tools.view.tools" target="classFrame">AbstractPagerTool</A>
+<BR>
<A HREF="AbstractSearchTool.html" title="class in org.apache.velocity.tools.view.tools" target="classFrame">AbstractSearchTool</A>
+<BR>
+<A HREF="BrowserSnifferTool.html" title="class in org.apache.velocity.tools.view.tools" target="classFrame">BrowserSnifferTool</A>
<BR>
<A HREF="CookieTool.html" title="class in org.apache.velocity.tools.view.tools" target="classFrame">CookieTool</A>
<BR>
Modified: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/package-summary.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/package-summary.html?rev=326968&r1=326967&r2=326968&view=diff
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/package-summary.html (original)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/package-summary.html Thu Oct 20 11:34:40 2005
@@ -2,9 +2,9 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.4.2_01) on Fri Mar 12 02:01:01 GMT 2004 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Oct 20 10:35:35 PDT 2005 -->
<TITLE>
-org.apache.velocity.tools.view.tools (Velocity Tools 1.1-dev Documentation)
+org.apache.velocity.tools.view.tools (Velocity Tools 1.2 Documentation)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools package">
@@ -14,9 +14,11 @@
<SCRIPT type="text/javascript">
function windowTitle()
{
- parent.document.title="org.apache.velocity.tools.view.tools (Velocity Tools 1.1-dev Documentation)";
+ parent.document.title="org.apache.velocity.tools.view.tools (Velocity Tools 1.2 Documentation)";
}
</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
</HEAD>
@@ -28,7 +30,7 @@
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
-<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<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">
@@ -52,7 +54,7 @@
<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" target="_top"><B>FRAMES</B></A>
+ <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">
<!--
@@ -65,6 +67,7 @@
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
+
</FONT></TD>
</TR>
</TABLE>
@@ -75,7 +78,8 @@
<H2>
Package org.apache.velocity.tools.view.tools
</H2>
-Provides the ViewTool interface and several useful implementing classes
+Provides the ViewTool and Configurable interfaces, as well as a number
+of useful implementing classes.
<P>
<B>See:</B>
<BR>
@@ -84,13 +88,16 @@
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=2><FONT SIZE="+2">
-<B>Interface Summary</B></FONT></TD>
+<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>Interface for tools that can be passed configuration parameters.</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>Generic view tool interface to assist in tool management.
- </TD>
+<TD>Generic view tool interface to assist in tool management.</TD>
</TR>
</TABLE>
@@ -99,13 +106,22 @@
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=2><FONT SIZE="+2">
-<B>Class Summary</B></FONT></TD>
+<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>
+ 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/CookieTool.html" title="class in org.apache.velocity.tools.view.tools">CookieTool</A></B></TD>
@@ -113,13 +129,11 @@
</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
- Usage:<br>
- Just call $import.read("http://www.foo.com/bleh.jsp?</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>
+<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>
@@ -140,14 +154,16 @@
</H2>
<P>
-Provides the ViewTool interface and several useful implementing classes.
+<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....
+Provides for....
-->
<h2>Package Specification</h2>
@@ -172,6 +188,8 @@
<P>
<P>
+<DL>
+</DL>
<HR>
@@ -180,7 +198,7 @@
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
-<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<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">
@@ -204,7 +222,7 @@
<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" target="_top"><B>FRAMES</B></A>
+ <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">
<!--
@@ -216,6 +234,7 @@
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
+
</FONT></TD>
</TR>
Modified: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/package-tree.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/package-tree.html?rev=326968&r1=326967&r2=326968&view=diff
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/package-tree.html (original)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/package-tree.html Thu Oct 20 11:34:40 2005
@@ -2,9 +2,9 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.4.2_01) on Fri Mar 12 02:01:01 GMT 2004 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Oct 20 10:35:35 PDT 2005 -->
<TITLE>
-org.apache.velocity.tools.view.tools Class Hierarchy (Velocity Tools 1.1-dev Documentation)
+org.apache.velocity.tools.view.tools Class Hierarchy (Velocity Tools 1.2 Documentation)
</TITLE>
@@ -13,9 +13,11 @@
<SCRIPT type="text/javascript">
function windowTitle()
{
- parent.document.title="org.apache.velocity.tools.view.tools Class Hierarchy (Velocity Tools 1.1-dev Documentation)";
+ parent.document.title="org.apache.velocity.tools.view.tools Class Hierarchy (Velocity Tools 1.2 Documentation)";
}
</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
</HEAD>
@@ -27,7 +29,7 @@
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
-<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<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">
@@ -51,7 +53,7 @@
<A HREF="../../../../../../org/apache/velocity/tools/view/servlet/package-tree.html"><B>PREV</B></A>
NEXT</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="../../../../../../index.html?org/apache/velocity/tools/view/tools/package-tree.html" target="_top"><B>FRAMES</B></A>
<A HREF="package-tree.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
@@ -64,6 +66,7 @@
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
+
</FONT></TD>
</TR>
</TABLE>
@@ -83,17 +86,22 @@
Class Hierarchy
</H2>
<UL>
-<LI TYPE="circle">class java.lang.Object<UL>
-<LI TYPE="circle">class org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/AbstractSearchTool.html" title="class in org.apache.velocity.tools.view.tools"><B>AbstractSearchTool</B></A> (implements org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A>)
-<LI TYPE="circle">class org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/AbstractSearchTool.StoredResults.html" title="class in org.apache.velocity.tools.view.tools"><B>AbstractSearchTool.StoredResults</B></A> (implements java.io.Serializable)
-<LI TYPE="circle">class org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/CookieTool.html" title="class in org.apache.velocity.tools.view.tools"><B>CookieTool</B></A> (implements org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A>)
-<LI TYPE="circle">class org.apache.velocity.tools.view.<A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.html" title="class in org.apache.velocity.tools.view"><B>ImportSupport</B></A><UL>
-<LI TYPE="circle">class org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ImportTool.html" title="class in org.apache.velocity.tools.view.tools"><B>ImportTool</B></A> (implements org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A>)
+<LI TYPE="circle">java.lang.Object<UL>
+<LI TYPE="circle">org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/AbstractPagerTool.html" title="class in org.apache.velocity.tools.view.tools"><B>AbstractPagerTool</B></A> (implements org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A>)
+<UL>
+<LI TYPE="circle">org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/AbstractSearchTool.html" title="class in org.apache.velocity.tools.view.tools"><B>AbstractSearchTool</B></A></UL>
+<LI TYPE="circle">org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/AbstractSearchTool.StoredResults.html" title="class in org.apache.velocity.tools.view.tools"><B>AbstractSearchTool.StoredResults</B></A> (implements java.io.Serializable)
+<LI TYPE="circle">org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/BrowserSnifferTool.html" title="class in org.apache.velocity.tools.view.tools"><B>BrowserSnifferTool</B></A> (implements org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A>)
+<LI TYPE="circle">org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/CookieTool.html" title="class in org.apache.velocity.tools.view.tools"><B>CookieTool</B></A> (implements org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A>)
+<LI TYPE="circle">org.apache.velocity.tools.view.<A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.html" title="class in org.apache.velocity.tools.view"><B>ImportSupport</B></A><UL>
+<LI TYPE="circle">org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ImportTool.html" title="class in org.apache.velocity.tools.view.tools"><B>ImportTool</B></A> (implements org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A>)
+</UL>
+<LI TYPE="circle">org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools"><B>LinkTool</B></A> (implements java.lang.Cloneable, org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A>)
+<LI TYPE="circle">org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.QueryPair.html" title="class in org.apache.velocity.tools.view.tools"><B>LinkTool.QueryPair</B></A><LI TYPE="circle">org.apache.velocity.tools.generic.<A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html" title="class in org.apache.velocity.tools.generic"><B>RenderTool</B></A><UL>
+<LI TYPE="circle">org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewRenderTool.html" title="class in org.apache.velocity.tools.view.tools"><B>ViewRenderTool</B></A> (implements org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/Configurable.html" title="interface in org.apache.velocity.tools.view.tools">Configurable</A>, org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A>)
</UL>
-<LI TYPE="circle">class org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools"><B>LinkTool</B></A> (implements java.lang.Cloneable, org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A>)
-<LI TYPE="circle">class org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.QueryPair.html" title="class in org.apache.velocity.tools.view.tools"><B>LinkTool.QueryPair</B></A><LI TYPE="circle">class org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html" title="class in org.apache.velocity.tools.view.tools"><B>ParameterParser</B></A> (implements org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A>)
-<LI TYPE="circle">class org.apache.velocity.tools.generic.<A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html" title="class in org.apache.velocity.tools.generic"><B>RenderTool</B></A><UL>
-<LI TYPE="circle">class org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewRenderTool.html" title="class in org.apache.velocity.tools.view.tools"><B>ViewRenderTool</B></A> (implements org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A>)
+<LI TYPE="circle">org.apache.velocity.tools.generic.<A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic"><B>ValueParser</B></A><UL>
+<LI TYPE="circle">org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html" title="class in org.apache.velocity.tools.view.tools"><B>ParameterParser</B></A> (implements org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A>)
</UL>
</UL>
</UL>
@@ -101,7 +109,7 @@
Interface Hierarchy
</H2>
<UL>
-<LI TYPE="circle">interface org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools"><B>ViewTool</B></A></UL>
+<LI TYPE="circle">org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/Configurable.html" title="interface in org.apache.velocity.tools.view.tools"><B>Configurable</B></A><LI TYPE="circle">org.apache.velocity.tools.view.tools.<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools"><B>ViewTool</B></A></UL>
<HR>
@@ -110,7 +118,7 @@
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
-<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<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">
@@ -134,7 +142,7 @@
<A HREF="../../../../../../org/apache/velocity/tools/view/servlet/package-tree.html"><B>PREV</B></A>
NEXT</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="../../../../../../index.html?org/apache/velocity/tools/view/tools/package-tree.html" target="_top"><B>FRAMES</B></A>
<A HREF="package-tree.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
@@ -146,6 +154,7 @@
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
+
</FONT></TD>
</TR>
Modified: jakarta/velocity/tools/trunk/docs/javadoc/overview-frame.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/overview-frame.html?rev=326968&r1=326967&r2=326968&view=diff
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/overview-frame.html (original)
+++ jakarta/velocity/tools/trunk/docs/javadoc/overview-frame.html Thu Oct 20 11:34:40 2005
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.4.2_01) on Fri Mar 12 02:01:01 GMT 2004 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Oct 20 10:35:35 PDT 2005 -->
<TITLE>
-Overview (Velocity Tools 1.1-dev Documentation)
+Overview (Velocity Tools 1.2 Documentation)
</TITLE>
-<META NAME="keywords" CONTENT="Overview, <h1>Velocity Tools 1.1-dev Documentation</h1>">
+<META NAME="keywords" CONTENT="Overview, <h1>Velocity Tools 1.2 Documentation</h1>">
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
@@ -18,8 +18,8 @@
<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
<TR>
-<TD NOWRAP><FONT size="+1" CLASS="FrameTitleFont">
-<B></B></FONT></TD>
+<TH ALIGN="left" NOWRAP><FONT size="+1" CLASS="FrameTitleFont">
+<B></B></FONT></TH>
</TR>
</TABLE>
---------------------------------------------------------------------
To unsubscribe, e-mail: velocity-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: velocity-dev-help@jakarta.apache.org