velocity-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nbu...@apache.org
Subject svn commit: r489560 [14/15] - in /velocity/tools/trunk/docs: ./ generic/ javadoc/ javadoc/org/apache/velocity/tools/generic/ javadoc/org/apache/velocity/tools/generic/log/ javadoc/org/apache/velocity/tools/struts/ javadoc/org/apache/velocity/tools/view...
Date Fri, 22 Dec 2006 05:44:18 GMT
Modified: velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/Configurable.html
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/Configurable.html?view=diff&rev=489560&r1=489559&r2=489560
==============================================================================
--- velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/Configurable.html (original)
+++ velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/Configurable.html Thu Dec 21 21:44:15 2006
@@ -1,220 +1,220 @@
-<!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_09) on Tue Nov 21 22:45:27 CET 2006 -->
-<TITLE>
-Configurable (Velocity Tools 1.3-dev Documentation)
-</TITLE>
-
-<META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools.Configurable interface">
-
-<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
-
-<SCRIPT type="text/javascript">
-function windowTitle()
-{
-    parent.document.title="Configurable (Velocity Tools 1.3-dev 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>&nbsp;</TD>
-  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
-  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
-  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
-  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
-  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
-  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
-  </TR>
-</TABLE>
-</TD>
-<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
-</EM>
-</TD>
-</TR>
-
-<TR>
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
-&nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/tools/BrowserSnifferTool.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>&nbsp;
-&nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/tools/CookieTool.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?org/apache/velocity/tools/view/tools/Configurable.html" target="_top"><B>FRAMES</B></A>  &nbsp;
-&nbsp;<A HREF="Configurable.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
-&nbsp;<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>
-<TR>
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
-</TR>
-</TABLE>
-<A NAME="skip-navbar_top"></A>
-<!-- ========= END OF TOP NAVBAR ========= -->
-
-<HR>
-<!-- ======== START OF CLASS DATA ======== -->
-<H2>
-<FONT SIZE="-1">
-org.apache.velocity.tools.view.tools</FONT>
-<BR>
-Interface Configurable</H2>
-<HR>
-<B>Deprecated.</B>&nbsp;<I>Your tools now only need to have a configure(Map) method.</I>
-<P>
-<DL>
-<DT><PRE>public interface <B>Configurable</B></DL>
-</PRE>
-
-<P>
-Interface for tools that can be passed configuration parameters.
-<P>
-
-<P>
-<DL>
-<DT><B>Since:</B></DT>
-  <DD>VelocityTools 1.2</DD>
-<DT><B>Version:</B></DT>
-  <DD>$Id: Configurable.java 385114 2006-03-11 17:48:34Z nbubna $</DD>
-<DT><B>Author:</B></DT>
-  <DD><a href="mailto:nathan@esha.com">Nathan Bubna</a></DD>
-</DL>
-<HR>
-
-<P>
-
-<!-- ========== METHOD SUMMARY =========== -->
-
-<A NAME="method_summary"><!-- --></A>
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<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>&nbsp;void</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/Configurable.html#configure(java.util.Map)">configure</A></B>(java.util.Map&nbsp;parameters)</CODE>
-
-<BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;Configures this tool using the specified parameters.</TD>
-</TR>
-</TABLE>
-&nbsp;
-<P>
-
-<!-- ============ METHOD DETAIL ========== -->
-
-<A NAME="method_detail"><!-- --></A>
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
-<B>Method Detail</B></FONT></TH>
-</TR>
-</TABLE>
-
-<A NAME="configure(java.util.Map)"><!-- --></A><H3>
-configure</H3>
-<PRE>
-void <B>configure</B>(java.util.Map&nbsp;parameters)</PRE>
-<DL>
-<DD><B>Deprecated.</B>&nbsp;<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>Parameters:</B><DD><CODE>parameters</CODE> - the configuration data for this tool</DL>
-</DD>
-</DL>
-<!-- ========= END OF CLASS DATA ========= -->
-<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>&nbsp;</TD>
-  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
-  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
-  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
-  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
-  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
-  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
-  </TR>
-</TABLE>
-</TD>
-<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
-</EM>
-</TD>
-</TR>
-
-<TR>
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
-&nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/tools/BrowserSnifferTool.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>&nbsp;
-&nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/tools/CookieTool.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?org/apache/velocity/tools/view/tools/Configurable.html" target="_top"><B>FRAMES</B></A>  &nbsp;
-&nbsp;<A HREF="Configurable.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
-&nbsp;<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>
-<TR>
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
-</TR>
-</TABLE>
-<A NAME="skip-navbar_bottom"></A>
-<!-- ======== END OF BOTTOM NAVBAR ======= -->
-
-<HR>
-Copyright (c) 2003-2006 Apache Software Foundation
-</BODY>
-</HTML>
+<!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 Thu Dec 21 21:15:31 PST 2006 -->
+<TITLE>
+Configurable (VelocityTools 1.3-beta1 Documentation)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools.Configurable interface">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+    parent.document.title="Configurable (VelocityTools 1.3-beta1 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>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
+  </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+&nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/tools/BrowserSnifferTool.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.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?org/apache/velocity/tools/view/tools/Configurable.html" target="_top"><B>FRAMES</B></A>  &nbsp;
+&nbsp;<A HREF="Configurable.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
+&nbsp;<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>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+org.apache.velocity.tools.view.tools</FONT>
+<BR>
+Interface Configurable</H2>
+<HR>
+<B>Deprecated.</B>&nbsp;<I>Your tools now only need to have a configure(Map) method.</I>
+<P>
+<DL>
+<DT><PRE>public interface <B>Configurable</B></DL>
+</PRE>
+
+<P>
+Interface for tools that can be passed configuration parameters.
+<P>
+
+<P>
+<DL>
+<DT><B>Since:</B></DT>
+  <DD>VelocityTools 1.2</DD>
+<DT><B>Version:</B></DT>
+  <DD>$Id: Configurable.java 479724 2006-11-27 18:49:37Z nbubna $</DD>
+<DT><B>Author:</B></DT>
+  <DD>Nathan Bubna</DD>
+</DL>
+<HR>
+
+<P>
+
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<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>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/Configurable.html#configure(java.util.Map)">configure</A></B>(java.util.Map&nbsp;parameters)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;Configures this tool using the specified parameters.</TD>
+</TR>
+</TABLE>
+&nbsp;
+<P>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="configure(java.util.Map)"><!-- --></A><H3>
+configure</H3>
+<PRE>
+void <B>configure</B>(java.util.Map&nbsp;parameters)</PRE>
+<DL>
+<DD><B>Deprecated.</B>&nbsp;<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>Parameters:</B><DD><CODE>parameters</CODE> - the configuration data for this tool</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<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>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
+  </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+&nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/tools/BrowserSnifferTool.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.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?org/apache/velocity/tools/view/tools/Configurable.html" target="_top"><B>FRAMES</B></A>  &nbsp;
+&nbsp;<A HREF="Configurable.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
+&nbsp;<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>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright (c) 2003-2006 Apache Software Foundation
+</BODY>
+</HTML>

Added: velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ContextTool.html
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ContextTool.html?view=auto&rev=489560
==============================================================================
--- velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ContextTool.html (added)
+++ velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ContextTool.html Thu Dec 21 21:44:15 2006
@@ -0,0 +1,581 @@
+<!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 Thu Dec 21 21:15:31 PST 2006 -->
+<TITLE>
+ContextTool (VelocityTools 1.3-beta1 Documentation)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools.ContextTool class">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+    parent.document.title="ContextTool (VelocityTools 1.3-beta1 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>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
+  </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+&nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/tools/Configurable.html" title="interface in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/tools/CookieTool.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?org/apache/velocity/tools/view/tools/ContextTool.html" target="_top"><B>FRAMES</B></A>  &nbsp;
+&nbsp;<A HREF="ContextTool.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
+&nbsp;<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>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+org.apache.velocity.tools.view.tools</FONT>
+<BR>
+Class ContextTool</H2>
+<PRE>
+java.lang.Object
+  <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.view.tools.ContextTool</B>
+</PRE>
+<HR>
+<DL>
+<DT><PRE>public class <B>ContextTool</B><DT>extends java.lang.Object</DL>
+</PRE>
+
+<P>
+<p>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.</p>
+ <p><pre>
+ Template example(s):
+  #foreach( $key in $context.keys )
+    $key = $context.get($key)
+  #end
+
+ Toolbox configuration:
+ &lt;tool&gt;
+   &lt;key&gt;context&lt;/key&gt;
+   &lt;scope&gt;request&lt;/scope&gt;
+   &lt;class&gt;org.apache.velocity.tools.view.tools.ContextTool&lt;/class&gt;
+ &lt;/tool&gt;
+ </pre></p>
+
+ <p>This class is only designed for use as a request-scope VelocityView tool.</p>
+<P>
+
+<P>
+<DL>
+<DT><B>Since:</B></DT>
+  <DD>VelocityTools 1.3</DD>
+<DT><B>Version:</B></DT>
+  <DD>$Id: ContextTool.java 385122 2006-03-11 18:37:42Z nbubna $</DD>
+<DT><B>Author:</B></DT>
+  <DD>Nathan Bubna</DD>
+</DL>
+<HR>
+
+<P>
+<!-- =========== FIELD SUMMARY =========== -->
+
+<A NAME="field_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<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">
+<CODE>protected &nbsp;javax.servlet.ServletContext</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#application">application</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected &nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/context/ViewContext.html" title="interface in org.apache.velocity.tools.view.context">ViewContext</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#context">context</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected &nbsp;javax.servlet.http.HttpServletRequest</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#request">request</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#SAFE_MODE_KEY">SAFE_MODE_KEY</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The key used for specifying whether to hide keys with '.' in them.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>private &nbsp;boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#safeMode">safeMode</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected &nbsp;javax.servlet.http.HttpSession</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#session">session</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected &nbsp;java.util.Map</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#toolbox">toolbox</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+</TR>
+</TABLE>
+&nbsp;
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+<A NAME="constructor_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<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/ContextTool.html#ContextTool()">ContextTool</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+</TR>
+</TABLE>
+&nbsp;
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<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>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#configure(java.util.Map)">configure</A></B>(java.util.Map&nbsp;params)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Looks for a safe-mode configuration setting.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#contains(java.lang.Object)">contains</A></B>(java.lang.Object&nbsp;refName)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if the context contains a value for the specified
+ reference name (aka context key).</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#get(java.lang.Object)">get</A></B>(java.lang.Object&nbsp;refName)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieves the value for the specified reference name (aka context key).</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;java.util.Set</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#getKeys()">getKeys</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a <CODE>Set</CODE> of the available reference keys in the current
+ context.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/context/ViewContext.html" title="interface in org.apache.velocity.tools.view.context">ViewContext</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#getThis()">getThis</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the context being analyzed by this tool.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;java.util.Map</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#getToolbox()">getToolbox</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a read-only view of the toolbox <CODE>Map</CODE>
+ for this context.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;java.util.Set</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#getValues()">getValues</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a <CODE>Set</CODE> of the available values in the current
+ context.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#init(java.lang.Object)">init</A></B>(java.lang.Object&nbsp;obj)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initializes this instance for the current request.</TD>
+</TR>
+</TABLE>
+&nbsp;<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">
+<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>
+</TR>
+</TABLE>
+&nbsp;
+<P>
+
+<!-- ============ FIELD DETAIL =========== -->
+
+<A NAME="field_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Field Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="SAFE_MODE_KEY"><!-- --></A><H3>
+SAFE_MODE_KEY</H3>
+<PRE>
+public static final java.lang.String <B>SAFE_MODE_KEY</B></PRE>
+<DL>
+<DD>The key used for specifying whether to hide keys with '.' in them.
+<P>
+<DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.velocity.tools.view.tools.ContextTool.SAFE_MODE_KEY">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="context"><!-- --></A><H3>
+context</H3>
+<PRE>
+protected <A HREF="../../../../../../org/apache/velocity/tools/view/context/ViewContext.html" title="interface in org.apache.velocity.tools.view.context">ViewContext</A> <B>context</B></PRE>
+<DL>
+<DL>
+</DL>
+</DL>
+<HR>
+
+<A NAME="toolbox"><!-- --></A><H3>
+toolbox</H3>
+<PRE>
+protected java.util.Map <B>toolbox</B></PRE>
+<DL>
+<DL>
+</DL>
+</DL>
+<HR>
+
+<A NAME="request"><!-- --></A><H3>
+request</H3>
+<PRE>
+protected javax.servlet.http.HttpServletRequest <B>request</B></PRE>
+<DL>
+<DL>
+</DL>
+</DL>
+<HR>
+
+<A NAME="session"><!-- --></A><H3>
+session</H3>
+<PRE>
+protected javax.servlet.http.HttpSession <B>session</B></PRE>
+<DL>
+<DL>
+</DL>
+</DL>
+<HR>
+
+<A NAME="application"><!-- --></A><H3>
+application</H3>
+<PRE>
+protected javax.servlet.ServletContext <B>application</B></PRE>
+<DL>
+<DL>
+</DL>
+</DL>
+<HR>
+
+<A NAME="safeMode"><!-- --></A><H3>
+safeMode</H3>
+<PRE>
+private boolean <B>safeMode</B></PRE>
+<DL>
+<DL>
+</DL>
+</DL>
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+<A NAME="constructor_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="ContextTool()"><!-- --></A><H3>
+ContextTool</H3>
+<PRE>
+public <B>ContextTool</B>()</PRE>
+<DL>
+</DL>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="configure(java.util.Map)"><!-- --></A><H3>
+configure</H3>
+<PRE>
+public void <B>configure</B>(java.util.Map&nbsp;params)</PRE>
+<DL>
+<DD>Looks for a safe-mode configuration setting. By default,
+ safe-mode is true and thus keys with '.' in them are hidden.
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="init(java.lang.Object)"><!-- --></A><H3>
+init</H3>
+<PRE>
+public void <B>init</B>(java.lang.Object&nbsp;obj)</PRE>
+<DL>
+<DD>Initializes this instance for the current request.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>obj</CODE> - the ViewContext of the current request</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getThis()"><!-- --></A><H3>
+getThis</H3>
+<PRE>
+public <A HREF="../../../../../../org/apache/velocity/tools/view/context/ViewContext.html" title="interface in org.apache.velocity.tools.view.context">ViewContext</A> <B>getThis</B>()</PRE>
+<DL>
+<DD>Returns the context being analyzed by this tool.
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getToolbox()"><!-- --></A><H3>
+getToolbox</H3>
+<PRE>
+public java.util.Map <B>getToolbox</B>()</PRE>
+<DL>
+<DD><p>Returns a read-only view of the toolbox <CODE>Map</CODE>
+ for this context.</p>
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>an unmodifiable version of the toolbox for this request
+         or <code>null</code> if there is none</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getKeys()"><!-- --></A><H3>
+getKeys</H3>
+<PRE>
+public java.util.Set <B>getKeys</B>()</PRE>
+<DL>
+<DD><p>Return a <CODE>Set</CODE> of the available reference keys in the current
+ context.</p>
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getValues()"><!-- --></A><H3>
+getValues</H3>
+<PRE>
+public java.util.Set <B>getValues</B>()</PRE>
+<DL>
+<DD><p>Return a <CODE>Set</CODE> of the available values in the current
+ context.</p>
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="contains(java.lang.Object)"><!-- --></A><H3>
+contains</H3>
+<PRE>
+public boolean <B>contains</B>(java.lang.Object&nbsp;refName)</PRE>
+<DL>
+<DD><p>Returns <code>true</code> if the context contains a value for the specified
+ reference name (aka context key).</p>
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="get(java.lang.Object)"><!-- --></A><H3>
+get</H3>
+<PRE>
+public java.lang.Object <B>get</B>(java.lang.Object&nbsp;refName)</PRE>
+<DL>
+<DD>Retrieves the value for the specified reference name (aka context key).
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<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>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
+  </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+&nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/tools/Configurable.html" title="interface in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/tools/CookieTool.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?org/apache/velocity/tools/view/tools/ContextTool.html" target="_top"><B>FRAMES</B></A>  &nbsp;
+&nbsp;<A HREF="ContextTool.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
+&nbsp;<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>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright (c) 2003-2006 Apache Software Foundation
+</BODY>
+</HTML>

Propchange: velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ContextTool.html
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/CookieTool.html
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/CookieTool.html?view=diff&rev=489560&r1=489559&r2=489560
==============================================================================
--- velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/CookieTool.html (original)
+++ velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/CookieTool.html Thu Dec 21 21:44:15 2006
@@ -2,9 +2,9 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.5.0_09) on Tue Nov 21 22:45:27 CET 2006 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Dec 21 21:15:31 PST 2006 -->
 <TITLE>
-CookieTool (Velocity Tools 1.3-dev Documentation)
+CookieTool (VelocityTools 1.3-beta1 Documentation)
 </TITLE>
 
 <META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools.CookieTool class">
@@ -14,7 +14,7 @@
 <SCRIPT type="text/javascript">
 function windowTitle()
 {
-    parent.document.title="CookieTool (Velocity Tools 1.3-dev Documentation)";
+    parent.document.title="CookieTool (VelocityTools 1.3-beta1 Documentation)";
 }
 </SCRIPT>
 <NOSCRIPT>
@@ -51,7 +51,7 @@
 
 <TR>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
-&nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/tools/Configurable.html" title="interface in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>&nbsp;
 &nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ImportTool.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?org/apache/velocity/tools/view/tools/CookieTool.html" target="_top"><B>FRAMES</B></A>  &nbsp;
@@ -121,7 +121,7 @@
 <DT><B>Version:</B></DT>
   <DD>$Id$</DD>
 <DT><B>Author:</B></DT>
-  <DD><a href="mailto:dim@colebatch.com">Dmitri Colebatch</a>, <a href="mailto:nathan@esha.com">Nathan Bubna</a></DD>
+  <DD><a href="mailto:dim@colebatch.com">Dmitri Colebatch</a>, Nathan Bubna</DD>
 </DL>
 <HR>
 
@@ -189,9 +189,9 @@
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;void</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/CookieTool.html#add(java.lang.String, java.lang.String, int)">add</A></B>(java.lang.String&nbsp;name,
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/CookieTool.html#add(java.lang.String, java.lang.String, java.lang.Object)">add</A></B>(java.lang.String&nbsp;name,
     java.lang.String&nbsp;value,
-    int&nbsp;maxAge)</CODE>
+    java.lang.Object&nbsp;maxAge)</CODE>
 
 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convenience method to add a new Cookie to the response
