A B C D E F G H I J K L M N O P 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
 
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
 
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(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
application - Variable in class org.apache.velocity.tools.struts.MessageResourcesTool
 
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
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.

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
 
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(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.
BUNDLES_KEY - Static variable in class org.apache.velocity.tools.generic.ResourceTool
 

C

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
 
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.
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
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
 
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.
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

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.
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
 
depth(int) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Set the maximum number of units to render for this comparison.
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

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.view.i18n.MultiViewsTool
 
EQUAL_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
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.
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(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(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.
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

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(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.
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
 
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
 
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
 
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
 
getStaticJavascript() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Render just the static JavaScript methods.
getStatus() - Method in class org.apache.velocity.tools.view.ImportSupport.ImportResponseWrapper
 
getStoredItems() - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
Retrieves stored search items (if any) from the user's session attributes.
getStoredItems() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
 
getStoredResults() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Retrieves stored search results (if any) from the user's session attributes.
getString(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getString(String, String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getString() - Method in class org.apache.velocity.tools.view.ImportSupport.ImportResponseWrapper
Retrieves the buffered output, using the containing tag's 'charEncoding' attribute, or the tag's default encoding, if necessary.
getString(String) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
Overrides ValueParser.getString(String key) to retrieve the String from the ServletRequest instead of an arbitrary Map.
getStrings(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getStrings(String) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
Overrides ValueParser.getString(String key) to retrieve Strings from the ServletRequest instead of an arbitrary Map.
getStringsDelimiter() - Method in class org.apache.velocity.tools.generic.ValueParser
Returns the delimiter used for separating values in a single String value.
getStyleAsInt(String) - Method in class org.apache.velocity.tools.generic.DateTool
Checks a string to see if it matches one of the standard DateFormat style patterns: FULL, LONG, MEDIUM, SHORT, or DEFAULT.
getStyleAsInt(String) - Method in class org.apache.velocity.tools.generic.NumberTool
Checks a string to see if it matches one of the standard NumberFormat style patterns: NUMBER, CURRENCY, PERCENT, INTEGER, or DEFAULT.
getSun() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getSun4() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getSun5() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getSuni86() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getSystemCalendar() - Static method in class org.apache.velocity.tools.generic.DateTool
 
getSystemDate() - Static method in class org.apache.velocity.tools.generic.DateTool
 
getSystemTime() - Static method in class org.apache.velocity.tools.generic.DateTool
 
getTemplate(HttpServletRequest) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Gets the requested template.
getTemplate(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Gets the requested template.
getTemplate(String) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Retrieves the requested template.
getTemplate(String, String) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Retrieves the requested template with the specified character encoding.
getText(String, Locale) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool
Retrieves the specified text resource.
getThis() - Method in class org.apache.velocity.tools.view.tools.ContextTool
Returns the context being analyzed by this tool.
getTimeZone() - Method in class org.apache.velocity.tools.generic.DateTool
This implementation returns the default TimeZone.
getToken() - Method in class org.apache.velocity.tools.struts.FormTool
Returns the transaction control token for this session or null if no token exists.
getToken(HttpSession) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the transaction token stored in this session or null if not used.
getTokenName() - Method in class org.apache.velocity.tools.struts.FormTool
Returns the query parameter name under which a transaction token must be reported.
getToolbox() - Method in class org.apache.velocity.tools.view.context.ChainedContext
Returns a read-only view of the toolbox Map for this context.
getToolbox(Object) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Overrides XMLToolboxManager to handle the separate scopes.
getToolbox(Object) - Method in interface org.apache.velocity.tools.view.ToolboxManager
Retrieves a map of the tools and data being managed.
getToolbox() - Method in class org.apache.velocity.tools.view.tools.ContextTool
Returns a read-only view of the toolbox Map for this context.
getToolbox(Object) - Method in class org.apache.velocity.tools.view.XMLToolboxManager
 
getToolInfoClass() - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet
Overrides ToolboxRuleSet to use ServletToolInfo class.
getToolInfoClass() - Method in class org.apache.velocity.tools.view.ToolboxRuleSet
Return the bean class to be created for tool elements.
getTotal(Collection, String) - Method in class org.apache.velocity.tools.generic.MathTool
Get the sum of the values from a list
getTotal(Object[], String) - Method in class org.apache.velocity.tools.generic.MathTool
Get the sum of the values from a list
getTotal(Collection) - Method in class org.apache.velocity.tools.generic.MathTool
Get the sum of the values
getTotal(Object[]) - Method in class org.apache.velocity.tools.generic.MathTool
Get the sum of the values
getTotal(double[]) - Method in class org.apache.velocity.tools.generic.MathTool
Get the sum of the values
getTotal(long[]) - Method in class org.apache.velocity.tools.generic.MathTool
Get the sum of the values
getTotal() - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
Returns the total number of items available.
getUnix() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getUnixware() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getURI() - Method in class org.apache.velocity.tools.view.tools.LinkTool
Returns the current URI of this link as set by the setURI(String), setAbsolute(String) or setRelative(String) methods.
getUri() - Method in class org.apache.velocity.tools.view.tools.LinkTool
Convenience method equivalent to LinkTool.getURI() to enable all lowercase $link.uri syntax.
getValue(Object) - Method in class org.apache.velocity.tools.generic.DateTool
Return the specified value of the date returned by DateTool.getCalendar() or null if the field is invalid.
getValue(Object, Object) - Method in class org.apache.velocity.tools.generic.DateTool
Returns the specified value of the specified date, or null if the field or date is invalid.
getValue(int, Object) - Method in class org.apache.velocity.tools.generic.DateTool
Returns the specified value of the specified date, or null if the field or date is invalid.
getValues() - Method in class org.apache.velocity.tools.view.tools.ContextTool
Return a Set of the available values in the current context.
getVelocityContext() - Method in class org.apache.velocity.tools.view.context.ChainedContext
Returns a reference to the Velocity context (this object).
getVelocityContext() - Method in interface org.apache.velocity.tools.view.context.ViewContext
Returns a reference to the current Velocity context.
getVelocityEngine() - Method in class org.apache.velocity.tools.view.context.ChainedContext
Returns a reference to the VelocityEngine.
getVelocityEngine() - Method in interface org.apache.velocity.tools.view.context.ViewContext
Returns the current VelocityEngine instance.
getVelocityEngine() - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Returns the underlying VelocityEngine being used.
getVelocityProperty(String, String) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Simplifies process of getting a property from VelocityEngine, because the VelocityEngine interface sucks compared to the singleton's.
getVersion() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getVista() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getVMS() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getWap() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getWebcrawler() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getWebTV() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getWeeks() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Return the number of weeks between the dates being compared.
getWget() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getWin16() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getWin2k() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getWin31() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getWin32() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getWin3x() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getWin95() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getWin98() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getWindows() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getWinme() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getWinnt() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getWinxp() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getWriter() - Method in class org.apache.velocity.tools.view.ImportSupport.ImportResponseWrapper
 
getX11() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getYahoo() - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
getYear() - Method in class org.apache.velocity.tools.generic.DateTool
Returns the year value of the date returned by DateTool.getCalendar().
getYear(Object) - Method in class org.apache.velocity.tools.generic.DateTool
Returns the year value of the specified date.
getYears() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Return the approximate number of years between the dates being compared.

H

handler - Static variable in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
 
handleRequest(HttpServletRequest, HttpServletResponse, Context) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Deprecated. This will be removed in VelocityTools 2.0.
hasItems() - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
Checks whether or not the result list is empty.
hasMore() - Method in class org.apache.velocity.tools.generic.IteratorTool
Returns true if there are more elements in the wrapped list.
hasNext() - Method in class org.apache.velocity.tools.generic.IteratorTool
Returns true if there are more elements in the list and more() was called.
hasResults() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Deprecated. Use AbstractPagerTool.hasItems()
HOUR_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
html(Object) - Method in class org.apache.velocity.tools.generic.EscapeTool
Escapes the characters in a String using HTML entities.
HTML_QUERY_DELIMITER - Static variable in class org.apache.velocity.tools.view.tools.LinkTool
Standard HTML delimiter for query data ('&')

I

idiv(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
Does integer division on the int values of the specified numbers.
importAttribute(String) - Method in class org.apache.velocity.tools.struts.TilesTool
Imports the named attribute-value from the current tiles-context into the current Velocity context.
importAttribute(String, String) - Method in class org.apache.velocity.tools.struts.TilesTool
Imports the named attribute-value from the current tiles-context into the named context ("page", "request", "session", or "application").
importAttributes() - Method in class org.apache.velocity.tools.struts.TilesTool
Imports all attributes in the current tiles-context into the current velocity-context.
importAttributes(String) - Method in class org.apache.velocity.tools.struts.TilesTool
Imports all attributes in the current tiles-context into the named context ("page", "request", "session", or "application").
ImportSupport - Class in org.apache.velocity.tools.view
Provides methods to import arbitrary local or remote resources as strings.
ImportSupport() - Constructor for class org.apache.velocity.tools.view.ImportSupport
 
ImportSupport.ImportResponseWrapper - Class in org.apache.velocity.tools.view
Wraps responses to allow us to retrieve results as Strings.
ImportSupport.ImportResponseWrapper(HttpServletResponse) - Constructor for class org.apache.velocity.tools.view.ImportSupport.ImportResponseWrapper
Constructs a new ImportResponseWrapper.
ImportSupport.SafeClosingHttpURLConnectionReader - Class in org.apache.velocity.tools.view
 
ImportTool - Class in org.apache.velocity.tools.view.tools
General-purpose text-importing view tool for templates.
ImportTool() - Constructor for class org.apache.velocity.tools.view.tools.ImportTool
Default constructor.
info(Object) - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Passes messages to Velocity's LogSystem at "INFO" level.
info(Object, Throwable) - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Passes messages to Velocity's LogSystem at "INFO" level.
init(RuntimeServices) - Method in class org.apache.velocity.tools.generic.log.CommonsLogLogSystem
LogSystem methods
init(Object) - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Initializes this tool.
init(Object) - Method in class org.apache.velocity.tools.struts.ErrorsTool
Initializes this tool.
init(Object) - Method in class org.apache.velocity.tools.struts.FormTool
Initializes this tool.
init(Object) - Method in class org.apache.velocity.tools.struts.MessageResourcesTool
Initializes this tool.
init(Object) - Method in class org.apache.velocity.tools.struts.TilesTool
Initializes this tool.
init(Object) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Initializes this tool.
init(Object) - Method in class org.apache.velocity.tools.view.i18n.MultiViewsTool
Extracts the default language from the specified ViewContext, looking first at the Velocity context, then the servlet context, then lastly at the JVM default.
init(RuntimeServices) - Method in class org.apache.velocity.tools.view.servlet.ServletLogger
init()
init(ServletConfig) - Method in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
Initializes Velocity, the view servlet and checks for changes to the initial layout configuration.
init(ServletConfig) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Initializes servlet, toolbox and Velocity template engine.
init(ExtendedProperties) - Method in class org.apache.velocity.tools.view.servlet.WebappLoader
This is abstract in the base class, so we need it.
init(Object) - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
Initializes this instance by grabbing the request and session objects from the current ViewContext.
init(Object) - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
 
init(Object) - Method in class org.apache.velocity.tools.view.tools.ContextTool
Initializes this instance for the current request.
init(Object) - Method in class org.apache.velocity.tools.view.tools.CookieTool
Initializes this instance for the current request.
init(Object) - Method in class org.apache.velocity.tools.view.tools.ImportTool
Initializes this tool.
init(Object) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Initializes this tool.
init(Object) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
Initializes this instance.
init(Object) - Method in class org.apache.velocity.tools.view.tools.ViewRenderTool
Initializes this instance.
init(Object) - Method in class org.apache.velocity.tools.view.tools.ViewResourceTool
Initializes this instance.
init(Object) - Method in interface org.apache.velocity.tools.view.tools.ViewTool
Deprecated. Initializes this instance using the given data
INIT_PROPS_KEY - Static variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
This is the string that is looked for when getInitParameter is called ("org.apache.velocity.properties").
initToolbox(ServletConfig) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Initializes the ServletToolboxManager for this servlet's toolbox (if any).
initVelocity(ServletConfig) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Initializes the Velocity runtime, first calling loadConfiguration(ServletConfig) to get a org.apache.commons.collections.ExtendedProperties of configuration information and then calling velocityEngine.init().
insert(Object[]) - Method in class org.apache.velocity.tools.generic.ResourceTool
 
insert(List) - Method in class org.apache.velocity.tools.generic.ResourceTool
 
insert(Object) - Method in class org.apache.velocity.tools.generic.ResourceTool
 
insert(Object, Object) - Method in class org.apache.velocity.tools.generic.ResourceTool
 
insert(Object[]) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
 
insert(List) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
 
insert(Object) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
 
insert(Object, Object) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
 
insert(Object) - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
Returns a new TextKey with the specified argument to be inserted into the text output.
insert(Object, Object) - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
Returns a new TextKey with the specified arguments to be inserted into the text output.
insert(Object, Object, Object) - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
Returns a new TextKey with the specified arguments to be inserted into the text output.
insert(List) - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
Returns a new TextKey with the specified List of arguments to be inserted into the text output.
insert(Object[]) - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
Returns a new TextKey with the specified array of arguments to be inserted into the text output.
integer(Object) - Method in class org.apache.velocity.tools.generic.NumberTool
Convenience method equivalent to $number.format("integer", $foo).
internalGet(String) - Method in class org.apache.velocity.tools.view.context.ChainedContext
Looks up and returns the object with the specified key.
internalRecurse(Context, String, int) - Method in class org.apache.velocity.tools.generic.RenderTool
 
internalSort(List, List) - Method in class org.apache.velocity.tools.generic.SortTool
 
isAbsoluteUrl(String) - Static method in class org.apache.velocity.tools.view.ImportSupport
Returns true if our current URL is absolute, false otherwise.
isArray(Object) - Method in class org.apache.velocity.tools.generic.ListTool
Checks if an object is an array.
isAuto() - Method in class org.apache.velocity.tools.generic.Alternator
 
isDebugEnabled() - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Always returns true since Velocity's LogSystem doesn't provide this information.
isEmpty(Object) - Method in class org.apache.velocity.tools.generic.ListTool
Checks if a List/array is empty.
isErrorEnabled() - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Always returns true since Velocity's LogSystem doesn't provide this information.
isFatalEnabled() - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Always returns true since Velocity's LogSystem doesn't provide this information.
isInfoEnabled() - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Always returns true since Velocity's LogSystem doesn't provide this information.
isList(Object) - Method in class org.apache.velocity.tools.generic.ListTool
Checks if an object is a List.
isSourceModified(Resource) - Method in class org.apache.velocity.tools.view.servlet.WebappLoader
Checks to see if a resource has been deleted, moved or modified.
isTraceEnabled() - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Always returns true since Velocity's LogSystem doesn't provide this information.
isWarnEnabled() - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Always returns true since Velocity's LogSystem doesn't provide this information.
IteratorTool - Class in org.apache.velocity.tools.generic
A convenience tool to use with #foreach loops.
IteratorTool() - Constructor for class org.apache.velocity.tools.generic.IteratorTool
Create a IteratorTool instance to use as tool.
IteratorTool(Object) - Constructor for class org.apache.velocity.tools.generic.IteratorTool
Create a IteratorTool instance to use in #foreach.

J

java(Object) - Method in class org.apache.velocity.tools.generic.EscapeTool
Escapes the characters in a String using Java String rules.
javascript(Object) - Method in class org.apache.velocity.tools.generic.EscapeTool
Escapes the characters in a String using JavaScript String rules.
jsFormName - Variable in class org.apache.velocity.tools.struts.ValidatorTool
formName is used for both Javascript and non-javascript validations.

K

KEY_CATCH_EXCEPTIONS - Static variable in class org.apache.velocity.tools.generic.RenderTool
 
KEY_ERROR_CAUSE - Static variable in class org.apache.velocity.tools.view.servlet.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.servlet.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.servlet.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.servlet.VelocityLayoutServlet
The context/parameter key used to specify an alternate layout to be used for a request instead of the default layout.
KEY_PARSE_DEPTH - Static variable in class org.apache.velocity.tools.generic.RenderTool
 
KEY_SCREEN_CONTENT - Static variable in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
The context key that will hold the content of the screen.

L

layoutDir - Variable in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
 
LinkTool - Class in org.apache.velocity.tools.view.tools
View tool to make building URIs pleasant and fun!
LinkTool() - Constructor for class org.apache.velocity.tools.view.tools.LinkTool
Default constructor.
LinkTool.QueryPair - Class in org.apache.velocity.tools.view.tools
Internal util class to handle representation and encoding of key/value pairs in the query string
LinkTool.QueryPair(String, Object) - Constructor for class org.apache.velocity.tools.view.tools.LinkTool.QueryPair
Construct a new query pair.
ListTool - Class in org.apache.velocity.tools.generic
Tool for working with Lists and arrays in Velocity templates.
ListTool() - Constructor for class org.apache.velocity.tools.generic.ListTool
Default constructor.
load(String) - Method in class org.apache.velocity.tools.view.XMLToolboxManager
Reads an XML document from the specified file path and sets up the toolbox from that.
load(InputStream) - Method in class org.apache.velocity.tools.view.XMLToolboxManager
Reads an XML document from an InputStream and sets up the toolbox from that.
loadConfiguration(ServletConfig) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Loads the configuration information and returns that information as an ExtendedProperties, which will be used to initialize the Velocity runtime.
locale(Locale) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Sets the locale used to look up the textual portions of the rendering.
locale(Locale) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
 
locale(Locale) - Method in class org.apache.velocity.tools.generic.ResourceTool
 
locale - Variable in class org.apache.velocity.tools.struts.MessageResourcesTool
 
locale(Locale) - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
Returns a new TextKey with the specified resource bundle set.
LOCALE_KEY - Static variable in class org.apache.velocity.tools.generic.ResourceTool
 
LOCK_CONFIG_KEY - Static variable in class org.apache.velocity.tools.generic.DateTool
The key used for specifying whether or not to prevent templates from reconfiguring this tool.
LOCK_CONFIG_KEY - Static variable in class org.apache.velocity.tools.generic.NumberTool
The key used for specifying whether or not to prevent templates from reconfiguring this tool.
log - Variable in class org.apache.velocity.tools.generic.log.CommonsLogLogSystem
the commons-logging Log instance
LOG - Static variable in class org.apache.velocity.tools.struts.ActionMessagesTool
 
LOG - Static variable in class org.apache.velocity.tools.struts.MessageResourcesTool
 
LOG - Static variable in class org.apache.velocity.tools.struts.StrutsLinkTool
 
LOG - Static variable in class org.apache.velocity.tools.struts.TilesTool
 
LOG - Static variable in class org.apache.velocity.tools.view.ImportSupport
 
LOG - Static variable in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
 
LOG - Static variable in class org.apache.velocity.tools.view.tools.ImportTool
 
LOG - Static variable in class org.apache.velocity.tools.view.tools.LinkTool
 
LOG - Static variable in class org.apache.velocity.tools.view.ViewToolInfo
 
LOG - Static variable in class org.apache.velocity.tools.view.XMLToolboxManager
 
LOGSYSTEM_COMMONS_LOG_NAME - Static variable in class org.apache.velocity.tools.generic.log.CommonsLogLogSystem
Property key for specifying the name for the log instance
LogSystemCommonsLog - Class in org.apache.velocity.tools.generic.log
Redirects commons-logging messages to Velocity's LogSystem.
LogSystemCommonsLog() - Constructor for class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
 
LogSystemCommonsLog(String) - Constructor for class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
 
LogSystemCommonsLog(boolean) - Constructor for class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Lets you set whether or not this instance should print the full stack trace of exceptions and errors passed to it.
LogSystemCommonsLog(boolean, String) - Constructor for class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Lets you set whether or not this instance should print the full stack trace of exceptions and errors passed to it.
logVelocityMessage(int, String) - Method in class org.apache.velocity.tools.generic.log.CommonsLogLogSystem
Send a log message from Velocity.
logVelocityMessage(int, String) - Method in class org.apache.velocity.tools.view.servlet.ServletLogger
Send a log message from Velocity.

M

make(List) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Make an automatic Alternator from a List.
make(boolean, List) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Deprecated. Use AlternatorTool.auto(List list) or AlternatorTool.manual(List list) instead.
make(Object[]) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Make an automatic Alternator from an object array.
make(boolean, Object[]) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Deprecated. Use AlternatorTool.auto(Object[] array) or AlternatorTool.manual(Object[] array) instead.
make(Object, Object) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Make an automatic Alternator from a list containing the two specified objects.
make(boolean, Object, Object) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Deprecated. Use AlternatorTool.auto(Object o1, Object o2) or AlternatorTool.manual(Object o1, Object o2) instead.
manual(List) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Make a manual Alternator from values in the specified List.
manual(Object[]) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Make a manual Alternator from the specified object array.
manual(Object, Object) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Make a manual Alternator from a list containing the two specified objects.
mark(int) - Method in class org.apache.velocity.tools.view.ImportSupport.SafeClosingHttpURLConnectionReader
 
markSupported() - Method in class org.apache.velocity.tools.view.ImportSupport.SafeClosingHttpURLConnectionReader
 
matchType(Number, double) - Method in class org.apache.velocity.tools.generic.MathTool
 
matchType(Number, Number, double) - Method in class org.apache.velocity.tools.generic.MathTool
Takes the original argument(s) and returns the resulting value as an instance of the best matching type (Integer, Long, or Double).
MathTool - Class in org.apache.velocity.tools.generic
Tool for performing math in Velocity.
MathTool() - Constructor for class org.apache.velocity.tools.generic.MathTool
 
max(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
mergeTemplate(Template, Context, HttpServletResponse) - Method in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
Overrides VelocityViewServlet.mergeTemplate to do a two-pass render for handling layouts
mergeTemplate(Template, Context, HttpServletResponse) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Merges the template with the context.
MessageResourcesTool - Class in org.apache.velocity.tools.struts
Abstract view tool that provides access to Struts' message resources.
MessageResourcesTool() - Constructor for class org.apache.velocity.tools.struts.MessageResourcesTool
 
MessageTool - Class in org.apache.velocity.tools.struts
View tool that provides methods to render Struts application resources for internationalized text.
MessageTool() - Constructor for class org.apache.velocity.tools.struts.MessageTool
Default constructor.
MessageTool.TextKey - Class in org.apache.velocity.tools.struts
Helper class to simplify tool usage when retrieving no-arg messages from the default bundle that have periods in their key.
MessageTool.TextKey(MessageTool, String, String, Object[]) - Constructor for class org.apache.velocity.tools.struts.MessageTool.TextKey
Deprecated. This will be removed after VelocityTools 1.4
MessageTool.TextKey(String, String, Object[], Locale) - Constructor for class org.apache.velocity.tools.struts.MessageTool.TextKey
 
methodExceptionHandlerPresent - Variable in class org.apache.velocity.tools.struts.TilesTool
Indicates if there is a MethodExceptionEventHandler present
MILLIS_PER_DAY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
The number of milliseconds in a day.
MILLIS_PER_HOUR - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
The number of milliseconds in an hour.
MILLIS_PER_MINUTE - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
The number of millseconds in a minute.
MILLIS_PER_MONTH - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
An approximation of the number of milliseconds in a month.
MILLIS_PER_SECOND - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
The number of milliseconds in a second.
MILLIS_PER_WEEK - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
The number of milliseconds in a week.
MILLIS_PER_YEAR - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
An approximation of the number of milliseconds in a year.
MILLISECOND_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
min(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
MINUTE_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
mod(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
Does integer modulus on the int values of the specified numbers.
MONTH_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
more() - Method in class org.apache.velocity.tools.generic.IteratorTool
Asks for the next element in the list.
mul(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
MultiViewsTool - Class in org.apache.velocity.tools.view.i18n
Allows for transparent content negotiation in a manner mimicking Apache httpd's MultiViews.
MultiViewsTool() - Constructor for class org.apache.velocity.tools.view.i18n.MultiViewsTool
Creates a new uninitialized instance.

N

next - Variable in class org.apache.velocity.tools.generic.IteratorTool
 
next() - Method in class org.apache.velocity.tools.generic.IteratorTool
Gets the next object in the list.
number(Object) - Method in class org.apache.velocity.tools.generic.NumberTool
Convenience method equivalent to $number.format("number", $foo).
NumberTool - Class in org.apache.velocity.tools.generic
Tool for working with Number in Velocity templates.
NumberTool() - Constructor for class org.apache.velocity.tools.generic.NumberTool
 

O

ONE_DAY_SUFFIX - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
org.apache.velocity.tools.generic - package org.apache.velocity.tools.generic
Contains a collection of reusable, general-purpose "tools" for Velocity.
org.apache.velocity.tools.generic.log - package org.apache.velocity.tools.generic.log
Contains classes created to serve as bridges between Commons-Logging and Velocity's LogSystem.
org.apache.velocity.tools.struts - package org.apache.velocity.tools.struts
Provides view tools to integrate Velocity with the Apache Struts framework.
org.apache.velocity.tools.view - package org.apache.velocity.tools.view
Contains base interfaces and classes for toolbox management.
org.apache.velocity.tools.view.context - package org.apache.velocity.tools.view.context
Provides special purpose implementations of the VelocityContext class related to the automatic toolbox management in a servlet environment.
org.apache.velocity.tools.view.i18n - package org.apache.velocity.tools.view.i18n
 
org.apache.velocity.tools.view.servlet - package org.apache.velocity.tools.view.servlet
Provides classes to support using Velocity in a servlet environment.
org.apache.velocity.tools.view.tools - package org.apache.velocity.tools.view.tools
Provides the ViewTool and Configurable interfaces, as well as a number of useful implementing classes.

P

param(Object, Object) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Convenience method equivalent to LinkTool.addQueryData(java.lang.String, java.lang.Object).
ParameterParser - Class in org.apache.velocity.tools.view.tools
Utility class for easy parsing of ServletRequest parameters.
ParameterParser() - Constructor for class org.apache.velocity.tools.view.tools.ParameterParser
Constructs a new instance
ParameterParser(ServletRequest) - Constructor for class org.apache.velocity.tools.view.tools.ParameterParser
Constructs a new instance using the specified request.
params(Map) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Convenience method equivalent to LinkTool.addQueryData(Map parameters).
parseBoolean(String) - Method in class org.apache.velocity.tools.generic.ValueParser
Converts a parameter value into a Boolean Sub-classes can override to allow for customized boolean parsing.
parseLocale(String) - Method in class org.apache.velocity.tools.generic.ValueParser
Converts a String value into a Locale.
parseNumber(String) - Method in class org.apache.velocity.tools.generic.MathTool
Converts an object into a Number (if it can) This is used as the base for all numeric parsing methods.
parseNumber(String) - Method in class org.apache.velocity.tools.generic.ValueParser
Converts a parameter value into a Number This is used as the base for all numeric parsing methods.
parseStringList(String) - Method in class org.apache.velocity.tools.generic.ValueParser
Converts a single String value into an array of Strings by splitting it on the tool's set delimiter.
paths - Variable in class org.apache.velocity.tools.view.servlet.WebappLoader
The root paths for templates (relative to webapp's root).
percent(Object) - Method in class org.apache.velocity.tools.generic.NumberTool
Convenience method equivalent to $number.format("percent", $foo).
performMerge(Template, Context, Writer) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
This is here so developers may override it and gain access to the Writer which the template will be merged into.
PLURAL_SUFFIX - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
popTilesContext() - Method in class org.apache.velocity.tools.struts.TilesTool
Pops the tiles sub-context off the context-stack after the lower level tiles have been rendered.
pow(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
PREFIX - Static variable in class org.apache.velocity.tools.view.servlet.ServletLogger
 
processAsDefinitionOrURL(String) - Method in class org.apache.velocity.tools.struts.TilesTool
Try to process name as a definition, or as an URL if not found.
processDefinition(ComponentDefinition) - Method in class org.apache.velocity.tools.struts.TilesTool
End of Process for definition.
processObjectValue(Object) - Method in class org.apache.velocity.tools.struts.TilesTool
Process an object retrieved as a bean or attribute.
processTypedAttribute(AttributeDefinition) - Method in class org.apache.velocity.tools.struts.TilesTool
Process typed attribute according to its type.
processUrl(String) - Method in class org.apache.velocity.tools.struts.TilesTool
Processes an url
PROPERTY_DEFAULT_LAYOUT - Static variable in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
The velocity.properties key for specifying the servlet's default layout template's filename.
PROPERTY_ERROR_TEMPLATE - Static variable in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
The velocity.properties key for specifying the servlet's error template.
PROPERTY_LAYOUT_DIR - Static variable in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
The velocity.properties key for specifying the relative directory holding layout templates.
propertyKey(Object) - Method in class org.apache.velocity.tools.generic.EscapeTool
Escapes the characters in a String using java.util.Properties rules for escaping property keys.
propertyValue(Object) - Method in class org.apache.velocity.tools.generic.EscapeTool
Escapes the characters in a String using java.util.Properties rules for escaping property values.
pushTilesContext() - Method in class org.apache.velocity.tools.struts.TilesTool
pushes the current tiles context onto the context-stack.

R

random(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
This returns a random Number within the specified range.
read() - Method in class org.apache.velocity.tools.view.ImportSupport.SafeClosingHttpURLConnectionReader
 
read(char[]) - Method in class org.apache.velocity.tools.view.ImportSupport.SafeClosingHttpURLConnectionReader
 
read(char[], int, int) - Method in class org.apache.velocity.tools.view.ImportSupport.SafeClosingHttpURLConnectionReader
 
read(String) - Method in class org.apache.velocity.tools.view.tools.ImportTool
Returns the supplied URL rendered as a String.
ready() - Method in class org.apache.velocity.tools.view.ImportSupport.SafeClosingHttpURLConnectionReader
 
recurse(Context, String) - Method in class org.apache.velocity.tools.generic.RenderTool
Recursively evaluates a String containing VTL using the current context, and returns the result as a String.
recurse(String) - Method in class org.apache.velocity.tools.view.tools.ViewRenderTool
Recursively evaluates a String containing VTL using the current context, and returns the result as a String.
relative(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Convenience method equivalent to LinkTool.setRelative(java.lang.String).
RELATIVE_TYPE - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
remove() - Method in class org.apache.velocity.tools.generic.IteratorTool
Removes the current element from the list.
render(Object, Object[]) - Method in class org.apache.velocity.tools.generic.ResourceTool
Renders the specified resource value and arguments as a String.
RenderTool - Class in org.apache.velocity.tools.generic
This tool exposes methods to evaluate the given strings as VTL (Velocity Template Language) using the given context.
RenderTool() - Constructor for class org.apache.velocity.tools.generic.RenderTool
 
request - Variable in class org.apache.velocity.tools.struts.FormTool
A reference to the HtttpServletRequest.
request - Variable in class org.apache.velocity.tools.struts.MessageResourcesTool
 
request - Variable in class org.apache.velocity.tools.struts.ValidatorTool
A reference to the HttpServletRequest.
REQUEST - Static variable in interface org.apache.velocity.tools.view.context.ViewContext
Key used for the HTTP request object.
request - Variable in class org.apache.velocity.tools.view.ImportSupport
 
request - Variable in class org.apache.velocity.tools.view.tools.ContextTool
 
request - Variable in class org.apache.velocity.tools.view.tools.CookieTool
 
request - Variable in class org.apache.velocity.tools.view.tools.LinkTool
A reference to the HttpServletRequest.
requestCleanup(HttpServletRequest, HttpServletResponse, Context) - Method in class org.apache.velocity.tools.view.servlet.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.generic.IteratorTool
Resets the wrapper so that it starts over at the beginning of the list.
reset() - Method in class org.apache.velocity.tools.view.ImportSupport.SafeClosingHttpURLConnectionReader
 
reset() - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
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.tools.AbstractSearchTool
Sets the criteria and results to null, page index to zero, and items per page to the default.
resources - Variable in class org.apache.velocity.tools.struts.MessageResourcesTool
 
resources - Variable in class org.apache.velocity.tools.struts.ValidatorTool
A reference to the ValidatorResources.
ResourceTool - Class in org.apache.velocity.tools.generic
Tool for accessing ResourceBundles and formatting messages therein.
ResourceTool() - Constructor for class org.apache.velocity.tools.generic.ResourceTool
 
ResourceTool.Key - Class in org.apache.velocity.tools.generic
Internal class used to enable an elegant syntax for accessing resources.
ResourceTool.Key(String, String[], Locale, Object[]) - Constructor for class org.apache.velocity.tools.generic.ResourceTool.Key
 
RESPONSE - Static variable in interface org.apache.velocity.tools.view.context.ViewContext
Key used for the HTTP response object.
response - Variable in class org.apache.velocity.tools.view.ImportSupport
 
response - Variable in class org.apache.velocity.tools.view.tools.CookieTool
 
response - Variable in class org.apache.velocity.tools.view.tools.LinkTool
A reference to the HttpServletResponse.
round(Object) - Method in class org.apache.velocity.tools.generic.MathTool
Rounds a number to the nearest whole Integer
roundTo(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
Rounds a number to the specified number of decimal places.

S

SAFE_MODE_KEY - Static variable in class org.apache.velocity.tools.view.tools.ContextTool
The key used for specifying whether to hide keys with '.' in them.
SECOND_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
SecureLinkTool - Class in org.apache.velocity.tools.struts
Tool to be able to use Struts SSL Extensions with Velocity.
SecureLinkTool() - Constructor for class org.apache.velocity.tools.struts.SecureLinkTool
 
selectModule(String, ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Select the module to which the specified request belongs, and add return the corresponding ModuleConfig.
SELF_ABSOLUTE_KEY - Static variable in class org.apache.velocity.tools.view.tools.LinkTool
Parameter key for configuring LinkTool.setSelfAbsolute(boolean) state
SELF_INCLUDE_PARAMETERS_KEY - Static variable in class org.apache.velocity.tools.view.tools.LinkTool
Parameter key for configuring LinkTool.setSelfIncludeParameters(boolean) state
SERVLET_CONTEXT_KEY - Static variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Key used to access the ServletContext in the Velocity application attributes.
servletContext - Variable in class org.apache.velocity.tools.view.servlet.ServletLogger
 
servletContext - Variable in class org.apache.velocity.tools.view.servlet.WebappLoader
 
ServletLogger - Class in org.apache.velocity.tools.view.servlet
Simple wrapper for the servlet log.
ServletLogger() - Constructor for class org.apache.velocity.tools.view.servlet.ServletLogger
Construct a simple logger for a servlet environment.
ServletToolboxManager - Class in org.apache.velocity.tools.view.servlet
A toolbox manager for the servlet environment.
ServletToolboxManager(ServletContext) - Constructor for class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Use getInstance(ServletContext,String) instead to ensure there is exactly one ServletToolboxManager per xml toolbox configuration file.
ServletToolboxRuleSet - Class in org.apache.velocity.tools.view.servlet
The set of Digester rules required to parse a toolbox configuration file (toolbox.xml) for the ServletToolboxManager class.
ServletToolboxRuleSet() - Constructor for class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet
 
ServletToolboxRuleSet.BooleanConfigRule - Class in org.apache.velocity.tools.view.servlet
Abstract rule for configuring boolean options on the parent object/element of the matching element.
ServletToolboxRuleSet.BooleanConfigRule() - Constructor for class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet.BooleanConfigRule
 
ServletToolboxRuleSet.CreateSessionRule - Class in org.apache.velocity.tools.view.servlet
Rule that sets setCreateSession() for the top object on the stack, which must be a org.apache.velocity.tools.ServletToolboxManager.
ServletToolboxRuleSet.CreateSessionRule() - Constructor for class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet.CreateSessionRule
 
ServletToolboxRuleSet.XhtmlRule - Class in org.apache.velocity.tools.view.servlet
Rule that sets setXhtml() for the top object on the stack, which must be a org.apache.velocity.tools.ServletToolboxManager.
ServletToolboxRuleSet.XhtmlRule() - Constructor for class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet.XhtmlRule
 
ServletToolInfo - Class in org.apache.velocity.tools.view.servlet
ToolInfo implementation that holds scope information for tools used in a servlet environment.
ServletToolInfo() - Constructor for class org.apache.velocity.tools.view.servlet.ServletToolInfo
 
ServletUtils - Class in org.apache.velocity.tools.view.servlet
A set of utility methods for the servlet environment.
ServletUtils() - Constructor for class org.apache.velocity.tools.view.servlet.ServletUtils
 
session - Variable in class org.apache.velocity.tools.struts.FormTool
A reference to the HtttpSession.
session - Variable in class org.apache.velocity.tools.struts.ValidatorTool
A reference to the HttpSession.
SESSION - Static variable in interface org.apache.velocity.tools.view.context.ViewContext
Key used for the HTTP session object.
session - Variable in class org.apache.velocity.tools.view.tools.AbstractPagerTool
 
session - Variable in class org.apache.velocity.tools.view.tools.ContextTool
 
SESSION_TOOLS_KEY - Static variable in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
 
set(Object, int, Object) - Method in class org.apache.velocity.tools.generic.ListTool
Sets the specified element of a List/array.
setAbsolute(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Returns a copy of the link with the specified URI reference either used as or converted to an absolute (non-relative) URI reference.
setAction(String) - Method in class org.apache.velocity.tools.struts.SecureLinkTool
Returns a copy of the link with the given action name converted into a server-relative URI reference.
setAction(String) - Method in class org.apache.velocity.tools.struts.StrutsLinkTool
Returns a copy of the link with the given action name converted into a server-relative URI reference.
setAnchor(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Returns a copy of the link with the specified anchor to be added to the end of the generated hyperlink.
setAuto(boolean) - Method in class org.apache.velocity.tools.generic.Alternator
If set to true, the list index will shift automatically after a call to toString().
setAutoAlternateDefault(boolean) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Sets the default for auto-alternating.
setAutoIgnoreParameters(boolean) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Controls whether or not the LinkTool.addQueryData(String,Object) and LinkTool.addQueryData(Map) methods will automatically add the specified parameter(s) to the ignore list for LinkTool.addAllParameters()
setBoolean(Object, Boolean) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet.BooleanConfigRule
Takes the parent object and boolean value in order to call the appropriate method on the parent for the implementing rule.
setBoolean(Object, Boolean) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet.CreateSessionRule
 
setBoolean(Object, Boolean) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet.XhtmlRule
 
setCatchExceptions(boolean) - Method in class org.apache.velocity.tools.generic.RenderTool
Sets whether or not the render() and eval() methods should catch exceptions during their execution or not.
setCdata(boolean) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Sets the cdata status.
setClassname(String) - Method in class org.apache.velocity.tools.view.ViewToolInfo
If an instance of the tool cannot be created from the classname passed to this method, it will throw an exception.
setContentType(String) - Method in class org.apache.velocity.tools.view.ImportSupport.ImportResponseWrapper
Has no effect.
setContentType(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Sets the content type of the response.
setCreateSession(boolean) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Sets whether or not to create a new session when none exists for the current request and session-scoped tools have been defined for this toolbox.
setCriteria(Object) - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Sets the criteria for this search.
setDefaultBundle(String) - Method in class org.apache.velocity.tools.generic.ResourceTool
 
setDefaultLocale(Locale) - Method in class org.apache.velocity.tools.generic.ResourceTool
 
setFormat(String) - Method in class org.apache.velocity.tools.generic.DateTool
Sets the default format for this instance.
setFormat(String) - Method in class org.apache.velocity.tools.generic.NumberTool
Sets the default format for this instance.
setForward(String) - Method in class org.apache.velocity.tools.struts.SecureLinkTool
Returns a copy of the link with the given global forward name converted into a server-relative URI reference.
setForward(String) - Method in class org.apache.velocity.tools.struts.StrutsLinkTool
Returns a copy of the link with the given global or local forward name converted into a server-relative URI reference.
setHtmlComment(boolean) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Sets whether or not to delimit the JavaScript with html comments.
setIndex(int) - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
Sets the index of the first result in the current page
setItems(List) - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
Sets the List to page through.
setItemsPerPage(int) - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
Sets the number of items returned in a page of items
setKey(String) - Method in class org.apache.velocity.tools.view.DataInfo
Mutators
setKey(String) - Method in class org.apache.velocity.tools.view.ViewToolInfo
Mutators
setLocale(Locale) - Method in class org.apache.velocity.tools.generic.DateTool
Sets the default locale for this instance.
setLocale(Locale) - Method in class org.apache.velocity.tools.generic.NumberTool
Sets the default locale for this instance.
setLocale(Locale) - Method in class org.apache.velocity.tools.view.ImportSupport.ImportResponseWrapper
Has no effect.
setMethod(String) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Sets the method name that will be used for the Javascript validation method name if it has a value.
setPage(int) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Sets the current page number of a multi-part form.
setParameter(String, String) - Method in class org.apache.velocity.tools.view.ViewToolInfo
Set/add new parameter for this tool.
setParameters(Map) - Method in class org.apache.velocity.tools.view.ViewToolInfo
Set parameter map for this tool.
setParseDepth(int) - Method in class org.apache.velocity.tools.generic.RenderTool
Set the maximum number of loops allowed when recursing.
setRelative(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Returns a copy of the link with the specified context-relative URI reference converted to a server-relative URI reference.
setRequest(ServletRequest) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
Sets the current ServletRequest
setRequestPath(String) - Method in class org.apache.velocity.tools.view.servlet.ServletToolInfo
 
setScope(String) - Method in class org.apache.velocity.tools.view.servlet.ServletToolInfo
 
setSelfAbsolute(boolean) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Controls whether or not the LinkTool.getSelf() method will return a duplicate with a URI in absolute or relative form.
setSelfIncludeParameters(boolean) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Controls whether or not the LinkTool.getSelf() method will return a duplicate that includes current request parameters.
setSlipSize(int) - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
Sets the number of result page indices for AbstractPagerTool.getSlip() to list.
setSource(Map) - Method in class org.apache.velocity.tools.generic.ValueParser
 
setSource(Map) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
Overrides ValueParser.setSource(Map source) to throw an UnsupportedOperationException, because this class uses a servlet request as its source, not a Map.
setSrc(String) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Sets the src attribute's value (used to include an external script resource) when defining the html script element.
setStatus(int) - Method in class org.apache.velocity.tools.view.ImportSupport.ImportResponseWrapper
Sets the status of the response
setStoredItems(List) - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
Stores current search items in the user's session attributes (if one currently exists) in order to do efficient result pagination.
setStoredItems(List) - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
 
setStoredResults(AbstractSearchTool.StoredResults) - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Stores current search results in the user's session attributes (if one currently exists) in order to do efficient result pagination.
setStringsDelimiter(String) - Method in class org.apache.velocity.tools.generic.ValueParser
Sets the delimiter used for separating values in a single String value.
setToolbox(Map) - Method in class org.apache.velocity.tools.view.context.ChainedContext
Sets the toolbox of view tools.
setType(String) - Method in class org.apache.velocity.tools.view.DataInfo
 
setup(HttpServletRequest) - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
Abstract method to make it as obvious as possible just where implementing classes should be retrieving and configuring display parameters.
setURI(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Returns a copy of the link with the given URI reference set.
setValue(String) - Method in class org.apache.velocity.tools.view.DataInfo
 
setVelocityEngine(VelocityEngine) - Static method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Set a VelocityEngine to handle all the log messages.
setVelocityEngine(VelocityEngine) - Method in class org.apache.velocity.tools.generic.RenderTool
Allow user to specify a VelocityEngine to be used in place of the Velocity singleton.
setVelocityEngine(VelocityEngine) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Sets the underlying VelocityEngine
setXhtml(Boolean) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Sets an application attribute to tell velocimacros and tools (especially the LinkTool) whether they should output XHTML or HTML.
setXhtml(boolean) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Controls the delimiter used for separating query data pairs.
shift() - Method in class org.apache.velocity.tools.generic.Alternator
Manually shifts the list index.
size(Object) - Method in class org.apache.velocity.tools.generic.ListTool
Gets the size of a List/array.
skip(long) - Method in class org.apache.velocity.tools.view.ImportSupport.SafeClosingHttpURLConnectionReader
 
SKIPPED_UNITS_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
The key used for specifying time units to be skipped over.
sort(Collection) - Method in class org.apache.velocity.tools.generic.SortTool
 
sort(Object[]) - Method in class org.apache.velocity.tools.generic.SortTool
 
sort(Map) - Method in class org.apache.velocity.tools.generic.SortTool
 
sort(Object, String) - Method in class org.apache.velocity.tools.generic.SortTool
Sorts the collection on a single property.
sort(Collection, List) - Method in class org.apache.velocity.tools.generic.SortTool
 
sort(Map, List) - Method in class org.apache.velocity.tools.generic.SortTool
 
sort(Object[], List) - Method in class org.apache.velocity.tools.generic.SortTool
 
SortTool - Class in org.apache.velocity.tools.generic
SortTool allows a user to sort a collection (or array, iterator, etc) on any arbitary set of properties exposed by the objects contained within the collection.
SortTool() - Constructor for class org.apache.velocity.tools.generic.SortTool
 
SortTool.PropertiesComparator - Class in org.apache.velocity.tools.generic
Does all of the comparisons
SortTool.PropertiesComparator(List) - Constructor for class org.apache.velocity.tools.generic.SortTool.PropertiesComparator
 
sql(Object) - Method in class org.apache.velocity.tools.generic.EscapeTool
Escapes the characters in a String to be suitable to pass to an SQL query.
stop() - Method in class org.apache.velocity.tools.generic.IteratorTool
Puts a condition to break out of the loop.
STORED_ITEMS_KEY - Static variable in class org.apache.velocity.tools.view.tools.AbstractPagerTool
the key under which items are stored in session
STORED_RESULTS_KEY - Static variable in class org.apache.velocity.tools.view.tools.AbstractSearchTool
the key under which StoredResults are kept in session
stripSession(String) - Static method in class org.apache.velocity.tools.view.ImportSupport
Strips a servlet session ID from url.
StrutsLinkTool - Class in org.apache.velocity.tools.struts
View tool to work with URI links in Struts.
StrutsLinkTool() - Constructor for class org.apache.velocity.tools.struts.StrutsLinkTool
 
StrutsUtils - Class in org.apache.velocity.tools.struts
A utility class to expose the Struts shared resources.
StrutsUtils() - Constructor for class org.apache.velocity.tools.struts.StrutsUtils
 
sub(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
 

T

templatePaths - Variable in class org.apache.velocity.tools.view.servlet.WebappLoader
 
TilesTool - Class in org.apache.velocity.tools.struts
View tool to use struts-tiles with Velocity.
TilesTool() - Constructor for class org.apache.velocity.tools.struts.TilesTool
Default constructor.
TIME_UNITS - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
Array of all time unit message keys to their millisecond conversion factor.
toCalendar(Object) - Method in class org.apache.velocity.tools.generic.DateTool
Converts an object to an instance of Calendar using the locale returned by DateTool.getLocale() if necessary.
toCalendar(Object, Locale) - Method in class org.apache.velocity.tools.generic.DateTool
Converts an object to an instance of Calendar using the locale returned by DateTool.getLocale() if necessary.
toDate(Object) - Method in class org.apache.velocity.tools.generic.DateTool
Converts an object to an instance of Date using the format returned by DateTool.getFormat(),the Locale returned by DateTool.getLocale(), and the TimeZone returned by DateTool.getTimeZone() if the object is not already an instance of Date, Calendar, or Long.
toDate(String, Object) - Method in class org.apache.velocity.tools.generic.DateTool
Converts an object to an instance of Date using the specified format,the Locale returned by DateTool.getLocale(), and the TimeZone returned by DateTool.getTimeZone() if the object is not already an instance of Date, Calendar, or Long.
toDate(String, Object, Locale) - Method in class org.apache.velocity.tools.generic.DateTool
Converts an object to an instance of Date using the specified format and Locale if the object is not already an instance of Date, Calendar, or Long.
toDate(String, Object, Locale, TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool
Converts an object to an instance of Date using the specified format, Locale, and TimeZone if the object is not already an instance of Date, Calendar, or Long.
toDays(long) - Static method in class org.apache.velocity.tools.generic.ComparisonDateTool
Returns the number of whole Days in the specified number of milliseconds.
toDouble(Object) - Method in class org.apache.velocity.tools.generic.MathTool
Converts an object with a numeric value into a Double Valid formats are Number or a String representation of a number
toEncoded(String, String) - Method in class org.apache.velocity.tools.struts.SecureLinkTool
Return the specified URL with the specified session identifier suitably encoded.
toHours(long) - Static method in class org.apache.velocity.tools.generic.ComparisonDateTool
Returns the number of whole Hours in the specified number of milliseconds.
toInteger(Object) - Method in class org.apache.velocity.tools.generic.MathTool
Converts an object with a numeric value into an Integer Valid formats are Number or a String representation of a number
toMinutes(long) - Static method in class org.apache.velocity.tools.generic.ComparisonDateTool
Returns the number of whole Minutes in the specified number of milliseconds.
toMonths(long) - Static method in class org.apache.velocity.tools.generic.ComparisonDateTool
Returns the number of whole Months in the specified number of milliseconds.
toNumber(Object) - Method in class org.apache.velocity.tools.generic.MathTool
Converts an object with a numeric value into a Number Valid formats are Number or a String representation of a number.
toNumber(Object) - Method in class org.apache.velocity.tools.generic.NumberTool
Converts an object to an instance of Number using the format returned by NumberTool.getFormat() and the Locale returned by NumberTool.getLocale() if the object is not already an instance of Number.
toNumber(String, Object) - Method in class org.apache.velocity.tools.generic.NumberTool
Converts an object to an instance of Number using the specified format and the Locale returned by NumberTool.getLocale() if the object is not already an instance of Number.
toNumber(String, Object, Locale) - Method in class org.apache.velocity.tools.generic.NumberTool
Converts an object to an instance of Number using the specified format and Localeif the object is not already an instance of Number.
toolbox - Variable in class org.apache.velocity.tools.view.tools.ContextTool
 
TOOLBOX_KEY - Static variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Key used to access the toolbox configuration file path from the Servlet or webapp init parameters ("org.apache.velocity.toolbox").
toolboxManager - Variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
A reference to the toolbox manager.
ToolboxManager - Interface in org.apache.velocity.tools.view
Common interface for toolbox manager implementations.
ToolboxRuleSet - Class in org.apache.velocity.tools.view
The set of Digester rules required to parse a toolbox configuration file (toolbox.xml) for the XMLToolboxManager class.
ToolboxRuleSet() - Constructor for class org.apache.velocity.tools.view.ToolboxRuleSet
 
ToolboxRuleSet.ParameterRule - Class in org.apache.velocity.tools.view
 
ToolboxRuleSet.ParameterRule() - Constructor for class org.apache.velocity.tools.view.ToolboxRuleSet.ParameterRule
 
ToolInfo - Interface in org.apache.velocity.tools.view
Interface to simplify and abstract tool handling.
toSeconds(long) - Static method in class org.apache.velocity.tools.generic.ComparisonDateTool
Returns the number of whole Seconds in the specified number of milliseconds.
toString() - Method in class org.apache.velocity.tools.generic.Alternator
Returns a string representation of the current item or null if the current item is null.
toString() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Renders this comparison to a String.
toString(long, int, int, boolean, Locale) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool
 
toString(long, int, boolean, Locale) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool
Converts the specified positive duration of milliseconds into larger units up to the specified number of positive units, beginning with the largest positive unit.
toString() - Method in class org.apache.velocity.tools.generic.DateTool
 
toString() - Method in class org.apache.velocity.tools.generic.IteratorTool
Returns this object as a String.
toString() - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
 
toString() - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
Renders the text output according to the collected key value, bundle, and arguments.
toString() - Method in class org.apache.velocity.tools.view.tools.LinkTool.QueryPair
Return the URL-encoded query string.
toString() - Method in class org.apache.velocity.tools.view.tools.LinkTool
Returns the full URI reference that's been built with this tool, including the query string and anchor, e.g.
toWeeks(long) - Static method in class org.apache.velocity.tools.generic.ComparisonDateTool
Returns the number of whole Weeks in the specified number of milliseconds.
toYears(long) - Static method in class org.apache.velocity.tools.generic.ComparisonDateTool
Returns the number of whole Years in the specified number of milliseconds.
trace(Object) - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Passes messages to Velocity's LogSystem at "DEBUG" level.
trace(Object, Throwable) - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Passes messages to Velocity's LogSystem at "DEBUG" level.
TYPE_ASCENDING_SHORT - Static variable in class org.apache.velocity.tools.generic.SortTool.PropertiesComparator
 
TYPE_BOOLEAN - Static variable in class org.apache.velocity.tools.view.DataInfo
 
TYPE_DESCENDING_SHORT - Static variable in class org.apache.velocity.tools.generic.SortTool.PropertiesComparator
 
TYPE_NUMBER - Static variable in class org.apache.velocity.tools.view.DataInfo
 
TYPE_STRING - Static variable in class org.apache.velocity.tools.view.DataInfo
 

U

uri(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Convenience method equivalent to LinkTool.setURI(java.lang.String).
url(Object) - Method in class org.apache.velocity.tools.generic.EscapeTool
Escape the characters in a String to be suitable to use as an HTTP parameter value.

V

VALID_SCHEME_CHARS - Static variable in class org.apache.velocity.tools.view.ImportSupport
 
validateToolInfo(ToolInfo) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Ensures that application-scoped tools do not have request path restrictions set for them, as those will not be enforced.
validateToolInfo(ToolInfo) - Method in class org.apache.velocity.tools.view.XMLToolboxManager
Checks whether an object described by a ToolInfo passes some basic sanity checks.
ValidatorTool - Class in org.apache.velocity.tools.struts
View tool that works with Struts Validator to produce client side javascript validation for your forms.
ValidatorTool() - Constructor for class org.apache.velocity.tools.struts.ValidatorTool
Default constructor.
ValueParser - Class in org.apache.velocity.tools.generic
Utility class for easy parsing of String values held in a Map.
ValueParser() - Constructor for class org.apache.velocity.tools.generic.ValueParser
 
ValueParser(Map) - Constructor for class org.apache.velocity.tools.generic.ValueParser
 
velocityContext - Variable in class org.apache.velocity.tools.struts.TilesTool
 
VelocityLayoutServlet - Class in org.apache.velocity.tools.view.servlet
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.servlet.VelocityLayoutServlet
 
VelocityViewServlet - Class in org.apache.velocity.tools.view.servlet
A servlet to process Velocity templates.
VelocityViewServlet() - Constructor for class org.apache.velocity.tools.view.servlet.VelocityViewServlet
 
ViewContext - Interface in org.apache.velocity.tools.view.context
Objects implementing this interface are passed to view tools upon initialization by the ServletToolboxManager.
ViewRenderTool - Class in org.apache.velocity.tools.view.tools
This tool expose methods to evaluate the given strings as VTL (Velocity Template Language) and automatically using the current context.
ViewRenderTool() - Constructor for class org.apache.velocity.tools.view.tools.ViewRenderTool
Constructs a new instance
ViewResourceTool - Class in org.apache.velocity.tools.view.tools
Tool for accessing ResourceBundles and formatting messages therein.
ViewResourceTool() - Constructor for class org.apache.velocity.tools.view.tools.ViewResourceTool
 
ViewTool - Interface in org.apache.velocity.tools.view.tools
Deprecated. Your tools now only need to have an init(Object) method.
ViewToolInfo - Class in org.apache.velocity.tools.view
ToolInfo implementation for view tools.
ViewToolInfo() - Constructor for class org.apache.velocity.tools.view.ViewToolInfo
 

W

warn(Object) - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Passes messages to Velocity's LogSystem at "WARN" level.
warn(Object, Throwable) - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Passes messages to Velocity's LogSystem at "WARN" level.
WebappLoader - Class in org.apache.velocity.tools.view.servlet
Resource loader that uses the ServletContext of a webapp to load Velocity templates.
WebappLoader() - Constructor for class org.apache.velocity.tools.view.servlet.WebappLoader
 
WEEK_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
whenIs(Object) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool
Returns a ComparisonDateTool.Comparison between the result of DateTool.getCalendar() and the specified date.
whenIs(Object, Object) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool
Returns a ComparisonDateTool.Comparison between the second specified date and the first specified date.
wrap(Object) - Method in class org.apache.velocity.tools.generic.IteratorTool
Wraps a list with the tool.

X

XHTML - Static variable in interface org.apache.velocity.tools.view.context.ViewContext
Key used for XHTML setting (tells tools and macros to output XHTML).
XHTML_QUERY_DELIMITER - Static variable in class org.apache.velocity.tools.view.tools.LinkTool
XHTML delimiter for query data ('&')
xml(Object) - Method in class org.apache.velocity.tools.generic.EscapeTool
Escapes the characters in a String using XML entities.
XMLToolboxManager - Class in org.apache.velocity.tools.view
A ToolboxManager for loading a toolbox from xml.
XMLToolboxManager() - Constructor for class org.apache.velocity.tools.view.XMLToolboxManager
Default constructor

Y

YEAR_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 

Z

ZERO_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 

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

Copyright © 2002-2009 Apache Software Foundation. All Rights Reserved.