| <!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:12 PDT 2010 --> | |
| <TITLE> | |
| ToolManager (VelocityTools 2.0 Documentation) | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.velocity.tools.ToolManager class"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="ToolManager (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/ToolInfo.html" title="class in org.apache.velocity.tools"><B>PREV CLASS</B></A> | |
| NEXT CLASS</FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/velocity/tools/ToolManager.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="ToolManager.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 ToolManager</H2> | |
| <PRE> | |
| java.lang.Object | |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.ToolManager</B> | |
| </PRE> | |
| <DL> | |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/velocity/tools/view/ViewToolManager.html" title="class in org.apache.velocity.tools.view">ViewToolManager</A></DD> | |
| </DL> | |
| <HR> | |
| <DL> | |
| <DT><PRE>public class <B>ToolManager</B><DT>extends java.lang.Object</DL> | |
| </PRE> | |
| <P> | |
| Manages tools for non-web applications. This simplifies the process | |
| of getting a tool-populated Velocity context for merging with templates. | |
| It allows for both direct configuration by passing in a <A HREF="../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>FactoryConfiguration</CODE></A> | |
| as well as configuration via a tools.xml or tools.properties file in | |
| either the classpath or the local file system. | |
| <P> | |
| <P> | |
| <DL> | |
| <DT><B>Version:</B></DT> | |
| <DD>$Id: ToolManager.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>private <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/ToolManager.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/ToolboxFactory.html" title="class in org.apache.velocity.tools">ToolboxFactory</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolManager.html#factory">factory</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/ToolManager.html#userOverwrite">userOverwrite</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected org.apache.velocity.app.VelocityEngine</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolManager.html#velocity">velocity</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/ToolManager.html#ToolManager()">ToolManager</A></B>()</CODE> | |
| <BR> | |
| Constructs an instance already configured to use the | |
| <A HREF="../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#getAutoLoaded()"><CODE>ConfigurationUtils.getAutoLoaded()</CODE></A> configuration | |
| and any configuration specified via a "org.apache.velocity.tools" | |
| system property.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolManager.html#ToolManager(boolean)">ToolManager</A></B>(boolean includeDefaults)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolManager.html#ToolManager(boolean, boolean)">ToolManager</A></B>(boolean autoConfig, | |
| boolean includeDefaults)</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>protected void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolManager.html#addToolboxes(org.apache.velocity.tools.ToolContext)">addToolboxes</A></B>(<A HREF="../../../../org/apache/velocity/tools/ToolContext.html" title="class in org.apache.velocity.tools">ToolContext</A> 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/ToolManager.html#autoConfigure(boolean)">autoConfigure</A></B>(boolean includeDefaults)</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/ToolManager.html#configure(org.apache.velocity.tools.config.FactoryConfiguration)">configure</A></B>(<A HREF="../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A> config)</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/ToolManager.html#configure(java.lang.String)">configure</A></B>(java.lang.String path)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/velocity/tools/ToolContext.html" title="class in org.apache.velocity.tools">ToolContext</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolManager.html#createContext()">createContext</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/velocity/tools/ToolContext.html" title="class in org.apache.velocity.tools">ToolContext</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolManager.html#createContext(java.util.Map)">createContext</A></B>(java.util.Map<java.lang.String,java.lang.Object> toolProps)</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/Toolbox.html" title="class in org.apache.velocity.tools">Toolbox</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolManager.html#createToolbox(java.lang.String)">createToolbox</A></B>(java.lang.String scope)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolManager.html#debug(java.lang.String, java.lang.Object...)">debug</A></B>(java.lang.String msg, | |
| java.lang.Object... args)</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/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolManager.html#findConfig(java.lang.String)">findConfig</A></B>(java.lang.String path)</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/Toolbox.html" title="class in org.apache.velocity.tools">Toolbox</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolManager.html#getApplicationToolbox()">getApplicationToolbox</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> org.apache.velocity.runtime.log.Log</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolManager.html#getLog()">getLog</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/Toolbox.html" title="class in org.apache.velocity.tools">Toolbox</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolManager.html#getRequestToolbox()">getRequestToolbox</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/velocity/tools/ToolboxFactory.html" title="class in org.apache.velocity.tools">ToolboxFactory</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolManager.html#getToolboxFactory()">getToolboxFactory</A></B>()</CODE> | |
| <BR> | |
| Returns the underlying <A HREF="../../../../org/apache/velocity/tools/ToolboxFactory.html" title="class in org.apache.velocity.tools"><CODE>ToolboxFactory</CODE></A> being used.</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/ToolManager.html#getUserCanOverwriteTools()">getUserCanOverwriteTools</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> org.apache.velocity.app.VelocityEngine</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolManager.html#getVelocityEngine()">getVelocityEngine</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolManager.html#hasApplicationTools()">hasApplicationTools</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolManager.html#hasRequestTools()">hasRequestTools</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolManager.html#hasTools(java.lang.String)">hasTools</A></B>(java.lang.String scope)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/tools/ToolManager.html#prepareContext(org.apache.velocity.tools.ToolContext)">prepareContext</A></B>(<A HREF="../../../../org/apache/velocity/tools/ToolContext.html" title="class in org.apache.velocity.tools">ToolContext</A> 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/ToolManager.html#setToolboxFactory(org.apache.velocity.tools.ToolboxFactory)">setToolboxFactory</A></B>(<A HREF="../../../../org/apache/velocity/tools/ToolboxFactory.html" title="class in org.apache.velocity.tools">ToolboxFactory</A> factory)</CODE> | |
| <BR> | |
| Sets the underlying ToolboxFactory being used.</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/ToolManager.html#setUserCanOverwriteTools(boolean)">setUserCanOverwriteTools</A></B>(boolean overwrite)</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/ToolManager.html#setVelocityEngine(org.apache.velocity.app.VelocityEngine)">setVelocityEngine</A></B>(org.apache.velocity.app.VelocityEngine engine)</CODE> | |
| <BR> | |
| Sets the underlying VelocityEngine being used.</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="velocity"><!-- --></A><H3> | |
| velocity</H3> | |
| <PRE> | |
| protected org.apache.velocity.app.VelocityEngine <B>velocity</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="factory"><!-- --></A><H3> | |
| factory</H3> | |
| <PRE> | |
| protected <A HREF="../../../../org/apache/velocity/tools/ToolboxFactory.html" title="class in org.apache.velocity.tools">ToolboxFactory</A> <B>factory</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="application"><!-- --></A><H3> | |
| application</H3> | |
| <PRE> | |
| private <A HREF="../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools">Toolbox</A> <B>application</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="ToolManager()"><!-- --></A><H3> | |
| ToolManager</H3> | |
| <PRE> | |
| public <B>ToolManager</B>()</PRE> | |
| <DL> | |
| <DD>Constructs an instance already configured to use the | |
| <A HREF="../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#getAutoLoaded()"><CODE>ConfigurationUtils.getAutoLoaded()</CODE></A> configuration | |
| and any configuration specified via a "org.apache.velocity.tools" | |
| system property. | |
| <P> | |
| </DL> | |
| <HR> | |
| <A NAME="ToolManager(boolean)"><!-- --></A><H3> | |
| ToolManager</H3> | |
| <PRE> | |
| public <B>ToolManager</B>(boolean includeDefaults)</PRE> | |
| <DL> | |
| </DL> | |
| <HR> | |
| <A NAME="ToolManager(boolean, boolean)"><!-- --></A><H3> | |
| ToolManager</H3> | |
| <PRE> | |
| public <B>ToolManager</B>(boolean autoConfig, | |
| boolean includeDefaults)</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="autoConfigure(boolean)"><!-- --></A><H3> | |
| autoConfigure</H3> | |
| <PRE> | |
| public void <B>autoConfigure</B>(boolean includeDefaults)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="configure(org.apache.velocity.tools.config.FactoryConfiguration)"><!-- --></A><H3> | |
| configure</H3> | |
| <PRE> | |
| public void <B>configure</B>(<A HREF="../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A> config)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="configure(java.lang.String)"><!-- --></A><H3> | |
| configure</H3> | |
| <PRE> | |
| public void <B>configure</B>(java.lang.String path)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="findConfig(java.lang.String)"><!-- --></A><H3> | |
| findConfig</H3> | |
| <PRE> | |
| protected <A HREF="../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A> <B>findConfig</B>(java.lang.String path)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getToolboxFactory()"><!-- --></A><H3> | |
| getToolboxFactory</H3> | |
| <PRE> | |
| public <A HREF="../../../../org/apache/velocity/tools/ToolboxFactory.html" title="class in org.apache.velocity.tools">ToolboxFactory</A> <B>getToolboxFactory</B>()</PRE> | |
| <DL> | |
| <DD>Returns the underlying <A HREF="../../../../org/apache/velocity/tools/ToolboxFactory.html" title="class in org.apache.velocity.tools"><CODE>ToolboxFactory</CODE></A> being used. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setToolboxFactory(org.apache.velocity.tools.ToolboxFactory)"><!-- --></A><H3> | |
| setToolboxFactory</H3> | |
| <PRE> | |
| public void <B>setToolboxFactory</B>(<A HREF="../../../../org/apache/velocity/tools/ToolboxFactory.html" title="class in org.apache.velocity.tools">ToolboxFactory</A> factory)</PRE> | |
| <DL> | |
| <DD>Sets the underlying ToolboxFactory being used. | |
| <b>If you use this, be sure that your ToolboxFactory | |
| is already properly configured.</b> | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setVelocityEngine(org.apache.velocity.app.VelocityEngine)"><!-- --></A><H3> | |
| setVelocityEngine</H3> | |
| <PRE> | |
| public void <B>setVelocityEngine</B>(org.apache.velocity.app.VelocityEngine engine)</PRE> | |
| <DL> | |
| <DD>Sets the underlying VelocityEngine being used. | |
| <b>If you use this, be sure that your VelocityEngine | |
| is already properly configured and initialized.</b> | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getVelocityEngine()"><!-- --></A><H3> | |
| getVelocityEngine</H3> | |
| <PRE> | |
| public org.apache.velocity.app.VelocityEngine <B>getVelocityEngine</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setUserCanOverwriteTools(boolean)"><!-- --></A><H3> | |
| setUserCanOverwriteTools</H3> | |
| <PRE> | |
| public void <B>setUserCanOverwriteTools</B>(boolean overwrite)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getUserCanOverwriteTools()"><!-- --></A><H3> | |
| getUserCanOverwriteTools</H3> | |
| <PRE> | |
| public boolean <B>getUserCanOverwriteTools</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getLog()"><!-- --></A><H3> | |
| getLog</H3> | |
| <PRE> | |
| public org.apache.velocity.runtime.log.Log <B>getLog</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="debug(java.lang.String, java.lang.Object...)"><!-- --></A><H3> | |
| debug</H3> | |
| <PRE> | |
| protected final void <B>debug</B>(java.lang.String msg, | |
| java.lang.Object... args)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="createContext()"><!-- --></A><H3> | |
| createContext</H3> | |
| <PRE> | |
| public <A HREF="../../../../org/apache/velocity/tools/ToolContext.html" title="class in org.apache.velocity.tools">ToolContext</A> <B>createContext</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="createContext(java.util.Map)"><!-- --></A><H3> | |
| createContext</H3> | |
| <PRE> | |
| public <A HREF="../../../../org/apache/velocity/tools/ToolContext.html" title="class in org.apache.velocity.tools">ToolContext</A> <B>createContext</B>(java.util.Map<java.lang.String,java.lang.Object> toolProps)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="prepareContext(org.apache.velocity.tools.ToolContext)"><!-- --></A><H3> | |
| prepareContext</H3> | |
| <PRE> | |
| protected void <B>prepareContext</B>(<A HREF="../../../../org/apache/velocity/tools/ToolContext.html" title="class in org.apache.velocity.tools">ToolContext</A> context)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="addToolboxes(org.apache.velocity.tools.ToolContext)"><!-- --></A><H3> | |
| addToolboxes</H3> | |
| <PRE> | |
| protected void <B>addToolboxes</B>(<A HREF="../../../../org/apache/velocity/tools/ToolContext.html" title="class in org.apache.velocity.tools">ToolContext</A> context)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="hasTools(java.lang.String)"><!-- --></A><H3> | |
| hasTools</H3> | |
| <PRE> | |
| protected boolean <B>hasTools</B>(java.lang.String scope)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="createToolbox(java.lang.String)"><!-- --></A><H3> | |
| createToolbox</H3> | |
| <PRE> | |
| protected <A HREF="../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools">Toolbox</A> <B>createToolbox</B>(java.lang.String scope)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="hasRequestTools()"><!-- --></A><H3> | |
| hasRequestTools</H3> | |
| <PRE> | |
| protected boolean <B>hasRequestTools</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getRequestToolbox()"><!-- --></A><H3> | |
| getRequestToolbox</H3> | |
| <PRE> | |
| protected <A HREF="../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools">Toolbox</A> <B>getRequestToolbox</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="hasApplicationTools()"><!-- --></A><H3> | |
| hasApplicationTools</H3> | |
| <PRE> | |
| protected boolean <B>hasApplicationTools</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getApplicationToolbox()"><!-- --></A><H3> | |
| getApplicationToolbox</H3> | |
| <PRE> | |
| protected <A HREF="../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools">Toolbox</A> <B>getApplicationToolbox</B>()</PRE> | |
| <DL> | |
| <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/ToolInfo.html" title="class in org.apache.velocity.tools"><B>PREV CLASS</B></A> | |
| NEXT CLASS</FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/velocity/tools/ToolManager.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="ToolManager.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> |