@@ -200,6 +200,26 @@
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;javax.servlet.http.Cookie</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/CookieTool.html#create(java.lang.String, java.lang.String)">create</A></B>(java.lang.String&nbsp;name,
+       java.lang.String&nbsp;value)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new Cookie with the specified name and value.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;javax.servlet.http.Cookie</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/CookieTool.html#create(java.lang.String, java.lang.String, java.lang.Object)">create</A></B>(java.lang.String&nbsp;name,
+       java.lang.String&nbsp;value,
+       java.lang.Object&nbsp;maxAge)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convenience method to create a new Cookie
+ and set an expiry time for it.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;javax.servlet.http.Cookie</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/CookieTool.html#get(java.lang.String)">get</A></B>(java.lang.String&nbsp;name)</CODE>
 
 <BR>
@@ -352,12 +372,12 @@
 </DL>
 <HR>
 
-<A NAME="add(java.lang.String, java.lang.String, int)"><!-- --></A><H3>
+<A NAME="add(java.lang.String, java.lang.String, java.lang.Object)"><!-- --></A><H3>
 add</H3>
 <PRE>
 public void <B>add</B>(java.lang.String&nbsp;name,
                 java.lang.String&nbsp;value,
-                int&nbsp;maxAge)</PRE>
+                java.lang.Object&nbsp;maxAge)</PRE>
 <DL>
 <DD>Convenience method to add a new Cookie to the response
  and set an expiry time for it.
