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

A

abbr(boolean) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Sets whether or not this comparison is to be rendered in abbreviated form or not.
ABBR_SUFFIX - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
abbreviate - Variable in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
 
abs(Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
absolute(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Convenience method equivalent to LinkTool.setAbsolute(java.lang.String).
AbstractPagerTool - Class in org.apache.velocity.tools.view.tools
Abstract view tool for doing request-based pagination of items in an a list.
AbstractPagerTool() - Constructor for class org.apache.velocity.tools.view.tools.AbstractPagerTool
 
AbstractSearchTool - Class in org.apache.velocity.tools.view.tools
Abstract view tool for doing "searching" and robust pagination of search results.
AbstractSearchTool() - Constructor for class org.apache.velocity.tools.view.tools.AbstractSearchTool
 
AbstractSearchTool.StoredResults - Class in org.apache.velocity.tools.view.tools
Simple utility class to hold a criterion and its result list.
AbstractSearchTool.StoredResults(Object, List) - Constructor for class org.apache.velocity.tools.view.tools.AbstractSearchTool.StoredResults
Creates a new instance.
acquireReader(String) - Method in class org.apache.velocity.tools.view.ImportSupport
 
acquireString(String) - Method in class org.apache.velocity.tools.view.ImportSupport
 
actionComparator - Static variable in class org.apache.velocity.tools.struts.ValidatorTool
A Comparator to use when sorting ValidatorAction objects.
ActionMessagesTool - Class in org.apache.velocity.tools.struts
View tool to work with the Struts action messages.
ActionMessagesTool() - Constructor for class org.apache.velocity.tools.struts.ActionMessagesTool
Default constructor.
actionMsgs - Variable in class org.apache.velocity.tools.struts.ActionMessagesTool
A reference to the queued action messages.
add(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
add(String, String) - Method in class org.apache.velocity.tools.view.tools.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.tools.CookieTool
Convenience method to add a new Cookie to the response and set an expiry time for it.
addAllParameters() - Method in class org.apache.velocity.tools.view.tools.LinkTool
Adds all of the current request's parameters to this link's "query data".
addData(ToolInfo) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Overrides XMLToolboxManager to put data into appTools map
addData(ToolInfo) - Method in interface org.apache.velocity.tools.view.ToolboxManager
Adds a data object for the context.
addData(ToolInfo) - Method in class org.apache.velocity.tools.view.XMLToolboxManager
 
addDataRules(Digester) - Method in class org.apache.velocity.tools.view.ToolboxRuleSet
Add rules for digesting data elements.
addIgnore(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Instructs this LinkTool to ignore the specified parameter when copying the current request's parameters.
addQueryData(String, Object) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Adds a key=value pair to the query data.
addQueryData(Map) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Adds multiple key=value pairs to the query data.
addRuleInstances(Digester) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet
Overrides ToolboxRuleSet to add create-session rule.
addRuleInstances(Digester) - Method in class org.apache.velocity.tools.view.ToolboxRuleSet
Add the set of Rule instances defined in this RuleSet to the specified Digester instance, associating them with our namespace URI (if any).
addTool(ToolInfo) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Overrides XMLToolboxManager to separate tools by scope.
addTool(ToolInfo) - Method in interface org.apache.velocity.tools.view.ToolboxManager
Adds a tool to be managed
addTool(ToolInfo) - Method in class org.apache.velocity.tools.view.XMLToolboxManager
 
addToolRules(Digester) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet
Overrides ToolboxRuleSet to add rule for scope element.
addToolRules(Digester) - Method in class org.apache.velocity.tools.view.ToolboxRuleSet
Add rules for digesting tool elements.
AFTER_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
allowsRequestPath(String) - Method in class org.apache.velocity.tools.view.servlet.ServletToolInfo
 
Alternator - Class in org.apache.velocity.tools.generic
Utility class for easily alternating over values in a list.
Alternator(List) - Constructor for class org.apache.velocity.tools.generic.Alternator
Creates a new Alternator for the specified list.
Alternator(Object[]) - Constructor for class org.apache.velocity.tools.generic.Alternator
Creates a new Alternator for the specified list.
Alternator(boolean, List) - Constructor for class org.apache.velocity.tools.generic.Alternator
Creates a new Alternator for the specified list with the specified automatic shifting preference.
Alternator(boolean, Object[]) - Constructor for class org.apache.velocity.tools.generic.Alternator
Creates a new Alternator for the specified list with the specified automatic shifting preference.
AlternatorTool - Class in org.apache.velocity.tools.generic
Simple tool to provide easy in-template instantiation of Alternators from varying "list" types.
AlternatorTool() - Constructor for class org.apache.velocity.tools.generic.AlternatorTool
 
anchor - Variable in class org.apache.velocity.tools.view.tools.LinkTool
The anchor set for this link.
anchor(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Convenience method equivalent to LinkTool.setAnchor(java.lang.String).
app - Variable in class org.apache.velocity.tools.struts.ValidatorTool
A reference to the ServletContext
appendAsArray(StringBuffer, String, Object[]) - Method in class org.apache.velocity.tools.view.tools.LinkTool.QueryPair
 
application - Variable in class org.apache.velocity.tools.struts.MessageResourcesTool
 
application - Variable in class org.apache.velocity.tools.view.context.ChainedContext
 
APPLICATION - Static variable in interface org.apache.velocity.tools.view.context.ViewContext
Key used for the servlet context object.
application - Variable in class org.apache.velocity.tools.view.ImportSupport
 
application - Variable in class org.apache.velocity.tools.view.tools.ContextTool
 
application - Variable in class org.apache.velocity.tools.view.tools.LinkTool
A reference to the ServletContext
APPLICATION_SCOPE - Static variable in class org.apache.velocity.tools.struts.TilesTool
 
appTools - Variable in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
 
args - Variable in class org.apache.velocity.tools.generic.ResourceTool.Key
 
args - Variable in class org.apache.velocity.tools.struts.MessageTool.TextKey
 
arrayContains(Object, Object) - Method in class org.apache.velocity.tools.generic.ListTool
Checks if an array contains a certain element.
auto - Variable in class org.apache.velocity.tools.generic.Alternator
 
auto(List) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Make an automatic Alternator from values in the specified List.
auto(Object[]) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Make an automatic Alternator from the specified object array.
auto(Object, Object) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Make an automatic Alternator from a list containing the two specified objects.
AUTO_ALTERNATE_DEFAULT_KEY - Static variable in class org.apache.velocity.tools.generic.AlternatorTool
 
AUTO_IGNORE_PARAMETERS_KEY - Static variable in class org.apache.velocity.tools.view.tools.LinkTool
Parameter key for configuring LinkTool.setAutoIgnoreParameters(boolean) state.
autoAlternateDefault - Variable in class org.apache.velocity.tools.generic.AlternatorTool
 
autoIgnore - Variable in class org.apache.velocity.tools.view.tools.LinkTool
true if parameters explicitly set on this LinkTool should be added to the ignore list.

B

BEFORE_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
begin(String, String, Attributes) - Method in class org.apache.velocity.tools.view.ToolboxRuleSet.ParameterRule
 
body(String, String, String) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet.BooleanConfigRule
 
bos - Variable in class org.apache.velocity.tools.view.ImportSupport.ImportResponseWrapper
A buffer, alternatively, to accumulate bytes.
BrowserSnifferTool - Class in org.apache.velocity.tools.view.tools
browser-sniffing tool (session or request scope requested, session scope advised).
BrowserSnifferTool() - Constructor for class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
bundle(String) - Method in class org.apache.velocity.tools.generic.ResourceTool
 
bundle(String) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
 
bundle - Variable in class org.apache.velocity.tools.struts.MessageTool.TextKey
 
bundle(String) - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
Returns a new TextKey with the specified resource bundle set.
BUNDLE_NAME_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
The key used for specifying a default locale via toolbox params.
bundleName - Variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
bundles - Variable in class org.apache.velocity.tools.generic.ResourceTool
 
bundles - Variable in class org.apache.velocity.tools.generic.ResourceTool.Key
 
BUNDLES_KEY - Static variable in class org.apache.velocity.tools.generic.ResourceTool
 

C

cached - Variable in class org.apache.velocity.tools.generic.ResourceTool.Key
 
cachedNext - Variable in class org.apache.velocity.tools.generic.IteratorTool
 
catchExceptions - Variable in class org.apache.velocity.tools.generic.RenderTool
 
cdata - Variable in class org.apache.velocity.tools.struts.ValidatorTool
 
ceil(Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
ChainedContext - Class in org.apache.velocity.tools.view.context
Velocity context implementation specific to the Servlet environment.
ChainedContext(VelocityEngine, HttpServletRequest, HttpServletResponse, ServletContext) - Constructor for class org.apache.velocity.tools.view.context.ChainedContext
 
ChainedContext(Context, VelocityEngine, HttpServletRequest, HttpServletResponse, ServletContext) - Constructor for class org.apache.velocity.tools.view.context.ChainedContext
 
clazz - Variable in class org.apache.velocity.tools.view.ViewToolInfo
 
clearArgs() - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
This will return a new TextKey that has no arguments to be inserted into the text output.
close() - Method in class org.apache.velocity.tools.view.ImportSupport.SafeClosingHttpURLConnectionReader
 
CommonsLogLogSystem - Class in org.apache.velocity.tools.generic.log
Redirects Velocity's LogSystem messages to commons-logging.
CommonsLogLogSystem() - Constructor for class org.apache.velocity.tools.generic.log.CommonsLogLogSystem
 
compare(Object, Object, int) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool
 
compare(Object, Object) - Method in class org.apache.velocity.tools.generic.SortTool.PropertiesComparator
 
ComparisonDateTool - Class in org.apache.velocity.tools.generic
Tool for comparing Date and Calendar values in Velocity templates.
ComparisonDateTool() - Constructor for class org.apache.velocity.tools.generic.ComparisonDateTool
 
ComparisonDateTool.Comparison - Class in org.apache.velocity.tools.generic
 
ComparisonDateTool.Comparison(long, int, int, boolean, Locale) - Constructor for class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
 
computeURL(HttpServletRequest, ServletContext, String) - Method in class org.apache.velocity.tools.struts.SecureLinkTool
Compute a hyperlink URL based on the specified action link.
configLocked - Variable in class org.apache.velocity.tools.generic.DateTool
 
configLocked - Variable in class org.apache.velocity.tools.generic.NumberTool
 
Configurable - Interface in org.apache.velocity.tools.view.tools
Deprecated. Your tools now only need to have a configure(Map) method.
configure(Map) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Looks for a default auto-alternate value in the given params, if not, set the default to true.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool
Calls the superclass implementation, then looks for a bundle name and any time units to be skipped.
configure(Map) - Method in class org.apache.velocity.tools.generic.DateTool
Looks for configuration values in the given params.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.DateTool
Does the actual configuration.
configure(Map) - Method in class org.apache.velocity.tools.generic.NumberTool
Looks for configuration values in the given params.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.NumberTool
Does the actual configuration.
configure(Map) - Method in class org.apache.velocity.tools.generic.RenderTool
Looks for parse depth and catch.exceptions parameters.
configure(Map) - Method in class org.apache.velocity.tools.generic.ResourceTool
 
configure(Map) - Method in interface org.apache.velocity.tools.view.tools.Configurable
Deprecated. Configures this tool using the specified parameters.
configure(Map) - Method in class org.apache.velocity.tools.view.tools.ContextTool
Looks for a safe-mode configuration setting.
configure(Map) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Configures this tool
configure - Variable in class org.apache.velocity.tools.view.ViewToolInfo
 
contains(Object, Object) - Method in class org.apache.velocity.tools.generic.ListTool
Checks if a List/array contains a certain element.
contains(Object) - Method in class org.apache.velocity.tools.view.tools.ContextTool
Returns true if the context contains a value for the specified reference name (aka context key).
CONTENT_TYPE - Static variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
The HTTP content type context key.
context - Variable in class org.apache.velocity.tools.struts.ValidatorTool
A reference to the ViewContext
context - Variable in class org.apache.velocity.tools.view.tools.ContextTool
 
context - Variable in class org.apache.velocity.tools.view.tools.ViewRenderTool
 
contextStack - Variable in class org.apache.velocity.tools.struts.TilesTool
A stack to hold ComponentContexts while nested tile-definitions are rendered.
ContextTool - Class in org.apache.velocity.tools.view.tools
View tool for convenient access to ViewContext data and meta-data.
ContextTool() - Constructor for class org.apache.velocity.tools.view.tools.ContextTool
 
CookieTool - Class in org.apache.velocity.tools.view.tools
View tool for convenient cookie access and creation.
CookieTool() - Constructor for class org.apache.velocity.tools.view.tools.CookieTool
 
copyWith(LinkTool.QueryPair) - Method in class org.apache.velocity.tools.view.tools.LinkTool
For internal use.
copyWith(Map) - Method in class org.apache.velocity.tools.view.tools.LinkTool
For internal use.
copyWith(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
For internal use.
copyWithAnchor(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
For internal use.
copyWithIgnore(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
For internal use.
create(String, String) - Method in class org.apache.velocity.tools.view.tools.CookieTool
Creates a new Cookie with the specified name and value.
create(String, String, Object) - Method in class org.apache.velocity.tools.view.tools.CookieTool
Convenience method to create a new Cookie and set an expiry time for it.
createActionList(ValidatorResources, Form) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Get List of actions for the given Form.
createContext(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
Overrides VelocityViewServlet to check the request for an alternate layout
createContext(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Creates and returns an initialized Velocity context.
createMethods(List) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Creates the JavaScript methods list from the given actions.
createSession - Variable in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
 
crit - Variable in class org.apache.velocity.tools.view.tools.AbstractSearchTool.StoredResults
 
criteria - Variable in class org.apache.velocity.tools.view.tools.AbstractSearchTool
 
currency(Object) - Method in class org.apache.velocity.tools.generic.NumberTool
Convenience method equivalent to $number.format("currency", $foo).
CURRENT_PREFIX - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
CURRENT_TYPE - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 

D

data - Variable in class org.apache.velocity.tools.view.DataInfo
 
data - Variable in class org.apache.velocity.tools.view.XMLToolboxManager
 
DataInfo - Class in org.apache.velocity.tools.view
ToolInfo implementation to handle "primitive" data types.
DataInfo() - Constructor for class org.apache.velocity.tools.view.DataInfo
 
DateTool - Class in org.apache.velocity.tools.generic
Tool for working with Date and Calendar in Velocity templates.
DateTool() - Constructor for class org.apache.velocity.tools.generic.DateTool
 
DAY_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
debug(Object) - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Passes messages to Velocity's LogSystem at "DEBUG" level.
debug(Object, Throwable) - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Passes messages to Velocity's LogSystem at "DEBUG" level.
DEFAULT_BUNDLE_NAME - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
The default path of the relative format resource bundles.
DEFAULT_CONTENT_TYPE - Static variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
The default content type for the response
DEFAULT_DEFAULT_LAYOUT - Static variable in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
The default filename for the servlet's default layout
DEFAULT_ENCODING - Static variable in class org.apache.velocity.tools.view.ImportSupport
Default character encoding for response.
DEFAULT_ERROR_TEMPLATE - Static variable in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
The default error template's filename.
DEFAULT_FORMAT - Static variable in class org.apache.velocity.tools.generic.DateTool
The default format to be used when none is specified.
DEFAULT_FORMAT - Static variable in class org.apache.velocity.tools.generic.NumberTool
The default format to be used when none is specified.
DEFAULT_FORMAT_KEY - Static variable in class org.apache.velocity.tools.generic.DateTool
The key used for specifying a default format via toolbox params.
DEFAULT_FORMAT_KEY - Static variable in class org.apache.velocity.tools.generic.NumberTool
The key used for specifying a default format via toolbox params.
DEFAULT_ITEMS_PER_PAGE - Static variable in class org.apache.velocity.tools.view.tools.AbstractPagerTool
the default number of items shown per page
DEFAULT_LANGUAGE_KEY - Static variable in class org.apache.velocity.tools.view.i18n.MultiViewsTool
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.servlet.VelocityLayoutServlet
The default layout directory
DEFAULT_LOCALE_KEY - Static variable in class org.apache.velocity.tools.generic.DateTool
The key used for specifying a default locale via toolbox params.
DEFAULT_LOCALE_KEY - Static variable in class org.apache.velocity.tools.generic.NumberTool
The key used for specifying a default locale via toolbox params.
DEFAULT_LOG_NAME - Static variable in class org.apache.velocity.tools.generic.log.CommonsLogLogSystem
Default name for the commons-logging instance
DEFAULT_OUTPUT_ENCODING - Static variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Default encoding for the output stream
DEFAULT_PARSE_DEPTH - Static variable in class org.apache.velocity.tools.generic.RenderTool
The maximum number of loops allowed when recursing.
DEFAULT_PROPERTIES_PATH - Static variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Default velocity properties file path.
DEFAULT_SLIP_SIZE - Static variable in class org.apache.velocity.tools.view.tools.AbstractPagerTool
the default max number of page indices to list
DEFAULT_TOOLBOX_PATH - Static variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Default toolbox configuration file path.
DEFAULT_TOOLS_PROPERTIES - Static variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Default Runtime properties.
defaultBundle - Variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
defaultContentType - Variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
The default content type.
defaultLanguage - Variable in class org.apache.velocity.tools.view.i18n.MultiViewsTool
The two character abbreviation for the request's default language.
defaultLayout - Variable in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
 
delimiter - Variable in class org.apache.velocity.tools.generic.ValueParser
 
depth(int) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Set the maximum number of units to render for this comparison.
depth - Variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
DEPTH_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
The key used for specifying a different default depth via toolbox params.
DIFF_TYPE - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
difference(Object, Object) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool
Returns a ComparisonDateTool.Comparison between the result of the second specified date and the first specified date.
div(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Handles GET - calls doRequest()
doInsert(String, String, Controller) - Method in class org.apache.velocity.tools.struts.TilesTool
Use this if there is no nested tile.
doInsert(Map, String, String, Controller) - Method in class org.apache.velocity.tools.struts.TilesTool
Use this if there is a nested tile.
doInsert(ComponentContext, String, String, Controller) - Method in class org.apache.velocity.tools.struts.TilesTool
An extension of the other two doInsert functions
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Handle a POST request - calls doRequest()
doRequest(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Handles with both GET and POST requests
dumpString(String, boolean) - Method in class org.apache.velocity.tools.generic.EscapeTool
This code was pulled from the Apache Harmony project.
duplicate() - Method in class org.apache.velocity.tools.view.tools.LinkTool
This is just to avoid duplicating this code for both copyWith() methods

E

encode - Static variable in class org.apache.velocity.tools.view.tools.LinkTool
Java 1.4 encode method to use instead of deprecated 1.3 version.
encodeURL(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Use the new URLEncoder.encode() method from java 1.4 if available, else use the old deprecated version.
engine - Variable in class org.apache.velocity.tools.generic.RenderTool
 
engine - Variable in class org.apache.velocity.tools.view.i18n.MultiViewsTool
 
EQUAL_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
equals(Object, Object) - Method in class org.apache.velocity.tools.generic.ListTool
Check if two objects are equal.
error(Object) - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Passes messages to Velocity's LogSystem at "ERROR" level.
error(Object, Throwable) - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Passes messages to Velocity's LogSystem at "ERROR" level.
error(HttpServletRequest, HttpServletResponse, Exception) - Method in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
Overrides VelocityViewServlet to display user's custom error template
error(HttpServletRequest, HttpServletResponse, Exception) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Invoked when there is an error thrown in any part of doRequest() processing.
errorMarkup(String, HttpServletRequest, HttpSession, ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns a formatted error message.
errorMarkup(String, String, HttpServletRequest, HttpSession, ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns a formatted error message.
ErrorsTool - Class in org.apache.velocity.tools.struts
View tool to work with the Struts error messages.
ErrorsTool() - Constructor for class org.apache.velocity.tools.struts.ErrorsTool
 
errorTemplate - Variable in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
 
escapeJavascript(String) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Backslash-escapes the following characters from the input string: ", ', \, \r, \n.
EscapeTool - Class in org.apache.velocity.tools.generic
Tool for working with escaping in Velocity templates.
EscapeTool() - Constructor for class org.apache.velocity.tools.generic.EscapeTool
Default constructor.
eval(Context, String) - Method in class org.apache.velocity.tools.generic.RenderTool
Evaluates a String containing VTL using the current context, and returns the result as a String.
eval(String) - Method in class org.apache.velocity.tools.view.tools.ViewRenderTool
Evaluates a String containing VTL using the current context, and returns the result as a String.
exactPath - Variable in class org.apache.velocity.tools.view.servlet.ServletToolInfo
 
executeQuery(Object) - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Executes a query for the specified criteria.
exist() - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns true if there are action messages queued, otherwise false.
exist(String) - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns true if there are action messages queued for the specified category of messages, otherwise false.
exists(String) - Method in class org.apache.velocity.tools.generic.ValueParser
Convenience method for checking whether a certain parameter exists.
exists(String) - Method in class org.apache.velocity.tools.struts.MessageTool
Checks if a message string for a specified message key exists for the user's locale.
exists(String, String) - Method in class org.apache.velocity.tools.struts.MessageTool
Checks if a message string for a specified message key exists for the user's locale.
exists() - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
Checks for the existence of the key that we've built up.

F

fatal(Object) - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Passes messages to Velocity's LogSystem at "ERROR" level.
fatal(Object, Throwable) - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Passes messages to Velocity's LogSystem at "ERROR" level.
fillContext(Context, HttpServletRequest) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
This is an extension hook for users who subclass this servlet to make their own modifications to the Context.
findInitParameter(ServletConfig, String) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Looks up an init parameter with the specified key in either the ServletConfig or, failing that, in the ServletContext.
findLocalizedResource(String, Locale) - Method in class org.apache.velocity.tools.view.i18n.MultiViewsTool
Calls MultiViewsTool.findLocalizedResource(String, String) using the language extracted from locale.
findLocalizedResource(String) - Method in class org.apache.velocity.tools.view.i18n.MultiViewsTool
Calls MultiViewsTool.findLocalizedResource(String, String) using the default language.
findLocalizedResource(String, String) - Method in class org.apache.velocity.tools.view.i18n.MultiViewsTool
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.
floor(Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
format - Variable in class org.apache.velocity.tools.generic.DateTool
 
format(Object) - Method in class org.apache.velocity.tools.generic.DateTool
Converts the specified object to a date and formats it according to the pattern or style returned by DateTool.getFormat().
format(String, Object) - Method in class org.apache.velocity.tools.generic.DateTool
Converts the specified object to a date and returns a formatted string representing that date in the locale returned by DateTool.getLocale().
format(String, Object, Locale) - Method in class org.apache.velocity.tools.generic.DateTool
Converts the specified object to a date and returns a formatted string representing that date in the specified Locale.
format(String, Object, Locale, TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool
Returns a formatted string representing the specified date, Locale, and TimeZone.
format(String, String, Object) - Method in class org.apache.velocity.tools.generic.DateTool
Returns the specified date as a string formatted according to the specified date and/or time styles.
format(String, String, Object, Locale) - Method in class org.apache.velocity.tools.generic.DateTool
Returns the specified date as a string formatted according to the specified Locale and date and/or time styles.
format(String, String, Object, Locale, TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool
Returns the specified date as a string formatted according to the specified Locale and date and/or time styles.
format - Variable in class org.apache.velocity.tools.generic.NumberTool
 
format(Object) - Method in class org.apache.velocity.tools.generic.NumberTool
Converts the specified object to a number and formats it according to the pattern or style returned by NumberTool.getFormat().
format(String, Object) - Method in class org.apache.velocity.tools.generic.NumberTool
Converts the specified object to a number and returns a formatted string representing that number in the locale returned by NumberTool.getLocale().
format(String, Object, Locale) - Method in class org.apache.velocity.tools.generic.NumberTool
Converts the specified object to a number and returns a formatted string representing that number in the specified Locale.
formName - Variable in class org.apache.velocity.tools.struts.ValidatorTool
 
FormTool - Class in org.apache.velocity.tools.struts
View tool to work with HTML forms in Struts.
FormTool() - Constructor for class org.apache.velocity.tools.struts.FormTool
Default constructor.

G

geckoMajorVersion - Variable in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
geckoMinorVersion - Variable in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
geckoVersion - Variable in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
get(String) - Method in class org.apache.velocity.tools.generic.DateTool
Returns a formatted string representing the date returned by DateTool.getDate().
get(String, String) - Method in class org.apache.velocity.tools.generic.DateTool
Returns a formatted string representing the date and/or time given by DateTool.getDate() in standard, localized patterns.
get(Object, int) - Method in class org.apache.velocity.tools.generic.ListTool
Gets the specified element of a List/array.
get(String) - Method in class org.apache.velocity.tools.generic.ResourceTool
 
get(String, String, Locale) - Method in class org.apache.velocity.tools.generic.ResourceTool
Returns the value for the specified key in the ResourceBundle for the specified basename and locale.
get(String, String[], Locale) - Method in class org.apache.velocity.tools.generic.ResourceTool
Retrieve a resource for the specified key from the first of the specified bundles in which a matching resource is found.
get(String) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
 
get(String) - Method in class org.apache.velocity.tools.generic.ValueParser
Convenience method for use in Velocity templates.
get(String) - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns the set of localized action messages as an java.util.List of strings for all actionMsgs queued of the specified category or null if no messages are queued for the specified category.
get(String, String) - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns the set of localized action messages as a java.util.List of strings for all action messages queued of the specified category or null if no action messages are queued for the specified category.
get(String) - Method in class org.apache.velocity.tools.struts.MessageTool
Looks up and returns the localized message for the specified key.
get(String, String) - Method in class org.apache.velocity.tools.struts.MessageTool
Looks up and returns the localized message for the specified key.
get(String, Object[]) - Method in class org.apache.velocity.tools.struts.MessageTool
Looks up and returns the localized message for the specified key.
get(String, String, Object[]) - Method in class org.apache.velocity.tools.struts.MessageTool
Looks up and returns the localized message for the specified key.
get(String, String, Object[], Locale) - Method in class org.apache.velocity.tools.struts.MessageTool
Looks up and returns the localized message for the specified key.
get(String, List) - Method in class org.apache.velocity.tools.struts.MessageTool
Same as MessageTool.get(String key, Object[] args), but takes a java.util.List instead of an array.
get(String, String, List) - Method in class org.apache.velocity.tools.struts.MessageTool
Same as MessageTool.get(String key, Object[] args), but takes a java.util.List instead of an array.
get(String, String, List, Locale) - Method in class org.apache.velocity.tools.struts.MessageTool
Looks up and returns the localized message for the specified key.
get(String) - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
Appends a period and the new key to the current key and returns a new TextKey instance with the combined result as its key.
get - Variable in class org.apache.velocity.tools.struts.StrutsLinkTool
 
get(String) - Method in class org.apache.velocity.tools.struts.StrutsLinkTool
This exists to enable a simplified syntax for using this tool in a template.
get(Object) - Method in class org.apache.velocity.tools.struts.TilesTool
A generic tiles insert function.
get(String) - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
get(Object) - Method in class org.apache.velocity.tools.view.tools.ContextTool
Retrieves the value for the specified reference name (aka context key).
get(String) - Method in class org.apache.velocity.tools.view.tools.CookieTool
Returns the Cookie with the specified name, if it exists.
getAbbr() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
This is equivalent to calling ComparisonDateTool.Comparison.abbr(boolean abbr) with true as the argument, thus setting this comparison to be rendered in abbreviated form.
getActionConfig(HttpServletRequest, ServletContext, String) - Static method in class org.apache.velocity.tools.struts.SecureLinkTool
Finds the configuration definition for the specified action link
getActionForm(HttpServletRequest, HttpSession) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the ActionForm bean associated with this request of null if none exists.
getActionFormName(HttpServletRequest, HttpSession) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the ActionForm name associated with this request of null if none exists.
getActionMappingName(String) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Return the form action converted into an action mapping path.
getActionMappingURL(ServletContext, HttpServletRequest, String) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the form action converted into a server-relative URI reference.
getAix() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getAix1() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getAix2() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getAix3() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getAix4() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getAll() - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns the set of localized action messages as an java.util.List of strings for all actionMsgs queued or null if no messages are queued.
getAll(String) - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns a List of all queued action messages using the specified message resource bundle.
getAll() - Method in class org.apache.velocity.tools.view.tools.CookieTool
Expose array of Cookies for this request to the template.
getAll() - Method in class org.apache.velocity.tools.view.tools.ParameterParser
Returns the map of all parameters available for the current request.
getAltavista() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getAmaya() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getAmiga() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getAnchor() - Method in class org.apache.velocity.tools.view.tools.LinkTool
Returns the anchor (internal document reference) set for this link.
getAol() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getAol3() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getAol4() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getAol5() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getAol6() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getAolTV() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getApplicationClass(String) - Method in class org.apache.velocity.tools.view.ViewToolInfo
Return the Class object for the specified fully qualified class name, from this web application's class loader.
getAttribute(String) - Method in class org.apache.velocity.tools.struts.TilesTool
Fetches a named attribute-value from the current tiles-context.
getAttribute(String) - Method in class org.apache.velocity.tools.view.context.ChainedContext
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 interface org.apache.velocity.tools.view.context.ViewContext
Searches for the named attribute in request, session (if valid), and application scope(s) in order and returns the value associated or null.
getAudrey() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getAutoAlternateDefault() - Method in class org.apache.velocity.tools.generic.AlternatorTool
Returns true if the default for auto-alternating is true.
getAvantgo() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getAverage(Collection, String) - Method in class org.apache.velocity.tools.generic.MathTool
Get the average of the values from a list
getAverage(Object[], String) - Method in class org.apache.velocity.tools.generic.MathTool
Get the sum of the values from a list
getAverage(Collection) - Method in class org.apache.velocity.tools.generic.MathTool
Get the average of the values
getAverage(Object[]) - Method in class org.apache.velocity.tools.generic.MathTool
Get the average of the values
getAverage(double[]) - Method in class org.apache.velocity.tools.generic.MathTool
Get the average of the values in an array of double values
getAverage(long[]) - Method in class org.apache.velocity.tools.generic.MathTool
Get the average of the values in an array of long values
getB() - Method in class org.apache.velocity.tools.generic.EscapeTool
Renders a backslash (\).
getBackslash() - Method in class org.apache.velocity.tools.generic.EscapeTool
Renders a backslash (\).
getBaseRef() - Method in class org.apache.velocity.tools.view.tools.LinkTool
Returns the full URI of this template without any query data.
getBean() - Method in class org.apache.velocity.tools.struts.FormTool
Returns the form bean associated with this action mapping.
getBlackberry() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getBoolean(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getBoolean(String, boolean) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getBoolean(String, Boolean) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getBooleans(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getBsd() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getCachedFile(String, String) - Method in class org.apache.velocity.tools.view.servlet.WebappLoader
 
getCalendar() - Method in class org.apache.velocity.tools.generic.DateTool
Returns a Calendar instance created using the timezone and locale returned by getTimeZone() and getLocale().
getCancelName() - Method in class org.apache.velocity.tools.struts.FormTool
Returns the query parameter name under which a cancel button press must be reported if form validation is to be skipped.
getCatchExceptions() - Method in class org.apache.velocity.tools.generic.RenderTool
Returns true if this render() and eval() methods will catch exceptions thrown during rendering.
getCdata() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Returns the cdata setting "true" or "false".
getClassname() - Method in class org.apache.velocity.tools.view.DataInfo
 
getClassname() - Method in interface org.apache.velocity.tools.view.ToolInfo
 
getClassname() - Method in class org.apache.velocity.tools.view.ViewToolInfo
 
getComparable(Object, String) - Static method in class org.apache.velocity.tools.generic.SortTool
Safely retrieves the comparable value for the specified property from the specified object.
getContentTypeAttribute(String, String) - Static method in class org.apache.velocity.tools.view.ImportSupport
Get the value associated with a content-type attribute.
getContextPath() - Method in class org.apache.velocity.tools.view.tools.LinkTool
Returns the context path that addresses this web application, e.g.
getContextURL() - Method in class org.apache.velocity.tools.view.tools.LinkTool
Returns the URI that addresses this web application.
getCriteria() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Return the criteria object for this request.
getCriteria() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool.StoredResults
 
getCss() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getCss1() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getCss2() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getCurl() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getCurrent() - Method in class org.apache.velocity.tools.generic.Alternator
Returns the current item without shifting the list index.
getCurrentContext() - Method in class org.apache.velocity.tools.struts.TilesTool
Retrieve the current tiles component context.
getD() - Method in class org.apache.velocity.tools.generic.EscapeTool
Renders a dollar sign ($).
getDataInfoClass() - Method in class org.apache.velocity.tools.view.ToolboxRuleSet
Return the bean class to be created for data elements.
getDate() - Method in class org.apache.velocity.tools.generic.DateTool
Returns a Date derived from the result of DateTool.getCalendar()
getDateFormat(String, Locale, TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool
Returns a DateFormat instance for the specified format, Locale, and TimeZone.
getDateFormat(String, String, Locale, TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool
Returns a DateFormat instance for the specified date style, time style, Locale, and TimeZone.
getDateFormat(int, int, Locale, TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool
Returns a DateFormat instance for the specified time style, date style, Locale, and TimeZone.
getDay() - Method in class org.apache.velocity.tools.generic.DateTool
Returns the day (of the month) value of the date returned by DateTool.getCalendar().
getDay(Object) - Method in class org.apache.velocity.tools.generic.DateTool
Returns the day (of the month) value for the specified date.
getDays() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Return the number of days between the dates being compared.
getDec() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getDefaultBundle() - Method in class org.apache.velocity.tools.generic.ResourceTool
 
getDefaultLocale() - Method in class org.apache.velocity.tools.generic.ResourceTool
 
getDifference() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Sets this comparison to be rendered as a ComparisonDateTool.difference(java.lang.Object, java.lang.Object).
getDollar() - Method in class org.apache.velocity.tools.generic.EscapeTool
Renders a dollar sign ($).
getDom0() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getDom1() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getDom2() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getDotnet() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getDouble(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getDouble(String, Double) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getDouble(String, double) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getDoubles(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getDynamicJavascript() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Render just the dynamic JavaScript to perform validations based on the form name attribute of the action mapping associated with the current request (if such exists).
getDynamicJavascript(String) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Render just the dynamic JavaScript to perform validations based on the supplied form name.
getDynamicJavascript(ValidatorResources, Locale, Form) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Generates the dynamic JavaScript for the form.
getE() - Method in class org.apache.velocity.tools.generic.EscapeTool
Renders an exclamation mark (!).
getEmacs() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getEpiphany() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getErrors(HttpServletRequest) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the Struts errors for this request or null if none exist.
getExclamation() - Method in class org.apache.velocity.tools.generic.EscapeTool
Renders an exclamation mark (!).
getExists() - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
 
getExists() - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
Convenience method to allow $text.key.exists syntax.
getFirefox() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getFirstIndex() - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
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() - Method in class org.apache.velocity.tools.generic.DateTool
Return the pattern or style to be used for formatting dates when none is specified.
getFormat() - Method in class org.apache.velocity.tools.generic.NumberTool
Return the pattern or style to be used for formatting numbers when none is specified.
getForwardURL(HttpServletRequest, ServletContext, String) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the action forward name converted into a server-relative URI reference.
getFreebsd() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getFromArray(Object, int) - Method in class org.apache.velocity.tools.generic.ListTool
Gets the specified element of an array.
getFull() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Sets the ComparisonDateTool.Comparison.depth(int depth) to which this comparison is rendered to the maximum number of time units available to the tool.
getGecko() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getGeckoMajorVersion() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getGeckoMinorVersion() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getGeckoVersion() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getGetright() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getGlobal() - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
This a convenience method and the equivalent of $messages.get($messages.globalName).
getGlobalName() - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns the default "GLOBAL" category name that can be used for messages that are not associated with a particular property.
getGoogle() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getH() - Method in class org.apache.velocity.tools.generic.EscapeTool
Renders a hash (#).
getHash() - Method in class org.apache.velocity.tools.generic.EscapeTool
Renders a hash (#).
getHotjava() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getHotjava3() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getHotjava3up() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getHours() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Return the number of hours between the dates being compared.
getHpux() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getHpux10() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getHpux9() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getHtmlComment() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Gets whether or not to delimit the JavaScript with html comments.
getIcab() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getIceweasel() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getIe() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getIe3() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getIe4() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getIe4up() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getIe5() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getIe55() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getIe55up() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getIe5up() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getIe6() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getIe6up() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getIe7() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getIe7up() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getIndex() - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
Returns the current search result index.
getInfoseek() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getInstance(Object) - Method in class org.apache.velocity.tools.view.DataInfo
Returns the data.
getInstance(ServletContext, String) - Static method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
ServletToolboxManager factory method.
getInstance(Object) - Method in interface org.apache.velocity.tools.view.ToolInfo
Returns an instance of the tool.
getInstance(Object) - Method in class org.apache.velocity.tools.view.ViewToolInfo
Returns a new instance of the tool.
getInt(String, int) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getInteger(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getInteger(String, Integer) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getIntegerInstance(Locale) - Method in class org.apache.velocity.tools.generic.NumberTool
Since we wish to continue supporting Java 1.3, for the present we cannot use Java 1.4's NumberFormat.getIntegerInstance(Locale) method.
getInts(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getIopener() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getIrix() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getIrix5() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getIrix6() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getItems() - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
Returns the item list.
getItems() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Gets the results for the given criteria either in memory or by performing a new query for them.
getItemsPerPage() - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
Returns the set number of items to be displayed per page of items
getJava() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getJavascript() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Render both dynamic and static JavaScript to perform validations based on the form name attribute of the action mapping associated with the current request (if such exists).
getJavascript(String) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Render both dynamic and static JavaScript to perform validations based on the supplied form name.
getJavascript(String, boolean) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Render both dynamic and static JavaScript to perform validations based on the supplied form name.
getJavascript() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getJavascriptBegin(String) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Returns the opening script element and some initial javascript.
getJavascriptEnd() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Returns the closing script element.
getJavascriptStaticMethods(ValidatorResources) - Method in class org.apache.velocity.tools.struts.ValidatorTool
 
getKey() - Method in class org.apache.velocity.tools.view.DataInfo
Accessors
getKey() - Method in interface org.apache.velocity.tools.view.ToolInfo
 
getKey() - Method in class org.apache.velocity.tools.view.tools.LinkTool.QueryPair
Gets the key for this QueryPair.
getKey() - Method in class org.apache.velocity.tools.view.ViewToolInfo
Accessors
getKeys() - Method in class org.apache.velocity.tools.view.tools.ContextTool
Return a Set of the available reference keys in the current context.
getKonqueror() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getLastIndex() - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
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.servlet.WebappLoader
Checks to see when a resource was last modified
getLinkexchange() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getLinks() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getLinux() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getList() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool.StoredResults
 
getLocale() - Method in class org.apache.velocity.tools.generic.DateTool
This implementation returns the configured default locale.
getLocale() - Method in class org.apache.velocity.tools.generic.NumberTool
This implementation returns the configured default locale.
getLocale(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getLocale(String, Locale) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getLocale(HttpServletRequest, HttpSession) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the java.util.Locale for the user.
getLocales(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getLotusnotes() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getLwp() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getLycos() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getLynx() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getMac() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getMac68k() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getMacosx() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getMacppc() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getMajorVersion() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getMessageResources(HttpServletRequest, ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the message resources for this application or null if not found.
getMessageResources(HttpServletRequest, ServletContext, String) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the message resources with the specified bundle name for this application or null if not found.
getMessages(HttpServletRequest) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the Struts messages for this request or null if none exist.
getMethod() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Gets the method name that will be used for the Javascript validation method name if it has a value.
getMilliseconds() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Return the number of milliseconds between the dates being compared.
getMinorVersion() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getMinutes() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Return the number of minutes between the dates being compared.
getMonth() - Method in class org.apache.velocity.tools.generic.DateTool
Returns the month value of the date returned by DateTool.getCalendar().
getMonth(Object) - Method in class org.apache.velocity.tools.generic.DateTool
Returns the month value of the specified date.
getMonths() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Return the approximate number of months between the dates being compared.
getMosaic() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getMozilla() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getMpras() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getMsgs() - Method in class org.apache.velocity.tools.struts.ErrorsTool
Renders the queued error messages as a list.
getMsgs(String) - Method in class org.apache.velocity.tools.struts.ErrorsTool
Renders the queued error messages of a particual category as a list.
getMsgs(String, String) - Method in class org.apache.velocity.tools.struts.ErrorsTool
Renders the queued error messages of a particual category as a list.
getMutex(HttpSession) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Returns a mutex (lock object) unique to the specified session to allow for reliable synchronization on the session.
getName() - Method in class org.apache.velocity.tools.struts.FormTool
Returns the form bean name associated with this action mapping.
getNav2() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getNav3() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getNav4() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getNav45() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getNav45up() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getNav4up() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getNav6() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getNav6up() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getNavgold() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getNeoplanet() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getNeoplanet2() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getNetscape() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getNext() - Method in class org.apache.velocity.tools.generic.Alternator
Returns the current item, then shifts the list index.
getNextIndex() - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
Returns the index for the next page of items (as determined by the current index, items per page, and the number of items).
getNumber(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getNumber(String, Number) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getNumberFormat(String, Locale) - Method in class org.apache.velocity.tools.generic.NumberTool
Returns a NumberFormat instance for the specified format and Locale.
getNumberFormat(int, Locale) - Method in class org.apache.velocity.tools.generic.NumberTool
Returns a NumberFormat instance for the specified number style and Locale.
getNumbers(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getOpera() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getOpera3() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getOpera4() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getOpera5() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getOpera6() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getOpera7() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getOpera8() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getOpera9() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getOs2() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getOutputStream() - Method in class org.apache.velocity.tools.view.ImportSupport.ImportResponseWrapper
 
getPage() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Gets the current page number of a multi-part form.
getPage() - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
Returns the current "page" of search items.
getPageDescription() - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
Returns a description of the current page.
getPageNumber(int) - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
Returns the "page number" for the specified index.
getPageNumber() - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
Returns the "page number" for the current index.
getPagesAvailable() - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
Returns the number of pages that can be made from this list given the set number of items per page.
getPalm() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getParameters() - Method in class org.apache.velocity.tools.view.ViewToolInfo
Get parameters for this tool.
getParams() - Method in class org.apache.velocity.tools.view.tools.LinkTool
Convenience method equivalent to LinkTool.getQueryData().
getParseDepth() - Method in class org.apache.velocity.tools.generic.RenderTool
Get the maximum number of loops allowed when recursing.
getPath(HttpServletRequest) - Static method in class org.apache.velocity.tools.view.servlet.ServletUtils
Retrieves the path for the specified request regardless of whether this is a direct request or an include by the RequestDispatcher.
getPrevIndex() - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
Return the index for the previous page of items (as determined by the current index, items per page, and the number of items).
getQ() - Method in class org.apache.velocity.tools.generic.EscapeTool
Renders a double quotation mark (").
getQueryData() - Method in class org.apache.velocity.tools.view.tools.LinkTool
Returns this link's query data as a url-encoded string e.g.
getQuote() - Method in class org.apache.velocity.tools.generic.EscapeTool
Renders a double quotation mark (").
getRandom() - Method in class org.apache.velocity.tools.generic.MathTool
 
getRaw() - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
 
getRelative() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Sets this comparison to be rendered as if it where generated using the ComparisonDateTool.whenIs(Object now, Object then) method.
getReliant() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getRequest() - Method in class org.apache.velocity.tools.view.context.ChainedContext
Returns the current servlet request.
getRequest() - Method in interface org.apache.velocity.tools.view.context.ViewContext
Returns the instance of HttpServletRequest for this request.
getRequest() - Method in class org.apache.velocity.tools.view.tools.ParameterParser
Returns the current ServletRequest for this instance.
getRequestPath() - Method in class org.apache.velocity.tools.view.servlet.ServletToolInfo
 
getRequestPath() - Method in class org.apache.velocity.tools.view.tools.LinkTool
Retrieves the path for the current request regardless of whether this is a direct request or an include by the RequestDispatcher.
getResources(String) - Method in class org.apache.velocity.tools.struts.MessageResourcesTool
Retrieves the specified MessageResources bundle, or the application's default MessageResources if no bundle is specified.
getResourceStream(String) - Method in class org.apache.velocity.tools.view.servlet.WebappLoader
Get an InputStream so that the Runtime can build a template with it.
getResponse() - Method in class org.apache.velocity.tools.view.context.ChainedContext
Returns the current servlet response.
getResponse() - Method in interface org.apache.velocity.tools.view.context.ViewContext
Returns the instance of HttpServletResponse for this request.
getResponseWriter(HttpServletResponse) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Procure a Writer with correct encoding which can be used even if HttpServletResponse's getOutputStream() method has already been called.
getResults() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Deprecated. Use AbstractPagerTool.getItems().
getRobot() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getRuleSet() - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Retrieves the rule set Digester should use to parse and load the toolbox for this manager.
getRuleSet() - Method in class org.apache.velocity.tools.view.XMLToolboxManager
Retrieves the rule set Digester should use to parse and load the toolbox for this manager.
getS() - Method in class org.apache.velocity.tools.generic.EscapeTool
Renders a single quotation mark (').
getSafari() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getSco() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getScooter() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getScope() - Method in class org.apache.velocity.tools.view.servlet.ServletToolInfo
 
getSeconds() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Return the number of seconds between the dates being compared.
getSelf() - Method in class org.apache.velocity.tools.view.tools.LinkTool
This method returns a new "self-referencing" LinkTool for the current request.
getServletContext() - Method in class org.apache.velocity.tools.view.context.ChainedContext
Returns the servlet context.
getServletContext() - Method in interface org.apache.velocity.tools.view.context.ViewContext
Returns the instance of ServletContext for this request.
getSingleQuote() - Method in class org.apache.velocity.tools.generic.EscapeTool
Renders a single quotation mark (').
getSinix() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getSize() - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns the number of action messages queued.
getSize(String) - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns the number of action messages queued for a particular property.
getSlip() - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
Returns a Sliding List of Indices for Pages of items.
getSlipSize() - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
Returns the number of result page indices AbstractPagerTool.getSlip() will return per request (if available).
getSlurp() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getSource() - Method in class org.apache.velocity.tools.generic.ValueParser
 
getSource() - Method in class org.apache.velocity.tools.view.tools.ParameterParser
Overrides ValueParser.getSource() to return the result of getRequest().getParameterMap().
getSrc() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Gets the src attribute's value when defining the html script element.
getStaroffice() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getStartElement() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Constructs the beginning
Copyright (c) 2003-2007 Apache Software Foundation