| <!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_14) on Mon Apr 26 10:16:11 PDT 2010 --> | |
| <TITLE> | |
| ToolContext (VelocityTools 2.0 Documentation) | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.velocity.tools.ToolContext class"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="ToolContext (VelocityTools 2.0 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/ToolboxFactory.html" title="class in org.apache.velocity.tools"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/velocity/tools/ToolInfo.html" title="class in org.apache.velocity.tools"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/velocity/tools/ToolContext.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="ToolContext.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</FONT> | |
| <BR> | |
| Class ToolContext</H2> | |
| <PRE> | |
| java.lang.Object | |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.ToolContext</B> | |
| </PRE> | |
| <DL> | |
| <DT><B>All Implemented Interfaces:</B> <DD>org.apache.velocity.context.Context</DD> | |
| </DL> | |
| <DL> | |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/velocity/tools/view/ViewToolContext.html" title="class in org.apache.velocity.tools.view">ViewToolContext</A></DD> | |
| </DL> | |
| <HR> | |
| <DL> | |
| <DT><PRE>public class <B>ToolContext</B><DT>extends java.lang.Object<DT>implements org.apache.velocity.context.Context</DL> | |
| </PRE> | |
| <P> | |
| <CODE>Context</CODE> implementation that keeps a list of <A HREF="../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools"><CODE>Toolbox</CODE></A>es | |
| and returns them as requested, using its internal context Map as the | |
| dynamic properties passed to the requested tools when they are first | |
| created. | |
| <P> | |
| <P> | |
| <DL> | |
| <DT><B>Version:</B></DT> | |
| <DD>$Id: ToolContext.java 511959 2007-02-26 19:24:39Z 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>static java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolContext.html#CATCH_EXCEPTIONS_KEY">CATCH_EXCEPTIONS_KEY</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/ToolContext.html#CONTEXT_KEY">CONTEXT_KEY</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/ToolContext.html#ENGINE_KEY">ENGINE_KEY</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private java.util.Map<java.lang.String,java.lang.Object></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolContext.html#localContext">localContext</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/ToolContext.html#LOCALE_KEY">LOCALE_KEY</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/ToolContext.html#LOG_KEY">LOG_KEY</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/ToolContext.html#PATH_KEY">PATH_KEY</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private java.util.List<<A HREF="../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools">Toolbox</A>></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolContext.html#toolboxes">toolboxes</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private java.util.Map<java.lang.String,java.lang.Object></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolContext.html#toolProps">toolProps</A></B></CODE> | |
| <BR> | |
| </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/ToolContext.html#userOverwrite">userOverwrite</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/ToolContext.html#ToolContext()">ToolContext</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolContext.html#ToolContext(java.util.Map)">ToolContext</A></B>(java.util.Map<java.lang.String,java.lang.Object> toolProps)</CODE> | |
| <BR> | |
| Creates an instance starting with the specified tool properties.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolContext.html#ToolContext(org.apache.velocity.app.VelocityEngine)">ToolContext</A></B>(org.apache.velocity.app.VelocityEngine engine)</CODE> | |
| <BR> | |
| Creates an instance that automatically has the specified | |
| VelocityEngine and related tool properties set.</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/ToolContext.html#addToolbox(org.apache.velocity.tools.Toolbox)">addToolbox</A></B>(<A HREF="../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools">Toolbox</A> toolbox)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolContext.html#containsKey(java.lang.Object)">containsKey</A></B>(java.lang.Object key)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected java.lang.Object</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolContext.html#findTool(java.lang.String)">findTool</A></B>(java.lang.String key)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.Object</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolContext.html#get(java.lang.String)">get</A></B>(java.lang.String key)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.Object[]</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolContext.html#getKeys()">getKeys</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.Map<java.lang.String,java.lang.Object></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolContext.html#getToolbox()">getToolbox</A></B>()</CODE> | |
| <BR> | |
| Returns a <CODE>Map</CODE> of all tools available to this | |
| context.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected java.util.List<<A HREF="../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools">Toolbox</A>></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolContext.html#getToolboxes()">getToolboxes</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.Map<java.lang.String,java.lang.Class></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolContext.html#getToolClassMap()">getToolClassMap</A></B>()</CODE> | |
| <BR> | |
| Gets a map of keys to classes for all available tools.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected java.util.Map<java.lang.String,java.lang.Object></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolContext.html#getToolProperties()">getToolProperties</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolContext.html#getUserCanOverwriteTools()">getUserCanOverwriteTools</A></B>()</CODE> | |
| <BR> | |
| Default is <code>true</code>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected java.lang.Object</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolContext.html#internalGet(java.lang.String)">internalGet</A></B>(java.lang.String key)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.Set<java.lang.String></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolContext.html#keySet()">keySet</A></B>()</CODE> | |
| <BR> | |
| </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/ToolContext.html#put(java.lang.String, java.lang.Object)">put</A></B>(java.lang.String key, | |
| java.lang.Object value)</CODE> | |
| <BR> | |
| </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/ToolContext.html#putAll(java.util.Map)">putAll</A></B>(java.util.Map context)</CODE> | |
| <BR> | |
| </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/ToolContext.html#putToolProperties(java.util.Map)">putToolProperties</A></B>(java.util.Map<java.lang.String,java.lang.Object> props)</CODE> | |
| <BR> | |
| </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/ToolContext.html#putToolProperty(java.lang.String, java.lang.Object)">putToolProperty</A></B>(java.lang.String key, | |
| java.lang.Object value)</CODE> | |
| <BR> | |
| </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/ToolContext.html#putVelocityEngine(org.apache.velocity.app.VelocityEngine)">putVelocityEngine</A></B>(org.apache.velocity.app.VelocityEngine engine)</CODE> | |
| <BR> | |
| Puts the specified VelocityEngine in the tool properties, | |
| as well as the Log for that engine.</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/ToolContext.html#remove(java.lang.Object)">remove</A></B>(java.lang.Object key)</CODE> | |
| <BR> | |
| </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/ToolContext.html#setUserCanOverwriteTools(boolean)">setUserCanOverwriteTools</A></B>(boolean overwrite)</CODE> | |
| <BR> | |
| Set whether or not tool references can be overwritten within a template.</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="PATH_KEY"><!-- --></A><H3> | |
| PATH_KEY</H3> | |
| <PRE> | |
| public static final java.lang.String <B>PATH_KEY</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.velocity.tools.ToolContext.PATH_KEY">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="CONTEXT_KEY"><!-- --></A><H3> | |
| CONTEXT_KEY</H3> | |
| <PRE> | |
| public static final java.lang.String <B>CONTEXT_KEY</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.velocity.tools.ToolContext.CONTEXT_KEY">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="ENGINE_KEY"><!-- --></A><H3> | |
| ENGINE_KEY</H3> | |
| <PRE> | |
| public static final java.lang.String <B>ENGINE_KEY</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.velocity.tools.ToolContext.ENGINE_KEY">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="LOCALE_KEY"><!-- --></A><H3> | |
| LOCALE_KEY</H3> | |
| <PRE> | |
| public static final java.lang.String <B>LOCALE_KEY</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.velocity.tools.ToolContext.LOCALE_KEY">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="LOG_KEY"><!-- --></A><H3> | |
| LOG_KEY</H3> | |
| <PRE> | |
| public static final java.lang.String <B>LOG_KEY</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.velocity.tools.ToolContext.LOG_KEY">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="CATCH_EXCEPTIONS_KEY"><!-- --></A><H3> | |
| CATCH_EXCEPTIONS_KEY</H3> | |
| <PRE> | |
| public static final java.lang.String <B>CATCH_EXCEPTIONS_KEY</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.velocity.tools.ToolContext.CATCH_EXCEPTIONS_KEY">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="toolboxes"><!-- --></A><H3> | |
| toolboxes</H3> | |
| <PRE> | |
| private java.util.List<<A HREF="../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools">Toolbox</A>> <B>toolboxes</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="toolProps"><!-- --></A><H3> | |
| toolProps</H3> | |
| <PRE> | |
| private java.util.Map<java.lang.String,java.lang.Object> <B>toolProps</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="localContext"><!-- --></A><H3> | |
| localContext</H3> | |
| <PRE> | |
| private java.util.Map<java.lang.String,java.lang.Object> <B>localContext</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="userOverwrite"><!-- --></A><H3> | |
| userOverwrite</H3> | |
| <PRE> | |
| private boolean <B>userOverwrite</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="ToolContext()"><!-- --></A><H3> | |
| ToolContext</H3> | |
| <PRE> | |
| public <B>ToolContext</B>()</PRE> | |
| <DL> | |
| </DL> | |
| <HR> | |
| <A NAME="ToolContext(org.apache.velocity.app.VelocityEngine)"><!-- --></A><H3> | |
| ToolContext</H3> | |
| <PRE> | |
| public <B>ToolContext</B>(org.apache.velocity.app.VelocityEngine engine)</PRE> | |
| <DL> | |
| <DD>Creates an instance that automatically has the specified | |
| VelocityEngine and related tool properties set. | |
| <P> | |
| </DL> | |
| <HR> | |
| <A NAME="ToolContext(java.util.Map)"><!-- --></A><H3> | |
| ToolContext</H3> | |
| <PRE> | |
| public <B>ToolContext</B>(java.util.Map<java.lang.String,java.lang.Object> toolProps)</PRE> | |
| <DL> | |
| <DD>Creates an instance starting with the specified tool properties. | |
| <P> | |
| </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="setUserCanOverwriteTools(boolean)"><!-- --></A><H3> | |
| setUserCanOverwriteTools</H3> | |
| <PRE> | |
| public void <B>setUserCanOverwriteTools</B>(boolean overwrite)</PRE> | |
| <DL> | |
| <DD>Set whether or not tool references can be overwritten within a template. | |
| The default value is <code>true</code>. Set this to false if you want to | |
| ensure that your tool references are never replaced within the course | |
| of a template. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getUserCanOverwriteTools()"><!-- --></A><H3> | |
| getUserCanOverwriteTools</H3> | |
| <PRE> | |
| public boolean <B>getUserCanOverwriteTools</B>()</PRE> | |
| <DL> | |
| <DD>Default is <code>true</code>. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/velocity/tools/ToolContext.html#setUserCanOverwriteTools(boolean)"><CODE>setUserCanOverwriteTools(boolean)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="addToolbox(org.apache.velocity.tools.Toolbox)"><!-- --></A><H3> | |
| addToolbox</H3> | |
| <PRE> | |
| public void <B>addToolbox</B>(<A HREF="../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools">Toolbox</A> toolbox)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getToolbox()"><!-- --></A><H3> | |
| getToolbox</H3> | |
| <PRE> | |
| public java.util.Map<java.lang.String,java.lang.Object> <B>getToolbox</B>()</PRE> | |
| <DL> | |
| <DD>Returns a <CODE>Map</CODE> of all tools available to this | |
| context. NOTE: this is not a cheap operation as it will | |
| request and initialize an instance of every available tool. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getToolClassMap()"><!-- --></A><H3> | |
| getToolClassMap</H3> | |
| <PRE> | |
| public java.util.Map<java.lang.String,java.lang.Class> <B>getToolClassMap</B>()</PRE> | |
| <DL> | |
| <DD>Gets a map of keys to classes for all available tools. | |
| This does not include any data nor any local context values. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getToolboxes()"><!-- --></A><H3> | |
| getToolboxes</H3> | |
| <PRE> | |
| protected java.util.List<<A HREF="../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools">Toolbox</A>> <B>getToolboxes</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getToolProperties()"><!-- --></A><H3> | |
| getToolProperties</H3> | |
| <PRE> | |
| protected java.util.Map<java.lang.String,java.lang.Object> <B>getToolProperties</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="putVelocityEngine(org.apache.velocity.app.VelocityEngine)"><!-- --></A><H3> | |
| putVelocityEngine</H3> | |
| <PRE> | |
| public void <B>putVelocityEngine</B>(org.apache.velocity.app.VelocityEngine engine)</PRE> | |
| <DL> | |
| <DD>Puts the specified VelocityEngine in the tool properties, | |
| as well as the Log for that engine. Last, if the specified | |
| engine has a MethodExceptionEventHandler configured, then | |
| this will automatically set <A HREF="../../../../org/apache/velocity/tools/ToolContext.html#CATCH_EXCEPTIONS_KEY"><CODE>CATCH_EXCEPTIONS_KEY</CODE></A> | |
| to false in the tool properties. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="putToolProperty(java.lang.String, java.lang.Object)"><!-- --></A><H3> | |
| putToolProperty</H3> | |
| <PRE> | |
| public java.lang.Object <B>putToolProperty</B>(java.lang.String key, | |
| java.lang.Object value)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="putToolProperties(java.util.Map)"><!-- --></A><H3> | |
| putToolProperties</H3> | |
| <PRE> | |
| public void <B>putToolProperties</B>(java.util.Map<java.lang.String,java.lang.Object> props)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="put(java.lang.String, java.lang.Object)"><!-- --></A><H3> | |
| put</H3> | |
| <PRE> | |
| public java.lang.Object <B>put</B>(java.lang.String key, | |
| java.lang.Object value)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE>put</CODE> in interface <CODE>org.apache.velocity.context.Context</CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="get(java.lang.String)"><!-- --></A><H3> | |
| get</H3> | |
| <PRE> | |
| public java.lang.Object <B>get</B>(java.lang.String key)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE>get</CODE> in interface <CODE>org.apache.velocity.context.Context</CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="internalGet(java.lang.String)"><!-- --></A><H3> | |
| internalGet</H3> | |
| <PRE> | |
| protected java.lang.Object <B>internalGet</B>(java.lang.String key)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="findTool(java.lang.String)"><!-- --></A><H3> | |
| findTool</H3> | |
| <PRE> | |
| protected java.lang.Object <B>findTool</B>(java.lang.String key)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="keySet()"><!-- --></A><H3> | |
| keySet</H3> | |
| <PRE> | |
| public java.util.Set<java.lang.String> <B>keySet</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="containsKey(java.lang.Object)"><!-- --></A><H3> | |
| containsKey</H3> | |
| <PRE> | |
| public boolean <B>containsKey</B>(java.lang.Object key)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE>containsKey</CODE> in interface <CODE>org.apache.velocity.context.Context</CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getKeys()"><!-- --></A><H3> | |
| getKeys</H3> | |
| <PRE> | |
| public java.lang.Object[] <B>getKeys</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE>getKeys</CODE> in interface <CODE>org.apache.velocity.context.Context</CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="remove(java.lang.Object)"><!-- --></A><H3> | |
| remove</H3> | |
| <PRE> | |
| public java.lang.Object <B>remove</B>(java.lang.Object key)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE>remove</CODE> in interface <CODE>org.apache.velocity.context.Context</CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="putAll(java.util.Map)"><!-- --></A><H3> | |
| putAll</H3> | |
| <PRE> | |
| public void <B>putAll</B>(java.util.Map context)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </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/ToolboxFactory.html" title="class in org.apache.velocity.tools"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/velocity/tools/ToolInfo.html" title="class in org.apache.velocity.tools"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/velocity/tools/ToolContext.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="ToolContext.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> |