@@ -366,6 +386,45 @@
 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name to give this cookie<DD><CODE>value</CODE> - the value to be set for this cookie<DD><CODE>maxAge</CODE> - the expiry to be set for this cookie</DL>
 </DD>
 </DL>
+<HR>
+
+<A NAME="create(java.lang.String, java.lang.String)"><!-- --></A><H3>
+create</H3>
+<PRE>
+public javax.servlet.http.Cookie <B>create</B>(java.lang.String&nbsp;name,
+                                        java.lang.String&nbsp;value)</PRE>
+<DL>
+<DD>Creates a new Cookie with the specified name and value.
+ This does *not* add the Cookie to the response, so the
+ created Cookie will not be set unless you do
+ <code>$response.addCookie($myCookie)</code>.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name to give this cookie<DD><CODE>value</CODE> - the value to be set for this cookie
+<DT><B>Returns:</B><DD>The new Cookie object.<DT><B>Since:</B></DT>
+  <DD>VelocityTools 1.3</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="create(java.lang.String, java.lang.String, java.lang.Object)"><!-- --></A><H3>
+create</H3>
+<PRE>
+public javax.servlet.http.Cookie <B>create</B>(java.lang.String&nbsp;name,
+                                        java.lang.String&nbsp;value,
+                                        java.lang.Object&nbsp;maxAge)</PRE>
+<DL>
+<DD>Convenience method to create a new Cookie
+ and set an expiry time for it.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name to give this cookie<DD><CODE>value</CODE> - the value to be set for this cookie<DD><CODE>maxAge</CODE> - the expiry to be set for this cookie
+<DT><B>Returns:</B><DD>The new Cookie object.<DT><B>Since:</B></DT>
+  <DD>VelocityTools 1.3</DD>
+</DL>
+</DD>
+</DL>
 <!-- ========= END OF CLASS DATA ========= -->
 <HR>
 
