A B C D E F G H I J K L M N O P R S T U V W X

## A

AbstractSearchTool - Class in org.apache.velocity.tools.view
  Abstract view tool for doing "searching" and robust pagination of search results.
AbstractSearchTool() - Constructor for class org.apache.velocity.tools.view.AbstractSearchTool
AbstractSearchTool.StoredResults - Class in org.apache.velocity.tools.view
  Simple utility class to hold a criterion and its result list.
acquireLocalURLReader(String) - Method in class org.apache.velocity.tools.view.ViewImportSupport
acquireLocalURLString(String) - Method in class org.apache.velocity.tools.view.ViewImportSupport
acquireRemoteURLReader(String) - Method in class org.apache.velocity.tools.view.ViewImportSupport
acquireRemoteURLString(String) - Method in class org.apache.velocity.tools.view.ViewImportSupport
add(Cookie) - Method in class org.apache.velocity.tools.view.CookieTool
  Adds the specified Cookie to the HttpServletResponse.
add(String, String) - Method in class org.apache.velocity.tools.view.CookieTool
  Adds a new Cookie with the specified name and value to the HttpServletResponse.
add(String, String, Object) - Method in class org.apache.velocity.tools.view.CookieTool
  Convenience method to add a new Cookie to the response and set an expiry time for it.
addDependencies(Map<String, List<String>>) - Method in class org.apache.velocity.tools.view.UiDependencyTool
  Adds the specified files organized by type to this instance's current dependencies.
