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 [19/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...
Added: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/Configurable.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/Configurable.html?rev=326968&view=auto
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/Configurable.html (added)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/Configurable.html Thu Oct 20 11:34:40 2005
@@ -0,0 +1,221 @@
+<!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 Oct 20 10:35:35 PDT 2005 -->
+<TITLE>
+Configurable (Velocity Tools 1.2 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.2 Documentation)";
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../../../org/apache/velocity/tools/view/tools/BrowserSnifferTool.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>
+ <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>
+ <A HREF="Configurable.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <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>
+<DL>
+<DT><B>All Known Implementing Classes:</B> <DD><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><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 321233 2005-10-14 22:25: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> 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 parameters)</CODE>
+
+<BR>
+ Configures this tool using the specified parameters.</TD>
+</TR>
+</TABLE>
+
+<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 parameters)</PRE>
+<DL>
+<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> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../../../org/apache/velocity/tools/view/tools/BrowserSnifferTool.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>
+ <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>
+ <A HREF="Configurable.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright (c) 2003 Apache Software Foundation
+</BODY>
+</HTML>
Modified: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/CookieTool.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/CookieTool.html?rev=326968&r1=326967&r2=326968&view=diff
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/CookieTool.html (original)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/CookieTool.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>
-CookieTool (Velocity Tools 1.1-dev Documentation)
+CookieTool (Velocity Tools 1.2 Documentation)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools.CookieTool class">
@@ -14,9 +14,11 @@
<SCRIPT type="text/javascript">
function windowTitle()
{
- parent.document.title="CookieTool (Velocity Tools 1.1-dev Documentation)";
+ parent.document.title="CookieTool (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">
- <A HREF="../../../../../../org/apache/velocity/tools/view/tools/AbstractSearchTool.StoredResults.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../../org/apache/velocity/tools/view/tools/Configurable.html" title="interface in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>
<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" target="_top"><B>FRAMES</B></A>
+ <A HREF="../../../../../../index.html?org/apache/velocity/tools/view/tools/CookieTool.html" target="_top"><B>FRAMES</B></A>
<A HREF="CookieTool.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,14 +89,15 @@
Class CookieTool</H2>
<PRE>
java.lang.Object
- <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.velocity.tools.view.tools.CookieTool</B>
+ <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.view.tools.CookieTool</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>CookieTool</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>CookieTool</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>
+</PRE>
<P>
<p>View tool for convenient cookie access and creation.</p>
@@ -118,23 +122,20 @@
<DT><B>Since:</B></DT>
<DD>VelocityTools 1.1</DD>
<DT><B>Version:</B></DT>
- <DD>$Id: CookieTool.html,v 1.7 2004/03/12 02:07:22 marino Exp $</DD>
+ <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>
</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">
@@ -159,8 +160,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/CookieTool.html#CookieTool()">CookieTool</A></B>()</CODE>
@@ -175,8 +176,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>
+<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">
@@ -186,7 +187,7 @@
<BR>
Adds a new Cookie with the specified name and value
- to the HttpServletResponse. </TD>
+ to the HttpServletResponse.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -205,9 +206,7 @@
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/CookieTool.html#get(java.lang.String)">get</A></B>(java.lang.String name)</CODE>
<BR>
- Returns the Cookie with the specified name, if it exists.
-
- </TD>
+ Returns the Cookie with the specified name, if it exists.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -215,9 +214,7 @@
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/CookieTool.html#getAll()">getAll</A></B>()</CODE>
<BR>
- Expose array of Cookies for this request to the template.
-
- </TD>
+ Expose array of Cookies for this request to the template.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -231,7 +228,7 @@
<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>
@@ -245,8 +242,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>
@@ -274,8 +271,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>
@@ -291,8 +288,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>
@@ -339,7 +336,7 @@
<DD>Returns the Cookie with the specified name, if it exists.
<p>So, if you had a cookie named 'foo', you'd get it's value
- by <code>$cookies.foo.value</code> or it's max age
+ by <code>$cookies.foo.value</code> or it's max age
by <code>$cookies.foo.maxAge</code></p>
<P>
<DD><DL>
@@ -396,7 +393,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">
@@ -417,10 +414,10 @@
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../../org/apache/velocity/tools/view/tools/AbstractSearchTool.StoredResults.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../../org/apache/velocity/tools/view/tools/Configurable.html" title="interface in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>
<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" target="_top"><B>FRAMES</B></A>
+ <A HREF="../../../../../../index.html?org/apache/velocity/tools/view/tools/CookieTool.html" target="_top"><B>FRAMES</B></A>
<A HREF="CookieTool.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
@@ -432,6 +429,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/ImportTool.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ImportTool.html?rev=326968&r1=326967&r2=326968&view=diff
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ImportTool.html (original)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/ImportTool.html Thu Oct 20 11:34:40 2005
@@ -1,29 +1,38 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc on Sat Feb 21 10:25:36 PST 2004 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Oct 20 10:35:35 PDT 2005 -->
<TITLE>
-ImportTool (Velocity Tools 1.1-rc1 Documentation)
+ImportTool (Velocity Tools 1.2 Documentation)
</TITLE>
-<META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools.ImportTool,ImportTool class">
+
+<META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools.ImportTool class">
+
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
-</HEAD>
-<SCRIPT>
-function asd()
+
+<SCRIPT type="text/javascript">
+function windowTitle()
{
-parent.document.title="ImportTool (Velocity Tools 1.1-rc1 Documentation)";
+ parent.document.title="ImportTool (Velocity Tools 1.2 Documentation)";
}
</SCRIPT>
-<BODY BGCOLOR="white" onload="asd();">
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
-<!-- ========== START OF NAVBAR ========== -->
+
+<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
-<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
+<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">
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
@@ -42,32 +51,34 @@
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../../org/apache/velocity/tools/view/tools/CookieTool.html"><B>PREV CLASS</B></A>
- <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html"><B>NEXT CLASS</B></A></FONT></TD>
+ <A HREF="../../../../../../org/apache/velocity/tools/view/tools/CookieTool.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.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="ImportTool.html" TARGET="_top"><B>NO FRAMES</B></A>
-
-<SCRIPT>
+ <A HREF="../../../../../../index.html?org/apache/velocity/tools/view/tools/ImportTool.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="ImportTool.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
<!--
if(window==top) {
- document.writeln('<A HREF="../../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
+ document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
-<A HREF="../../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
+ <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
+
+
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: <A HREF="#nested_classes_inherited_from_class_org.apache.velocity.tools.view.ImportSupport">NESTED</A> | <A HREF="#fields_inherited_from_class_org.apache.velocity.tools.view.ImportSupport">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+ SUMMARY: <A HREF="#nested_classes_inherited_from_class_org.apache.velocity.tools.view.ImportSupport">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
-<!-- =========== END OF NAVBAR =========== -->
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
@@ -78,21 +89,20 @@
Class ImportTool</H2>
<PRE>
java.lang.Object
- |
- +--<A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.html">org.apache.velocity.tools.view.ImportSupport</A>
- |
- +--<B>org.apache.velocity.tools.view.tools.ImportTool</B>
+ <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.html" title="class in org.apache.velocity.tools.view">org.apache.velocity.tools.view.ImportSupport</A>
+ <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.view.tools.ImportTool</B>
</PRE>
<DL>
-<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html">ViewTool</A></DD>
+<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>ImportTool</B><DT>extends <A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.html">ImportSupport</A><DT>implements <A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html">ViewTool</A></DL>
+<DT><PRE>public class <B>ImportTool</B><DT>extends <A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.html" title="class in org.apache.velocity.tools.view">ImportSupport</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>General-purpose text-importing view tool for templates</p>
- <p>Usage:<br>
+General-purpose text-importing view tool for templates.
+ <p>Usage:<br />
Just call $import.read("http://www.foo.com/bleh.jsp?sneh=bar") to insert the contents of the named
resource into the template.
</p>
@@ -111,7 +121,7 @@
<DT><B>Since:</B></DT>
<DD>VelocityTools 1.1</DD>
<DT><B>Version:</B></DT>
- <DD>$Revision: 1.3 $ $Date: 2004/02/21 18:33:04 $</DD>
+ <DD>$Revision$ $Date$</DD>
<DT><B>Author:</B></DT>
<DD><a href="mailto:marinoj@centrum.is">Marino A. Jonsson</a></DD>
</DL>
@@ -121,35 +131,43 @@
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="nested_class_summary"><!-- --></A>
-<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=2><FONT SIZE="+2">
-<B>Nested Class Summary</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Nested Class Summary</B></FONT></TH>
</TR>
</TABLE>
<A NAME="nested_classes_inherited_from_class_org.apache.velocity.tools.view.ImportSupport"><!-- --></A>
-<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
-<TD><B>Nested classes inherited from class org.apache.velocity.tools.view.<A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.html">ImportSupport</A></B></TD>
+<TH ALIGN="left"><B>Nested classes/interfaces inherited from class org.apache.velocity.tools.view.<A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.html" title="class in org.apache.velocity.tools.view">ImportSupport</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE><A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.ImportResponseWrapper.html">ImportSupport.ImportResponseWrapper</A></CODE></TD>
+<TD><CODE><A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.ImportResponseWrapper.html" title="class in org.apache.velocity.tools.view">ImportSupport.ImportResponseWrapper</A></CODE></TD>
</TR>
</TABLE>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
-<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<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">
+<CODE>protected static org.apache.commons.logging.Log</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ImportTool.html#LOG">LOG</A></B></CODE>
+
+<BR>
+ </TD>
</TR>
</TABLE>
<A NAME="fields_inherited_from_class_org.apache.velocity.tools.view.ImportSupport"><!-- --></A>
-<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<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.view.<A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.html">ImportSupport</A></B></TD>
+<TH ALIGN="left"><B>Fields inherited from class org.apache.velocity.tools.view.<A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.html" title="class in org.apache.velocity.tools.view">ImportSupport</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.html#application">application</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.html#DEFAULT_ENCODING">DEFAULT_ENCODING</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.html#isAbsoluteUrl">isAbsoluteUrl</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.html#request">request</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.html#response">response</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.html#VALID_SCHEME_CHARS">VALID_SCHEME_CHARS</A></CODE></TD>
@@ -159,10 +177,10 @@
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
-<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<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/ImportTool.html#ImportTool()">ImportTool</A></B>()</CODE>
@@ -175,10 +193,10 @@
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
-<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<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">
@@ -194,22 +212,22 @@
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ImportTool.html#read(java.lang.String)">read</A></B>(java.lang.String url)</CODE>
<BR>
- </TD>
+ Returns the supplied URL rendered as a String.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.apache.velocity.tools.view.ImportSupport"><!-- --></A>
-<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<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.view.<A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.html">ImportSupport</A></B></TD>
+<TH ALIGN="left"><B>Methods inherited from class org.apache.velocity.tools.view.<A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.html" title="class in org.apache.velocity.tools.view">ImportSupport</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.html#acquireReader(java.lang.String)">acquireReader</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.html#acquireString(java.lang.String)">acquireString</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.html#getContentTypeAttribute(java.lang.String, java.lang.String)">getContentTypeAttribute</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.html#isAbsoluteUrl(java.lang.String)">isAbsoluteUrl</A>, <A HREF="../../../../../../org/apache/velocity/tools/view/ImportSupport.html#stripSession(java.lang.String)">stripSession</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
-<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<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>
@@ -220,14 +238,30 @@
<!-- ============ 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="LOG"><!-- --></A><H3>
+LOG</H3>
+<PRE>
+protected static final org.apache.commons.logging.Log <B>LOG</B></PRE>
+<DL>
+<DL>
+</DL>
+</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
-<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<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>
@@ -243,10 +277,10 @@
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
-<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
+<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>
@@ -258,7 +292,7 @@
<DD>Initializes this tool.
<P>
<DD><DL>
-<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html#init(java.lang.Object)">init</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html">ViewTool</A></CODE></DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html#init(java.lang.Object)">init</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>obj</CODE> - the current ViewContext
@@ -273,6 +307,8 @@
<PRE>
public java.lang.String <B>read</B>(java.lang.String url)</PRE>
<DL>
+<DD>Returns the supplied URL rendered as a String.
+<P>
<DD><DL>
</DL>
</DD>
@@ -284,13 +320,15 @@
<!-- ========= END OF CLASS DATA ========= -->
<HR>
-<!-- ========== START OF NAVBAR ========== -->
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
-<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
+<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">
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
@@ -309,32 +347,34 @@
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../../org/apache/velocity/tools/view/tools/CookieTool.html"><B>PREV CLASS</B></A>
- <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html"><B>NEXT CLASS</B></A></FONT></TD>
+ <A HREF="../../../../../../org/apache/velocity/tools/view/tools/CookieTool.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.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="ImportTool.html" TARGET="_top"><B>NO FRAMES</B></A>
-
-<SCRIPT>
+ <A HREF="../../../../../../index.html?org/apache/velocity/tools/view/tools/ImportTool.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="ImportTool.html" target="_top"><B>NO FRAMES</B></A>
+ <SCRIPT type="text/javascript">
<!--
if(window==top) {
- document.writeln('<A HREF="../../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
+ document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
-<A HREF="../../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
+ <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
+
+
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: <A HREF="#nested_classes_inherited_from_class_org.apache.velocity.tools.view.ImportSupport">NESTED</A> | <A HREF="#fields_inherited_from_class_org.apache.velocity.tools.view.ImportSupport">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+ SUMMARY: <A HREF="#nested_classes_inherited_from_class_org.apache.velocity.tools.view.ImportSupport">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
+DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
-<!-- =========== END OF NAVBAR =========== -->
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright (c) 2003 Apache Software Foundation
Modified: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/LinkTool.QueryPair.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/LinkTool.QueryPair.html?rev=326968&r1=326967&r2=326968&view=diff
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/LinkTool.QueryPair.html (original)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/LinkTool.QueryPair.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>
-LinkTool.QueryPair (Velocity Tools 1.1-dev Documentation)
+LinkTool.QueryPair (Velocity Tools 1.2 Documentation)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools.LinkTool.QueryPair class">
@@ -14,9 +14,11 @@
<SCRIPT type="text/javascript">
function windowTitle()
{
- parent.document.title="LinkTool.QueryPair (Velocity Tools 1.1-dev Documentation)";
+ parent.document.title="LinkTool.QueryPair (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.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>
<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.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/LinkTool.QueryPair.html" target="_top"><B>FRAMES</B></A>
<A HREF="LinkTool.QueryPair.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,14 +89,15 @@
Class LinkTool.QueryPair</H2>
<PRE>
java.lang.Object
- <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.velocity.tools.view.tools.LinkTool.QueryPair</B>
+ <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.view.tools.LinkTool.QueryPair</B>
</PRE>
<DL>
<DT><B>Enclosing class:</B><DD><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A></DD>
</DL>
<HR>
<DL>
-<DT>protected final class <B>LinkTool.QueryPair</B><DT>extends java.lang.Object</DL>
+<DT><PRE>protected final class <B>LinkTool.QueryPair</B><DT>extends java.lang.Object</DL>
+</PRE>
<P>
Internal util class to handle representation and
@@ -104,16 +108,13 @@
<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">
@@ -138,8 +139,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/LinkTool.QueryPair.html#LinkTool.QueryPair(java.lang.String, java.lang.Object)">LinkTool.QueryPair</A></B>(java.lang.String key,
@@ -155,8 +156,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>
+<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">
@@ -180,7 +181,7 @@
<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, wait, wait, wait</CODE></TD>
@@ -194,8 +195,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>
@@ -223,8 +224,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>
@@ -236,15 +237,17 @@
<DL>
<DD>Construct a new query pair.
<P>
+<DL>
<DT><B>Parameters:</B><DD><CODE>key</CODE> - query pair<DD><CODE>value</CODE> - query value</DL>
+</DL>
<!-- ============ 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>
@@ -256,6 +259,9 @@
<DD>Return the URL-encoded query string.
<P>
<DD><DL>
+<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
+</DD>
+<DD><DL>
</DL>
</DD>
</DL>
@@ -281,7 +287,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">
@@ -305,7 +311,7 @@
<A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>
<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.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/LinkTool.QueryPair.html" target="_top"><B>FRAMES</B></A>
<A HREF="LinkTool.QueryPair.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
@@ -317,6 +323,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/LinkTool.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/LinkTool.html?rev=326968&r1=326967&r2=326968&view=diff
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/LinkTool.html (original)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/view/tools/LinkTool.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>
-LinkTool (Velocity Tools 1.1-dev Documentation)
+LinkTool (Velocity Tools 1.2 Documentation)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools.LinkTool class">
@@ -14,9 +14,11 @@
<SCRIPT type="text/javascript">
function windowTitle()
{
- parent.document.title="LinkTool (Velocity Tools 1.1-dev Documentation)";
+ parent.document.title="LinkTool (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/ImportTool.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>
<A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.QueryPair.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/LinkTool.html" target="_top"><B>FRAMES</B></A>
<A HREF="LinkTool.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,7 +89,7 @@
Class LinkTool</H2>
<PRE>
java.lang.Object
- <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.velocity.tools.view.tools.LinkTool</B>
+ <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.view.tools.LinkTool</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.lang.Cloneable, <A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A></DD>
@@ -96,10 +99,11 @@
</DL>
<HR>
<DL>
-<DT>public class <B>LinkTool</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>, java.lang.Cloneable</DL>
+<DT><PRE>public class <B>LinkTool</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>, java.lang.Cloneable</DL>
+</PRE>
<P>
-<p>View tool to make building URIs pleasant and fun! :)</p>
+View tool to make building URIs pleasant and fun!
<p><pre>
Template example(s):
#set( $base = $link.setRelative('MyPage.vm').setAnchor('view') )
@@ -122,7 +126,7 @@
<DT><B>Since:</B></DT>
<DD>VelocityTools 1.0</DD>
<DT><B>Version:</B></DT>
- <DD>$Id: LinkTool.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:sidler@teamup.com">Gabe Sidler</a>, <a href="mailto:nathan@esha.com">Nathan Bubna</a></DD>
</DL>
@@ -134,8 +138,8 @@
<A NAME="nested_class_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=2><FONT SIZE="+2">
-<B>Nested Class Summary</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Nested Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -147,14 +151,13 @@
encoding of key/value pairs in the query string</TD>
</TR>
</TABLE>
-
-<!-- =========== FIELD 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">
@@ -190,6 +193,14 @@
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected static org.apache.commons.logging.Log</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#LOG">LOG</A></B></CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private java.util.ArrayList</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#queryData">queryData</A></B></CODE>
@@ -243,14 +254,14 @@
<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/LinkTool.html#LinkTool()">LinkTool</A></B>()</CODE>
<BR>
- Default constructor. </TD>
+ Default constructor.</TD>
</TR>
</TABLE>
@@ -259,8 +270,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>
+<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">
@@ -269,7 +280,7 @@
java.lang.Object value)</CODE>
<BR>
- Adds a key=value pair to the query data. </TD>
+ Adds a key=value pair to the query data.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -277,9 +288,7 @@
<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> pair)</CODE>
<BR>
- For internal use.
-
- </TD>
+ For internal use.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -287,9 +296,7 @@
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#copyWith(java.lang.String)">copyWith</A></B>(java.lang.String uri)</CODE>
<BR>
- For internal use.
-
- </TD>
+ For internal use.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -297,9 +304,7 @@
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#copyWithAnchor(java.lang.String)">copyWithAnchor</A></B>(java.lang.String anchor)</CODE>
<BR>
- For internal use.
-
- </TD>
+ For internal use.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -316,7 +321,7 @@
<BR>
Use the new URLEncoder.encode() method from java 1.4 if available, else
- use the old deprecated version. </TD>
+ use the old deprecated version.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -332,8 +337,7 @@
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getBaseRef()">getBaseRef</A></B>()</CODE>
<BR>
- Returns the full URI of this template without any query data.
- </TD>
+ Returns the full URI of this template without any query data.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -341,8 +345,8 @@
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getContextPath()">getContextPath</A></B>()</CODE>
<BR>
- Returns the context path that addresses this web
- application, e.g. </TD>
+ Returns the context path that addresses this web
+ application, e.g.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -350,7 +354,7 @@
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getContextURL()">getContextURL</A></B>()</CODE>
<BR>
- Returns the URI that addresses this web application. </TD>
+ Returns the URI that addresses this web application.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -358,8 +362,7 @@
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getQueryData()">getQueryData</A></B>()</CODE>
<BR>
- Returns this link's query data as a url-encoded string e.g.
- </TD>
+ Returns this link's query data as a url-encoded string e.g.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -367,8 +370,8 @@
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getURI()">getURI</A></B>()</CODE>
<BR>
- Returns the current URI of this link as set by the setURI(String)
- or setRelative(String) methods. </TD>
+ Returns the current URI of this link as set by the setURI(String)
+ or setRelative(String) methods.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -384,7 +387,7 @@
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setAnchor(java.lang.String)">setAnchor</A></B>(java.lang.String anchor)</CODE>
<BR>
- Returns a copy of the link with the specified anchor to be
+ Returns a copy of the link with the specified anchor to be
added to the end of the generated hyperlink.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -394,7 +397,7 @@
<BR>
Returns a copy of the link with the specified context-relative
- URI reference converted to a server-relative URI reference. </TD>
+ URI reference converted to a server-relative URI reference.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -402,8 +405,7 @@
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setURI(java.lang.String)">setURI</A></B>(java.lang.String uri)</CODE>
<BR>
- Returns a copy of the link with the given URI reference set.
- </TD>
+ Returns a copy of the link with the given URI reference set.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -411,8 +413,7 @@
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setXhtml(boolean)">setXhtml</A></B>(boolean useXhtml)</CODE>
<BR>
- Controls the delimiter used for separating query data pairs.
- </TD>
+ Controls the delimiter used for separating query data pairs.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -420,15 +421,14 @@
<TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#toString()">toString</A></B>()</CODE>
<BR>
- Returns the full URI reference that's been built with this tool,
- including the query string and anchor, e.g.
- </TD>
+ Returns the full URI reference that's been built with this tool,
+ including the query string and anchor, e.g.</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, wait, wait, wait</CODE></TD>
@@ -442,11 +442,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="LOG"><!-- --></A><H3>
+LOG</H3>
+<PRE>
+protected static final org.apache.commons.logging.Log <B>LOG</B></PRE>
+<DL>
+<DL>
+</DL>
+</DL>
+<HR>
+
<A NAME="HTML_QUERY_DELIMITER"><!-- --></A><H3>
HTML_QUERY_DELIMITER</H3>
<PRE>
@@ -571,8 +581,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>
@@ -590,8 +600,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>
@@ -660,14 +670,14 @@
<DL>
<DD>For internal use.
- Copies 'that' LinkTool into this one and sets the new
+ Copies 'that' LinkTool into this one and sets the new
anchor for the link.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>anchor</CODE> - URI string</DL>
</DD>
</DL>
<HR>
@@ -711,7 +721,7 @@
<PRE>
public <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A> <B>setAnchor</B>(java.lang.String anchor)</PRE>
<DL>
-<DD><p>Returns a copy of the link with the specified anchor to be
+<DD><p>Returns a copy of the link with the specified anchor to be
added to the end of the generated hyperlink.</p>
Example:<br>
@@ -751,9 +761,9 @@
public <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A> <B>setRelative</B>(java.lang.String uri)</PRE>
<DL>
<DD><p>Returns a copy of the link with the specified context-relative
- URI reference converted to a server-relative URI reference. This
- method will overwrite any previous URI reference settings but will
- copy the query string.</p>
+ URI reference converted to a server-relative URI reference. This
+ method will overwrite any previous URI reference settings but will
+ copy the query string.</p>
Example:<br>
<code><a href='$link.setRelative("/templates/login/index.vm")'>Login Page</a></code><br>
@@ -764,7 +774,7 @@
</DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>uri</CODE> - A context-relative URI reference. A context-relative URI
+<DT><B>Parameters:</B><DD><CODE>uri</CODE> - A context-relative URI reference. A context-relative URI
is a URI that is relative to the root of this web application.
<DT><B>Returns:</B><DD>a new instance of LinkTool with the specified URI</DL>
</DD>
@@ -776,11 +786,11 @@
<PRE>
public <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A> <B>setURI</B>(java.lang.String uri)</PRE>
<DL>
-<DD><p>Returns a copy of the link with the given URI reference set.
- No conversions are applied to the given URI reference. The URI
+<DD><p>Returns a copy of the link with the given URI reference set.
+ No conversions are applied to the given URI reference. The URI
reference can be absolute, server-relative, relative and may
- contain query parameters. This method will overwrite any
- previous URI reference settings but will copy the query
+ contain query parameters. This method will overwrite any
+ previous URI reference settings but will copy the query
string.</p>
<P>
<DD><DL>
@@ -798,9 +808,9 @@
<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
- have been applied. The returned URI reference does not include query
+<DD><p>Returns the current URI of this link as set by the setURI(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>
<DD><DL>
@@ -818,7 +828,7 @@
public <A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A> <B>addQueryData</B>(java.lang.String key,
java.lang.Object value)</PRE>
<DL>
-<DD><p>Adds a key=value pair to the query data. This returns a new LinkTool
+<DD><p>Adds a key=value pair to the query data. This returns a new LinkTool
containing both a copy of this LinkTool's query data and the new data.
Query data is URL encoded before it is appended.</p>
<P>
@@ -837,7 +847,7 @@
<PRE>
public java.lang.String <B>getQueryData</B>()</PRE>
<DL>
-<DD><p>Returns this link's query data as a url-encoded string e.g.
+<DD><p>Returns this link's query data as a url-encoded string e.g.
<code>key=value&foo=this+is+encoded</code>.</p>
<P>
<DD><DL>
@@ -854,9 +864,9 @@
<PRE>
public java.lang.String <B>getContextURL</B>()</PRE>
<DL>
-<DD><p>Returns the URI that addresses this web application. E.g.
- <code>http://myserver.net/myapp</code>. This string does not end
- with a "/". Note! This will not represent any URI reference or
+<DD><p>Returns the URI that addresses this web application. E.g.
+ <code>http://myserver.net/myapp</code>. This string does not end
+ with a "/". Note! This will not represent any URI reference or
query data set for this LinkTool.</p>
<P>
<DD><DL>
@@ -873,10 +883,10 @@
<PRE>
public java.lang.String <B>getContextPath</B>()</PRE>
<DL>
-<DD><p>Returns the context path that addresses this web
- application, e.g. <code>/myapp</code>. This string starts
- with a "/" but does not end with a "/" Note! This will not
- represent any URI reference or query data set for this
+<DD><p>Returns the context path that addresses this web
+ application, e.g. <code>/myapp</code>. This string starts
+ with a "/" but does not end with a "/" Note! This will not
+ represent any URI reference or query data set for this
LinkTool.</p>
<P>
<DD><DL>
@@ -895,9 +905,9 @@
<DL>
<DD>Returns the full URI of this template without any query data.
e.g. <code>http://myserver.net/myapp/stuff/View.vm</code>
- Note! The returned String will not represent any URI reference
- or query data set for this LinkTool. A typical application of
- this method is with the HTML base tag. For example:
+ Note! The returned String will not represent any URI reference
+ or query data set for this LinkTool. A typical application of
+ this method is with the HTML base tag. For example:
<code><base href="$link.baseRef"></code>
<P>
<DD><DL>
@@ -914,15 +924,15 @@
<PRE>
public java.lang.String <B>toString</B>()</PRE>
<DL>
-<DD>Returns the full URI reference that's been built with this tool,
- including the query string and anchor, e.g.
+<DD>Returns the full URI reference that's been built with this tool,
+ including the query string and anchor, e.g.
<code>http://myserver.net/myapp/stuff/View.vm?id=42&type=blue#foo</code>.
Typically, it is not necessary to call this method explicitely.
- Velocity will call the toString() method automatically to obtain
+ Velocity will call the toString() method automatically to obtain
a representable version of an object.
<P>
<DD><DL>
-</DL>
+<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
</DL>
@@ -957,7 +967,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">
@@ -981,7 +991,7 @@
<A HREF="../../../../../../org/apache/velocity/tools/view/tools/ImportTool.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>
<A HREF="../../../../../../org/apache/velocity/tools/view/tools/LinkTool.QueryPair.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/LinkTool.html" target="_top"><B>FRAMES</B></A>
<A HREF="LinkTool.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
@@ -993,6 +1003,7 @@
<NOSCRIPT>
<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
+
</FONT></TD>
</TR>
---------------------------------------------------------------------
To unsubscribe, e-mail: velocity-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: velocity-dev-help@jakarta.apache.org