@@ -396,7 +455,7 @@
 
 <TR>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
-&nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/tools/Configurable.html" title="interface in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>&nbsp;
 &nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ImportTool.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?org/apache/velocity/tools/view/tools/CookieTool.html" target="_top"><B>FRAMES</B></A>  &nbsp;

Modified: velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ImportTool.html
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ImportTool.html?view=diff&rev=489560&r1=489559&r2=489560
==============================================================================
--- velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ImportTool.html (original)
+++ velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ImportTool.html Thu Dec 21 21:44:15 2006
@@ -2,9 +2,9 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.5.0_09) on Tue Nov 21 22:45:27 CET 2006 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Dec 21 21:15:31 PST 2006 -->
 <TITLE>
-ImportTool (Velocity Tools 1.3-dev Documentation)
+ImportTool (VelocityTools 1.3-beta1 Documentation)
 </TITLE>
 
 <META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools.ImportTool class">
@@ -14,7 +14,7 @@
 <SCRIPT type="text/javascript">
 function windowTitle()
 {
-    parent.document.title="ImportTool (Velocity Tools 1.3-dev Documentation)";
+    parent.document.title="ImportTool (VelocityTools 1.3-beta1 Documentation)";
 }
 </SCRIPT>
 <NOSCRIPT>