addFile(String, String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
  Adds a file to this instance's dependencies under the specified type.
addFile(String, String) - Method in class org.apache.velocity.tools.view.UiDependencyTool.Group
addGroup(String) - Method in class org.apache.velocity.tools.view.UiDependencyTool.Group
addMissingRequestParams(Object...) - Method in class org.apache.velocity.tools.view.LinkTool
  Adds all of the current request's parameters to this link's "query data" except for those whose keys match any of the specified strings or already have a value set for them in the current instance.
addRequestParams(Object...) - Method in class org.apache.velocity.tools.view.LinkTool
  Adds the specified parameters (if they exist) from the current request to the query data of a copy of this instance.
addRequestParamsExcept(Object...) - Method in class org.apache.velocity.tools.view.LinkTool
  Adds all of the current request's parameters to this link's "query data" except for those whose keys match any of the specified strings.
addToolboxes(ToolContext) - Method in class org.apache.velocity.tools.view.ViewToolManager
addToolboxesUnderKey(String) - Method in class org.apache.velocity.tools.view.ViewToolContext
ALT_VELOCITY_VIEW_KEY - Static variable in class org.apache.velocity.tools.view.ServletUtils
APPLICATION - Static variable in interface org.apache.velocity.tools.view.ViewContext
  Key used for the servlet context object in templates.
application - Variable in class org.apache.velocity.tools.view.ViewContextTool
application - Variable in class org.apache.velocity.tools.view.ViewImportSupport
autoConfigure(boolean) - Method in class org.apache.velocity.tools.view.ViewToolManager

## B

begin(String, String, Attributes) - Method in class org.apache.velocity.tools.view.UiDependencyTool.FileRule
begin(String, String, Attributes) - Method in class org.apache.velocity.tools.view.UiDependencyTool.GroupRule
begin(String, String, Attributes) - Method in class org.apache.velocity.tools.view.UiDependencyTool.TypeRule
body(String, String, String) - Method in class org.apache.velocity.tools.view.UiDependencyTool.FileRule
body(String, String, String) - Method in class org.apache.velocity.tools.view.UiDependencyTool.NeedsRule
body(String, String, String) - Method in class org.apache.velocity.tools.view.UiDependencyTool.TypeRule
BreadcrumbTool - Class in org.apache.velocity.tools.view
  Helper tool to display a navigation breadcrumb to the end user.
BreadcrumbTool() - Constructor for class org.apache.velocity.tools.view.BreadcrumbTool
BreadcrumbTool.NavigationElement - Class in org.apache.velocity.tools.view
  Class representing a navigation element
BrowserTool - Class in org.apache.velocity.tools.view
  Browser sniffing tool (session or request scope requested, session scope advised).
BrowserTool() - Constructor for class org.apache.velocity.tools.view.BrowserTool
BrowserToolDeprecatedMethods - Class in org.apache.velocity.tools.view
  Deprecated.
BrowserToolDeprecatedMethods() - Constructor for class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
BUFFER_OUTPUT_PARAM - Static variable in class org.apache.velocity.tools.view.VelocityViewServlet

## C

CLEAN_CONFIGURATION_KEY - Static variable in class org.apache.velocity.tools.view.VelocityView
  Controls removal of tools or data with invalid configurations before initialization is finished.
close() - Method in class org.apache.velocity.tools.view.ViewImportSupport.SafeClosingHttpURLConnectionReader
combinePath(String, String) - Static method in class org.apache.velocity.tools.view.ServletUtils
  If end is null, this will return start and vice versa.
comment(Object) - Method in class org.apache.velocity.tools.view.CookieTool.SugarCookie
CONFIGURATION_KEY - Static variable in class org.apache.velocity.tools.view.ServletUtils
  Key used to access a live `FactoryConfiguration` previously placed in the ServletContext attributes.
configure(ValueParser) - Method in class org.apache.velocity.tools.view.BreadcrumbTool
  Configuration
configure(ValueParser) - Method in class org.apache.velocity.tools.view.ImportTool
configure(ValueParser) - Method in class org.apache.velocity.tools.view.IncludeTool
  Extracts the default language from the specified `ViewContext`, looking first at the Velocity context, then the servlet context, then lastly at the JVM default.
configure(ViewToolContext) - Method in class org.apache.velocity.tools.view.IncludeTool
configure(ValueParser) - Method in class org.apache.velocity.tools.view.JsonTool
  Configuration.
configure(ValueParser) - Method in class org.apache.velocity.tools.view.LinkTool
configure(ValueParser) - Method in class org.apache.velocity.tools.view.ParameterTool
configure(ValueParser) - Method in class org.apache.velocity.tools.view.UiDependencyTool
configure(JeeConfig, VelocityEngine) - Method in class org.apache.velocity.tools.view.VelocityView
configure(JeeConfig, ToolboxFactory) - Method in class org.apache.velocity.tools.view.VelocityView
  Here's the configuration lookup/loading order: If loadDefaults is true, `ConfigurationUtils.getDefaultTools()` Config file optionally specified by servletContext `org.apache.velocity.tools` init-param Config file optionally at `/WEB-INF/tools.xml` (conventional location) Config file optionally specified by servlet `org.apache.velocity.tools` init-param Remember that as these configurations are added on top of each other, the newer values will always override the older ones.
configure(ValueParser) - Method in class org.apache.velocity.tools.view.ViewContextTool
configure(ValueParser) - Method in class org.apache.velocity.tools.view.ViewImportSupport
configure(FactoryConfiguration) - Method in class org.apache.velocity.tools.view.ViewToolManager
configure(ValueParser) - Method in class org.apache.velocity.tools.view.XmlTool
  Configuration.
containsKey(String) - Method in class org.apache.velocity.tools.view.ViewToolContext
  Indicates whether the specified key is in the context.
CONTENT_TYPE_KEY - Static variable in class org.apache.velocity.tools.view.VelocityView
  The HTTP content type context key.
context - Variable in class org.apache.velocity.tools.view.JeeContextConfig
context(String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
  Sets a custom {context} variable for the formats to use.
CONTEXT_KEY - Static variable in class org.apache.velocity.tools.view.VelocityViewFilter
CookieTool - Class in org.apache.velocity.tools.view
  View tool for convenient cookie access and creation.
CookieTool() - Constructor for class org.apache.velocity.tools.view.CookieTool
CookieTool.SugarCookie - Class in org.apache.velocity.tools.view
  Extends `Cookie` to add some fluid API sugar and a toString() method that renders the Cookie's value instead of the usual Object.toString() shenanigans.
create(String, String) - Method in class org.apache.velocity.tools.view.CookieTool
  Creates a new Cookie with the specified name and value.
create(String, String, Object) - Method in class org.apache.velocity.tools.view.CookieTool
  Convenience method to create a new Cookie and set an expiry time for it.
CREATE_SESSION_PROPERTY - Static variable in class org.apache.velocity.tools.view.ViewToolManager
createContext(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityView
  Creates and returns an initialized Velocity context.
createContext(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewFilter
createContext(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
  Get a configured Velocity context for the current request and response
createContext(Map<String, Object>) - Method in class org.apache.velocity.tools.view.ViewToolManager
createContext(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.ViewToolManager
createDigester() - Method in class org.apache.velocity.tools.view.UiDependencyTool
  Creates the `Digester` used by `UiDependencyTool.read(java.lang.String, boolean)` to create the group info for this instance out of the specified XML file.
customize(BreadcrumbTool.NavigationElement, HttpServletRequest) - Method in class org.apache.velocity.tools.view.BreadcrumbTool
  Let the user customize programmatically the name and URL of a specific element.

## D

DEFAULT_CONTENT_TYPE - Static variable in class org.apache.velocity.tools.view.VelocityView
  The default content type for the response
DEFAULT_CRITERIA_KEY - Static variable in class org.apache.velocity.tools.view.AbstractSearchTool
DEFAULT_DEFAULT_LAYOUT - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
  The default filename for the servlet's default layout
DEFAULT_ERROR_TEMPLATE - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
  The default error template's filename.
DEFAULT_INDEX_KEY - Static variable in class org.apache.velocity.tools.view.PagerTool
DEFAULT_ITEMS_PER_PAGE - Static variable in class org.apache.velocity.tools.view.PagerTool
  the default number of items shown per page
DEFAULT_ITEMS_PER_PAGE_KEY - Static variable in class org.apache.velocity.tools.view.PagerTool
DEFAULT_LANGUAGE_KEY - Static variable in class org.apache.velocity.tools.view.IncludeTool
  The key used to search initialization, context, and JVM parameters for the default language to use.
DEFAULT_LAYOUT_DIR - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
  The default layout directory
DEFAULT_NEW_ITEMS_KEY - Static variable in class org.apache.velocity.tools.view.PagerTool
DEFAULT_OUTPUT_ENCODING - Static variable in class org.apache.velocity.tools.view.VelocityView
  Default encoding for the output stream
DEFAULT_PROPERTIES_PATH - Static variable in class org.apache.velocity.tools.view.VelocityView
  Default Runtime properties.
DEFAULT_SLIP_SIZE - Static variable in class org.apache.velocity.tools.view.PagerTool
  the default max number of page indices to list
DEFAULT_SLIP_SIZE_KEY - Static variable in class org.apache.velocity.tools.view.PagerTool
DEFAULT_SOURCE_FILE - Static variable in class org.apache.velocity.tools.view.UiDependencyTool
DEFAULT_TOOLBOX_KEY - Static variable in interface org.apache.velocity.tools.view.ViewContext
  Default key used to store toolboxes in request/session/application attributes.
DEFAULT_TOOLBOX_KEY - Static variable in class org.apache.velocity.tools.view.ViewToolManager
defaultLanguage - Variable in class org.apache.velocity.tools.view.IncludeTool
  The two character abbreviation for the request's default language.
defaultLayout - Variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
delete(String) - Method in class org.apache.velocity.tools.view.CookieTool
  Retrieves the specified cookie and sets the Max-Age to 0 to tell the browser to delete the cookie.
destroy() - Method in class org.apache.velocity.tools.view.VelocityViewFilter
discover(Class) - Method in class org.apache.velocity.tools.view.WebappUberspector.GetAttributeExecutor
discover(Class, Object) - Method in class org.apache.velocity.tools.view.WebappUberspector.SetAttributeExecutor
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.apache.velocity.tools.view.VelocityViewFilter
  Simply prepares the request (and/or session) toolbox(es) for other filters, servlets or whatnot to use.
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
  Handles GET - calls doRequest()
domain(Object) - Method in class org.apache.velocity.tools.view.CookieTool.SugarCookie
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
  Handle a POST request - calls doRequest()
doRequest(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
  Handles with both GET and POST requests

## E

end(String, String) - Method in class org.apache.velocity.tools.view.UiDependencyTool.GroupRule
engine - Variable in class org.apache.velocity.tools.view.IncludeTool
error(HttpServletRequest, HttpServletResponse, Throwable) - Method in class org.apache.velocity.tools.view.VelocityLayoutServlet
  Overrides VelocityViewServlet to display user's custom error template
error(HttpServletRequest, HttpServletResponse, Throwable) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
  Invoked when there is an error thrown in any part of doRequest() processing.
errorTemplate - Variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
execute(Object) - Method in class org.apache.velocity.tools.view.WebappUberspector.GetAttributeExecutor
execute(Object, Object) - Method in class org.apache.velocity.tools.view.WebappUberspector.SetAttributeExecutor
executeQuery(Object) - Method in class org.apache.velocity.tools.view.AbstractSearchTool
  Executes a query for the specified criteria.
exists(String) - Method in class org.apache.velocity.tools.view.IncludeTool
  Checks to see whether a #parse-able template or #include-able resource exists under the specified name/path.
exists(String, String) - Method in class org.apache.velocity.tools.view.IncludeTool
  Checks to see whether a localized version of the named template exists for the specified language.

## F

FileRule() - Constructor for class org.apache.velocity.tools.view.UiDependencyTool.FileRule
fillContext(Context, HttpServletRequest) - Method in class org.apache.velocity.tools.view.VelocityLayoutServlet
  Overrides VelocityViewServlet to check the request for an alternate layout
fillContext(Context, HttpServletRequest) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
  Standard extension point to populate the context with additional entries
fillKeyset(Set) - Method in class org.apache.velocity.tools.view.ViewContextTool
filter - Variable in class org.apache.velocity.tools.view.JeeFilterConfig
find(String, Locale) - Method in class org.apache.velocity.tools.view.IncludeTool
  Calls `IncludeTool.find(String, String)` using the language extracted from `locale`.
find(String) - Method in class org.apache.velocity.tools.view.IncludeTool
  Calls `IncludeTool.find(String, String)` using the default language.
find(String, String) - Method in class org.apache.velocity.tools.view.IncludeTool
  Finds the a localized version of the requested Velocity resource (such as a file or template) which is most appropriate for the locale of the current request.
findConfig(String) - Method in class org.apache.velocity.tools.view.ViewToolManager
findInitParameter(String) - Method in interface org.apache.velocity.tools.view.JeeConfig
  Looks for the specified init-param in the servlet/filter config (i.e.
findInitParameter(String) - Method in class org.apache.velocity.tools.view.JeeContextConfig
  Only checks the `ServletContext`'s init-params for the specified parameter.
findInitParameter(String) - Method in class org.apache.velocity.tools.view.JeeFilterConfig
  Looks for the specified init-param in the servlet/filter config (i.e.
findInitParameter(String) - Method in class org.apache.velocity.tools.view.JeeServletConfig
  Looks for the specified init-param in the servlet/filter config (i.e.
findInitParameter(String) - Method in class org.apache.velocity.tools.view.VelocityViewFilter
  Looks up an init parameter with the specified key in either the FilterConfig or, failing that, in the ServletContext.
findInitParameter(ServletConfig, String) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
  Looks up an init parameter with the specified key in either the ServletConfig or, failing that, in the ServletContext.
findLayout(HttpServletRequest) - Method in class org.apache.velocity.tools.view.VelocityLayoutServlet
  Searches for a non-default layout to be used for this request.
findTool(String, ServletContext) - Static method in class org.apache.velocity.tools.view.ServletUtils
findTool(String, String, ServletContext) - Static method in class org.apache.velocity.tools.view.ServletUtils
findTool(String, HttpServletRequest) - Static method in class org.apache.velocity.tools.view.ServletUtils
findTool(String, String, HttpServletRequest) - Static method in class org.apache.velocity.tools.view.ServletUtils
findTool(String, HttpServletRequest, ServletContext) - Static method in class org.apache.velocity.tools.view.ServletUtils
findTool(String, String, HttpServletRequest, ServletContext) - Static method in class org.apache.velocity.tools.view.ServletUtils
format(String, String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
  Applies the format string to the given value.
formatElementName(String) - Method in class org.apache.velocity.tools.view.BreadcrumbTool
  Automatic default formatting of URI elements

## G

get(String) - Method in class org.apache.velocity.tools.view.BrowserTool
get(String) - Method in class org.apache.velocity.tools.view.CookieTool
  Returns the Cookie with the specified name, if it exists.
get(String) - Method in class org.apache.velocity.tools.view.ViewToolContext
  Looks up and returns the object with the specified key.
getAcceptLanguage() - Method in class org.apache.velocity.tools.view.BrowserTool
getAll() - Method in class org.apache.velocity.tools.view.CookieTool
  Expose array of Cookies for this request to the template.
getAll() - Method in class org.apache.velocity.tools.view.ParameterTool
getAttribute(String) - Method in interface org.apache.velocity.tools.view.ViewContext
  Searches for the named attribute in request, session (if valid), and application scope(s) in order and returns the value associated or null.
getAttribute(String) - Method in class org.apache.velocity.tools.view.ViewToolContext
  Searches for the named attribute in request, session (if valid), and application scope(s) in order and returns the value associated or null.
GetAttributeExecutor(Logger, Introspector, Class, String) - Constructor for class org.apache.velocity.tools.view.WebappUberspector.GetAttributeExecutor
getBrowser() - Method in class org.apache.velocity.tools.view.BrowserTool
getBrowser() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getBrowser() - Method in class org.apache.velocity.tools.view.UAParser.UserAgent
getConfiguration(ServletContext) - Static method in class org.apache.velocity.tools.view.ServletUtils
getConfiguration(String, ServletContext) - Static method in class org.apache.velocity.tools.view.ServletUtils
getConfiguration(String) - Method in class org.apache.velocity.tools.view.VelocityView
getConfiguration(String, boolean) - Method in class org.apache.velocity.tools.view.VelocityView
getContextKey() - Method in class org.apache.velocity.tools.view.VelocityViewFilter
getContextPath() - Method in class org.apache.velocity.tools.view.LinkTool
  Initially, this returns the context path that addresses this web application, e.g.
getContextURL() - Method in class org.apache.velocity.tools.view.LinkTool
  Returns a URL that addresses the web application.
getCreateSession() - Method in class org.apache.velocity.tools.view.PagerTool
getCreateSession() - Method in class org.apache.velocity.tools.view.ViewToolManager
getCriteria() - Method in class org.apache.velocity.tools.view.AbstractSearchTool
  Return the criteria object for this request.
getCriteria() - Method in class org.apache.velocity.tools.view.AbstractSearchTool.StoredResults
getCriteriaKey() - Method in class org.apache.velocity.tools.view.AbstractSearchTool
getCss() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getCss1() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getCss2() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getCss3() - Method in class org.apache.velocity.tools.view.BrowserTool
getDefaultContentType() - Method in class org.apache.velocity.tools.view.VelocityView
getDefaultToolsConfiguration() - Method in class org.apache.velocity.tools.view.VelocityView
getDependencies() - Method in class org.apache.velocity.tools.view.UiDependencyTool
  Returns the current dependencies of this instance, organized as an ordered map of file types to lists of the required files of that type.
getDependencies(String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
  Returns the `List` of files for the specified file type, if any.
getDependencies(UiDependencyTool) - Method in class org.apache.velocity.tools.view.UiDependencyTool.Group
getDevice() - Method in class org.apache.velocity.tools.view.BrowserTool
getDeviceType() - Method in class org.apache.velocity.tools.view.UAParser.UserAgent
getDom0() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getDom1() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getDom2() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getDom3() - Method in class org.apache.velocity.tools.view.BrowserTool
getDotnet() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getExtension(String) - Static method in class org.apache.velocity.tools.view.BreadcrumbTool
  Utility method to return URI file extension
getFileResource(String) - Method in class org.apache.velocity.tools.view.ViewImportSupport
getFilterConfig() - Method in class org.apache.velocity.tools.view.VelocityViewFilter
getFirstIndex() - Method in class org.apache.velocity.tools.view.PagerTool
  Returns the index of the first item on the current page of results (as determined by the current index, items per page, and the number of items).
getFormat(String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
  Retrieves the configured format string for the specified file type.
getGeckoMajorVersion() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getGeckoMinorVersion() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getGeckoVersion() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getGroup(String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
  NOTE: This method may change or disappear w/o warning; don't depend on it unless you're willing to update your code whenever this changes.
getGroupDependencies(String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
  Returns the dependencies of the specified group, organized as an ordered map of file types to lists of the required files of that type.
getIe() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getIe3() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getIe4() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getIe4up() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getIe5() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getIe55() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getIe55up() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getIe5up() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getIe6() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getIe6up() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getIe7() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getIe7up() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getIe8() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getIe8up() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getIndex() - Method in class org.apache.velocity.tools.view.PagerTool
  Returns the current search result index.
getIndexKey() - Method in class org.apache.velocity.tools.view.PagerTool
getInitParameter(String) - Method in interface org.apache.velocity.tools.view.JeeConfig
  Returns an initialization parameter.
getInitParameter(String) - Method in class org.apache.velocity.tools.view.JeeContextConfig
  Returns an initialization parameter.
getInitParameter(String) - Method in class org.apache.velocity.tools.view.JeeFilterConfig
  Returns an initialization parameter.
getInitParameter(String) - Method in class org.apache.velocity.tools.view.JeeServletConfig
  Returns an initialization parameter.
getInitParameterNames() - Method in interface org.apache.velocity.tools.view.JeeConfig
  Returns all the parameter names.
getInitParameterNames() - Method in class org.apache.velocity.tools.view.JeeContextConfig
  Returns all the parameter names.
getInitParameterNames() - Method in class org.apache.velocity.tools.view.JeeFilterConfig
  Returns all the parameter names.
getInitParameterNames() - Method in class org.apache.velocity.tools.view.JeeServletConfig
  Returns all the parameter names.
getInputStream(String, ServletContext) - Static method in class org.apache.velocity.tools.view.ServletUtils
getInputStream(String, boolean) - Method in class org.apache.velocity.tools.view.VelocityView
getInstance() - Method in class org.apache.velocity.tools.view.ServletUtils
getIPAddress() - Method in class org.apache.velocity.tools.view.BrowserTool
  Get the client browser IP address.
getItems() - Method in class org.apache.velocity.tools.view.AbstractSearchTool
  Gets the results for the given criteria either in memory or by performing a new query for them.
getItems() - Method in class org.apache.velocity.tools.view.PagerTool
  Returns the item list.
getItemsPerPage() - Method in class org.apache.velocity.tools.view.PagerTool
  Returns the set number of items to be displayed per page of items
getItemsPerPageKey() - Method in class org.apache.velocity.tools.view.PagerTool
getJavascript() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getLanguagesFilter() - Method in class org.apache.velocity.tools.view.BrowserTool
getLastIndex() - Method in class org.apache.velocity.tools.view.PagerTool
  Returns the index of the last item on the current page of results (as determined by the current index, items per page, and the number of items).
getLastModified(Resource) - Method in class org.apache.velocity.tools.view.WebappResourceLoader
  Checks to see when a resource was last modified
getList() - Method in class org.apache.velocity.tools.view.AbstractSearchTool.StoredResults
getLog() - Method in class org.apache.velocity.tools.view.VelocityViewServlet
getMajorVersion() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getMajorVersion() - Method in class org.apache.velocity.tools.view.UAParser.UAEntity
getMinorVersion() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getMinorVersion() - Method in class org.apache.velocity.tools.view.UAParser.UAEntity
getMutex(HttpSession, String, Object) - Static method in class org.apache.velocity.tools.view.ServletUtils
  Returns a mutex (lock object) unique to the specified session and stored under the specified key to allow for reliable synchronization on the session.
getName() - Method in class org.apache.velocity.tools.view.BreadcrumbTool.NavigationElement
  Displayed name getter
getName() - Method in interface org.apache.velocity.tools.view.JeeConfig
  Returns the name of the servlet (or filter) being used.
getName() - Method in class org.apache.velocity.tools.view.JeeContextConfig
  Returns the name of the servlet (or filter) being used.
getName() - Method in class org.apache.velocity.tools.view.JeeFilterConfig
  Returns the name of the servlet (or filter) being used.
getName() - Method in class org.apache.velocity.tools.view.JeeServletConfig
  Returns the name of the servlet (or filter) being used.
getName() - Method in class org.apache.velocity.tools.view.UAParser.UAEntity
getNav2() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getNav3() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getNav4() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getNav45() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getNav45up() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getNav4up() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getNav6() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getNav6up() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getNavgold() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getNewItemsKey() - Method in class org.apache.velocity.tools.view.PagerTool
getNextIndex() - Method in class org.apache.velocity.tools.view.PagerTool
  Returns the index for the next page of items (as determined by the current index, items per page, and the number of items).
getOpera3() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getOpera4() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getOpera5() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getOpera6() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getOpera7() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getOpera8() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getOpera9() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getOperatingSystem() - Method in class org.apache.velocity.tools.view.BrowserTool
getOperatingSystem() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getOperatingSystem() - Method in class org.apache.velocity.tools.view.UAParser.UserAgent
getOutputStream() - Method in class org.apache.velocity.tools.view.ViewImportSupport.ImportResponseWrapper
getOutputWriter(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
  Get the output stream writer to use.
getPage() - Method in class org.apache.velocity.tools.view.PagerTool
  Returns the current "page" of search items.
getPageDescription() - Method in class org.apache.velocity.tools.view.PagerTool
  Returns a description of the current page.
getPageNumber(int) - Method in class org.apache.velocity.tools.view.PagerTool
  Returns the "page number" for the specified index.
getPageNumber() - Method in class org.apache.velocity.tools.view.PagerTool
  Returns the "page number" for the current index.
getPagesAvailable() - Method in class org.apache.velocity.tools.view.PagerTool
  Returns the number of pages that can be made from this list given the set number of items per page.
getPath(HttpServletRequest) - Static method in class org.apache.velocity.tools.view.ServletUtils
  Retrieves the path for the specified request regardless of whether this is a direct request or an include by the RequestDispatcher.
getPlain() - Method in class org.apache.velocity.tools.view.CookieTool.SugarCookie
getPreferredLanguage() - Method in class org.apache.velocity.tools.view.BrowserTool
getPreferredLocale() - Method in class org.apache.velocity.tools.view.BrowserTool
getPrevIndex() - Method in class org.apache.velocity.tools.view.PagerTool
  Return the index for the previous page of items (as determined by the current index, items per page, and the number of items).
getProperties(String) - Method in class org.apache.velocity.tools.view.VelocityView
getProperties(String, boolean) - Method in class org.apache.velocity.tools.view.VelocityView
getProperty(String, String) - Method in class org.apache.velocity.tools.view.VelocityView
  Simplifies process of getting a property from VelocityEngine, because the VelocityEngine interface sucks compared to the singleton's.
getPropertyGet(Object, String, Info) - Method in class org.apache.velocity.tools.view.WebappUberspector
  Property getter
getPropertySet(Object, String, Object, Info) - Method in class org.apache.velocity.tools.view.WebappUberspector
  Property setter
getPublishToolboxes() - Method in class org.apache.velocity.tools.view.ViewToolManager
getRenderingEngine() - Method in class org.apache.velocity.tools.view.BrowserTool
getRenderingEngine() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getRenderingEngine() - Method in class org.apache.velocity.tools.view.UAParser.UserAgent
getRequest() - Method in class org.apache.velocity.tools.view.ParameterTool
  Returns the current `ServletRequest` for this instance.
getRequest() - Method in interface org.apache.velocity.tools.view.ViewContext
getRequest() - Method in class org.apache.velocity.tools.view.ViewToolContext
getRequestPath() - Method in class org.apache.velocity.tools.view.LinkTool
  Initially, this retrieves the path for the current request regardless of whether this is a direct request or an include by the RequestDispatcher.
getResourceReader(String, String) - Method in class org.apache.velocity.tools.view.WebappResourceLoader
  Get Reader so that the Runtime can build a template with it.
getResponse() - Method in interface org.apache.velocity.tools.view.ViewContext
getResponse() - Method in class org.apache.velocity.tools.view.ViewToolContext
getServletApi(String) - Method in class org.apache.velocity.tools.view.ViewToolContext
  Returns the current matching servlet request, response, session, or servlet context instance, or null if the key matches none of those keys.
getServletContext() - Method in interface org.apache.velocity.tools.view.JeeConfig
  Returns the servlet context.
getServletContext() - Method in class org.apache.velocity.tools.view.JeeContextConfig
  Returns the servlet context.
getServletContext() - Method in class org.apache.velocity.tools.view.JeeFilterConfig
  Returns the servlet context.
getServletContext() - Method in class org.apache.velocity.tools.view.JeeServletConfig
  Returns the servlet context.
getServletContext() - Method in interface org.apache.velocity.tools.view.ViewContext
getServletContext() - Method in class org.apache.velocity.tools.view.ViewToolContext
getSession() - Method in class org.apache.velocity.tools.view.ViewToolContext
getSessionToolbox() - Method in class org.apache.velocity.tools.view.ViewToolManager
getSessionToolbox(HttpSession) - Method in class org.apache.velocity.tools.view.ViewToolManager
getSlip() - Method in class org.apache.velocity.tools.view.PagerTool
  Returns a Sliding List of Indices for Pages of items.
getSlipSize() - Method in class org.apache.velocity.tools.view.PagerTool
  Returns the number of result page indices `PagerTool.getSlip()` will return per request (if available).
getSlipSizeKey() - Method in class org.apache.velocity.tools.view.PagerTool
getSource() - Method in class org.apache.velocity.tools.view.ParameterTool
  Overrides ValueParser.getSource() to return the result of getRequest().getParameterMap() and expand singleton arrays within it first.
getStatus() - Method in class org.apache.velocity.tools.view.ViewImportSupport.ImportResponseWrapper
getStoredItems() - Method in class org.apache.velocity.tools.view.AbstractSearchTool
getStoredItems() - Method in class org.apache.velocity.tools.view.PagerTool
  Retrieves stored search items (if any) from the user's session attributes.
getStoredResults() - Method in class org.apache.velocity.tools.view.AbstractSearchTool
  Retrieves stored search results (if any) from the user's session attributes.
getString() - Method in class org.apache.velocity.tools.view.ViewImportSupport.ImportResponseWrapper
  Retrieves the buffered output, using the containing tag's 'charEncoding' attribute, or the tag's default encoding, if necessary.
getTemplate(HttpServletRequest) - Method in class org.apache.velocity.tools.view.VelocityView
  Gets the requested template.
getTemplate(String) - Method in class org.apache.velocity.tools.view.VelocityView
  Retrieves the requested template.
getTemplate(String, String) - Method in class org.apache.velocity.tools.view.VelocityView
  Retrieves the requested template with the specified character encoding.
getTemplate(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
  Get a template by client request and response
getTemplate(String) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
  Get a template by name
getToolboxes() - Method in class org.apache.velocity.tools.view.ViewToolContext
getToolboxKey() - Method in class org.apache.velocity.tools.view.ViewToolManager
getToolVar(String) - Method in class org.apache.velocity.tools.view.ViewToolContext
  Finds the automatically provided values, either configured tools or servlet API objects (request, response, etc).
getTotal() - Method in class org.apache.velocity.tools.view.PagerTool
  Returns the total number of items available.
getUrl() - Method in class org.apache.velocity.tools.view.BreadcrumbTool.NavigationElement
  Destination URL getter
getURL(String, ServletContext) - Static method in class org.apache.velocity.tools.view.ServletUtils
getUserAgent() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getUserAgentString() - Method in class org.apache.velocity.tools.view.BrowserTool
getUserAgentString() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getUserVar(String) - Method in class org.apache.velocity.tools.view.ViewToolContext
  Finds "user" set values, either in the local context or in the scoped attributes if none is in the local context.
getValue(String) - Method in class org.apache.velocity.tools.view.ParameterTool
  Overrides ValueParser.getValue(String key) to retrieve the value from the ServletRequest instead of an arbitrary Map.
getValues(String) - Method in class org.apache.velocity.tools.view.ParameterTool
  Overrides ValueParser.getValues(String key) to retrieve Strings from the ServletRequest instead of an arbitrary Map.
getVelocityContext() - Method in interface org.apache.velocity.tools.view.ViewContext
getVelocityContext() - Method in class org.apache.velocity.tools.view.ViewToolContext
getVelocityEngine() - Method in interface org.apache.velocity.tools.view.ViewContext
getVelocityEngine() - Method in class org.apache.velocity.tools.view.ViewToolContext
getVelocityProperty(String, String) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
getVelocityView(ServletConfig) - Static method in class org.apache.velocity.tools.view.ServletUtils
  Returns the shared `VelocityView` for the specified `ServletConfig`'s context.
getVelocityView(FilterConfig) - Static method in class org.apache.velocity.tools.view.ServletUtils
  Returns the shared `VelocityView` for the specified `FilterConfig`'s context.
getVelocityView(JeeConfig) - Static method in class org.apache.velocity.tools.view.ServletUtils
  Returns the shared `VelocityView` for the specified `JeeConfig`'s context.
getVelocityView(ServletContext) - Static method in class org.apache.velocity.tools.view.ServletUtils
  Returns the shared `VelocityView` for the specified `ServletContext`.
getVelocityView(ServletContext, boolean) - Static method in class org.apache.velocity.tools.view.ServletUtils
  Returns the shared `VelocityView` for the specified `ServletContext`.
getVelocityView() - Method in class org.apache.velocity.tools.view.VelocityViewFilter
getVelocityView() - Method in class org.apache.velocity.tools.view.VelocityViewServlet
getVersion() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getVista() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getWin16() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getWin2k() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getWin31() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getWin32() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getWin3x() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getWin95() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getWin98() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getWinme() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getWinnt() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getWinxp() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
getWriter() - Method in class org.apache.velocity.tools.view.ViewImportSupport.ImportResponseWrapper
Group(String) - Constructor for class org.apache.velocity.tools.view.UiDependencyTool.Group
GroupRule() - Constructor for class org.apache.velocity.tools.view.UiDependencyTool.GroupRule
GROUPS_KEY_SPACE - Static variable in class org.apache.velocity.tools.view.UiDependencyTool

## H

handleRequest(HttpServletRequest, HttpServletResponse, Context) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
  This was a common extension point, but now it is usually simpler to override `VelocityViewServlet.fillContext(org.apache.velocity.context.Context, javax.servlet.http.HttpServletRequest)` to add custom things to the `Context` or override a `VelocityViewServlet.getTemplate(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)` method to change how `Template`s are retrieved.
hasItems() - Method in class org.apache.velocity.tools.view.PagerTool
  Checks whether or not the result list is empty.
hasSessionTools() - Method in class org.apache.velocity.tools.view.ViewToolManager

## I

ImportResponseWrapper(HttpServletResponse) - Constructor for class org.apache.velocity.tools.view.ViewImportSupport.ImportResponseWrapper
  Constructs a new ImportResponseWrapper.
ImportTool - Class in org.apache.velocity.tools.view
  General-purpose text-importing view tool for templates.
ImportTool() - Constructor for class org.apache.velocity.tools.view.ImportTool
INCLUDE_REQUEST_PARAMS_KEY - Static variable in class org.apache.velocity.tools.view.LinkTool
includeRequestParams - Variable in class org.apache.velocity.tools.view.LinkTool
IncludeTool - Class in org.apache.velocity.tools.view
  Allows for transparent content negotiation in a manner mimicking Apache httpd's MultiViews.
IncludeTool() - Constructor for class org.apache.velocity.tools.view.IncludeTool
init(ServletConfig) - Method in class org.apache.velocity.tools.view.VelocityLayoutServlet
  Initializes Velocity, the view servlet and checks for changes to the initial layout configuration.
init(JeeConfig) - Method in class org.apache.velocity.tools.view.VelocityView
  Initializes ToolboxFactory, VelocityEngine, and sets default encoding for processing requests.
init(JeeConfig, VelocityEngine) - Method in class org.apache.velocity.tools.view.VelocityView
  Initializes the Velocity runtime, first calling loadConfiguration(JeeConfig) to get a java.util.Properties of configuration information and then calling velocityEngine.init().
init(FilterConfig) - Method in class org.apache.velocity.tools.view.VelocityViewFilter
  Initializes VelocityView used to process requests.
init(ServletConfig) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
  Initializes servlet and VelocityView used to process requests.
init(ExtProperties) - Method in class org.apache.velocity.tools.view.WebappResourceLoader
  This is abstract in the base class, so we need it.
init() - Method in class org.apache.velocity.tools.view.WebappUberspector
  init method
initializeImportSupport(ValueParser) - Method in class org.apache.velocity.tools.view.ImportTool
initializeImportSupport(ValueParser) - Method in class org.apache.velocity.tools.view.JsonTool
  Importsupport initialization
initializeImportSupport(ValueParser) - Method in class org.apache.velocity.tools.view.XmlTool
  ImportSupport initialization.
initRequest(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
  Request and response initialization.
INSTANCE - Static variable in class org.apache.velocity.tools.view.ServletUtils
isAix() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isAix1() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isAix2() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isAix3() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isAix4() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isAmiga() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isAndroid() - Method in class org.apache.velocity.tools.view.BrowserTool
isBlackberry() - Method in class org.apache.velocity.tools.view.BrowserTool
isBlink() - Method in class org.apache.velocity.tools.view.BrowserTool
isBSD() - Method in class org.apache.velocity.tools.view.BrowserTool
isBsd() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isChrome() - Method in class org.apache.velocity.tools.view.BrowserTool
isChrome() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isDec() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isDesktop() - Method in class org.apache.velocity.tools.view.BrowserTool
isEdgeHTML() - Method in class org.apache.velocity.tools.view.BrowserTool
isEmacs() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isFirefox() - Method in class org.apache.velocity.tools.view.BrowserTool
isFirefox() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isFreebsd() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isGecko() - Method in class org.apache.velocity.tools.view.BrowserTool
isGecko() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isHpux() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isHpux10() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isHpux9() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isIOS() - Method in class org.apache.velocity.tools.view.BrowserTool
isIrix() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isIrix5() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isIrix6() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isJsonContentType(String) - Static method in class org.apache.velocity.tools.view.JsonTool
  Check if a given content type is of JSON type
isJsonMimeType(String) - Static method in class org.apache.velocity.tools.view.JsonTool
  Check if a given mime type is of JSON type
isKHTML() - Method in class org.apache.velocity.tools.view.BrowserTool
isKonqueror() - Method in class org.apache.velocity.tools.view.BrowserTool
isKonqueror() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isLinks() - Method in class org.apache.velocity.tools.view.BrowserTool
isLinks() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isLinux() - Method in class org.apache.velocity.tools.view.BrowserTool
isLinux() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isMac() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isMac68k() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isMacppc() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isMobile() - Method in class org.apache.velocity.tools.view.BrowserTool
isMozilla() - Method in class org.apache.velocity.tools.view.BrowserTool
isMozilla() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isMpras() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isMSIE() - Method in class org.apache.velocity.tools.view.BrowserTool
isMSIE() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isNetscape() - Method in class org.apache.velocity.tools.view.BrowserTool
isNetscape() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isOpera() - Method in class org.apache.velocity.tools.view.BrowserTool
isOpera() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isOs2() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isOSX() - Method in class org.apache.velocity.tools.view.BrowserTool
isOSX() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isPathChanged() - Method in class org.apache.velocity.tools.view.LinkTool
isPresto() - Method in class org.apache.velocity.tools.view.BrowserTool
isReliant() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isRobot() - Method in class org.apache.velocity.tools.view.BrowserTool
isSafari() - Method in class org.apache.velocity.tools.view.BrowserTool
isSafari() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isSco() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isSinix() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isSourceModified(Resource) - Method in class org.apache.velocity.tools.view.WebappResourceLoader
  Checks to see if a resource has been deleted, moved or modified.
isSun() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isSun4() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isSun5() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isSuni86() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isSymbian() - Method in class org.apache.velocity.tools.view.BrowserTool
isTablet() - Method in class org.apache.velocity.tools.view.BrowserTool
isTrident() - Method in class org.apache.velocity.tools.view.BrowserTool
isTV() - Method in class org.apache.velocity.tools.view.BrowserTool
isUnix() - Method in class org.apache.velocity.tools.view.BrowserTool
isUnixware() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isVMS() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isWebappResource(String) - Static method in class org.apache.velocity.tools.view.ServletUtils
isWebKit() - Method in class org.apache.velocity.tools.view.BrowserTool
isWindows() - Method in class org.apache.velocity.tools.view.BrowserTool
isWindows() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
isX11() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
iterator() - Method in class org.apache.velocity.tools.view.BreadcrumbTool
  Navigation elements iteration

## J

JeeConfig - Interface in org.apache.velocity.tools.view
  Because sometimes you don't care about the difference between a servlet and a filter.
JeeContextConfig - Class in org.apache.velocity.tools.view
  Implements `JeeConfig` with only a `ServletContext`.
JeeContextConfig(ServletContext) - Constructor for class org.apache.velocity.tools.view.JeeContextConfig
JeeFilterConfig - Class in org.apache.velocity.tools.view
  Implements `JeeConfig` with a `FilterConfig`.
JeeFilterConfig(FilterConfig) - Constructor for class org.apache.velocity.tools.view.JeeFilterConfig
JeeServletConfig - Class in org.apache.velocity.tools.view
  Implements `JeeConfig` with a `ServletConfig`.
JeeServletConfig(ServletConfig) - Constructor for class org.apache.velocity.tools.view.JeeServletConfig
JsonTool - Class in org.apache.velocity.tools.view
  View version of `JsonTool`.
JsonTool() - Constructor for class org.apache.velocity.tools.view.JsonTool

## K

KEY_ERROR_CAUSE - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
  The context key that holds the `Throwable` that broke the rendering of the requested screen.
KEY_ERROR_INVOCATION_EXCEPTION - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
  The context key that holds the `MethodInvocationException` that broke the rendering of the requested screen.
KEY_ERROR_STACKTRACE - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
  The context key that holds the stack trace of the error that broke the rendering of the requested screen.
KEY_LAYOUT - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
  The context/parameter key used to specify an alternate layout to be used for a request instead of the default layout.
KEY_SCREEN_CONTENT - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
  The context key that will hold the content of the screen.

## L

layoutDir - Variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
LinkTool - Class in org.apache.velocity.tools.view
  The LinkTool provides many methods to work with URIs and can help you: construct full URIs (absolute or relative) encode session ID into a URI retrieve server, port and path info for the current request reconstruct or alter the current request URI and more..
LinkTool() - Constructor for class org.apache.velocity.tools.view.LinkTool
LOAD_DEFAULTS_KEY - Static variable in class org.apache.velocity.tools.view.VelocityView
  Controls loading of available default tool configurations provided by VelocityTools.
log - Static variable in class org.apache.velocity.tools.view.CookieTool

## M

makeGroup(String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
  NOTE: This method may change or disappear w/o warning; don't depend on it unless you're willing to update your code whenever this changes.
manageResourceNotFound(HttpServletRequest, HttpServletResponse, ResourceNotFoundException) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
  Manages the `ResourceNotFoundException` to send an HTTP 404 result when needed.
mark(int) - Method in class org.apache.velocity.tools.view.ViewImportSupport.SafeClosingHttpURLConnectionReader
markSupported() - Method in class org.apache.velocity.tools.view.ViewImportSupport.SafeClosingHttpURLConnectionReader
maxAge(Object) - Method in class org.apache.velocity.tools.view.CookieTool.SugarCookie
merge(Template, Context, Writer) - Method in class org.apache.velocity.tools.view.VelocityView
  Merges the template with the context.
mergeQueryStrings(String) - Method in class org.apache.velocity.tools.view.ViewImportSupport
  Merge original parameters into the query string
mergeTemplate(Template, Context, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityLayoutServlet
  Overrides VelocityViewServlet.mergeTemplate to do a two-pass render for handling layouts
mergeTemplate(Template, Context, HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
  Merge template
mergeTemplate(Template, Context, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
  Deprecated.
  see {`VelocityViewServlet.mergeTemplate(Template, Context, HttpServletRequest, HttpServletResponse)`}

## N

NavigationElement(String, String) - Constructor for class org.apache.velocity.tools.view.BreadcrumbTool.NavigationElement
  Constructor
navigationElements - Variable in class org.apache.velocity.tools.view.BreadcrumbTool
  Navigation elements for the current URI
NeedsRule() - Constructor for class org.apache.velocity.tools.view.UiDependencyTool.NeedsRule

## O

on(String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
  Adds all the files required for the specified group, then returns this instance.
on(String, String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
  Adds the specified file to this instance's list of dependencies of the specified type, then returns this instance.
org.apache.velocity.tools.view - package org.apache.velocity.tools.view
  Contains tools and supporting infrastructure for using those tools in a servlet environment as well as general use classes to support use of Velocity as (or in) the view layer of web applications.
OUTPUT_ENCODING_KEY - Static variable in class org.apache.velocity.tools.view.VelocityView
  The HTTP output encoding.

## P

PagerTool - Class in org.apache.velocity.tools.view
  View tool for doing request-based pagination of items in an a list.
PagerTool() - Constructor for class org.apache.velocity.tools.view.PagerTool
ParameterTool - Class in org.apache.velocity.tools.view
  Utility class for easy parsing of `ServletRequest` parameters.
ParameterTool() - Constructor for class org.apache.velocity.tools.view.ParameterTool
  Constructs a new instance
ParameterTool(ServletRequest) - Constructor for class org.apache.velocity.tools.view.ParameterTool
  Constructs a new instance using the specified request.
parseUserAgent(String, Logger) - Static method in class org.apache.velocity.tools.view.UAParser
path(Object) - Method in class org.apache.velocity.tools.view.CookieTool.SugarCookie
paths - Variable in class org.apache.velocity.tools.view.WebappResourceLoader
  The root paths for templates (relative to webapp's root).
performMerge(Template, Context, Writer) - Method in class org.apache.velocity.tools.view.VelocityView
  This is here so developers may override it and gain access to the Writer which the template will be merged into.
prepareContext(ViewToolContext, HttpServletRequest) - Method in class org.apache.velocity.tools.view.ViewToolManager
print() - Method in class org.apache.velocity.tools.view.UiDependencyTool
  Formats and prints all the current dependencies of this tool, using a new line in between the printed/formatted files.
print(String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
  If the parameter value is a known type, then this will format and print all of this instance's current dependencies of the specified type, using a new line in between the printed/formatted files.
print(String, String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
  Formats and prints all of this instance's current dependencies of the specified type, using the specified delimiter in between the printed/formatted files.
printAll(String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
  Formats and prints all the current dependencies of this tool, using the specified delimiter in between the printed/formatted files.
PROPERTIES_KEY - Static variable in class org.apache.velocity.tools.view.VelocityView
  This is the string that is looked for when getInitParameter is called ("org.apache.velocity.properties").
PROPERTY_DEFAULT_LAYOUT - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
  The velocity.properties key for specifying the servlet's default layout template's filename.
PROPERTY_DYNAMIC_LAYOUT - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
  The velocity.properties key for specifying whether dynamic layout change is allowed
PROPERTY_ERROR_TEMPLATE - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
  The velocity.properties key for specifying the servlet's error template.
PROPERTY_LAYOUT_DIR - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
  The velocity.properties key for specifying the relative directory holding layout templates.
PUBLISH_TOOLBOXES_PROPERTY - Static variable in class org.apache.velocity.tools.view.ViewToolManager
publishApplicationTools() - Method in class org.apache.velocity.tools.view.ViewToolManager
  Publish `Scope.APPLICATION` Toolbox.
publishToolboxes(ServletRequest) - Method in class org.apache.velocity.tools.view.ViewToolManager
  Places the `Scope.REQUEST` `Toolbox` (if any) into the `ServletRequest` attributes using `Toolbox.KEY` as the key.
publishToolboxes(HttpServletRequest) - Method in class org.apache.velocity.tools.view.ViewToolManager
  Places the `Scope.REQUEST` `Toolbox` (if any) into the `HttpServletRequest` attributes using `Toolbox.KEY` as the key, places the `Scope.SESSION` Toolbox (if any) into the attributes of the `HttpSession` (if any) then ensures that the `Scope.APPLICATION` Toolbox (if any) has been placed in the `ServletContext` attributes.
putToolProperties() - Method in class org.apache.velocity.tools.view.ViewToolContext

## R

read(Object) - Method in class org.apache.velocity.tools.view.ImportTool
  Returns the supplied URL rendered as a String.
read(String, boolean) - Method in class org.apache.velocity.tools.view.UiDependencyTool
  Reads group info out of the specified file and into this instance.
read() - Method in class org.apache.velocity.tools.view.ViewImportSupport.SafeClosingHttpURLConnectionReader
read(char[]) - Method in class org.apache.velocity.tools.view.ViewImportSupport.SafeClosingHttpURLConnectionReader
read(char[], int, int) - Method in class org.apache.velocity.tools.view.ViewImportSupport.SafeClosingHttpURLConnectionReader
ready() - Method in class org.apache.velocity.tools.view.ViewImportSupport.SafeClosingHttpURLConnectionReader
render(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityView
render(HttpServletRequest, Writer) - Method in class org.apache.velocity.tools.view.VelocityView
request - Variable in class org.apache.velocity.tools.view.BreadcrumbTool
  Current request
request - Variable in class org.apache.velocity.tools.view.CookieTool
request - Variable in class org.apache.velocity.tools.view.LinkTool
REQUEST - Static variable in interface org.apache.velocity.tools.view.ViewContext
  Key used for the HTTP request object.
request - Variable in class org.apache.velocity.tools.view.ViewContextTool
request - Variable in class org.apache.velocity.tools.view.ViewImportSupport
requestCleanup(HttpServletRequest, HttpServletResponse, Context) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
  Cleanup routine called at the end of the request processing sequence allows a derived class to do resource cleanup or other end of process cycle tasks.
reset() - Method in class org.apache.velocity.tools.view.AbstractSearchTool
  Sets the criteria and results to null, page index to zero, and items per page to the default.
reset() - Method in class org.apache.velocity.tools.view.PagerTool
  Sets the item list to null, page index to zero, and items per page to the default.
reset() - Method in class org.apache.velocity.tools.view.ViewImportSupport.SafeClosingHttpURLConnectionReader
resolve(UiDependencyTool) - Method in class org.apache.velocity.tools.view.UiDependencyTool.Group
response - Variable in class org.apache.velocity.tools.view.CookieTool
response - Variable in class org.apache.velocity.tools.view.LinkTool
RESPONSE - Static variable in interface org.apache.velocity.tools.view.ViewContext
  Key used for the HTTP response object.
response - Variable in class org.apache.velocity.tools.view.ViewImportSupport

## S

secure(Object) - Method in class org.apache.velocity.tools.view.CookieTool.SugarCookie
servlet - Variable in class org.apache.velocity.tools.view.JeeServletConfig
SERVLET_CONTEXT_KEY - Static variable in class org.apache.velocity.tools.view.VelocityView
  Key used to access the ServletContext in the Velocity application attributes.
SERVLET_CONTEXT_KEY - Static variable in interface org.apache.velocity.tools.view.ViewContext
  Key used for the servlet context object in tool properties.
servletContext - Variable in class org.apache.velocity.tools.view.ViewToolManager
servletContext - Variable in class org.apache.velocity.tools.view.WebappResourceLoader
ServletUtils - Class in org.apache.velocity.tools.view
  A set of utility methods for supporting and using VelocityTools in the servlet environment.
ServletUtils() - Constructor for class org.apache.velocity.tools.view.ServletUtils
session - Variable in class org.apache.velocity.tools.view.PagerTool
SESSION - Static variable in interface org.apache.velocity.tools.view.ViewContext
  Key used for the HTTP session object.
session - Variable in class org.apache.velocity.tools.view.ViewContextTool
setAcceptLanguage(String) - Method in class org.apache.velocity.tools.view.BrowserTool
SetAttributeExecutor(Logger, Introspector, Class, Object, String) - Constructor for class org.apache.velocity.tools.view.WebappUberspector.SetAttributeExecutor
setBrowser(String, String, String) - Method in class org.apache.velocity.tools.view.UAParser.UserAgent
setContentType(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
  Sets the content type of the response.
setContentType(String) - Method in class org.apache.velocity.tools.view.ViewImportSupport.ImportResponseWrapper
  Has no effect.
setCreateSession(boolean) - Method in class org.apache.velocity.tools.view.PagerTool
setCreateSession(boolean) - Method in class org.apache.velocity.tools.view.ViewToolManager
  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.
setCriteria(Object) - Method in class org.apache.velocity.tools.view.AbstractSearchTool
  Sets the criteria for this search.
setCriteriaKey(String) - Method in class org.apache.velocity.tools.view.AbstractSearchTool
setDefaultContentType(String) - Method in class org.apache.velocity.tools.view.VelocityView
  Sets the configured default Content-Type.
setDeviceType(UAParser.DeviceType) - Method in class org.apache.velocity.tools.view.UAParser.UserAgent
setEncoding(JeeConfig) - Method in class org.apache.velocity.tools.view.VelocityView
setFormat(String, String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
  Sets the format string for the specified file type.
setFromRequest(HttpServletRequest) - Method in class org.apache.velocity.tools.view.LinkTool
setIncludeRequestParams(boolean) - Method in class org.apache.velocity.tools.view.LinkTool
  Controls whether or not this tool starts off with all parameters from the last request automatically.
setIndex(int) - Method in class org.apache.velocity.tools.view.PagerTool
  Sets the index of the first result in the current page
setIndexKey(String) - Method in class org.apache.velocity.tools.view.PagerTool
setItems(List) - Method in class org.apache.velocity.tools.view.PagerTool
  Sets the List to page through.
setItemsPerPage(int) - Method in class org.apache.velocity.tools.view.PagerTool
  Sets the number of items returned in a page of items
setItemsPerPageKey(String) - Method in class org.apache.velocity.tools.view.PagerTool
setLanguagesFilter(String) - Method in class org.apache.velocity.tools.view.BrowserTool
setLocale(Locale) - Method in class org.apache.velocity.tools.view.ViewImportSupport.ImportResponseWrapper
  Has no effect.
setName(String) - Method in class org.apache.velocity.tools.view.BreadcrumbTool.NavigationElement
  Displayed name setter
setNewItemsKey(String) - Method in class org.apache.velocity.tools.view.PagerTool
setOperatingSystem(String, String, String) - Method in class org.apache.velocity.tools.view.UAParser.UserAgent
setPublishToolboxes(boolean) - Method in class org.apache.velocity.tools.view.ViewToolManager
  Sets whether or not the creation of a new `ViewToolContext` should make the various scoped `Toolbox` instances available publically via the HttpServletRequest/HttpSession/ServletContext attributes or simply add the Toolbox instances directly to the context.
setRenderingEngine(String, String, String) - Method in class org.apache.velocity.tools.view.UAParser.UserAgent
setRequest(HttpServletRequest) - Method in class org.apache.velocity.tools.view.BreadcrumbTool
  Current request setter
setRequest(HttpServletRequest) - Method in class org.apache.velocity.tools.view.BrowserTool
  Retrieves the User-Agent header from the request (if any).
setRequest(HttpServletRequest) - Method in class org.apache.velocity.tools.view.CookieTool
  Sets the current `HttpServletRequest`.
setRequest(HttpServletRequest) - Method in class org.apache.velocity.tools.view.PagerTool
  Initializes this tool with the specified `HttpServletRequest`.
setRequest(ServletRequest) - Method in class org.apache.velocity.tools.view.ParameterTool
  Sets the current `ServletRequest`
setRequest(HttpServletRequest) - Method in class org.apache.velocity.tools.view.ViewImportSupport
  Sets the current `HttpServletRequest`.
setResponse(HttpServletResponse) - Method in class org.apache.velocity.tools.view.CookieTool
  Sets the current `HttpServletResponse`.
setResponse(HttpServletResponse) - Method in class org.apache.velocity.tools.view.ViewImportSupport
  Sets the current `HttpServletResponse`.
setServletContext(ServletContext) - Method in class org.apache.velocity.tools.view.ViewImportSupport
  Sets the `ServletContext`.
setSlipSize(int) - Method in class org.apache.velocity.tools.view.PagerTool
  Sets the number of result page indices for `PagerTool.getSlip()` to list.
setSlipSizeKey(String) - Method in class org.apache.velocity.tools.view.PagerTool
setSource(Map) - Method in class org.apache.velocity.tools.view.ParameterTool
  Overrides ValueParser.setSource(Map source) to throw an UnsupportedOperationException, because this class uses a servlet request as its source, not a Map.
setStatus(int) - Method in class org.apache.velocity.tools.view.ViewImportSupport.ImportResponseWrapper
  Sets the status of the response
setStoredItems(List) - Method in class org.apache.velocity.tools.view.AbstractSearchTool
setStoredItems(List) - Method in class org.apache.velocity.tools.view.PagerTool
  Stores current search items in the user's session attributes (if one currently exists) in order to do efficient result pagination.
setStoredResults(AbstractSearchTool.StoredResults) - Method in class org.apache.velocity.tools.view.AbstractSearchTool
  Stores current search results in the user's session attributes (if one currently exists) in order to do efficient result pagination.
setToolboxKey(String) - Method in class org.apache.velocity.tools.view.ViewToolContext
setToolboxKey(String) - Method in class org.apache.velocity.tools.view.ViewToolManager
  Sets a new attribute key to be used for publishing each `Toolbox`.
setup(HttpServletRequest) - Method in class org.apache.velocity.tools.view.AbstractSearchTool
  Sets the criteria *if* it is set in the request parameters.
setup(HttpServletRequest) - Method in class org.apache.velocity.tools.view.PagerTool
  Sets the index, itemsPerPage, and/or slipSize *if* they are set in the request parameters.
setUrl(String) - Method in class org.apache.velocity.tools.view.BreadcrumbTool.NavigationElement
  Destination URL setter
setUserAgentString(String) - Method in class org.apache.velocity.tools.view.BrowserTool
  Sets the User-Agent string to be parsed for info.
setVelocityEngine(VelocityEngine) - Method in class org.apache.velocity.tools.view.VelocityView
  Overrides super class to ensure engine is not set to null.
setVelocityView(VelocityView) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
SHARED_CONFIG_PARAM - Static variable in class org.apache.velocity.tools.view.ServletUtils
skip(long) - Method in class org.apache.velocity.tools.view.ViewImportSupport.SafeClosingHttpURLConnectionReader
SOURCE_FILE_KEY - Static variable in class org.apache.velocity.tools.view.UiDependencyTool
STORED_ITEMS_KEY - Static variable in class org.apache.velocity.tools.view.PagerTool
  the key under which items are stored in session
STORED_RESULTS_KEY - Static variable in class org.apache.velocity.tools.view.AbstractSearchTool
  the key under which StoredResults are kept in session
StoredResults(Object, List) - Constructor for class org.apache.velocity.tools.view.AbstractSearchTool.StoredResults
  Creates a new instance.
stripSession(String) - Static method in class org.apache.velocity.tools.view.ViewImportSupport
  Strips a servlet session ID from `url`.
SugarCookie(Cookie) - Constructor for class org.apache.velocity.tools.view.CookieTool.SugarCookie
SugarCookie(String, String) - Constructor for class org.apache.velocity.tools.view.CookieTool.SugarCookie

## T

templatePaths - Variable in class org.apache.velocity.tools.view.WebappResourceLoader
test(String) - Method in class org.apache.velocity.tools.view.BrowserTool
test(String) - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
  Deprecated.
TOOLS_KEY - Static variable in class org.apache.velocity.tools.view.VelocityView
  Key used to access the toolbox configuration file path from the Servlet or webapp init parameters ("org.apache.velocity.tools") or to access a live `FactoryConfiguration` previously placed in the ServletContext attributes.
toString() - Method in class org.apache.velocity.tools.view.BreadcrumbTool
  Default concatenation of navigation elements, separated by '>'
toString() - Method in class org.apache.velocity.tools.view.BrowserTool
toString() - Method in class org.apache.velocity.tools.view.CookieTool.SugarCookie
toString() - Method in class org.apache.velocity.tools.view.CookieTool
toString() - Method in class org.apache.velocity.tools.view.LinkTool
  Overrides to use response.encodeURL to get session id into URL if sessions are used but cookies are not supported.
toString() - Method in class org.apache.velocity.tools.view.UiDependencyTool
  Returns an empty String to avoid polluting the template output after a successful call to `UiDependencyTool.on(String)` or `UiDependencyTool.on(String,String)`.
TypeRule() - Constructor for class org.apache.velocity.tools.view.UiDependencyTool.TypeRule
TYPES_KEY_SPACE - Static variable in class org.apache.velocity.tools.view.UiDependencyTool

## U

UAEntity(String, String, String) - Constructor for class org.apache.velocity.tools.view.UAParser.UAEntity
UAEntity(String, String, String, boolean) - Constructor for class org.apache.velocity.tools.view.UAParser.UAEntity
UAParser - Class in org.apache.velocity.tools.view
UAParser() - Constructor for class org.apache.velocity.tools.view.UAParser
UAParser.DeviceType - Enum in org.apache.velocity.tools.view
UAParser.UAEntity - Class in org.apache.velocity.tools.view
UAParser.UserAgent - Class in org.apache.velocity.tools.view
UiDependencyTool - Class in org.apache.velocity.tools.view
  NOTE: This tool is considered "beta" quality due to lack of public testing and is not automatically provided via the default tools.xml file.
UiDependencyTool() - Constructor for class org.apache.velocity.tools.view.UiDependencyTool
UiDependencyTool.FileRule - Class in org.apache.velocity.tools.view
  NOTE: This class may change or disappear w/o warning; don't depend on it unless you're willing to update your code whenever this changes.
UiDependencyTool.Group - Class in org.apache.velocity.tools.view
  NOTE: This class may change or disappear w/o warning; don't depend on it unless you're willing to update your code whenever this changes.
UiDependencyTool.GroupRule - Class in org.apache.velocity.tools.view
  NOTE: This class may change or disappear w/o warning; don't depend on it unless you're willing to update your code whenever this changes.
UiDependencyTool.NeedsRule - Class in org.apache.velocity.tools.view
  NOTE: This class may change or disappear w/o warning; don't depend on it unless you're willing to update your code whenever this changes.
UiDependencyTool.TypeRule - Class in org.apache.velocity.tools.view
  NOTE: This class may change or disappear w/o warning; don't depend on it unless you're willing to update your code whenever this changes.
unpublishApplicationTools() - Method in class org.apache.velocity.tools.view.ViewToolManager
  Removes any published `Scope.APPLICATION` Toolbox.
updateGlobalProperties() - Method in class org.apache.velocity.tools.view.ViewToolManager
  Checks the internal `ToolboxFactory` for any changes to the createSession or publishToolboxes settings.
USER_OVERWRITE_KEY - Static variable in class org.apache.velocity.tools.view.VelocityView
  Controls whether or not templates can overwrite tool and servlet API variables in the local context.
USER_PROPERTIES_PATH - Static variable in class org.apache.velocity.tools.view.VelocityView
  Default velocity properties file path.
USER_TOOLS_PATH - Static variable in class org.apache.velocity.tools.view.VelocityView
  Default toolbox configuration file path.
UserAgent() - Constructor for class org.apache.velocity.tools.view.UAParser.UserAgent

## V

value(Object) - Method in class org.apache.velocity.tools.view.CookieTool.SugarCookie
valueOf(String) - Static method in enum org.apache.velocity.tools.view.UAParser.DeviceType
  Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.velocity.tools.view.UAParser.DeviceType
  Returns an array containing the constants of this enum type, in the order they are declared.
VELOCITY_VIEW_KEY - Static variable in class org.apache.velocity.tools.view.ServletUtils
VelocityLayoutServlet - Class in org.apache.velocity.tools.view
  Extension of the VelocityViewServlet to perform "two-pass" layout rendering and allow for a customized error screen.
VelocityLayoutServlet() - Constructor for class org.apache.velocity.tools.view.VelocityLayoutServlet
VelocityView - Class in org.apache.velocity.tools.view
  The class provides the following features:
VelocityView(ServletConfig) - Constructor for class org.apache.velocity.tools.view.VelocityView
VelocityView(FilterConfig) - Constructor for class org.apache.velocity.tools.view.VelocityView
VelocityView(ServletContext) - Constructor for class org.apache.velocity.tools.view.VelocityView
VelocityView(JeeConfig) - Constructor for class org.apache.velocity.tools.view.VelocityView
VelocityViewFilter - Class in org.apache.velocity.tools.view
  A filter to ensure VelocityTools `Toolbox`es are available in the request/session/application scopes.
VelocityViewFilter() - Constructor for class org.apache.velocity.tools.view.VelocityViewFilter
VelocityViewServlet - Class in org.apache.velocity.tools.view
  A servlet to process Velocity templates.
VelocityViewServlet() - Constructor for class org.apache.velocity.tools.view.VelocityViewServlet
version(Object) - Method in class org.apache.velocity.tools.view.CookieTool.SugarCookie
ViewContext - Interface in org.apache.velocity.tools.view
  This interface provides view tools in a servlet environment access to relevant context information, like servlet request, servlet context and the velocity context.
ViewContextTool - Class in org.apache.velocity.tools.view
  Extension of `ContextTool` that includes keys and values from the `HttpServletRequest`, `HttpSession` and `ServletContext`.
ViewContextTool() - Constructor for class org.apache.velocity.tools.view.ViewContextTool
ViewImportSupport - Class in org.apache.velocity.tools.view
  Provides methods to import arbitrary local or remote resources as strings.
ViewImportSupport() - Constructor for class org.apache.velocity.tools.view.ViewImportSupport
ViewImportSupport.ImportResponseWrapper - Class in org.apache.velocity.tools.view
  Wraps responses to allow us to retrieve results as Strings.
ViewImportSupport.SafeClosingHttpURLConnectionReader - Class in org.apache.velocity.tools.view
ViewToolContext - Class in org.apache.velocity.tools.view
  `ToolContext` implementation specific to the servlet environment.
ViewToolContext(VelocityEngine, HttpServletRequest, HttpServletResponse, ServletContext) - Constructor for class org.apache.velocity.tools.view.ViewToolContext
ViewToolManager - Class in org.apache.velocity.tools.view
  Manages tools for web applications.
ViewToolManager(ServletContext) - Constructor for class org.apache.velocity.tools.view.ViewToolManager
  Constructs an instance already configured to use any configuration specified via a "org.apache.velocity.tools" system property.
ViewToolManager(ServletContext, boolean) - Constructor for class org.apache.velocity.tools.view.ViewToolManager
ViewToolManager(ServletContext, boolean, boolean) - Constructor for class org.apache.velocity.tools.view.ViewToolManager

## W

WebappResourceLoader - Class in org.apache.velocity.tools.view
  Resource loader that uses the ServletContext of a webapp to load Velocity templates.
WebappResourceLoader() - Constructor for class org.apache.velocity.tools.view.WebappResourceLoader
WebappUberspector - Class in org.apache.velocity.tools.view
  This custom uberspector allows getAttribute() and setAttribute() as standard getters and setters for the "request","session" and "application" keys.
WebappUberspector() - Constructor for class org.apache.velocity.tools.view.WebappUberspector
WebappUberspector.GetAttributeExecutor - Class in org.apache.velocity.tools.view
  Executor for getAttribute(name) method.
WebappUberspector.SetAttributeExecutor - Class in org.apache.velocity.tools.view
  Executor for setAttribute(name,value) method

## X

XmlTool - Class in org.apache.velocity.tools.view
  View version of `XmlTool`.
XmlTool() - Constructor for class org.apache.velocity.tools.view.XmlTool

A B C D E F G H I J K L M N O P R S T U V W X