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 [8/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/co...
Added: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/struts/MessageTool.TextKey.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/struts/MessageTool.TextKey.html?rev=326968&view=auto
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/struts/MessageTool.TextKey.html (added)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/struts/MessageTool.TextKey.html Thu Oct 20 11:34:40 2005
@@ -0,0 +1,354 @@
+<!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:34 PDT 2005 -->
+<TITLE>
+MessageTool.TextKey (Velocity Tools 1.2 Documentation)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.velocity.tools.struts.MessageTool.TextKey class">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="MessageTool.TextKey (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/struts/MessageTool.html" title="class in org.apache.velocity.tools.struts"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html" title="class in org.apache.velocity.tools.struts"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../../index.html?org/apache/velocity/tools/struts/MessageTool.TextKey.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="MessageTool.TextKey.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 | <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: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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.struts</FONT>
+<BR>
+Class MessageTool.TextKey</H2>
+<PRE>
+java.lang.Object
+ <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.struts.MessageTool.TextKey</B>
+</PRE>
+<DL>
+<DT><B>Enclosing class:</B><DD><A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.html" title="class in org.apache.velocity.tools.struts">MessageTool</A></DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public class <B>MessageTool.TextKey</B><DT>extends java.lang.Object</DL>
+</PRE>
+
+<P>
+Helper class to simplify tool usage when retrieving
+ no-arg messages from the default bundle that have periods
+ in their key.
+
+ <p>So instead of <code>$text.get("forms.profile.title")</code>,1
+ you can just type <code>$text.forms.profile.title</code>. Also,
+ this lets you do things like:
+ <pre>
+ #set( $profiletext = $text.forms.profile )
+ <h1>$profiletext.title</h1>
+ <h3>$profiletext.subtitle</h3>
+ </pre>
+ </p>
+<P>
+
+<P>
+<DL>
+<DT><B>Since:</B></DT>
+ <DD>VelocityTools 1.2</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>private java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.TextKey.html#key">key</A></B></CODE>
+
+<BR>
+ </TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>private <A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.html" title="class in org.apache.velocity.tools.struts">MessageTool</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.TextKey.html#tool">tool</A></B></CODE>
+
+<BR>
+ </TD>
+</TR>
+</TABLE>
+
+<!-- ======== 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/struts/MessageTool.TextKey.html#MessageTool.TextKey(org.apache.velocity.tools.struts.MessageTool, java.lang.String)">MessageTool.TextKey</A></B>(<A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.html" title="class in org.apache.velocity.tools.struts">MessageTool</A> tool,
+ java.lang.String key)</CODE>
+
+<BR>
+ </TD>
+</TR>
+</TABLE>
+
+<!-- ========== 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> <A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.TextKey.html" title="class in org.apache.velocity.tools.struts">MessageTool.TextKey</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.TextKey.html#get(java.lang.String)">get</A></B>(java.lang.String key)</CODE>
+
+<BR>
+ Appends a period and the new key to the current
+ key and returns a new TextKey instance with the
+ combined result as its key.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.TextKey.html#toString()">toString</A></B>()</CODE>
+
+<BR>
+ </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">
+<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>
+</TR>
+</TABLE>
+
+<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="tool"><!-- --></A><H3>
+tool</H3>
+<PRE>
+private <A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.html" title="class in org.apache.velocity.tools.struts">MessageTool</A> <B>tool</B></PRE>
+<DL>
+<DL>
+</DL>
+</DL>
+<HR>
+
+<A NAME="key"><!-- --></A><H3>
+key</H3>
+<PRE>
+private java.lang.String <B>key</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="MessageTool.TextKey(org.apache.velocity.tools.struts.MessageTool, java.lang.String)"><!-- --></A><H3>
+MessageTool.TextKey</H3>
+<PRE>
+public <B>MessageTool.TextKey</B>(<A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.html" title="class in org.apache.velocity.tools.struts">MessageTool</A> tool,
+ java.lang.String key)</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="get(java.lang.String)"><!-- --></A><H3>
+get</H3>
+<PRE>
+public <A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.TextKey.html" title="class in org.apache.velocity.tools.struts">MessageTool.TextKey</A> <B>get</B>(java.lang.String key)</PRE>
+<DL>
+<DD>Appends a period and the new key to the current
+ key and returns a new TextKey instance with the
+ combined result as its key.
+<P>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="toString()"><!-- --></A><H3>
+toString</H3>
+<PRE>
+public java.lang.String <B>toString</B>()</PRE>
+<DL>
+<DD><DL>
+<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
+</DD>
+<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> </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/struts/MessageTool.html" title="class in org.apache.velocity.tools.struts"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html" title="class in org.apache.velocity.tools.struts"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../../index.html?org/apache/velocity/tools/struts/MessageTool.TextKey.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="MessageTool.TextKey.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 | <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: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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/struts/MessageTool.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/struts/MessageTool.html?rev=326968&r1=326967&r2=326968&view=diff
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/struts/MessageTool.html (original)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/struts/MessageTool.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:02 GMT 2004 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Oct 20 10:35:34 PDT 2005 -->
<TITLE>
-MessageTool (Velocity Tools 1.1-dev Documentation)
+MessageTool (Velocity Tools 1.2 Documentation)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.velocity.tools.struts.MessageTool class">
@@ -14,9 +14,11 @@
<SCRIPT type="text/javascript">
function windowTitle()
{
- parent.document.title="MessageTool (Velocity Tools 1.1-dev Documentation)";
+ parent.document.title="MessageTool (Velocity Tools 1.2 Documentation)";
}
</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
</HEAD>
@@ -28,7 +30,7 @@
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
-<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
@@ -50,9 +52,9 @@
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../org/apache/velocity/tools/struts/MessageResourcesTool.html" title="class in org.apache.velocity.tools.struts"><B>PREV CLASS</B></A>
- <A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html" title="class in org.apache.velocity.tools.struts"><B>NEXT CLASS</B></A></FONT></TD>
+ <A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.TextKey.html" title="class in org.apache.velocity.tools.struts"><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/struts/MessageTool.html" target="_top"><B>FRAMES</B></A>
<A HREF="MessageTool.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
@@ -65,11 +67,12 @@
<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 | <A HREF="#fields_inherited_from_class_org.apache.velocity.tools.struts.MessageResourcesTool">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+ SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#fields_inherited_from_class_org.apache.velocity.tools.struts.MessageResourcesTool">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>
</TR>
@@ -86,20 +89,21 @@
Class MessageTool</H2>
<PRE>
java.lang.Object
- <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/velocity/tools/struts/MessageResourcesTool.html" title="class in org.apache.velocity.tools.struts">org.apache.velocity.tools.struts.MessageResourcesTool</A>
- <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.velocity.tools.struts.MessageTool</B>
+ <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/velocity/tools/struts/MessageResourcesTool.html" title="class in org.apache.velocity.tools.struts">org.apache.velocity.tools.struts.MessageResourcesTool</A>
+ <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.struts.MessageTool</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>MessageTool</B><DT>extends <A HREF="../../../../../org/apache/velocity/tools/struts/MessageResourcesTool.html" title="class in org.apache.velocity.tools.struts">MessageResourcesTool</A></DL>
+<DT><PRE>public class <B>MessageTool</B><DT>extends <A HREF="../../../../../org/apache/velocity/tools/struts/MessageResourcesTool.html" title="class in org.apache.velocity.tools.struts">MessageResourcesTool</A></DL>
+</PRE>
<P>
<p>View tool that provides methods to render Struts
application resources for internationalized text.</p>
-
+
<p><pre>
Template example(s):
#if( $text.exists('greeting') )
@@ -122,7 +126,7 @@
<DT><B>Since:</B></DT>
<DD>VelocityTools 1.0</DD>
<DT><B>Version:</B></DT>
- <DD>$Id: MessageTool.html,v 1.8 2004/03/12 02:07:07 marino Exp $</DD>
+ <DD>$Id$</DD>
<DT><B>Author:</B></DT>
<DD><a href="mailto:sidler@teamup.com">Gabe Sidler</a></DD>
</DL>
@@ -131,23 +135,39 @@
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
+<A NAME="nested_class_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>Nested Class Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> class</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.TextKey.html" title="class in org.apache.velocity.tools.struts">MessageTool.TextKey</A></B></CODE>
-<!-- =========== FIELD SUMMARY =========== -->
+<BR>
+ Helper class to simplify tool usage when retrieving
+ no-arg messages from the default bundle that have periods
+ in their key.</TD>
+</TR>
+</TABLE>
+ <!-- =========== 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>
</TABLE>
<A NAME="fields_inherited_from_class_org.apache.velocity.tools.struts.MessageResourcesTool"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
-<TD><B>Fields inherited from class org.apache.velocity.tools.struts.<A HREF="../../../../../org/apache/velocity/tools/struts/MessageResourcesTool.html" title="class in org.apache.velocity.tools.struts">MessageResourcesTool</A></B></TD>
+<TH ALIGN="left"><B>Fields inherited from class org.apache.velocity.tools.struts.<A HREF="../../../../../org/apache/velocity/tools/struts/MessageResourcesTool.html" title="class in org.apache.velocity.tools.struts">MessageResourcesTool</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE><A HREF="../../../../../org/apache/velocity/tools/struts/MessageResourcesTool.html#application">application</A>, <A HREF="../../../../../org/apache/velocity/tools/struts/MessageResourcesTool.html#locale">locale</A>, <A HREF="../../../../../org/apache/velocity/tools/struts/MessageResourcesTool.html#request">request</A>, <A HREF="../../../../../org/apache/velocity/tools/struts/MessageResourcesTool.html#resources">resources</A></CODE></TD>
+<TD><CODE><A HREF="../../../../../org/apache/velocity/tools/struts/MessageResourcesTool.html#application">application</A>, <A HREF="../../../../../org/apache/velocity/tools/struts/MessageResourcesTool.html#locale">locale</A>, <A HREF="../../../../../org/apache/velocity/tools/struts/MessageResourcesTool.html#LOG">LOG</A>, <A HREF="../../../../../org/apache/velocity/tools/struts/MessageResourcesTool.html#request">request</A>, <A HREF="../../../../../org/apache/velocity/tools/struts/MessageResourcesTool.html#resources">resources</A></CODE></TD>
</TR>
</TABLE>
@@ -156,14 +176,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/struts/MessageTool.html#MessageTool()">MessageTool</A></B>()</CODE>
<BR>
- Default constructor. </TD>
+ Default constructor.</TD>
</TR>
</TABLE>
@@ -172,8 +192,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">
@@ -196,12 +216,11 @@
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> java.lang.String</CODE></FONT></TD>
+<CODE> <A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.TextKey.html" title="class in org.apache.velocity.tools.struts">MessageTool.TextKey</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.html#get(java.lang.String)">get</A></B>(java.lang.String key)</CODE>
<BR>
- Looks up and returns the localized message for the specified key.
- </TD>
+ Looks up and returns the localized message for the specified key.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -211,7 +230,7 @@
<BR>
Same as <A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.html#get(java.lang.String, java.lang.Object[])"><CODE>get(String key, Object[] args)</CODE></A>, but takes a
- <code>java.util.List</code> instead of an array. </TD>
+ <code>java.util.List</code> instead of an array.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -220,8 +239,7 @@
java.lang.Object[] args)</CODE>
<BR>
- Looks up and returns the localized message for the specified key.
- </TD>
+ Looks up and returns the localized message for the specified key.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -230,8 +248,7 @@
java.lang.String bundle)</CODE>
<BR>
- Looks up and returns the localized message for the specified key.
- </TD>
+ Looks up and returns the localized message for the specified key.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -242,7 +259,7 @@
<BR>
Same as <A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.html#get(java.lang.String, java.lang.Object[])"><CODE>get(String key, Object[] args)</CODE></A>, but takes a
- <code>java.util.List</code> instead of an array. </TD>
+ <code>java.util.List</code> instead of an array.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -252,23 +269,13 @@
java.lang.Object[] args)</CODE>
<BR>
- Looks up and returns the localized message for the specified key.
- </TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> java.util.Locale</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.html#getLocale()">getLocale</A></B>()</CODE>
-
-<BR>
- <B>Deprecated.</B> <I>This does not fit the purpose of MessageTool and will be
- removed in VelocityTools 1.2</I></TD>
+ Looks up and returns the localized message for the specified key.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.apache.velocity.tools.struts.MessageResourcesTool"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
-<TD><B>Methods inherited from class org.apache.velocity.tools.struts.<A HREF="../../../../../org/apache/velocity/tools/struts/MessageResourcesTool.html" title="class in org.apache.velocity.tools.struts">MessageResourcesTool</A></B></TD>
+<TH ALIGN="left"><B>Methods inherited from class org.apache.velocity.tools.struts.<A HREF="../../../../../org/apache/velocity/tools/struts/MessageResourcesTool.html" title="class in org.apache.velocity.tools.struts">MessageResourcesTool</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/velocity/tools/struts/MessageResourcesTool.html#getResources(java.lang.String)">getResources</A>, <A HREF="../../../../../org/apache/velocity/tools/struts/MessageResourcesTool.html#init(java.lang.Object)">init</A></CODE></TD>
@@ -277,7 +284,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>
@@ -286,16 +293,13 @@
<P>
-<!-- ============ FIELD DETAIL =========== -->
-
-
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<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>
@@ -313,24 +317,24 @@
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TD COLSPAN=1><FONT SIZE="+2">
-<B>Method Detail</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="get(java.lang.String)"><!-- --></A><H3>
get</H3>
<PRE>
-public java.lang.String <B>get</B>(java.lang.String key)</PRE>
+public <A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.TextKey.html" title="class in org.apache.velocity.tools.struts">MessageTool.TextKey</A> <B>get</B>(java.lang.String key)</PRE>
<DL>
<DD>Looks up and returns the localized message for the specified key.
The user's locale is consulted to determine the language of the
message.
+
+ <p><pre>Example use: $text.forms.profile.title</pre></p>
<P>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>key</CODE> - message key
-<DT><B>Returns:</B><DD>the localized message for the specified key or
- <code>null</code> if no such message exists</DL>
+<DT><B>Parameters:</B><DD><CODE>key</CODE> - message key</DL>
</DD>
</DL>
<HR>
@@ -468,23 +472,6 @@
</DL>
</DD>
</DL>
-<HR>
-
-<A NAME="getLocale()"><!-- --></A><H3>
-getLocale</H3>
-<PRE>
-public java.util.Locale <B>getLocale</B>()</PRE>
-<DL>
-<DD><B>Deprecated.</B> <I>This does not fit the purpose of MessageTool and will be
- removed in VelocityTools 1.2</I>
-<P>
-<DD>Returns the user's locale. If a locale is not found, the default
- locale is returned.
-<P>
-<DD><DL>
-</DL>
-</DD>
-</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
@@ -494,7 +481,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">
@@ -516,9 +503,9 @@
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../org/apache/velocity/tools/struts/MessageResourcesTool.html" title="class in org.apache.velocity.tools.struts"><B>PREV CLASS</B></A>
- <A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html" title="class in org.apache.velocity.tools.struts"><B>NEXT CLASS</B></A></FONT></TD>
+ <A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.TextKey.html" title="class in org.apache.velocity.tools.struts"><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/struts/MessageTool.html" target="_top"><B>FRAMES</B></A>
<A HREF="MessageTool.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
@@ -531,11 +518,12 @@
<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 | <A HREF="#fields_inherited_from_class_org.apache.velocity.tools.struts.MessageResourcesTool">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
+ SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#fields_inherited_from_class_org.apache.velocity.tools.struts.MessageResourcesTool">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>
</TR>
Modified: jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/struts/SecureLinkTool.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/struts/SecureLinkTool.html?rev=326968&r1=326967&r2=326968&view=diff
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/struts/SecureLinkTool.html (original)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/struts/SecureLinkTool.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:33 PST 2004 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Oct 20 10:35:34 PDT 2005 -->
<TITLE>
-SecureLinkTool (Velocity Tools 1.1-rc1 Documentation)
+SecureLinkTool (Velocity Tools 1.2 Documentation)
</TITLE>
-<META NAME="keywords" CONTENT="org.apache.velocity.tools.struts.SecureLinkTool,SecureLinkTool class">
+
+<META NAME="keywords" CONTENT="org.apache.velocity.tools.struts.SecureLinkTool 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="SecureLinkTool (Velocity Tools 1.1-rc1 Documentation)";
+ parent.document.title="SecureLinkTool (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,22 +51,23 @@
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.html"><B>PREV CLASS</B></A>
- <A HREF="../../../../../org/apache/velocity/tools/struts/StrutsLinkTool.html"><B>NEXT CLASS</B></A></FONT></TD>
+ <A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.TextKey.html" title="class in org.apache.velocity.tools.struts"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../org/apache/velocity/tools/struts/StrutsLinkTool.html" title="class in org.apache.velocity.tools.struts"><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="SecureLinkTool.html" TARGET="_top"><B>NO FRAMES</B></A>
-
-<SCRIPT>
+ <A HREF="../../../../../index.html?org/apache/velocity/tools/struts/SecureLinkTool.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="SecureLinkTool.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>
@@ -67,7 +77,8 @@
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,21 @@
Class SecureLinkTool</H2>
<PRE>
java.lang.Object
- |
- +--<A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html">org.apache.velocity.tools.view.tools.LinkTool</A>
- |
- +--<B>org.apache.velocity.tools.struts.SecureLinkTool</B>
+ <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">org.apache.velocity.tools.view.tools.LinkTool</A>
+ <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.struts.SecureLinkTool</B>
</PRE>
<DL>
-<DT><B>All Implemented Interfaces:</B> <DD>java.lang.Cloneable, <A HREF="../../../../../org/apache/velocity/tools/view/tools/ViewTool.html">ViewTool</A></DD>
+<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>
</DL>
<HR>
<DL>
-<DT>public class <B>SecureLinkTool</B><DT>extends <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html">LinkTool</A></DL>
+<DT><PRE>public class <B>SecureLinkTool</B><DT>extends <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A></DL>
+</PRE>
<P>
-<p>Tool to be able to use Struts SSL Extensions with Velocity</p>
- <p>It has the same interface as StrutsLinkTool and can function as a substitute if Struts 1.1 and SSL Ext are installed. </p>
+Tool to be able to use Struts SSL Extensions with Velocity.
+ <p>It has the same interface as StrutsLinkTool and can function as a
+ substitute if Struts 1.1 and SSL Ext are installed. </p>
<p>Usage:
<pre>
Template example:
@@ -119,7 +130,7 @@
<DT><B>Since:</B></DT>
<DD>VelocityTools 1.1</DD>
<DT><B>Version:</B></DT>
- <DD>$Revision: 1.4 $ $Date: 2004/02/21 18:33:03 $</DD>
+ <DD>$Revision$ $Date$</DD>
<DT><B>Author:</B></DT>
<DD><a href="mailto:marinoj@centrum.is">Marino A. Jonsson</a></DD>
</DL>
@@ -129,29 +140,29 @@
<!-- ======== 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.tools.LinkTool"><!-- --></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.tools.<A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html">LinkTool</A></B></TD>
+<TH ALIGN="left"><B>Nested classes/interfaces inherited from class org.apache.velocity.tools.view.tools.<A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE><A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.QueryPair.html">LinkTool.QueryPair</A></CODE></TD>
+<TD><CODE><A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.QueryPair.html" title="class in org.apache.velocity.tools.view.tools">LinkTool.QueryPair</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">
@@ -187,22 +198,22 @@
</TR>
</TABLE>
<A NAME="fields_inherited_from_class_org.apache.velocity.tools.view.tools.LinkTool"><!-- --></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.tools.<A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html">LinkTool</A></B></TD>
+<TH ALIGN="left"><B>Fields inherited from class org.apache.velocity.tools.view.tools.<A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE><A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#application">application</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#HTML_QUERY_DELIMITER">HTML_QUERY_DELIMITER</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#request">request</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#response">response</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#XHTML_QUERY_DELIMITER">XHTML_QUERY_DELIMITER</A></CODE></TD>
+<TD><CODE><A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#application">application</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#HTML_QUERY_DELIMITER">HTML_QUERY_DELIMITER</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#LOG">LOG</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#request">request</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#response">response</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#XHTML_QUERY_DELIMITER">XHTML_QUERY_DELIMITER</A></CODE></TD>
</TR>
</TABLE>
<!-- ======== 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/struts/SecureLinkTool.html#SecureLinkTool()">SecureLinkTool</A></B>()</CODE>
@@ -215,10 +226,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">
@@ -242,7 +253,7 @@
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> <A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html">SecureLinkTool</A></CODE></FONT></TD>
+<CODE> <A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html" title="class in org.apache.velocity.tools.struts">SecureLinkTool</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#setAction(java.lang.String)">setAction</A></B>(java.lang.String action)</CODE>
<BR>
@@ -251,7 +262,7 @@
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> <A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html">SecureLinkTool</A></CODE></FONT></TD>
+<CODE> <A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html" title="class in org.apache.velocity.tools.struts">SecureLinkTool</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html#setForward(java.lang.String)">setForward</A></B>(java.lang.String forward)</CODE>
<BR>
@@ -280,18 +291,18 @@
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.apache.velocity.tools.view.tools.LinkTool"><!-- --></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.tools.<A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html">LinkTool</A></B></TD>
+<TH ALIGN="left"><B>Methods inherited from class org.apache.velocity.tools.view.tools.<A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#addQueryData(java.lang.String, java.lang.Object)">addQueryData</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#copyWith(org.apache.velocity.tools.view.tools.LinkTool.QueryPair)">copyWith</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#copyWith(java.lang.String)">copyWith</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#copyWithAnchor(java.lang.String)">copyWithAnchor</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#encodeURL(java.lang.String)">encodeURL</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getAnchor()">getAnchor</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getBaseRef()">getBaseRef</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getContextPath()">getContextPath</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getContextURL()">getContextURL</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getQueryData()">getQueryData</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getURI()">getURI</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#init(java.lang.Object)">init</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setAnchor(java.lang.String)">setAnchor</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setRelative(java.lang.String)">setRelative</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setURI(java.lang.String)">setURI</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setXhtml(boolean)">setXhtml</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#toString()">toString</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, wait, wait, wait</CODE></TD>
@@ -303,10 +314,10 @@
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_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>Field Detail</B></FONT></TD>
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
@@ -352,10 +363,10 @@
<!-- ========= 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>
@@ -369,17 +380,17 @@
<!-- ============ 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>
<A NAME="setAction(java.lang.String)"><!-- --></A><H3>
setAction</H3>
<PRE>
-public <A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html">SecureLinkTool</A> <B>setAction</B>(java.lang.String action)</PRE>
+public <A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html" title="class in org.apache.velocity.tools.struts">SecureLinkTool</A> <B>setAction</B>(java.lang.String action)</PRE>
<DL>
<DD><p>Returns a copy of the link with the given action name
converted into a server-relative URI reference. This method
@@ -397,7 +408,7 @@
<A NAME="setForward(java.lang.String)"><!-- --></A><H3>
setForward</H3>
<PRE>
-public <A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html">SecureLinkTool</A> <B>setForward</B>(java.lang.String forward)</PRE>
+public <A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html" title="class in org.apache.velocity.tools.struts">SecureLinkTool</A> <B>setForward</B>(java.lang.String forward)</PRE>
<DL>
<DD><p>Returns a copy of the link with the given global forward name
converted into a server-relative URI reference. If the parameter
@@ -481,13 +492,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>
@@ -506,22 +519,23 @@
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.html"><B>PREV CLASS</B></A>
- <A HREF="../../../../../org/apache/velocity/tools/struts/StrutsLinkTool.html"><B>NEXT CLASS</B></A></FONT></TD>
+ <A HREF="../../../../../org/apache/velocity/tools/struts/MessageTool.TextKey.html" title="class in org.apache.velocity.tools.struts"><B>PREV CLASS</B></A>
+ <A HREF="../../../../../org/apache/velocity/tools/struts/StrutsLinkTool.html" title="class in org.apache.velocity.tools.struts"><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="SecureLinkTool.html" TARGET="_top"><B>NO FRAMES</B></A>
-
-<SCRIPT>
+ <A HREF="../../../../../index.html?org/apache/velocity/tools/struts/SecureLinkTool.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="SecureLinkTool.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>
@@ -531,7 +545,8 @@
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/struts/StrutsLinkTool.html
URL: http://svn.apache.org/viewcvs/jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/struts/StrutsLinkTool.html?rev=326968&r1=326967&r2=326968&view=diff
==============================================================================
--- jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/struts/StrutsLinkTool.html (original)
+++ jakarta/velocity/tools/trunk/docs/javadoc/org/apache/velocity/tools/struts/StrutsLinkTool.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:02 GMT 2004 -->
+<!-- Generated by javadoc (build 1.5.0_02) on Thu Oct 20 10:35:34 PDT 2005 -->
<TITLE>
-StrutsLinkTool (Velocity Tools 1.1-dev Documentation)
+StrutsLinkTool (Velocity Tools 1.2 Documentation)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.velocity.tools.struts.StrutsLinkTool class">
@@ -14,9 +14,11 @@
<SCRIPT type="text/javascript">
function windowTitle()
{
- parent.document.title="StrutsLinkTool (Velocity Tools 1.1-dev Documentation)";
+ parent.document.title="StrutsLinkTool (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/struts/SecureLinkTool.html" title="class in org.apache.velocity.tools.struts"><B>PREV CLASS</B></A>
<A HREF="../../../../../org/apache/velocity/tools/struts/StrutsUtils.html" title="class in org.apache.velocity.tools.struts"><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/struts/StrutsLinkTool.html" target="_top"><B>FRAMES</B></A>
<A HREF="StrutsLinkTool.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
@@ -65,13 +67,14 @@
<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.tools.LinkTool">NESTED</A> | <A HREF="#fields_inherited_from_class_org.apache.velocity.tools.view.tools.LinkTool">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.tools.LinkTool">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>
<A NAME="skip-navbar_top"></A>
@@ -86,18 +89,19 @@
Class StrutsLinkTool</H2>
<PRE>
java.lang.Object
- <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">org.apache.velocity.tools.view.tools.LinkTool</A>
- <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.velocity.tools.struts.StrutsLinkTool</B>
+ <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">org.apache.velocity.tools.view.tools.LinkTool</A>
+ <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.struts.StrutsLinkTool</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>
</DL>
<HR>
<DL>
-<DT>public class <B>StrutsLinkTool</B><DT>extends <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A></DL>
+<DT><PRE>public class <B>StrutsLinkTool</B><DT>extends <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A></DL>
+</PRE>
<P>
-<p>View tool to work with URI links in Struts.</p>
+<p>View tool to work with URI links in Struts.</p>
<p><pre>
Template example(s):
<a href="$link.setAction('update')">update something</a>
@@ -119,7 +123,7 @@
<P>
<DL>
<DT><B>Version:</B></DT>
- <DD>$Id: StrutsLinkTool.html,v 1.8 2004/03/12 02:07:07 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>
@@ -131,14 +135,14 @@
<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>
</TABLE>
<A NAME="nested_classes_inherited_from_class_org.apache.velocity.tools.view.tools.LinkTool"><!-- --></A>
<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.tools.<A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A></B></TD>
+<TH ALIGN="left"><B>Nested classes/interfaces inherited from class org.apache.velocity.tools.view.tools.<A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.QueryPair.html" title="class in org.apache.velocity.tools.view.tools">LinkTool.QueryPair</A></CODE></TD>
@@ -150,14 +154,22 @@
<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">
+<CODE>protected static org.apache.commons.logging.Log</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/struts/StrutsLinkTool.html#LOG">LOG</A></B></CODE>
+
+<BR>
+ </TD>
</TR>
</TABLE>
<A NAME="fields_inherited_from_class_org.apache.velocity.tools.view.tools.LinkTool"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
-<TD><B>Fields inherited from class org.apache.velocity.tools.view.tools.<A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A></B></TD>
+<TH ALIGN="left"><B>Fields inherited from class org.apache.velocity.tools.view.tools.<A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#application">application</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#HTML_QUERY_DELIMITER">HTML_QUERY_DELIMITER</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#request">request</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#response">response</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#XHTML_QUERY_DELIMITER">XHTML_QUERY_DELIMITER</A></CODE></TD>
@@ -169,8 +181,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/struts/StrutsLinkTool.html#StrutsLinkTool()">StrutsLinkTool</A></B>()</CODE>
@@ -185,8 +197,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">
@@ -195,7 +207,7 @@
<BR>
Returns a copy of the link with the given action name
- converted into a server-relative URI reference. </TD>
+ converted into a server-relative URI reference.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -204,13 +216,13 @@
<BR>
Returns a copy of the link with the given global forward name
- converted into a server-relative URI reference. </TD>
+ converted into a server-relative URI reference.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.apache.velocity.tools.view.tools.LinkTool"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
-<TD><B>Methods inherited from class org.apache.velocity.tools.view.tools.<A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A></B></TD>
+<TH ALIGN="left"><B>Methods inherited from class org.apache.velocity.tools.view.tools.<A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html" title="class in org.apache.velocity.tools.view.tools">LinkTool</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#addQueryData(java.lang.String, java.lang.Object)">addQueryData</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#copyWith(org.apache.velocity.tools.view.tools.LinkTool.QueryPair)">copyWith</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#copyWith(java.lang.String)">copyWith</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#copyWithAnchor(java.lang.String)">copyWithAnchor</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#encodeURL(java.lang.String)">encodeURL</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getAnchor()">getAnchor</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getBaseRef()">getBaseRef</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getContextPath()">getContextPath</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getContextURL()">getContextURL</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getQueryData()">getQueryData</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#getURI()">getURI</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#init(java.lang.Object)">init</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setAnchor(java.lang.String)">setAnchor</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setRelative(java.lang.String)">setRelative</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setURI(java.lang.String)">setURI</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#setXhtml(boolean)">setXhtml</A>, <A HREF="../../../../../org/apache/velocity/tools/view/tools/LinkTool.html#toString()">toString</A></CODE></TD>
@@ -219,7 +231,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>
@@ -230,14 +242,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" 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>
@@ -253,8 +281,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>
@@ -264,9 +292,9 @@
public <A HREF="../../../../../org/apache/velocity/tools/struts/StrutsLinkTool.html" title="class in org.apache.velocity.tools.struts">StrutsLinkTool</A> <B>setAction</B>(java.lang.String action)</PRE>
<DL>
<DD><p>Returns a copy of the link with the given action name
- converted into a server-relative URI reference. This method
- does not check if the specified action really is defined.
- This method will overwrite any previous URI reference settings
+ converted into a server-relative URI reference. This method
+ does not check if the specified action really is defined.
+ This method will overwrite any previous URI reference settings
but will copy the query string.</p>
<P>
<DD><DL>
@@ -282,9 +310,9 @@
public <A HREF="../../../../../org/apache/velocity/tools/struts/StrutsLinkTool.html" title="class in org.apache.velocity.tools.struts">StrutsLinkTool</A> <B>setForward</B>(java.lang.String forward)</PRE>
<DL>
<DD><p>Returns a copy of the link with the given global forward name
- converted into a server-relative URI reference. If the parameter
- does not map to an existing global forward name, <code>null</code>
- is returned. This method will overwrite any previous URI reference
+ converted into a server-relative URI reference. If the parameter
+ does not map to an existing global forward name, <code>null</code>
+ is returned. This method will overwrite any previous URI reference
settings but will copy the query string.</p>
<P>
<DD><DL>
@@ -301,7 +329,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">
@@ -325,7 +353,7 @@
<A HREF="../../../../../org/apache/velocity/tools/struts/SecureLinkTool.html" title="class in org.apache.velocity.tools.struts"><B>PREV CLASS</B></A>
<A HREF="../../../../../org/apache/velocity/tools/struts/StrutsUtils.html" title="class in org.apache.velocity.tools.struts"><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/struts/StrutsLinkTool.html" target="_top"><B>FRAMES</B></A>
<A HREF="StrutsLinkTool.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
@@ -338,13 +366,14 @@
<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.tools.LinkTool">NESTED</A> | <A HREF="#fields_inherited_from_class_org.apache.velocity.tools.view.tools.LinkTool">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.tools.LinkTool">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>
<A NAME="skip-navbar_bottom"></A>
---------------------------------------------------------------------
To unsubscribe, e-mail: velocity-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: velocity-dev-help@jakarta.apache.org