Modified: velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/LinkTool.QueryPair.html
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/LinkTool.QueryPair.html?view=diff&rev=489560&r1=489559&r2=489560
==============================================================================
--- velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/LinkTool.QueryPair.html (original)
+++ velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/LinkTool.QueryPair.html Thu Dec 21 21:44:15 2006
@@ -2,9 +2,9 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.5.0_09) on Tue Nov 21 22:45:27 CET 2006 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Dec 21 21:15:31 PST 2006 -->
 <TITLE>
-LinkTool.QueryPair (Velocity Tools 1.3-dev Documentation)
+LinkTool.QueryPair (VelocityTools 1.3-beta1 Documentation)
 </TITLE>
 
 <META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools.LinkTool.QueryPair class">
@@ -14,7 +14,7 @@
 <SCRIPT type="text/javascript">
 function windowTitle()
 {
-    parent.document.title="LinkTool.QueryPair (Velocity Tools 1.3-dev Documentation)";
+    parent.document.title="LinkTool.QueryPair (VelocityTools 1.3-beta1 Documentation)";
 }
 </SCRIPT>
 <NOSCRIPT>

Modified: velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/LinkTool.html
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/LinkTool.html?view=diff&rev=489560&r1=489559&r2=489560
==============================================================================
--- velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/LinkTool.html (original)
+++ velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/LinkTool.html Thu Dec 21 21:44:15 2006
@@ -2,9 +2,9 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.5.0_09) on Tue Nov 21 22:45:27 CET 2006 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Dec 21 21:15:31 PST 2006 -->
 <TITLE>
-LinkTool (Velocity Tools 1.3-dev Documentation)
+LinkTool (VelocityTools 1.3-beta1 Documentation)
 </TITLE>
 
 <META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools.LinkTool class">
@@ -14,7 +14,7 @@
 <SCRIPT type="text/javascript">
 function windowTitle()
 {
-    parent.document.title="LinkTool (Velocity Tools 1.3-dev Documentation)";
+    parent.document.title="LinkTool (VelocityTools 1.3-beta1 Documentation)";
 }
 </SCRIPT>
 <NOSCRIPT>
@@ -128,7 +128,7 @@
 <DT><B>Version:</B></DT>
   <DD>$Id$</DD>
 <DT><B>Author:</B></DT>
-  <DD><a href="mailto:sidler@teamup.com">Gabe Sidler</a>, <a href="mailto:nathan@esha.com">Nathan Bubna</a></DD>
+  <DD><a href="mailto:sidler@teamup.com">Gabe Sidler</a>, Nathan Bubna</DD>
 </DL>
 <HR>
 
@@ -233,6 +233,38 @@
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#SELF_ABSOLUTE_KEY">SELF_ABSOLUTE_KEY</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parameter key for configuring <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setSelfAbsolute(boolean)"><CODE>setSelfAbsolute(boolean)</CODE></A> state</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#SELF_INCLUDE_PARAMETERS_KEY">SELF_INCLUDE_PARAMETERS_KEY</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parameter key for configuring <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setSelfIncludeParameters(boolean)"><CODE>setSelfIncludeParameters(boolean)</CODE></A> state</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>private &nbsp;boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#selfAbsolute">selfAbsolute</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The self-absolute status</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>private &nbsp;boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#selfParams">selfParams</A></B></CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The self-include-parameters status</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>private &nbsp;java.lang.String</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#uri">uri</A></B></CODE>
 
@@ -308,6 +340,14 @@
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#configure(java.util.Map)">configure</A></B>(java.util.Map&nbsp;params)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Configures this tool</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>protected &nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A></CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#copyWith(org.apache.velocity.tools.view.tools.LinkTool.QueryPair)">copyWith</A></B>(<A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.QueryPair.html" title="class in org.apache.velocity.tools.view.tools">LinkTool.QueryPair</A>&nbsp;pair)</CODE>
 
@@ -317,7 +357,7 @@
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>protected &nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A></CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#copyWith(java.util.Map)">copyWith</A></B>(java.util.Map&nbsp;queryData)</CODE>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#copyWith(java.util.Map)">copyWith</A></B>(java.util.Map&nbsp;newQueryData)</CODE>
 
 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;For internal use.</TD>
@@ -391,6 +431,15 @@
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getParams()">getParams</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convenience method equivalent to
+ <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getQueryData()"><CODE>getQueryData()</CODE></A>.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getQueryData()">getQueryData</A></B>()</CODE>
 
 <BR>
@@ -399,11 +448,39 @@
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getRequestPath()">getRequestPath</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieves the path for the current request regardless of
+ whether this is a direct request or an include by the
+ RequestDispatcher.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getSelf()">getSelf</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method returns a new "self-referencing" LinkTool for the current
+ request.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getUri()">getUri</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convenience method equivalent to <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getURI()"><CODE>getURI()</CODE></A> to enable
+ all lowercase <code>$link.uri</code> syntax.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getURI()">getURI</A></B>()</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the current URI of this link as set by the setURI(String)
- or setRelative(String) methods.</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the current URI of this link as set by the setURI(String),
+ setAbsolute(String) or setRelative(String) methods.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -469,6 +546,24 @@
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected &nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setSelfAbsolute(boolean)">setSelfAbsolute</A></B>(boolean&nbsp;selfAbsolute)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Controls whether or not the <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getSelf()"><CODE>getSelf()</CODE></A> method will return
+    a duplicate with a URI in absolute or relative form.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected &nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setSelfIncludeParameters(boolean)">setSelfIncludeParameters</A></B>(boolean&nbsp;selfParams)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Controls whether or not the <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getSelf()"><CODE>getSelf()</CODE></A> method will return
+    a duplicate that includes current request parameters.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;<A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A></CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setURI(java.lang.String)">setURI</A></B>(java.lang.String&nbsp;uri)</CODE>
 
@@ -533,6 +628,34 @@
 </DL>
 <HR>
 
