| <!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:15 PDT 2010 --> | |
| <TITLE> | |
| ViewToolManager (VelocityTools 2.0 Documentation) | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.velocity.tools.view.ViewToolManager class"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="ViewToolManager (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/view/ViewToolInfo.html" title="class in org.apache.velocity.tools.view"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../../org/apache/velocity/tools/view/WebappResourceLoader.html" title="class in org.apache.velocity.tools.view"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../index.html?org/apache/velocity/tools/view/ViewToolManager.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="ViewToolManager.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</FONT> | |
| <BR> | |
| Class ViewToolManager</H2> | |
| <PRE> | |
| java.lang.Object | |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/velocity/tools/ToolManager.html" title="class in org.apache.velocity.tools">org.apache.velocity.tools.ToolManager</A> | |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.view.ViewToolManager</B> | |
| </PRE> | |
| <DL> | |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/velocity/tools/view/VelocityView.html" title="class in org.apache.velocity.tools.view">VelocityView</A></DD> | |
| </DL> | |
| <HR> | |
| <DL> | |
| <DT><PRE>public class <B>ViewToolManager</B><DT>extends <A HREF="../../../../../org/apache/velocity/tools/ToolManager.html" title="class in org.apache.velocity.tools">ToolManager</A></DL> | |
| </PRE> | |
| <P> | |
| Manages tools for 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> | |
| or having one in the ServletContext attributes under | |
| <A HREF="../../../../../org/apache/velocity/tools/view/ServletUtils.html#CONFIGURATION_KEY"><CODE>ServletUtils.CONFIGURATION_KEY</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 boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#appToolsPublished">appToolsPublished</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/ViewToolManager.html#CREATE_SESSION_PROPERTY">CREATE_SESSION_PROPERTY</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/view/ViewToolManager.html#createSession">createSession</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/ViewToolManager.html#DEFAULT_TOOLBOX_KEY">DEFAULT_TOOLBOX_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/view/ViewToolManager.html#PUBLISH_TOOLBOXES_PROPERTY">PUBLISH_TOOLBOXES_PROPERTY</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/view/ViewToolManager.html#publishToolboxes">publishToolboxes</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.ServletContext</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#servletContext">servletContext</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </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/view/ViewToolManager.html#toolboxKey">toolboxKey</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="fields_inherited_from_class_org.apache.velocity.tools.ToolManager"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
| <TH ALIGN="left"><B>Fields inherited from class org.apache.velocity.tools.<A HREF="../../../../../org/apache/velocity/tools/ToolManager.html" title="class in org.apache.velocity.tools">ToolManager</A></B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#factory">factory</A>, <A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#velocity">velocity</A></CODE></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/ViewToolManager.html#ViewToolManager(javax.servlet.ServletContext)">ViewToolManager</A></B>(javax.servlet.ServletContext app)</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/view/ViewToolManager.html#ViewToolManager(javax.servlet.ServletContext, boolean)">ViewToolManager</A></B>(javax.servlet.ServletContext app, | |
| boolean includeDefaults)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#ViewToolManager(javax.servlet.ServletContext, boolean, boolean)">ViewToolManager</A></B>(javax.servlet.ServletContext app, | |
| 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/view/ViewToolManager.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/view/ViewToolManager.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/view/ViewToolManager.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> <A HREF="../../../../../org/apache/velocity/tools/view/ViewToolContext.html" title="class in org.apache.velocity.tools.view">ViewToolContext</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#createContext(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">createContext</A></B>(javax.servlet.http.HttpServletRequest request, | |
| javax.servlet.http.HttpServletResponse response)</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/view/ViewToolManager.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/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/view/ViewToolManager.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> boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#getCreateSession()">getCreateSession</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/view/ViewToolManager.html#getPublishToolboxes()">getPublishToolboxes</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/view/ViewToolManager.html#getSessionToolbox()">getSessionToolbox</A></B>()</CODE> | |
| <BR> | |
| </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/view/ViewToolManager.html#getToolboxKey()">getToolboxKey</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/view/ViewToolManager.html#hasSessionTools()">hasSessionTools</A></B>()</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/view/ViewToolManager.html#prepareContext(org.apache.velocity.tools.view.ViewToolContext, javax.servlet.http.HttpServletRequest)">prepareContext</A></B>(<A HREF="../../../../../org/apache/velocity/tools/view/ViewToolContext.html" title="class in org.apache.velocity.tools.view">ViewToolContext</A> context, | |
| javax.servlet.http.HttpServletRequest request)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#publishToolbox(javax.servlet.ServletRequest)">publishToolbox</A></B>(javax.servlet.ServletRequest request)</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/view/ViewToolManager.html#publishToolboxes(javax.servlet.http.HttpServletRequest)">publishToolboxes</A></B>(javax.servlet.http.HttpServletRequest request)</CODE> | |
| <BR> | |
| Places the <A HREF="../../../../../org/apache/velocity/tools/Scope.html#REQUEST"><CODE>Scope.REQUEST</CODE></A> <A HREF="../../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools"><CODE>Toolbox</CODE></A> (if any) | |
| into the <CODE>HttpServletRequest</CODE> attributes using | |
| <A HREF="../../../../../org/apache/velocity/tools/Toolbox.html#KEY"><CODE>Toolbox.KEY</CODE></A> as the key, places the <A HREF="../../../../../org/apache/velocity/tools/Scope.html#SESSION"><CODE>Scope.SESSION</CODE></A> | |
| Toolbox (if any) into the attributes of the <CODE>HttpSession</CODE> (if any) | |
| then ensures that the <A HREF="../../../../../org/apache/velocity/tools/Scope.html#APPLICATION"><CODE>Scope.APPLICATION</CODE></A> Toolbox (if any) | |
| has been placed in the <CODE>ServletContext</CODE> attributes.</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/ViewToolManager.html#publishToolboxes(javax.servlet.ServletRequest)">publishToolboxes</A></B>(javax.servlet.ServletRequest request)</CODE> | |
| <BR> | |
| Places the <A HREF="../../../../../org/apache/velocity/tools/Scope.html#REQUEST"><CODE>Scope.REQUEST</CODE></A> <A HREF="../../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools"><CODE>Toolbox</CODE></A> (if any) | |
| into the <CODE>ServletRequest</CODE> attributes using | |
| <A HREF="../../../../../org/apache/velocity/tools/Toolbox.html#KEY"><CODE>Toolbox.KEY</CODE></A> as the key.</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/ViewToolManager.html#setCreateSession(boolean)">setCreateSession</A></B>(boolean create)</CODE> | |
| <BR> | |
| Sets whether or not a new HttpSession should be created | |
| when there are session scoped tools to be stored in the session, | |
| but no session has been created yet.</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/ViewToolManager.html#setPublishToolboxes(boolean)">setPublishToolboxes</A></B>(boolean publish)</CODE> | |
| <BR> | |
| Sets whether or not the creation of a new <A HREF="../../../../../org/apache/velocity/tools/view/ViewToolContext.html" title="class in org.apache.velocity.tools.view"><CODE>ViewToolContext</CODE></A> | |
| should make the various scoped <A HREF="../../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools"><CODE>Toolbox</CODE></A> instances available | |
| publically via the HttpServletRequest/HttpSession/ServletContext | |
| attributes or simply add the Toolbox instances directly to the | |
| 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/ViewToolManager.html#setToolboxKey(java.lang.String)">setToolboxKey</A></B>(java.lang.String key)</CODE> | |
| <BR> | |
| Sets a new attribute key to be used for publishing each <A HREF="../../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools"><CODE>Toolbox</CODE></A>.</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/view/ViewToolManager.html#unpublishApplicationTools()">unpublishApplicationTools</A></B>()</CODE> | |
| <BR> | |
| Removes any published <A HREF="../../../../../org/apache/velocity/tools/Scope.html#APPLICATION"><CODE>Scope.APPLICATION</CODE></A> Toolbox.</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/view/ViewToolManager.html#updateGlobalProperties()">updateGlobalProperties</A></B>()</CODE> | |
| <BR> | |
| Checks the internal <A HREF="../../../../../org/apache/velocity/tools/ToolboxFactory.html" title="class in org.apache.velocity.tools"><CODE>ToolboxFactory</CODE></A> for any changes to | |
| the createSession or publishToolboxes settings.</TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="methods_inherited_from_class_org.apache.velocity.tools.ToolManager"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.velocity.tools.<A HREF="../../../../../org/apache/velocity/tools/ToolManager.html" title="class in org.apache.velocity.tools">ToolManager</A></B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#configure(java.lang.String)">configure</A>, <A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#createContext()">createContext</A>, <A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#createToolbox(java.lang.String)">createToolbox</A>, <A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#debug(java.lang.String, java.lang.Object...)">debug</A>, <A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#getApplicationToolbox()">getApplicationToolbox</A>, <A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#getLog()">getLog</A>, <A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#getRequestToolbox()">getRequestToolbox</A>, <A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#getToolboxFactory()">getToolboxFactory</A>, <A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#getUserCanOverwriteTools()">getUserCanOverwriteTools</A>, <A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#getVelocityEngine()">getVelocityEngine</A>, <A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#hasApplicationTools()">hasApplicationTools</A>, <A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#hasRequestTools()">hasRequestTools</A>, <A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#hasTools(java.lang.String)">hasTools</A>, <A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#prepareContext(org.apache.velocity.tools.ToolContext)">prepareContext</A>, <A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#setToolboxFactory(org.apache.velocity.tools.ToolboxFactory)">setToolboxFactory</A>, <A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#setUserCanOverwriteTools(boolean)">setUserCanOverwriteTools</A>, <A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#setVelocityEngine(org.apache.velocity.app.VelocityEngine)">setVelocityEngine</A></CODE></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="CREATE_SESSION_PROPERTY"><!-- --></A><H3> | |
| CREATE_SESSION_PROPERTY</H3> | |
| <PRE> | |
| public static final java.lang.String <B>CREATE_SESSION_PROPERTY</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.view.ViewToolManager.CREATE_SESSION_PROPERTY">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="PUBLISH_TOOLBOXES_PROPERTY"><!-- --></A><H3> | |
| PUBLISH_TOOLBOXES_PROPERTY</H3> | |
| <PRE> | |
| public static final java.lang.String <B>PUBLISH_TOOLBOXES_PROPERTY</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.view.ViewToolManager.PUBLISH_TOOLBOXES_PROPERTY">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="DEFAULT_TOOLBOX_KEY"><!-- --></A><H3> | |
| DEFAULT_TOOLBOX_KEY</H3> | |
| <PRE> | |
| public static final java.lang.String <B>DEFAULT_TOOLBOX_KEY</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="servletContext"><!-- --></A><H3> | |
| servletContext</H3> | |
| <PRE> | |
| protected javax.servlet.ServletContext <B>servletContext</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="createSession"><!-- --></A><H3> | |
| createSession</H3> | |
| <PRE> | |
| private boolean <B>createSession</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="publishToolboxes"><!-- --></A><H3> | |
| publishToolboxes</H3> | |
| <PRE> | |
| private boolean <B>publishToolboxes</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="appToolsPublished"><!-- --></A><H3> | |
| appToolsPublished</H3> | |
| <PRE> | |
| private boolean <B>appToolsPublished</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="toolboxKey"><!-- --></A><H3> | |
| toolboxKey</H3> | |
| <PRE> | |
| private java.lang.String <B>toolboxKey</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="ViewToolManager(javax.servlet.ServletContext)"><!-- --></A><H3> | |
| ViewToolManager</H3> | |
| <PRE> | |
| public <B>ViewToolManager</B>(javax.servlet.ServletContext app)</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="ViewToolManager(javax.servlet.ServletContext, boolean)"><!-- --></A><H3> | |
| ViewToolManager</H3> | |
| <PRE> | |
| public <B>ViewToolManager</B>(javax.servlet.ServletContext app, | |
| boolean includeDefaults)</PRE> | |
| <DL> | |
| </DL> | |
| <HR> | |
| <A NAME="ViewToolManager(javax.servlet.ServletContext, boolean, boolean)"><!-- --></A><H3> | |
| ViewToolManager</H3> | |
| <PRE> | |
| public <B>ViewToolManager</B>(javax.servlet.ServletContext app, | |
| 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> | |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#autoConfigure(boolean)">autoConfigure</A></CODE> in class <CODE><A HREF="../../../../../org/apache/velocity/tools/ToolManager.html" title="class in org.apache.velocity.tools">ToolManager</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setPublishToolboxes(boolean)"><!-- --></A><H3> | |
| setPublishToolboxes</H3> | |
| <PRE> | |
| public void <B>setPublishToolboxes</B>(boolean publish)</PRE> | |
| <DL> | |
| <DD>Sets whether or not the creation of a new <A HREF="../../../../../org/apache/velocity/tools/view/ViewToolContext.html" title="class in org.apache.velocity.tools.view"><CODE>ViewToolContext</CODE></A> | |
| should make the various scoped <A HREF="../../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools"><CODE>Toolbox</CODE></A> instances available | |
| publically via the HttpServletRequest/HttpSession/ServletContext | |
| attributes or simply add the Toolbox instances directly to the | |
| context. <b>It is important to note that if this is set to false, | |
| session-scoped tools will NOT be stored in the session, but instead | |
| be recreated for each request.</b> | |
| <P> | |
| <DD><DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#publishToolboxes"><CODE>publishToolboxes</CODE></A>, | |
| <A HREF="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#setToolboxKey(java.lang.String)"><CODE>setToolboxKey(java.lang.String)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getPublishToolboxes()"><!-- --></A><H3> | |
| getPublishToolboxes</H3> | |
| <PRE> | |
| public boolean <B>getPublishToolboxes</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setToolboxKey(java.lang.String)"><!-- --></A><H3> | |
| setToolboxKey</H3> | |
| <PRE> | |
| public void <B>setToolboxKey</B>(java.lang.String key)</PRE> | |
| <DL> | |
| <DD>Sets a new attribute key to be used for publishing each <A HREF="../../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools"><CODE>Toolbox</CODE></A>. | |
| <P> | |
| <DD><DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#setPublishToolboxes(boolean)"><CODE>setPublishToolboxes(boolean)</CODE></A>, | |
| <A HREF="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#publishToolboxes"><CODE>publishToolboxes</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getToolboxKey()"><!-- --></A><H3> | |
| getToolboxKey</H3> | |
| <PRE> | |
| public java.lang.String <B>getToolboxKey</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setCreateSession(boolean)"><!-- --></A><H3> | |
| setCreateSession</H3> | |
| <PRE> | |
| public void <B>setCreateSession</B>(boolean create)</PRE> | |
| <DL> | |
| <DD>Sets whether or not a new HttpSession should be created | |
| when there are session scoped tools to be stored in the session, | |
| but no session has been created yet. | |
| <P> | |
| <DD><DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/view/ViewToolManager.html#publishToolboxes"><CODE>publishToolboxes</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getCreateSession()"><!-- --></A><H3> | |
| getCreateSession</H3> | |
| <PRE> | |
| public boolean <B>getCreateSession</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="updateGlobalProperties()"><!-- --></A><H3> | |
| updateGlobalProperties</H3> | |
| <PRE> | |
| protected void <B>updateGlobalProperties</B>()</PRE> | |
| <DL> | |
| <DD>Checks the internal <A HREF="../../../../../org/apache/velocity/tools/ToolboxFactory.html" title="class in org.apache.velocity.tools"><CODE>ToolboxFactory</CODE></A> for any changes to | |
| the createSession or publishToolboxes settings. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="unpublishApplicationTools()"><!-- --></A><H3> | |
| unpublishApplicationTools</H3> | |
| <PRE> | |
| protected void <B>unpublishApplicationTools</B>()</PRE> | |
| <DL> | |
| <DD>Removes any published <A HREF="../../../../../org/apache/velocity/tools/Scope.html#APPLICATION"><CODE>Scope.APPLICATION</CODE></A> Toolbox. | |
| <P> | |
| <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> | |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#configure(org.apache.velocity.tools.config.FactoryConfiguration)">configure</A></CODE> in class <CODE><A HREF="../../../../../org/apache/velocity/tools/ToolManager.html" title="class in org.apache.velocity.tools">ToolManager</A></CODE></DL> | |
| </DD> | |
| <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> | |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#findConfig(java.lang.String)">findConfig</A></CODE> in class <CODE><A HREF="../../../../../org/apache/velocity/tools/ToolManager.html" title="class in org.apache.velocity.tools">ToolManager</A></CODE></DL> | |
| </DD> | |
| <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> | |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#addToolboxes(org.apache.velocity.tools.ToolContext)">addToolboxes</A></CODE> in class <CODE><A HREF="../../../../../org/apache/velocity/tools/ToolManager.html" title="class in org.apache.velocity.tools">ToolManager</A></CODE></DL> | |
| </DD> | |
| <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> | |
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/velocity/tools/ToolManager.html#createContext(java.util.Map)">createContext</A></CODE> in class <CODE><A HREF="../../../../../org/apache/velocity/tools/ToolManager.html" title="class in org.apache.velocity.tools">ToolManager</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="createContext(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><!-- --></A><H3> | |
| createContext</H3> | |
| <PRE> | |
| public <A HREF="../../../../../org/apache/velocity/tools/view/ViewToolContext.html" title="class in org.apache.velocity.tools.view">ViewToolContext</A> <B>createContext</B>(javax.servlet.http.HttpServletRequest request, | |
| javax.servlet.http.HttpServletResponse response)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="prepareContext(org.apache.velocity.tools.view.ViewToolContext, javax.servlet.http.HttpServletRequest)"><!-- --></A><H3> | |
| prepareContext</H3> | |
| <PRE> | |
| public void <B>prepareContext</B>(<A HREF="../../../../../org/apache/velocity/tools/view/ViewToolContext.html" title="class in org.apache.velocity.tools.view">ViewToolContext</A> context, | |
| javax.servlet.http.HttpServletRequest request)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="hasSessionTools()"><!-- --></A><H3> | |
| hasSessionTools</H3> | |
| <PRE> | |
| protected boolean <B>hasSessionTools</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getSessionToolbox()"><!-- --></A><H3> | |
| getSessionToolbox</H3> | |
| <PRE> | |
| protected <A HREF="../../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools">Toolbox</A> <B>getSessionToolbox</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="publishToolboxes(javax.servlet.ServletRequest)"><!-- --></A><H3> | |
| publishToolboxes</H3> | |
| <PRE> | |
| public void <B>publishToolboxes</B>(javax.servlet.ServletRequest request)</PRE> | |
| <DL> | |
| <DD>Places the <A HREF="../../../../../org/apache/velocity/tools/Scope.html#REQUEST"><CODE>Scope.REQUEST</CODE></A> <A HREF="../../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools"><CODE>Toolbox</CODE></A> (if any) | |
| into the <CODE>ServletRequest</CODE> attributes using | |
| <A HREF="../../../../../org/apache/velocity/tools/Toolbox.html#KEY"><CODE>Toolbox.KEY</CODE></A> as the key. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="publishToolbox(javax.servlet.ServletRequest)"><!-- --></A><H3> | |
| publishToolbox</H3> | |
| <PRE> | |
| private void <B>publishToolbox</B>(javax.servlet.ServletRequest request)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="publishToolboxes(javax.servlet.http.HttpServletRequest)"><!-- --></A><H3> | |
| publishToolboxes</H3> | |
| <PRE> | |
| public void <B>publishToolboxes</B>(javax.servlet.http.HttpServletRequest request)</PRE> | |
| <DL> | |
| <DD>Places the <A HREF="../../../../../org/apache/velocity/tools/Scope.html#REQUEST"><CODE>Scope.REQUEST</CODE></A> <A HREF="../../../../../org/apache/velocity/tools/Toolbox.html" title="class in org.apache.velocity.tools"><CODE>Toolbox</CODE></A> (if any) | |
| into the <CODE>HttpServletRequest</CODE> attributes using | |
| <A HREF="../../../../../org/apache/velocity/tools/Toolbox.html#KEY"><CODE>Toolbox.KEY</CODE></A> as the key, places the <A HREF="../../../../../org/apache/velocity/tools/Scope.html#SESSION"><CODE>Scope.SESSION</CODE></A> | |
| Toolbox (if any) into the attributes of the <CODE>HttpSession</CODE> (if any) | |
| then ensures that the <A HREF="../../../../../org/apache/velocity/tools/Scope.html#APPLICATION"><CODE>Scope.APPLICATION</CODE></A> Toolbox (if any) | |
| has been placed in the <CODE>ServletContext</CODE> attributes. | |
| <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/ViewToolInfo.html" title="class in org.apache.velocity.tools.view"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../../org/apache/velocity/tools/view/WebappResourceLoader.html" title="class in org.apache.velocity.tools.view"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../index.html?org/apache/velocity/tools/view/ViewToolManager.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="ViewToolManager.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> |