| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
| <!--NewPage--> | |
| <HTML> | |
| <HEAD> | |
| <!-- Generated by javadoc (build 1.5.0_02) on Mon Nov 26 08:08:46 PST 2007 --> | |
| <TITLE> | |
| ContextTool (VelocityTools 1.4 Documentation) | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools.ContextTool class"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="ContextTool (VelocityTools 1.4 Documentation)"; | |
| } | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| </NOSCRIPT> | |
| </HEAD> | |
| <BODY BGCOLOR="white" onload="windowTitle();"> | |
| <!-- ========= START OF TOP NAVBAR ======= --> | |
| <A NAME="navbar_top"><!-- --></A> | |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
| <TR> | |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
| <A NAME="navbar_top_firstrow"><!-- --></A> | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
| <TR ALIGN="center" VALIGN="top"> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
| <TD BGCOLOR="#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/Configurable.html" title="interface 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/ContextTool.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="ContextTool.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.view.tools</FONT> | |
| <BR> | |
| Class ContextTool</H2> | |
| <PRE> | |
| java.lang.Object | |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.view.tools.ContextTool</B> | |
| </PRE> | |
| <HR> | |
| <DL> | |
| <DT><PRE>public class <B>ContextTool</B><DT>extends java.lang.Object</DL> | |
| </PRE> | |
| <P> | |
| <p>View tool for convenient access to <A HREF="../../../../../../org/apache/velocity/tools/view/context/ViewContext.html" title="interface in org.apache.velocity.tools.view.context"><CODE>ViewContext</CODE></A> data and | |
| meta-data.</p> | |
| <p><pre> | |
| Template example(s): | |
| #foreach( $key in $context.keys ) | |
| $key = $context.get($key) | |
| #end | |
| Toolbox configuration: | |
| <tool> | |
| <key>context</key> | |
| <scope>request</scope> | |
| <class>org.apache.velocity.tools.view.tools.ContextTool</class> | |
| </tool> | |
| </pre></p> | |
| <p>This class is only designed for use as a request-scope VelocityView tool.</p> | |
| <P> | |
| <P> | |
| <DL> | |
| <DT><B>Since:</B></DT> | |
| <DD>VelocityTools 1.3</DD> | |
| <DT><B>Version:</B></DT> | |
| <DD>$Id: ContextTool.java 385122 2006-03-11 18:37:42Z nbubna $</DD> | |
| <DT><B>Author:</B></DT> | |
| <DD>Nathan Bubna</DD> | |
| </DL> | |
| <HR> | |
| <P> | |
| <!-- =========== FIELD SUMMARY =========== --> | |
| <A NAME="field_summary"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
| <B>Field Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected javax.servlet.ServletContext</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#application">application</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected <A HREF="../../../../../../org/apache/velocity/tools/view/context/ViewContext.html" title="interface in org.apache.velocity.tools.view.context">ViewContext</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#context">context</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected javax.servlet.http.HttpServletRequest</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#request">request</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#SAFE_MODE_KEY">SAFE_MODE_KEY</A></B></CODE> | |
| <BR> | |
| The key used for specifying whether to hide keys with '.' in them.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#safeMode">safeMode</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected javax.servlet.http.HttpSession</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#session">session</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected java.util.Map</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#toolbox">toolbox</A></B></CODE> | |
| <BR> | |
| </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/view/tools/ContextTool.html#ContextTool()">ContextTool</A></B>()</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> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#configure(java.util.Map)">configure</A></B>(java.util.Map params)</CODE> | |
| <BR> | |
| Looks for a safe-mode configuration setting.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#contains(java.lang.Object)">contains</A></B>(java.lang.Object refName)</CODE> | |
| <BR> | |
| Returns <code>true</code> if the context contains a value for the specified | |
| reference name (aka context key).</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.Object</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#get(java.lang.Object)">get</A></B>(java.lang.Object refName)</CODE> | |
| <BR> | |
| Retrieves the value for the specified reference name (aka context key).</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.Set</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#getKeys()">getKeys</A></B>()</CODE> | |
| <BR> | |
| Return a <CODE>Set</CODE> of the available reference keys in the current | |
| context.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../../../org/apache/velocity/tools/view/context/ViewContext.html" title="interface in org.apache.velocity.tools.view.context">ViewContext</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#getThis()">getThis</A></B>()</CODE> | |
| <BR> | |
| Returns the context being analyzed by this tool.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.Map</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#getToolbox()">getToolbox</A></B>()</CODE> | |
| <BR> | |
| Returns a read-only view of the toolbox <CODE>Map</CODE> | |
| for this context.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.Set</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#getValues()">getValues</A></B>()</CODE> | |
| <BR> | |
| Return a <CODE>Set</CODE> of the available values in the current | |
| context.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ContextTool.html#init(java.lang.Object)">init</A></B>(java.lang.Object obj)</CODE> | |
| <BR> | |
| Initializes this instance for the current request.</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, toString, 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="SAFE_MODE_KEY"><!-- --></A><H3> | |
| SAFE_MODE_KEY</H3> | |
| <PRE> | |
| public static final java.lang.String <B>SAFE_MODE_KEY</B></PRE> | |
| <DL> | |
| <DD>The key used for specifying whether to hide keys with '.' in them. | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.velocity.tools.view.tools.ContextTool.SAFE_MODE_KEY">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="context"><!-- --></A><H3> | |
| context</H3> | |
| <PRE> | |
| protected <A HREF="../../../../../../org/apache/velocity/tools/view/context/ViewContext.html" title="interface in org.apache.velocity.tools.view.context">ViewContext</A> <B>context</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="toolbox"><!-- --></A><H3> | |
| toolbox</H3> | |
| <PRE> | |
| protected java.util.Map <B>toolbox</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="request"><!-- --></A><H3> | |
| request</H3> | |
| <PRE> | |
| protected javax.servlet.http.HttpServletRequest <B>request</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="session"><!-- --></A><H3> | |
| session</H3> | |
| <PRE> | |
| protected javax.servlet.http.HttpSession <B>session</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="application"><!-- --></A><H3> | |
| application</H3> | |
| <PRE> | |
| protected javax.servlet.ServletContext <B>application</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="safeMode"><!-- --></A><H3> | |
| safeMode</H3> | |
| <PRE> | |
| private boolean <B>safeMode</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> | |
| <A NAME="constructor_detail"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
| <B>Constructor Detail</B></FONT></TH> | |
| </TR> | |
| </TABLE> | |
| <A NAME="ContextTool()"><!-- --></A><H3> | |
| ContextTool</H3> | |
| <PRE> | |
| public <B>ContextTool</B>()</PRE> | |
| <DL> | |
| </DL> | |
| <!-- ============ METHOD DETAIL ========== --> | |
| <A NAME="method_detail"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
| <B>Method Detail</B></FONT></TH> | |
| </TR> | |
| </TABLE> | |
| <A NAME="configure(java.util.Map)"><!-- --></A><H3> | |
| configure</H3> | |
| <PRE> | |
| public void <B>configure</B>(java.util.Map params)</PRE> | |
| <DL> | |
| <DD>Looks for a safe-mode configuration setting. By default, | |
| safe-mode is true and thus keys with '.' in them are hidden. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="init(java.lang.Object)"><!-- --></A><H3> | |
| init</H3> | |
| <PRE> | |
| public void <B>init</B>(java.lang.Object obj)</PRE> | |
| <DL> | |
| <DD>Initializes this instance for the current request. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>obj</CODE> - the ViewContext of the current request</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getThis()"><!-- --></A><H3> | |
| getThis</H3> | |
| <PRE> | |
| public <A HREF="../../../../../../org/apache/velocity/tools/view/context/ViewContext.html" title="interface in org.apache.velocity.tools.view.context">ViewContext</A> <B>getThis</B>()</PRE> | |
| <DL> | |
| <DD>Returns the context being analyzed by this tool. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getToolbox()"><!-- --></A><H3> | |
| getToolbox</H3> | |
| <PRE> | |
| public java.util.Map <B>getToolbox</B>()</PRE> | |
| <DL> | |
| <DD><p>Returns a read-only view of the toolbox <CODE>Map</CODE> | |
| for this context.</p> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>an unmodifiable version of the toolbox for this request | |
| or <code>null</code> if there is none</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getKeys()"><!-- --></A><H3> | |
| getKeys</H3> | |
| <PRE> | |
| public java.util.Set <B>getKeys</B>()</PRE> | |
| <DL> | |
| <DD><p>Return a <CODE>Set</CODE> of the available reference keys in the current | |
| context.</p> | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getValues()"><!-- --></A><H3> | |
| getValues</H3> | |
| <PRE> | |
| public java.util.Set <B>getValues</B>()</PRE> | |
| <DL> | |
| <DD><p>Return a <CODE>Set</CODE> of the available values in the current | |
| context.</p> | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="contains(java.lang.Object)"><!-- --></A><H3> | |
| contains</H3> | |
| <PRE> | |
| public boolean <B>contains</B>(java.lang.Object refName)</PRE> | |
| <DL> | |
| <DD><p>Returns <code>true</code> if the context contains a value for the specified | |
| reference name (aka context key).</p> | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="get(java.lang.Object)"><!-- --></A><H3> | |
| get</H3> | |
| <PRE> | |
| public java.lang.Object <B>get</B>(java.lang.Object refName)</PRE> | |
| <DL> | |
| <DD>Retrieves the value for the specified reference name (aka context key). | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <!-- ========= END OF CLASS DATA ========= --> | |
| <HR> | |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> | |
| <A NAME="navbar_bottom"><!-- --></A> | |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
| <TR> | |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
| <TR ALIGN="center" VALIGN="top"> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </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/Configurable.html" title="interface 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/ContextTool.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="ContextTool.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-2007 Apache Software Foundation | |
| </BODY> | |
| </HTML> |