+<A NAME="SELF_ABSOLUTE_KEY"><!-- --></A><H3>
+SELF_ABSOLUTE_KEY</H3>
+<PRE>
+public static final java.lang.String <B>SELF_ABSOLUTE_KEY</B></PRE>
+<DL>
+<DD>Parameter key for configuring <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setSelfAbsolute(boolean)"><CODE>setSelfAbsolute(boolean)</CODE></A> state
+<P>
+<DL>
+<DT><B>Since:</B></DT>
+  <DD>VelocityTools 1.3</DD>
+<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.velocity.tools.view.tools.LinkTool.SELF_ABSOLUTE_KEY">Constant Field Values</A></DL>
+</DL>
+<HR>
+
+<A NAME="SELF_INCLUDE_PARAMETERS_KEY"><!-- --></A><H3>
+SELF_INCLUDE_PARAMETERS_KEY</H3>
+<PRE>
+public static final java.lang.String <B>SELF_INCLUDE_PARAMETERS_KEY</B></PRE>
+<DL>
+<DD>Parameter key for configuring <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setSelfIncludeParameters(boolean)"><CODE>setSelfIncludeParameters(boolean)</CODE></A> state
+<P>
+<DL>
+<DT><B>Since:</B></DT>
+  <DD>VelocityTools 1.3</DD>
+<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.velocity.tools.view.tools.LinkTool.SELF_INCLUDE_PARAMETERS_KEY">Constant Field Values</A></DL>
+</DL>
+<HR>
+
 <A NAME="HTML_QUERY_DELIMITER"><!-- --></A><H3>
 HTML_QUERY_DELIMITER</H3>
 <PRE>
@@ -641,6 +764,30 @@
 </DL>
 <HR>
 
+<A NAME="selfAbsolute"><!-- --></A><H3>
+selfAbsolute</H3>
+<PRE>
+private boolean <B>selfAbsolute</B></PRE>
+<DL>
+<DD>The self-absolute status
+<P>
+<DL>
+</DL>
+</DL>
+<HR>
+
+<A NAME="selfParams"><!-- --></A><H3>
+selfParams</H3>
+<PRE>
+private boolean <B>selfParams</B></PRE>
+<DL>
+<DD>The self-include-parameters status
+<P>
+<DL>
+</DL>
+</DL>
+<HR>
+
 <A NAME="encode"><!-- --></A><H3>
 encode</H3>
 <PRE>
@@ -703,6 +850,48 @@
 </DL>
 <HR>
 
+<A NAME="setSelfAbsolute(boolean)"><!-- --></A><H3>
+setSelfAbsolute</H3>
+<PRE>
+protected void <B>setSelfAbsolute</B>(boolean&nbsp;selfAbsolute)</PRE>
+<DL>
+<DD><p>Controls whether or not the <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getSelf()"><CODE>getSelf()</CODE></A> method will return
+    a duplicate with a URI in absolute or relative form.</p>
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>selfAbsolute</CODE> - if true, the <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getSelf()"><CODE>getSelf()</CODE></A> method will return
+        a duplicate of this tool with an absolute self-referencing URI;
+        if false, a duplicate with a relative self-referencing URI will
+        be returned<DT><B>Since:</B></DT>
+  <DD>VelocityTools 1.3</DD>
+<DT><B>See Also:</B><DD><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getSelf()"><CODE>getSelf()</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setSelfIncludeParameters(boolean)"><!-- --></A><H3>
+setSelfIncludeParameters</H3>
+<PRE>
+protected void <B>setSelfIncludeParameters</B>(boolean&nbsp;selfParams)</PRE>
+<DL>
+<DD><p>Controls whether or not the <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getSelf()"><CODE>getSelf()</CODE></A> method will return
+    a duplicate that includes current request parameters.</p>
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>selfParams</CODE> - if true, the <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getSelf()"><CODE>getSelf()</CODE></A> method will return
+        a duplicate of this tool that includes current request parameters<DT><B>Since:</B></DT>
+  <DD>VelocityTools 1.3</DD>
+<DT><B>See Also:</B><DD><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getSelf()"><CODE>getSelf()</CODE></A></DL>
+</DD>
+</DL>
+<HR>
+
 <A NAME="copyWith(org.apache.velocity.tools.view.tools.LinkTool.QueryPair)"><!-- --></A><H3>
 copyWith</H3>
 <PRE>
@@ -724,7 +913,7 @@
 <A NAME="copyWith(java.util.Map)"><!-- --></A><H3>
 copyWith</H3>
 <PRE>
-protected <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A> <B>copyWith</B>(java.util.Map&nbsp;queryData)</PRE>
+protected <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A> <B>copyWith</B>(java.util.Map&nbsp;newQueryData)</PRE>
 <DL>
 <DD>For internal use.
 
@@ -734,7 +923,7 @@
 </DL>
 </DD>
 <DD><DL>
-<DT><B>Parameters:</B><DD><CODE>queryData</CODE> - the query parameters to add<DT><B>Since:</B></DT>
+<DT><B>Parameters:</B><DD><CODE>newQueryData</CODE> - the query parameters to add<DT><B>Since:</B></DT>
   <DD>VelocityTools 1.3</DD>
 </DL>
 </DD>
@@ -794,6 +983,24 @@
 </DL>
 <HR>
 
+<A NAME="configure(java.util.Map)"><!-- --></A><H3>
+configure</H3>
+<PRE>
+public void <B>configure</B>(java.util.Map&nbsp;params)</PRE>
+<DL>
+<DD>Configures this tool
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>params</CODE> - Map of configuration parameters<DT><B>Since:</B></DT>
+  <DD>VelocityTools 1.3</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
 <A NAME="init(java.lang.Object)"><!-- --></A><H3>
 init</H3>
 <PRE>
@@ -1007,8 +1214,8 @@
 <PRE>
 public java.lang.String <B>getURI</B>()</PRE>
 <DL>
