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

A

abbr(boolean) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Sets whether or not this comparison is to be rendered in abbreviated form or not.
ABBR_SUFFIX - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
abbreviate - Variable in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
 
abs(Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
absolute(String) - Method in class org.apache.velocity.tools.view.LinkTool
Convenience method equivalent to LinkTool.setAbsolute(java.lang.String).
AbstractLockConfig - Class in org.apache.velocity.tools.generic
Implements common logic and constants for tools which by default lock down the public configure(Map) method, to keep the tool thread-safe in templates and most other common uses.
AbstractLockConfig() - Constructor for class org.apache.velocity.tools.generic.AbstractLockConfig
 
AbstractPagerTool - Class in org.apache.velocity.tools.view.tools
Deprecated. 
AbstractPagerTool() - Constructor for class org.apache.velocity.tools.view.tools.AbstractPagerTool
Deprecated.  
AbstractSearchTool - Class in org.apache.velocity.tools.view
Abstract view tool for doing "searching" and robust pagination of search results.
AbstractSearchTool() - Constructor for class org.apache.velocity.tools.view.AbstractSearchTool
 
AbstractSearchTool - Class in org.apache.velocity.tools.view.tools
Deprecated. 
AbstractSearchTool() - Constructor for class org.apache.velocity.tools.view.tools.AbstractSearchTool
Deprecated.  
AbstractSearchTool.StoredResults - Class in org.apache.velocity.tools.view
Simple utility class to hold a criterion and its result list.
AbstractSearchTool.StoredResults(Object, List) - Constructor for class org.apache.velocity.tools.view.AbstractSearchTool.StoredResults
Creates a new instance.
acquireReader(String) - Method in class org.apache.velocity.tools.view.ImportSupport
 
acquireString(String) - Method in class org.apache.velocity.tools.view.ImportSupport
 
actionComparator - Static variable in class org.apache.velocity.tools.struts.ValidatorTool
A Comparator to use when sorting ValidatorAction objects.
ActionMessagesTool - Class in org.apache.velocity.tools.struts
View tool to work with the Struts action messages.
ActionMessagesTool() - Constructor for class org.apache.velocity.tools.struts.ActionMessagesTool
 
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.CookieTool
Adds a new Cookie with the specified name and value to the HttpServletResponse.
add(String, String, Object) - Method in class org.apache.velocity.tools.view.CookieTool
Convenience method to add a new Cookie to the response and set an expiry time for it.
addChild(C) - Method in class org.apache.velocity.tools.config.CompoundConfiguration
 
addConfiguration(CompoundConfiguration<C>) - Method in class org.apache.velocity.tools.config.CompoundConfiguration
 
addConfiguration(Configuration<T>) - Method in class org.apache.velocity.tools.config.Configuration
 
addConfiguration(FactoryConfiguration) - Method in class org.apache.velocity.tools.config.FactoryConfiguration
 
addConfiguration(ToolboxConfiguration) - Method in class org.apache.velocity.tools.config.ToolboxConfiguration
 
addData(Data) - Method in class org.apache.velocity.tools.config.FactoryConfiguration
 
addData(ToolInfo) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Deprecated. 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
Deprecated.  
addDataRules(Digester) - Method in class org.apache.velocity.tools.view.ToolboxRuleSet
Deprecated. Add rules for digesting data elements.
addDefault() - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration
Adds the FactoryConfiguration.getDefault() configuration to this the current configuration.
addDefault() - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap
 
addedDefault - Variable in class org.apache.velocity.tools.config.EasyFactoryConfiguration
 
addProperties(Map<String, Object>) - Method in class org.apache.velocity.tools.ToolInfo
Adds a map of properties from a parent scope to the properties for this tool.
addProperty(Property) - Method in class org.apache.velocity.tools.config.Configuration
 
addQueryData(String, Object) - Method in class org.apache.velocity.tools.view.LinkTool
Adds a key=value pair to the query data.
addQueryData(Map) - Method in class org.apache.velocity.tools.view.LinkTool
Adds multiple key=value pairs to the query data.
addRuleInstances(Digester) - Method in class org.apache.velocity.tools.config.OldXmlFactoryConfigurationRuleSet
Deprecated.  
addRuleInstances(Digester) - Method in class org.apache.velocity.tools.config.XmlFactoryConfigurationRuleSet
Add the set of Rule instances defined in this RuleSet to the specified Digester instance, associating them with our namespace URI (if any).
addRuleInstances(Digester) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet
Deprecated. Overrides ToolboxRuleSet to add create-session rule.
addRuleInstances(Digester) - Method in class org.apache.velocity.tools.view.ToolboxRuleSet
Deprecated. Add the set of Rule instances defined in this RuleSet to the specified Digester instance, associating them with our namespace URI (if any).
addTool(ToolConfiguration) - Method in class org.apache.velocity.tools.config.ToolboxConfiguration
 
addTool(ToolInfo) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Deprecated. 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
Deprecated.  
addToolbox(ToolboxConfiguration) - Method in class org.apache.velocity.tools.config.FactoryConfiguration
 
addToolbox(Toolbox) - Method in class org.apache.velocity.tools.ToolContext
 
addToolboxes(ToolContext) - Method in class org.apache.velocity.tools.ToolManager
 
addToolboxesUnderKey(String) - Method in class org.apache.velocity.tools.view.ViewToolContext
 
addToolInfo(String, ToolInfo) - Method in class org.apache.velocity.tools.ToolboxFactory
 
addToolRules(Digester) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet
Deprecated. Overrides ToolboxRuleSet to add rule for scope element.
addToolRules(Digester) - Method in class org.apache.velocity.tools.view.ToolboxRuleSet
Deprecated. 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
Deprecated.  
alt(Object) - Method in class org.apache.velocity.tools.generic.DisplayTool
Returns a configured default value if specified value is null.
alt(Object, Object) - Method in class org.apache.velocity.tools.generic.DisplayTool
Returns the second argument if first argument specified is null.
Alternator - Class in org.apache.velocity.tools.generic
Utility class for easily alternating over values in a list.
Alternator(List) - Constructor for class org.apache.velocity.tools.generic.Alternator
Creates a new Alternator for the specified list.
Alternator(Object[]) - Constructor for class org.apache.velocity.tools.generic.Alternator
Creates a new Alternator for the specified list.
Alternator(boolean, List) - Constructor for class org.apache.velocity.tools.generic.Alternator
Creates a new Alternator for the specified list with the specified automatic shifting preference.
Alternator(boolean, Object[]) - Constructor for class org.apache.velocity.tools.generic.Alternator
Creates a new Alternator for the specified list with the specified automatic shifting preference.
AlternatorTool - Class in org.apache.velocity.tools.generic
Simple tool to provide easy in-template instantiation of Alternators from varying "list" types.
AlternatorTool() - Constructor for class org.apache.velocity.tools.generic.AlternatorTool
 
anchor - Variable in class org.apache.velocity.tools.view.LinkTool
The anchor set for this link.
anchor(String) - Method in class org.apache.velocity.tools.view.LinkTool
Convenience method equivalent to LinkTool.setAnchor(java.lang.String).
app - Variable in class org.apache.velocity.tools.struts.ValidatorTool
A reference to the ServletContext
appendAsArray(StringBuffer, String, Object[]) - Method in class org.apache.velocity.tools.view.LinkTool.QueryPair
 
appendChildren(StringBuilder, String, String) - Method in class org.apache.velocity.tools.config.CompoundConfiguration
 
appendProperties(StringBuilder) - Method in class org.apache.velocity.tools.config.Configuration
 
application - Variable in class org.apache.velocity.tools.struts.MessageResourcesTool
 
application - Variable in class org.apache.velocity.tools.ToolManager
 
application - Variable in class org.apache.velocity.tools.view.ContextTool
 
application - Variable in class org.apache.velocity.tools.view.ImportSupport
 
application - Variable in class org.apache.velocity.tools.view.LinkTool
A reference to the ServletContext
APPLICATION - Static variable in interface org.apache.velocity.tools.view.ViewContext
Key used for the servlet context object in templates.
application - Variable in class org.apache.velocity.tools.view.ViewToolContext
 
APPLICATION_SCOPE - Static variable in class org.apache.velocity.tools.struts.TilesTool
 
APPLICATION_SCOPE - Static variable in class org.apache.velocity.tools.ToolboxFactory
 
appTools - Variable in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Deprecated.  
args - Variable in class org.apache.velocity.tools.generic.ResourceTool.Key
 
args - Variable in class org.apache.velocity.tools.struts.MessageTool.TextKey
 
arrayContains(Object, Object) - Method in class org.apache.velocity.tools.generic.ListTool
Checks if an array contains a certain element.
auto - Variable in class org.apache.velocity.tools.generic.Alternator
 
auto(List) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Make an automatic Alternator from values in the specified List.
auto(Object[]) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Make an automatic Alternator from the specified object array.
auto(Object, Object) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Make an automatic Alternator from a list containing the two specified objects.
AUTO_ALTERNATE_DEFAULT_KEY - Static variable in class org.apache.velocity.tools.generic.AlternatorTool
 
autoAlternateDefault - Variable in class org.apache.velocity.tools.generic.AlternatorTool
 

B

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

C

cache - Variable in class org.apache.velocity.tools.Toolbox
 
cached - Variable in class org.apache.velocity.tools.generic.ResourceTool.Key
 
cacheData(Map<String, Object>) - Method in class org.apache.velocity.tools.Toolbox
 
cachedNext - Variable in class org.apache.velocity.tools.generic.IteratorTool
 
CATCH_EXCEPTIONS_KEY - Static variable in class org.apache.velocity.tools.ToolContext
 
catchExceptions - Variable in class org.apache.velocity.tools.generic.RenderTool
 
catchExceptions - Variable in class org.apache.velocity.tools.struts.TilesTool
Indicates if there is a MethodExceptionEventHandler present
cdata - Variable in class org.apache.velocity.tools.struts.ValidatorTool
 
ceil(Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
ChainedContext - Class in org.apache.velocity.tools.view.context
Deprecated. Use ViewToolContext instead
ChainedContext(VelocityEngine, HttpServletRequest, HttpServletResponse, ServletContext) - Constructor for class org.apache.velocity.tools.view.context.ChainedContext
Deprecated.  
ChainedContext(Context, VelocityEngine, HttpServletRequest, HttpServletResponse, ServletContext) - Constructor for class org.apache.velocity.tools.view.context.ChainedContext
Deprecated.  
children - Variable in class org.apache.velocity.tools.config.CompoundConfiguration
 
classname - Variable in class org.apache.velocity.tools.config.ToolConfiguration
 
ClassUtils - Class in org.apache.velocity.tools
Repository for common class and reflection methods.
ClassUtils() - Constructor for class org.apache.velocity.tools.ClassUtils
 
clazz - Variable in class org.apache.velocity.tools.ToolInfo
 
clazz - Variable in class org.apache.velocity.tools.view.ViewToolInfo
Deprecated.  
clean(FactoryConfiguration) - Method in class org.apache.velocity.tools.config.ConfigurationCleaner
 
clean(ToolboxConfiguration) - Method in class org.apache.velocity.tools.config.ConfigurationCleaner
 
CLEAN_CONFIGURATION_KEY - Static variable in class org.apache.velocity.tools.view.VelocityView
 
cleanProperties(Configuration) - Method in class org.apache.velocity.tools.config.ConfigurationCleaner
 
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
 
combine(Toolbox...) - Method in class org.apache.velocity.tools.Toolbox
Returns a new Toolbox that is a combination of this toolbox with one or more specified Toolboxes.
combine(Map<String, Object>...) - Method in class org.apache.velocity.tools.ToolInfo
 
CommonsLogLogSystem - Class in org.apache.velocity.tools.generic.log
Deprecated. Use CommonsLogLogChute in Velocity 1.6 instead.
CommonsLogLogSystem() - Constructor for class org.apache.velocity.tools.generic.log.CommonsLogLogSystem
Deprecated.  
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
 
CompoundConfiguration<C extends Configuration> - Class in org.apache.velocity.tools.config
 
CompoundConfiguration() - Constructor for class org.apache.velocity.tools.config.CompoundConfiguration
 
computeURL(HttpServletRequest, ServletContext, String) - Method in class org.apache.velocity.tools.struts.SecureLinkTool
Compute a hyperlink URL based on the specified action link.
config - Variable in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap
 
configLocked - Variable in class org.apache.velocity.tools.generic.AbstractLockConfig
 
Configuration<T> - Class in org.apache.velocity.tools.config
 
Configuration() - Constructor for class org.apache.velocity.tools.config.Configuration
 
ConfigurationCleaner - Class in org.apache.velocity.tools.config
 
ConfigurationCleaner() - Constructor for class org.apache.velocity.tools.config.ConfigurationCleaner
 
ConfigurationException - Exception in org.apache.velocity.tools.config
 
ConfigurationException(Data, Throwable) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
 
ConfigurationException(Data, String) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
 
ConfigurationException(Configuration, Throwable) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
 
ConfigurationException(Configuration, String) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
 
configure(Map) - Method in class org.apache.velocity.tools.generic.AbstractLockConfig
Looks for configuration values in the given params.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.AbstractLockConfig
Does the actual configuration.
configure(ValueParser) - 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(ValueParser) - Method in class org.apache.velocity.tools.generic.ConversionTool
Does the actual configuration.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.DisplayTool
Does the actual configuration.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.FormatConfig
Does the actual configuration.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.LocaleConfig
Does the actual configuration.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.RenderTool
Looks for parse depth and catch.exceptions parameters.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.ResourceTool
 
configure(Object, Map<String, Object>) - Method in class org.apache.velocity.tools.OldToolInfo
 
configure(Map) - Method in class org.apache.velocity.tools.struts.MessageResourcesTool
Initializes this tool.
configure(Map) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Initializes this tool.
configure(FactoryConfiguration) - Method in class org.apache.velocity.tools.ToolboxFactory
 
configure - Variable in class org.apache.velocity.tools.ToolInfo
 
configure(Object, Map<String, Object>) - Method in class org.apache.velocity.tools.ToolInfo
Actually performs configuration of the newly instantiated tool using the combined final set of configuration properties.
configure(FactoryConfiguration) - Method in class org.apache.velocity.tools.ToolManager
 
configure(String) - Method in class org.apache.velocity.tools.ToolManager
 
configure(Map) - Method in class org.apache.velocity.tools.view.ContextTool
Initializes this instance for the current request.
configure(Map) - Method in class org.apache.velocity.tools.view.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.
configure(ViewToolContext) - Method in class org.apache.velocity.tools.view.MultiViewsTool
 
configure(ServletConfig, VelocityEngine) - Method in class org.apache.velocity.tools.view.VelocityView
 
configure(ServletConfig, ToolboxFactory) - Method in class org.apache.velocity.tools.view.VelocityView
 
configure - Variable in class org.apache.velocity.tools.view.ViewToolInfo
Deprecated.  
CONFIGURE_METHOD_NAME - Static variable in class org.apache.velocity.tools.ToolInfo
 
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.ContextTool
Returns true if the context contains a value for the specified reference name (aka context key).
containsKey(Object) - Method in class org.apache.velocity.tools.ToolContext
 
CONTENT_TYPE_KEY - Static variable in class org.apache.velocity.tools.view.VelocityView
The HTTP content type context key.
context - Variable in class org.apache.velocity.tools.struts.ValidatorTool
A reference to the ViewContext
context - Variable in class org.apache.velocity.tools.view.ContextTool
 
context - Variable in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
context - Variable in class org.apache.velocity.tools.view.ViewRenderTool
 
CONTEXT_KEY - Static variable in class org.apache.velocity.tools.ToolContext
 
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
View tool for convenient access to ViewContext data and meta-data.
ContextTool() - Constructor for class org.apache.velocity.tools.view.ContextTool
 
ContextTool - Class in org.apache.velocity.tools.view.tools
Deprecated. 
ContextTool() - Constructor for class org.apache.velocity.tools.view.tools.ContextTool
Deprecated.  
ConversionTool - Class in org.apache.velocity.tools.generic
Utility class for easy conversion of String values to richer types.
ConversionTool() - Constructor for class org.apache.velocity.tools.generic.ConversionTool
 
ConversionUtils - Class in org.apache.velocity.tools
Utility methods for parsing or otherwise converting between types.
ConversionUtils() - Constructor for class org.apache.velocity.tools.ConversionUtils
 
convert(Object) - Method in class org.apache.velocity.tools.config.Data.DataConverter
 
convert(Object) - Method in class org.apache.velocity.tools.config.Data.ListConverter
 
convertableProperties - Variable in class org.apache.velocity.tools.config.Configuration
 
converter - Variable in class org.apache.velocity.tools.config.Data
 
converter - Variable in class org.apache.velocity.tools.config.Data.DataConverter
 
convertWith(Converter) - Method in class org.apache.velocity.tools.config.Data
This is a convenience method for those doing configuration in java.
CookieTool - Class in org.apache.velocity.tools.view
View tool for convenient cookie access and creation.
CookieTool() - Constructor for class org.apache.velocity.tools.view.CookieTool
 
CookieTool - Class in org.apache.velocity.tools.view.tools
Deprecated. 
CookieTool() - Constructor for class org.apache.velocity.tools.view.tools.CookieTool
Deprecated.  
copyWith(LinkTool.QueryPair) - Method in class org.apache.velocity.tools.view.LinkTool
For internal use.
copyWith(Map) - Method in class org.apache.velocity.tools.view.LinkTool
For internal use.
copyWith(String) - Method in class org.apache.velocity.tools.view.LinkTool
For internal use.
copyWithAnchor(String) - Method in class org.apache.velocity.tools.view.LinkTool
For internal use.
count - Static variable in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
create(Map<String, Object>) - Method in class org.apache.velocity.tools.ToolInfo
Returns a new instance of the tool.
create(String, String) - Method in class org.apache.velocity.tools.view.CookieTool
Creates a new Cookie with the specified name and value.
create(String, String, Object) - Method in class org.apache.velocity.tools.view.CookieTool
Convenience method to create a new Cookie and set an expiry time for it.
CREATE_SESSION_PROPERTY - Static variable in class org.apache.velocity.tools.view.VelocityView
 
createActionList(ValidatorResources, Form) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Get List of actions for the given Form.
createContext() - Method in class org.apache.velocity.tools.ToolManager
 
createContext(Map<String, Object>) - Method in class org.apache.velocity.tools.ToolManager
 
createContext(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityView
Creates and returns an initialized Velocity context.
createContext(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
 
createDefaultFactory() - Static method in class org.apache.velocity.tools.config.FactoryConfiguration
 
createFactory() - Method in class org.apache.velocity.tools.config.FactoryConfiguration
 
createInfo() - Method in class org.apache.velocity.tools.config.ToolConfiguration
 
createMethods(List) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Creates the JavaScript methods list from the given actions.
createSession - Variable in class org.apache.velocity.tools.view.PagerTool
 
createSession - Variable in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Deprecated.  
createSession - Variable in class org.apache.velocity.tools.view.VelocityView
 
createToolbox(String) - Method in class org.apache.velocity.tools.ToolboxFactory
 
crit - Variable in class org.apache.velocity.tools.view.AbstractSearchTool.StoredResults
 
criteria - Variable in class org.apache.velocity.tools.view.AbstractSearchTool
 
criteriaKey - Variable in class org.apache.velocity.tools.view.AbstractSearchTool
 
currency(Object) - Method in class org.apache.velocity.tools.generic.NumberTool
Convenience method equivalent to $number.format("currency", $foo).
CURRENT_PREFIX - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
CURRENT_TYPE - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 

D

Data - Class in org.apache.velocity.tools.config
 
Data() - Constructor for class org.apache.velocity.tools.config.Data
 
data - Variable in class org.apache.velocity.tools.config.FactoryConfiguration
 
data - Variable in class org.apache.velocity.tools.ToolboxFactory
 
data - Variable in class org.apache.velocity.tools.view.DataInfo
Deprecated.  
data - Variable in class org.apache.velocity.tools.view.XMLToolboxManager
Deprecated.  
Data.DataConverter - Class in org.apache.velocity.tools.config
 
Data.DataConverter() - Constructor for class org.apache.velocity.tools.config.Data.DataConverter
 
Data.ListConverter - Class in org.apache.velocity.tools.config
 
Data.ListConverter() - Constructor for class org.apache.velocity.tools.config.Data.ListConverter
 
dataClass - Variable in class org.apache.velocity.tools.config.XmlFactoryConfigurationRuleSet
 
DataInfo - Class in org.apache.velocity.tools.view
Deprecated. Use ToolInfo
DataInfo() - Constructor for class org.apache.velocity.tools.view.DataInfo
Deprecated.  
DATE_FORMAT_KEY - Static variable in class org.apache.velocity.tools.generic.ConversionTool
 
dateFormat - Variable in class org.apache.velocity.tools.generic.ConversionTool
 
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(String) - Method in class org.apache.velocity.tools.config.LogSupport
 
debug(Object) - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Passes messages to Velocity's LogChute at "DEBUG" level.
debug(Object, Throwable) - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Passes messages to Velocity's LogChute at "DEBUG" level.
DEFAULT_ALTERNATE_KEY - Static variable in class org.apache.velocity.tools.generic.DisplayTool
 
DEFAULT_BODY_CONTENT_KEY - Static variable in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
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.VelocityView
The default content type for the response
DEFAULT_CRITERIA_KEY - Static variable in class org.apache.velocity.tools.view.AbstractSearchTool
 
DEFAULT_DATE_FORMAT - Static variable in class org.apache.velocity.tools.generic.ConversionTool
 
DEFAULT_DEFAULT_LAYOUT - Static variable in class org.apache.velocity.tools.view.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.VelocityLayoutServlet
The default error template's filename.
DEFAULT_FORMAT - Static variable in class org.apache.velocity.tools.generic.FormatConfig
The default format to be used when none is specified.
DEFAULT_FORMAT_KEY - Static variable in class org.apache.velocity.tools.generic.DateTool
Deprecated. 
DEFAULT_FORMAT_KEY - Static variable in class org.apache.velocity.tools.generic.NumberTool
Deprecated. 
DEFAULT_INDEX_KEY - Static variable in class org.apache.velocity.tools.view.PagerTool
 
DEFAULT_ITEMS_PER_PAGE - Static variable in class org.apache.velocity.tools.view.PagerTool
the default number of items shown per page
DEFAULT_ITEMS_PER_PAGE_KEY - Static variable in class org.apache.velocity.tools.view.PagerTool
 
DEFAULT_LANGUAGE_KEY - Static variable in class org.apache.velocity.tools.view.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.VelocityLayoutServlet
The default layout directory
DEFAULT_LOCALE - Static variable in class org.apache.velocity.tools.generic.LocaleConfig
The default Locale to be used when none is specified.
DEFAULT_LOCALE_KEY - Static variable in class org.apache.velocity.tools.generic.DateTool
Deprecated. 
DEFAULT_LOCALE_KEY - Static variable in class org.apache.velocity.tools.generic.NumberTool
Deprecated. 
DEFAULT_LOG_NAME - Static variable in class org.apache.velocity.tools.generic.log.CommonsLogLogSystem
Deprecated. Default name for the commons-logging instance
DEFAULT_NAME - Static variable in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
DEFAULT_NEW_ITEMS_KEY - Static variable in class org.apache.velocity.tools.view.PagerTool
 
DEFAULT_NUMBER_FORMAT - Static variable in class org.apache.velocity.tools.generic.ConversionTool
 
DEFAULT_OUTPUT_ENCODING - Static variable in class org.apache.velocity.tools.view.VelocityView
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_PREFIX - Static variable in class org.apache.velocity.tools.config.LogSupport
 
DEFAULT_PROPERTIES_PATH - Static variable in class org.apache.velocity.tools.view.VelocityView
Default Runtime properties.
DEFAULT_SCOPE - Static variable in class org.apache.velocity.tools.ToolboxFactory
 
DEFAULT_SLIP_SIZE - Static variable in class org.apache.velocity.tools.view.PagerTool
the default max number of page indices to list
DEFAULT_SLIP_SIZE_KEY - Static variable in class org.apache.velocity.tools.view.PagerTool
 
DEFAULT_STRINGS_DELIMITER - Static variable in class org.apache.velocity.tools.generic.ConversionTool
 
DEFAULT_TOOLBOX_KEY - Static variable in class org.apache.velocity.tools.view.VelocityView
 
DEFAULT_TOOLBOX_KEY - Static variable in interface org.apache.velocity.tools.view.ViewContext
Default key used to store toolboxes in request/session/application attributes.
DEFAULT_TOOLBOX_PATH - Static variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Deprecated. Default path is now managed by VelocityView
defaultAlternate - Variable in class org.apache.velocity.tools.generic.DisplayTool
 
defaultBundle - Variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
defaultContentType - Variable in class org.apache.velocity.tools.view.VelocityView
 
defaultDelim - Variable in class org.apache.velocity.tools.generic.DisplayTool
 
defaultFinalDelim - Variable in class org.apache.velocity.tools.generic.DisplayTool
 
DefaultKey - Annotation Type in org.apache.velocity.tools.config
Annotation specifying the default key to use for a tool class in the case none was specified.
defaultLanguage - Variable in class org.apache.velocity.tools.view.MultiViewsTool
The two character abbreviation for the request's default language.
defaultLayout - Variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
 
defaultMaxLength - Variable in class org.apache.velocity.tools.generic.DisplayTool
 
defaultSuffix - Variable in class org.apache.velocity.tools.generic.DisplayTool
 
DEPRECATED_TOOLS_KEY - Static variable in class org.apache.velocity.tools.view.VelocityView
Deprecated. 
DEPRECATED_USER_TOOLS_PATH - Static variable in class org.apache.velocity.tools.view.VelocityView
Deprecated. 
deprecationSupportMode - Variable in class org.apache.velocity.tools.view.VelocityView
 
depth(int) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Set the maximum number of units to render for this comparison.
depth - Variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
DEPTH_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
The key used for specifying a different default depth via toolbox params.
DIFF_TYPE - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
difference(Object, Object) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool
Returns a ComparisonDateTool.Comparison between the result of the second specified date and the first specified date.
digForDependencies(Class) - Method in class org.apache.velocity.tools.config.ToolConfiguration
 
DisplayTool - Class in org.apache.velocity.tools.generic
Provides general utility methods for controlling the display of references.
DisplayTool() - Constructor for class org.apache.velocity.tools.generic.DisplayTool
 
div(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
doEndTag() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.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.VelocityViewServlet
Handle a POST request - calls doRequest()
doRequest(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
Handles with both GET and POST requests
doStartTag() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
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.LinkTool
This is just to avoid duplicating this code for both copyWith() methods

E

EasyFactoryConfiguration - Class in org.apache.velocity.tools.config
FactoryConfiguration subclass that simplifies the process of configuration a ToolboxFactory in Java without the use of an xml or properties configuration file.
EasyFactoryConfiguration() - Constructor for class org.apache.velocity.tools.config.EasyFactoryConfiguration
 
EasyFactoryConfiguration(boolean) - Constructor for class org.apache.velocity.tools.config.EasyFactoryConfiguration
 
EasyFactoryConfiguration.EasyWrap<C extends Configuration> - Class in org.apache.velocity.tools.config
 
EasyFactoryConfiguration.EasyWrap(C, Configuration) - Constructor for class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap
 
enabled - Variable in class org.apache.velocity.tools.view.ServletLogChute
Deprecated.  
encodeURL(String) - Method in class org.apache.velocity.tools.view.LinkTool
Delegates encoding of the specified url to URLEncoder.encode(java.lang.String) using the character encoding for the current HttpServletResponse.
end() - Method in class org.apache.velocity.tools.config.OldXmlFactoryConfigurationRuleSet.SetNextDataRule
Deprecated.  
engine - Variable in class org.apache.velocity.tools.generic.RenderTool
 
engine - Variable in class org.apache.velocity.tools.ToolManager
 
engine - Variable in class org.apache.velocity.tools.view.MultiViewsTool
 
ENGINE_KEY - Static variable in class org.apache.velocity.tools.ToolContext
 
EQUAL_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
equals(Object, Object) - Method in class org.apache.velocity.tools.generic.ListTool
Check if two objects are equal.
error(Object) - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Passes messages to Velocity's LogChute at "ERROR" level.
error(Object, Throwable) - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Passes messages to Velocity's LogChute at "ERROR" level.
error(HttpServletRequest, HttpServletResponse, Throwable) - Method in class org.apache.velocity.tools.view.VelocityLayoutServlet
Overrides VelocityViewServlet to display user's custom error template
error(HttpServletRequest, HttpServletResponse, Throwable) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
Invoked when there is an error thrown in any part of doRequest() processing.
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.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.ViewRenderTool
Evaluates a String containing VTL using the current context, and returns the result as a String.
exactPath - Variable in class org.apache.velocity.tools.view.servlet.ServletToolInfo
Deprecated.  
executeQuery(Object) - Method in class org.apache.velocity.tools.view.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

factory - Variable in class org.apache.velocity.tools.ToolManager
 
FactoryConfiguration - Class in org.apache.velocity.tools.config
//TODO: add ability to log all this stuff
FactoryConfiguration() - Constructor for class org.apache.velocity.tools.config.FactoryConfiguration
 
fatal(Object) - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Passes messages to Velocity's LogChute at "ERROR" level.
fatal(Object, Throwable) - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Passes messages to Velocity's LogChute at "ERROR" level.
FileFactoryConfiguration - Class in org.apache.velocity.tools.config
Provides support for reading a configuration file from a specified path, This frees the user from having to obtain an InputStream themselves.
FileFactoryConfiguration() - Constructor for class org.apache.velocity.tools.config.FileFactoryConfiguration
 
fillContext(Context, HttpServletRequest) - Method in class org.apache.velocity.tools.view.VelocityLayoutServlet
Overrides VelocityViewServlet to check the request for an alternate layout
fillContext(Context, HttpServletRequest) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
 
findDeclaredMethod(Class, String, Class[]) - Static method in class org.apache.velocity.tools.ClassUtils
 
findInitParameter(String, ServletConfig) - Method in class org.apache.velocity.tools.view.VelocityView
 
findInitParameter(ServletConfig, String) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
Looks up an init parameter with the specified key in either the ServletConfig or, failing that, in the ServletContext.
findLocalizedResource(String, Locale) - Method in class org.apache.velocity.tools.view.MultiViewsTool
Calls MultiViewsTool.findLocalizedResource(String, String) using the language extracted from locale.
findLocalizedResource(String) - Method in class org.apache.velocity.tools.view.MultiViewsTool
Calls MultiViewsTool.findLocalizedResource(String, String) using the default language.
findLocalizedResource(String, String) - Method in class org.apache.velocity.tools.view.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.
findMatchingChild(C) - Method in class org.apache.velocity.tools.config.CompoundConfiguration
 
findMatchingChild(ToolboxConfiguration) - Method in class org.apache.velocity.tools.config.FactoryConfiguration
 
findMatchingChild(ToolConfiguration) - Method in class org.apache.velocity.tools.config.ToolboxConfiguration
 
findMethod(Class, String, Class[]) - Static method in class org.apache.velocity.tools.ClassUtils
 
findTool(String) - Method in class org.apache.velocity.tools.ToolContext
 
findTool(String, ServletContext) - Static method in class org.apache.velocity.tools.view.ServletUtils
 
findTool(String, String, ServletContext) - Static method in class org.apache.velocity.tools.view.ServletUtils
 
findTool(String, HttpServletRequest) - Static method in class org.apache.velocity.tools.view.ServletUtils
 
findTool(String, String, HttpServletRequest) - Static method in class org.apache.velocity.tools.view.ServletUtils
 
findTool(String, HttpServletRequest, ServletContext) - Static method in class org.apache.velocity.tools.view.ServletUtils
 
findTool(String, String, HttpServletRequest, ServletContext) - Static method in class org.apache.velocity.tools.view.ServletUtils
 
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 FormatConfig.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 LocaleConfig.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(Collection, String, String) - Method in class org.apache.velocity.tools.generic.DisplayTool
Does the actual formatting of the collection.
format - Variable in class org.apache.velocity.tools.generic.FormatConfig
 
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 FormatConfig.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 LocaleConfig.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.
FORMAT_KEY - Static variable in class org.apache.velocity.tools.generic.FormatConfig
The key used for specifying a default format via tool configuration.
FormatConfig - Class in org.apache.velocity.tools.generic
Implements common logic and constants for tools which allow their default format to be configured.
FormatConfig() - Constructor for class org.apache.velocity.tools.generic.FormatConfig
 
formName - Variable in class org.apache.velocity.tools.struts.ValidatorTool
 
FormTool - Class in org.apache.velocity.tools.struts
View tool to work with HTML forms in Struts.
FormTool() - Constructor for class org.apache.velocity.tools.struts.FormTool
Default constructor.

G

geckoMajorVersion - Variable in class org.apache.velocity.tools.view.BrowserTool
 
geckoMinorVersion - Variable in class org.apache.velocity.tools.view.BrowserTool
 
geckoVersion - Variable in class org.apache.velocity.tools.view.BrowserTool
 
GENERIC_CONFIGURATION_PATH - Static variable in class org.apache.velocity.tools.config.FactoryConfiguration
 
get(String) - Method in class org.apache.velocity.tools.generic.DateTool
Returns a formatted string representing the date returned by DateTool.getDate().
get(String, String) - Method in class org.apache.velocity.tools.generic.DateTool
Returns a formatted string representing the date and/or time given by DateTool.getDate() in standard, localized patterns.
get(Object, int) - Method in class org.apache.velocity.tools.generic.ListTool
Gets the specified element of a List/array.
get(String) - Method in class org.apache.velocity.tools.generic.ResourceTool
 
get(String, String, Locale) - Method in class org.apache.velocity.tools.generic.ResourceTool
Returns the value for the specified key in the ResourceBundle for the specified basename and locale.
get(String, String[], Locale) - Method in class org.apache.velocity.tools.generic.ResourceTool
Retrieve a resource for the specified key from the first of the specified bundles in which a matching resource is found.
get(String) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
 
get(String) - Method in class org.apache.velocity.tools.generic.ValueParser
Convenience method for use in Velocity templates.
get(String) - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns the set of localized action messages as an java.util.List of strings for all actionMsgs queued of the specified category or null if no messages are queued for the specified category.
get(String, String) - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns the set of localized action messages as a java.util.List of strings for all action messages queued of the specified category or null if no action messages are queued for the specified category.
get(String) - Method in class org.apache.velocity.tools.struts.MessageTool
Looks up and returns the localized message for the specified key.
get(String, String) - Method in class org.apache.velocity.tools.struts.MessageTool
Looks up and returns the localized message for the specified key.
get(String, Object[]) - Method in class org.apache.velocity.tools.struts.MessageTool
Looks up and returns the localized message for the specified key.
get(String, String, Object[]) - Method in class org.apache.velocity.tools.struts.MessageTool
Looks up and returns the localized message for the specified key.
get(String, String, Object[], Locale) - Method in class org.apache.velocity.tools.struts.MessageTool
Looks up and returns the localized message for the specified key.
get(String, List) - Method in class org.apache.velocity.tools.struts.MessageTool
Same as MessageTool.get(String key, Object[] args), but takes a java.util.List instead of an array.
get(String, String, List) - Method in class org.apache.velocity.tools.struts.MessageTool
Same as MessageTool.get(String key, Object[] args), but takes a java.util.List instead of an array.
get(String, String, List, Locale) - Method in class org.apache.velocity.tools.struts.MessageTool
Looks up and returns the localized message for the specified key.
get(String) - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
Appends a period and the new key to the current key and returns a new TextKey instance with the combined result as its key.
get - Variable in class org.apache.velocity.tools.struts.StrutsLinkTool
 
get(String) - Method in class org.apache.velocity.tools.struts.StrutsLinkTool
This exists to enable a simplified syntax for using this tool in a template.
get(Object) - Method in class org.apache.velocity.tools.struts.TilesTool
A generic tiles insert function.
get(String) - Method in class org.apache.velocity.tools.Toolbox
 
get(String, String) - Method in class org.apache.velocity.tools.Toolbox
 
get(String, Map<String, Object>) - Method in class org.apache.velocity.tools.Toolbox
 
get(String, String, Map<String, Object>) - Method in class org.apache.velocity.tools.Toolbox
 
get(String) - Method in class org.apache.velocity.tools.ToolContext
 
get(String) - Method in class org.apache.velocity.tools.view.BrowserTool
 
get(Object) - Method in class org.apache.velocity.tools.view.ContextTool
Retrieves the value for the specified reference name (aka context key).
get(String) - Method in class org.apache.velocity.tools.view.CookieTool
Returns the Cookie with the specified name, if it exists.
get(String) - Method in class org.apache.velocity.tools.view.ViewToolContext
Looks up and returns the object with the specified key.
getAbbr() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
This is equivalent to calling ComparisonDateTool.Comparison.abbr(boolean abbr) with true as the argument, thus setting this comparison to be rendered in abbreviated form.
getActionConfig(HttpServletRequest, ServletContext, String) - Static method in class org.apache.velocity.tools.struts.SecureLinkTool
Finds the configuration definition for the specified action link
getActionForm(HttpServletRequest, HttpSession) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the ActionForm bean associated with this request of null if none exists.
getActionFormName(HttpServletRequest, HttpSession) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the ActionForm name associated with this request of null if none exists.
getActionMappingName(String) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Return the form action converted into an action mapping path.
getActionMappingURL(ServletContext, HttpServletRequest, String) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the form action converted into a server-relative URI reference.
getActionMessages() - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
 
getActionMessages() - Method in class org.apache.velocity.tools.struts.ErrorsTool
 
getAix() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAix1() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAix2() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAix3() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAix4() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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(Map<String, Object>) - Method in class org.apache.velocity.tools.Toolbox
 
getAll() - Method in class org.apache.velocity.tools.view.CookieTool
Expose array of Cookies for this request to the template.
getAll() - Method in class org.apache.velocity.tools.view.ParameterTool
Returns the map of all parameters available for the current request.
getAltavista() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAmaya() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAmiga() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAnchor() - Method in class org.apache.velocity.tools.view.LinkTool
Returns the anchor (internal document reference) set for this link.
getAol() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAol3() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAol4() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAol5() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAol6() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAolTV() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getApplicationClass(String) - Method in class org.apache.velocity.tools.view.ViewToolInfo
Deprecated. Return the Class object for the specified fully qualified class name, from this web application's class loader.
getApplicationToolbox() - Method in class org.apache.velocity.tools.ToolManager
 
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.jsp.JspToolContext
 
getAttribute(String) - Method in interface org.apache.velocity.tools.view.ViewContext
Searches for the named attribute in request, session (if valid), and application scope(s) in order and returns the value associated or null.
getAttribute(String) - Method in class org.apache.velocity.tools.view.ViewToolContext
Searches for the named attribute in request, session (if valid), and application scope(s) in order and returns the value associated or null.
getAudrey() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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.BrowserTool
 
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.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.BrowserTool
 
getBodyContentKey() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
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.BrowserTool
 
getCachedFile(String, String) - Method in class org.apache.velocity.tools.view.WebappResourceLoader
 
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".
getChildren() - Method in class org.apache.velocity.tools.config.CompoundConfiguration
 
getClass(String) - Static method in class org.apache.velocity.tools.ClassUtils
Return the Class object for the specified fully qualified class name, from this thread's current class loader.
getClassname() - Method in class org.apache.velocity.tools.config.ToolConfiguration
 
getClassname() - Method in class org.apache.velocity.tools.ToolInfo
 
getClassname() - Method in class org.apache.velocity.tools.view.DataInfo
Deprecated.  
getClassname() - Method in interface org.apache.velocity.tools.view.ToolInfo
Deprecated.  
getClassname() - Method in class org.apache.velocity.tools.view.ViewToolInfo
Deprecated.  
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.
getConfiguration() - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap
 
getConfiguration(String) - Method in class org.apache.velocity.tools.ToolManager
 
getConfiguration(String) - Method in class org.apache.velocity.tools.view.VelocityView
 
getConfiguration(String, boolean) - Method in class org.apache.velocity.tools.view.VelocityView
 
getConfigure() - Method in class org.apache.velocity.tools.ToolInfo
 
getContentTypeAttribute(String, String) - Static method in class org.apache.velocity.tools.view.ImportSupport
Get the value associated with a content-type attribute.
getContext(HttpServletRequest) - Method in class org.apache.velocity.tools.view.VelocityView
 
getContext(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityView
 
getContextPath() - Method in class org.apache.velocity.tools.view.LinkTool
Returns the context path that addresses this web application, e.g.
getContextURL() - Method in class org.apache.velocity.tools.view.LinkTool
Returns the URI that addresses this web application.
getConvertableProperties() - Method in class org.apache.velocity.tools.config.Configuration
 
getConvertedValue() - Method in class org.apache.velocity.tools.config.Data
 
getConverter() - Method in class org.apache.velocity.tools.config.Data.DataConverter
 
getConverter() - Method in class org.apache.velocity.tools.config.Data
 
getCreateSession() - Method in class org.apache.velocity.tools.view.PagerTool
 
getCriteria() - Method in class org.apache.velocity.tools.view.AbstractSearchTool
Return the criteria object for this request.
getCriteria() - Method in class org.apache.velocity.tools.view.AbstractSearchTool.StoredResults
 
getCriteriaKey() - Method in class org.apache.velocity.tools.view.AbstractSearchTool
 
getCss() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getCss1() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getCss2() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getCurl() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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 ($).
getData() - Method in class org.apache.velocity.tools.config.FactoryConfiguration
 
getData() - Method in class org.apache.velocity.tools.ToolboxFactory
 
getDataConverter(String) - Method in class org.apache.velocity.tools.config.Data
 
getDataInfoClass() - Method in class org.apache.velocity.tools.view.ToolboxRuleSet
Deprecated. 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) - Static method in class org.apache.velocity.tools.ConversionUtils
Returns a DateFormat instance for the specified format, Locale, and TimeZone.
getDateFormat(String, String, Locale, TimeZone) - Static method in class org.apache.velocity.tools.ConversionUtils
Returns a DateFormat instance for the specified date style, time style, Locale, and TimeZone.
getDateFormat(int, int, Locale, TimeZone) - Static method in class org.apache.velocity.tools.ConversionUtils
Returns a DateFormat instance for the specified time style, date style, Locale, and TimeZone.
getDateFormat() - Method in class org.apache.velocity.tools.generic.ConversionTool
 
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
Deprecated. 
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.BrowserTool
 
getDefault() - Static method in class org.apache.velocity.tools.config.FactoryConfiguration
Returns the "default" FactoryConfiguration.
getDefaultBundle() - Method in class org.apache.velocity.tools.generic.ResourceTool
 
getDefaultContentType() - Method in class org.apache.velocity.tools.view.VelocityView
 
getDefaultLocale() - Method in class org.apache.velocity.tools.generic.ResourceTool
Deprecated. 
getDeprecatedConfig(ServletConfig) - Method in class org.apache.velocity.tools.view.VelocityView
Deprecated. 
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.BrowserTool
 
getDom1() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getDom2() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getDotnet() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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.BrowserTool
 
getEnabledLevel() - Method in class org.apache.velocity.tools.view.ServletLogChute
Deprecated. Returns the current minimum level at which messages will be printed.
getEpiphany() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getError(ToolConfiguration.Status) - Method in class org.apache.velocity.tools.config.ToolConfiguration
 
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.
getFileInputStream(String) - Method in class org.apache.velocity.tools.ToolManager
 
getFirefox() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getFirstIndex() - Method in class org.apache.velocity.tools.view.PagerTool
Returns the index of the first item on the current page of results (as determined by the current index, items per page, and the number of items).
getFormat() - Method in class org.apache.velocity.tools.generic.FormatConfig
This returns the configured default format for this tool.
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.BrowserTool
 
getFromArray(Object, int) - Method in class org.apache.velocity.tools.generic.ListTool
Gets the specified element of an array.
getFromCache(String, String) - Method in class org.apache.velocity.tools.Toolbox
 
getFromInfo(String, String, Map<String, Object>) - Method in class org.apache.velocity.tools.Toolbox
 
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.BrowserTool
 
getGeckoMajorVersion() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getGeckoMinorVersion() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getGeckoVersion() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getGetright() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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.
getGlobalProperty(String) - Method in class org.apache.velocity.tools.ToolboxFactory
 
getGoogle() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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.BrowserTool
 
getHotjava3() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getHotjava3up() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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.BrowserTool
 
getHpux10() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getHpux9() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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.BrowserTool
 
getIceweasel() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe3() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe4() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe4up() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe5() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe55() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe55up() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe5up() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe6() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe6up() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe7() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe7up() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIndex() - Method in class org.apache.velocity.tools.view.PagerTool
Returns the current search result index.
getIndexKey() - Method in class org.apache.velocity.tools.view.PagerTool
 
getInfoseek() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getInputStream(String) - Method in class org.apache.velocity.tools.ToolManager
 
getInputStream(String, boolean) - Method in class org.apache.velocity.tools.view.VelocityView
 
getInstance(String) - Static method in class org.apache.velocity.tools.ClassUtils
 
getInstance(Object) - Method in class org.apache.velocity.tools.view.DataInfo
Deprecated. Returns the data.
getInstance(ServletContext, String) - Static method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Deprecated. ServletToolboxManager factory method.
getInstance(Object) - Method in interface org.apache.velocity.tools.view.ToolInfo
Deprecated. Returns an instance of the tool.
getInstance(Object) - Method in class org.apache.velocity.tools.view.ViewToolInfo
Deprecated. 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
 
getInvalidScopes() - Method in class org.apache.velocity.tools.config.ToolConfiguration
 
getIopener() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIrix() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIrix5() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIrix6() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getItems() - Method in class org.apache.velocity.tools.view.AbstractSearchTool
Gets the results for the given criteria either in memory or by performing a new query for them.
getItems() - Method in class org.apache.velocity.tools.view.PagerTool
Returns the item list.
getItemsPerPage() - Method in class org.apache.velocity.tools.view.PagerTool
Returns the set number of items to be displayed per page of items
getItemsPerPageKey() - Method in class org.apache.velocity.tools.view.PagerTool
 
getJava() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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.BrowserTool
 
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.config.Data
 
getKey() - Method in class org.apache.velocity.tools.config.ToolConfiguration
Returns the key set for this tool, if not null.
getKey() - Method in class org.apache.velocity.tools.ToolInfo
Accessors
getKey() - Method in class org.apache.velocity.tools.view.DataInfo
Deprecated. Accessors
getKey() - Method in interface org.apache.velocity.tools.view.ToolInfo
Deprecated.  
getKey() - Method in class org.apache.velocity.tools.view.ViewToolInfo
Deprecated. Accessors
getKeys() - Method in class org.apache.velocity.tools.Toolbox
 
getKeys() - Method in class org.apache.velocity.tools.ToolContext
 
getKeys() - Method in class org.apache.velocity.tools.view.ContextTool
Return a Set of the available reference keys in the current context.
getKonqueror() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getLastIndex() - Method in class org.apache.velocity.tools.view.PagerTool
Returns the index of the last item on the current page of results (as determined by the current index, items per page, and the number of items).
getLastModified(Resource) - Method in class org.apache.velocity.tools.view.WebappResourceLoader
Checks to see when a resource was last modified
getLinkexchange() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getLinks() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getLinux() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getList() - Method in class org.apache.velocity.tools.view.AbstractSearchTool.StoredResults
 
getLocale() - Method in class org.apache.velocity.tools.generic.LocaleConfig
This returns the configured default Locale for this tool.
getLocale(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getLocale(String, Locale) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getLocale() - Method in class org.apache.velocity.tools.struts.MessageResourcesTool
Retrieves the Locale for this request.
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
 
getLog() - Method in class org.apache.velocity.tools.config.LogSupport
 
getLog() - Method in class org.apache.velocity.tools.view.VelocityView
 
getLog() - Method in class org.apache.velocity.tools.view.VelocityViewServlet
 
getLotusnotes() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getLwp() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getLycos() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getLynx() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getMac() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getMac68k() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getMacosx() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getMacppc() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getMajorVersion() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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.BrowserTool
 
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.BrowserTool
 
getMozilla() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getMpras() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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
Deprecated. Returns a mutex (lock object) unique to the specified session to allow for reliable synchronization on the session.
getMutex(HttpSession) - Method in class org.apache.velocity.tools.view.VelocityView
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.config.Property
 
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.BrowserTool
 
getNav3() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getNav4() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getNav45() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getNav45up() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getNav4up() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getNav6() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getNav6up() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getNavgold() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getNeoplanet() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getNeoplanet2() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getNetscape() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getNewItemsKey() - Method in class org.apache.velocity.tools.view.PagerTool
 
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.PagerTool
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) - Static method in class org.apache.velocity.tools.ConversionUtils
Returns a NumberFormat instance for the specified format and Locale.
getNumberFormat(int, Locale) - Static method in class org.apache.velocity.tools.ConversionUtils
Returns a NumberFormat instance for the specified number style and Locale.
getNumberFormat() - Method in class org.apache.velocity.tools.generic.ConversionTool
 
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
Deprecated. 
getNumbers(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getNumberStyleAsInt(String) - Static method in class org.apache.velocity.tools.ConversionUtils
Checks a string to see if it matches one of the standard NumberFormat style patterns: number, currency, percent, integer, or default.
getOpera() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getOpera3() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getOpera4() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getOpera5() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getOpera6() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getOpera7() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getOpera8() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getOpera9() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getOs2() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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.PagerTool
Returns the current "page" of search items.
getPageContext() - Method in class org.apache.velocity.tools.view.jsp.JspToolContext
 
getPageDescription() - Method in class org.apache.velocity.tools.view.PagerTool
Returns a description of the current page.
getPageNumber(int) - Method in class org.apache.velocity.tools.view.PagerTool
Returns the "page number" for the specified index.
getPageNumber() - Method in class org.apache.velocity.tools.view.PagerTool
Returns the "page number" for the current index.
getPagesAvailable() - Method in class org.apache.velocity.tools.view.PagerTool
Returns the number of pages that can be made from this list given the set number of items per page.
getPalm() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getParameters() - Method in class org.apache.velocity.tools.view.ViewToolInfo
Deprecated. Get parameters for this tool.
getParams() - Method in class org.apache.velocity.tools.view.LinkTool
Convenience method equivalent to LinkTool.getQueryData().
getParent() - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap
 
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.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.PagerTool
Return the index for the previous page of items (as determined by the current index, items per page, and the number of items).
getProperties() - Method in class org.apache.velocity.tools.config.Configuration
 
getProperties() - Method in class org.apache.velocity.tools.Toolbox
 
getProperties() - Method in class org.apache.velocity.tools.ToolInfo
 
getProperties(String) - Method in class org.apache.velocity.tools.view.VelocityView
 
getProperties(String, boolean) - Method in class org.apache.velocity.tools.view.VelocityView
 
getProperty(String, String) - Method in class org.apache.velocity.tools.view.VelocityView
Simplifies process of getting a property from VelocityEngine, because the VelocityEngine interface sucks compared to the singleton's.
getProps() - Method in class org.apache.velocity.tools.ToolInfo
 
getQ() - Method in class org.apache.velocity.tools.generic.EscapeTool
Renders a double quotation mark (").
getQueryData() - Method in class org.apache.velocity.tools.view.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.BrowserTool
 
getRenderedBody() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
getRequest() - Method in class org.apache.velocity.tools.view.ParameterTool
Returns the current ServletRequest for this instance.
getRequest() - Method in interface org.apache.velocity.tools.view.ViewContext
Returns the instance of HttpServletRequest for this request.
getRequest() - Method in class org.apache.velocity.tools.view.ViewToolContext
Returns the current servlet request.
getRequestPath() - Method in class org.apache.velocity.tools.view.LinkTool
Retrieves the path for the current request regardless of whether this is a direct request or an include by the RequestDispatcher.
getRequestPath() - Method in class org.apache.velocity.tools.view.servlet.ServletToolInfo
Deprecated.  
getRequestToolbox() - Method in class org.apache.velocity.tools.ToolManager
 
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.WebappResourceLoader
Get an InputStream so that the Runtime can build a template with it.
getResponse() - Method in interface org.apache.velocity.tools.view.ViewContext
Returns the instance of HttpServletResponse for this request.
getResponse() - Method in class org.apache.velocity.tools.view.ViewToolContext
Returns the current servlet response.
getRestrictTo() - Method in class org.apache.velocity.tools.config.ToolConfiguration
 
getResults() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Deprecated. Use PagerTool.getItems().
getRobot() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getRuleSet() - Method in class org.apache.velocity.tools.config.XmlFactoryConfiguration
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.servlet.ServletToolboxManager
Deprecated. 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
Deprecated. 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.BrowserTool
 
getSco() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getScooter() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getScope() - Method in class org.apache.velocity.tools.config.ToolboxConfiguration
 
getScope() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
getScope() - Method in class org.apache.velocity.tools.view.servlet.ServletToolInfo
Deprecated.  
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.LinkTool
This method returns a new "self-referencing" LinkTool for the current request.
getServletApi(String) - Method in class org.apache.velocity.tools.view.jsp.JspToolContext
 
getServletApi(String) - Method in class org.apache.velocity.tools.view.ViewToolContext
Returns the current matching servlet request, response, session, or servlet context instance, or null if the key matches none of those keys.
getServletContext() - Method in interface org.apache.velocity.tools.view.ViewContext
Returns the instance of ServletContext for this request.
getServletContext() - Method in class org.apache.velocity.tools.view.ViewToolContext
Returns the servlet context.
getSession() - Method in class org.apache.velocity.tools.view.ViewToolContext
Returns the current session, if any.
getSimpleProperties() - Method in class org.apache.velocity.tools.config.Configuration
 
getSingleQuote() - Method in class org.apache.velocity.tools.generic.EscapeTool
Renders a single quotation mark (').
getSinix() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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.PagerTool
Returns a Sliding List of Indices for Pages of items.
getSlipSize() - Method in class org.apache.velocity.tools.view.PagerTool
Returns the number of result page indices PagerTool.getSlip() will return per request (if available).
getSlipSizeKey() - Method in class org.apache.velocity.tools.view.PagerTool
 
getSlurp() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getSource() - Method in exception org.apache.velocity.tools.config.ConfigurationException
 
getSource() - Method in class org.apache.velocity.tools.generic.ValueParser
 
getSource() - Method in class org.apache.velocity.tools.view.ParameterTool
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.BrowserTool
 
getStartElement() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Constructs the beginning
Copyright (c) 2003-2007 Apache Software Foundation