-<DD><p>Returns the current URI of this link as set by the setURI(String)
- or setRelative(String) methods. Any conversions
+<DD><p>Returns the current URI of this link as set by the setURI(String),
+ setAbsolute(String) or setRelative(String) methods. Any conversions
  have been applied. The returned URI reference does not include query
  data that was added with method addQueryData().</p>
 <P>
@@ -1021,6 +1228,25 @@
 </DL>
 <HR>
 
+<A NAME="getUri()"><!-- --></A><H3>
+getUri</H3>
+<PRE>
+public java.lang.String <B>getUri</B>()</PRE>
+<DL>
+<DD>Convenience method equivalent to <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getURI()"><CODE>getURI()</CODE></A> to enable
+ all lowercase <code>$link.uri</code> syntax.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Since:</B></DT>
+  <DD>VelocityTools 1.3</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
 <A NAME="addQueryData(java.lang.String, java.lang.Object)"><!-- --></A><H3>
 addQueryData</H3>
 <PRE>
@@ -1118,6 +1344,25 @@
 </DL>
 <HR>
 
+<A NAME="getParams()"><!-- --></A><H3>
+getParams</H3>
+<PRE>
+public java.lang.String <B>getParams</B>()</PRE>
+<DL>
+<DD>Convenience method equivalent to
+ <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getQueryData()"><CODE>getQueryData()</CODE></A>.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Since:</B></DT>
+  <DD>VelocityTools 1.3</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
 <A NAME="getContextURL()"><!-- --></A><H3>
 getContextURL</H3>
 <PRE>
@@ -1157,6 +1402,28 @@
 </DL>
 <HR>
 
+<A NAME="getRequestPath()"><!-- --></A><H3>
+getRequestPath</H3>
+<PRE>
+public java.lang.String <B>getRequestPath</B>()</PRE>
+<DL>
+<DD><p>Retrieves the path for the current request regardless of
+ whether this is a direct request or an include by the
+ RequestDispatcher. Note! This will not
+ represent any URI reference or query data set for this
+ LinkTool.</p>
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Since:</B></DT>
+  <DD>VelocityTools 1.3</DD>
+</DL>
+</DD>
+</DL>
+<HR>
+
 <A NAME="getBaseRef()"><!-- --></A><H3>
 getBaseRef</H3>
 <PRE>
@@ -1174,6 +1441,32 @@
 </DD>
 <DD><DL>
 </DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getSelf()"><!-- --></A><H3>
+getSelf</H3>
+<PRE>
+public <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A> <B>getSelf</B>()</PRE>
+<DL>
+<DD>This method returns a new "self-referencing" LinkTool for the current
+ request. By default, this is merely a shortcut for calling
+ <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#relative(java.lang.String)"><CODE>relative(String uri)</CODE></A> using the result of
+ <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getRequestPath()"><CODE>getRequestPath()</CODE></A>.  However, this tool can be configured
+ to return an absolute URI and/or to include the parameters of the
+ current request (in addition to any others set so far).
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Since:</B></DT>
+  <DD>VelocityTools 1.3</DD>
+<DT><B>See Also:</B><DD><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#uri(java.lang.String)"><CODE>uri(String uri)</CODE></A>, 
+<A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#configure(java.util.Map)"><CODE>configure(Map params)</CODE></A>, 
+<A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setSelfAbsolute(boolean)"><CODE>setSelfAbsolute(boolean selfAbsolute)</CODE></A>, 
+<A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setSelfIncludeParameters(boolean)"><CODE>setSelfIncludeParameters(boolean selfParams)</CODE></A></DL>
 </DD>
 </DL>
 <HR>

Modified: velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ParameterParser.html
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ParameterParser.html?view=diff&rev=489560&r1=489559&r2=489560
==============================================================================
--- velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ParameterParser.html (original)
+++ velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ParameterParser.html Thu Dec 21 21:44:15 2006
@@ -2,9 +2,9 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.5.0_09) on Tue Nov 21 22:45:27 CET 2006 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Dec 21 21:15:31 PST 2006 -->
 <TITLE>
-ParameterParser (Velocity Tools 1.3-dev Documentation)
+ParameterParser (VelocityTools 1.3-beta1 Documentation)
 </TITLE>
 
 <META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools.ParameterParser class">
@@ -14,7 +14,7 @@
 <SCRIPT type="text/javascript">
 function windowTitle()
 {
-    parent.document.title="ParameterParser (Velocity Tools 1.3-dev Documentation)";
+    parent.document.title="ParameterParser (VelocityTools 1.3-beta1 Documentation)";
 }
 </SCRIPT>
 <NOSCRIPT>
@@ -124,7 +124,7 @@
 <DT><B>Version:</B></DT>
   <DD>$Revision$ $Date$</DD>
 <DT><B>Author:</B></DT>
-  <DD><a href="mailto:nathan@esha.com">Nathan Bubna</a></DD>
+  <DD>Nathan Bubna</DD>
 </DL>
 <HR>
 
@@ -179,6 +179,14 @@
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;java.util.Map</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#getAll()">getAll</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the map of all parameters available for the current request.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>protected &nbsp;javax.servlet.ServletRequest</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#getRequest()">getRequest</A></B>()</CODE>
 
@@ -192,8 +200,7 @@
 
 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Overrides ValueParser.getSource() to return the result
- of getRequest().getParameterMap() if Servlet 2.3 or above
- is being used.</TD>
+ of getRequest().getParameterMap().</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -430,14 +437,24 @@
 protected java.util.Map <B>getSource</B>()</PRE>
 <DL>
 <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.
+ of getRequest().getParameterMap().
 <P>
 <DD><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>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getAll()"><!-- --></A><H3>
+getAll</H3>
+<PRE>
+public java.util.Map <B>getAll</B>()</PRE>
+<DL>
+<DD>Returns the map of all parameters available for the current request.
+<P>
 <DD><DL>
 </DL>
 </DD>

Modified: velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ViewRenderTool.html
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ViewRenderTool.html?view=diff&rev=489560&r1=489559&r2=489560
==============================================================================
--- velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ViewRenderTool.html (original)
+++ velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ViewRenderTool.html Thu Dec 21 21:44:15 2006
@@ -2,9 +2,9 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.5.0_09) on Tue Nov 21 22:45:27 CET 2006 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Dec 21 21:15:31 PST 2006 -->
 <TITLE>
-ViewRenderTool (Velocity Tools 1.3-dev Documentation)
+ViewRenderTool (VelocityTools 1.3-beta1 Documentation)
 </TITLE>
 
 <META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools.ViewRenderTool class">
@@ -14,7 +14,7 @@
 <SCRIPT type="text/javascript">
 function windowTitle()
 {
-    parent.document.title="ViewRenderTool (Velocity Tools 1.3-dev Documentation)";
+    parent.document.title="ViewRenderTool (VelocityTools 1.3-beta1 Documentation)";
 }
 </SCRIPT>
 <NOSCRIPT>
@@ -151,7 +151,7 @@
 <DT><B>Version:</B></DT>
   <DD>$Revision$ $Date$</DD>
 <DT><B>Author:</B></DT>
-  <DD><a href="mailto:nathan@esha.com">Nathan Bubna</a></DD>
+  <DD>Nathan Bubna</DD>
 </DL>
 <HR>
 
@@ -179,7 +179,7 @@
 <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><A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html#DEFAULT_PARSE_DEPTH">DEFAULT_PARSE_DEPTH</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html#KEY_PARSE_DEPTH">KEY_PARSE_DEPTH</A></CODE></TD>
+<TD><CODE><A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html#DEFAULT_PARSE_DEPTH">DEFAULT_PARSE_DEPTH</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html#KEY_CATCH_EXCEPTIONS">KEY_CATCH_EXCEPTIONS</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html#KEY_PARSE_DEPTH">KEY_PARSE_DEPTH</A></CODE></TD>
 </TR>
 </TABLE>
 &nbsp;
@@ -240,7 +240,7 @@
 <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#configure(java.util.Map)">configure</A>, <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>
+<TD><CODE><A HREF="../../../../../../org/apache/velocity/tools/generic/RenderTool.html#configure(java.util.Map)">configure</A>, <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#getCatchExceptions()">getCatchExceptions</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#setCatchExceptions(boolean)">setCatchExceptions</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>
 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>

Modified: velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ViewTool.html
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ViewTool.html?view=diff&rev=489560&r1=489559&r2=489560
==============================================================================
--- velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ViewTool.html (original)
+++ velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ViewTool.html Thu Dec 21 21:44:15 2006
@@ -2,9 +2,9 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.5.0_09) on Tue Nov 21 22:45:27 CET 2006 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Dec 21 21:15:31 PST 2006 -->
 <TITLE>
-ViewTool (Velocity Tools 1.3-dev Documentation)
+ViewTool (VelocityTools 1.3-beta1 Documentation)
 </TITLE>
 
 <META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools.ViewTool interface">
@@ -14,7 +14,7 @@
 <SCRIPT type="text/javascript">
 function windowTitle()
 {
-    parent.document.title="ViewTool (Velocity Tools 1.3-dev Documentation)";
+    parent.document.title="ViewTool (VelocityTools 1.3-beta1 Documentation)";
 }
 </SCRIPT>
 <NOSCRIPT>
@@ -107,7 +107,7 @@
 <DT><B>Version:</B></DT>
   <DD>$Id$</DD>
 <DT><B>Author:</B></DT>
-  <DD><a href="mailto:nathan@esha.com">Nathan Bubna</a></DD>
+  <DD>Nathan Bubna</DD>
 </DL>
 <HR>
 

Modified: velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/package-frame.html
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/package-frame.html?view=diff&rev=489560&r1=489559&r2=489560
==============================================================================
--- velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/package-frame.html (original)
+++ velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/package-frame.html Thu Dec 21 21:44:15 2006
@@ -2,9 +2,9 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.5.0_09) on Tue Nov 21 22:45:27 CET 2006 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Dec 21 21:15:31 PST 2006 -->
 <TITLE>
-org.apache.velocity.tools.view.tools (Velocity Tools 1.3-dev Documentation)
+org.apache.velocity.tools.view.tools (VelocityTools 1.3-beta1 Documentation)
 </TITLE>
 
 <META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools package">
@@ -41,6 +41,8 @@
 <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="ContextTool.html" title="class in org.apache.velocity.tools.view.tools" target="classFrame">ContextTool</A>
 <BR>
 <A HREF="CookieTool.html" title="class in org.apache.velocity.tools.view.tools" target="classFrame">CookieTool</A>
 <BR>

Modified: velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/package-summary.html
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/package-summary.html?view=diff&rev=489560&r1=489559&r2=489560
==============================================================================
--- velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/package-summary.html (original)
+++ velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/package-summary.html Thu Dec 21 21:44:15 2006
@@ -2,9 +2,9 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.5.0_09) on Tue Nov 21 22:45:27 CET 2006 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Dec 21 21:15:31 PST 2006 -->
 <TITLE>
-org.apache.velocity.tools.view.tools (Velocity Tools 1.3-dev Documentation)
+org.apache.velocity.tools.view.tools (VelocityTools 1.3-beta1 Documentation)
 </TITLE>
 
 <META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools package">
@@ -14,7 +14,7 @@
 <SCRIPT type="text/javascript">
 function windowTitle()
 {
-    parent.document.title="org.apache.velocity.tools.view.tools (Velocity Tools 1.3-dev Documentation)";
+    parent.document.title="org.apache.velocity.tools.view.tools (VelocityTools 1.3-beta1 Documentation)";
 }
 </SCRIPT>
 <NOSCRIPT>
@@ -122,6 +122,11 @@
 <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>



Mime
View raw message