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

A

APPLICATION - Static variable in interface org.apache.velocity.tools.view.context.ViewContext
Key used for the servlet context object.
APPLICATION_SCOPE - Static variable in class org.apache.velocity.tools.struts.TilesTool
 
APPLICATION_SCOPE - Static variable in class org.apache.velocity.tools.view.servlet.ServletToolInfo
Deprecated. use ViewContext.APPLICATION
AbstractSearchTool - class org.apache.velocity.tools.view.tools.AbstractSearchTool.
Abstract view tool for doing "searching" and robust pagination of search results.
AbstractSearchTool() - Constructor for class org.apache.velocity.tools.view.tools.AbstractSearchTool
 
AbstractSearchTool.StoredResults - class org.apache.velocity.tools.view.tools.AbstractSearchTool.StoredResults.
Simple utility class to hold a criterion and its result list.
AbstractSearchTool.StoredResults(Object, List) - Constructor for class org.apache.velocity.tools.view.tools.AbstractSearchTool.StoredResults
Creates a new instance.
ActionMessagesTool - class org.apache.velocity.tools.struts.ActionMessagesTool.
View tool to work with the Struts action messages.
ActionMessagesTool() - Constructor for class org.apache.velocity.tools.struts.ActionMessagesTool
Default constructor.
abs(Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
acquireReader(String) - Method in class org.apache.velocity.tools.view.ImportSupport
 
acquireString(String) - Method in class org.apache.velocity.tools.view.ImportSupport
 
actionMsgs - Variable in class org.apache.velocity.tools.struts.ActionMessagesTool
A reference to the queued action messages.
add(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
add(String, String) - Method in class org.apache.velocity.tools.view.tools.CookieTool
Adds a new Cookie with the specified name and value to the HttpServletResponse.
add(String, String, int) - Method in class org.apache.velocity.tools.view.tools.CookieTool
Convenience method to add a new Cookie to the response and set an expiry time for it.
addDataRules(Digester) - Method in class org.apache.velocity.tools.view.ToolboxRuleSet
Add rules for digesting data elements.
addQueryData(String, Object) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Adds a key=value pair to the query data.
addRuleInstances(Digester) - Method in class org.apache.velocity.tools.view.ToolboxRuleSet
Add the set of Rule instances defined in this RuleSet to the specified Digester instance, associating them with our namespace URI (if any).
addRuleInstances(Digester) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet
Overrides ToolboxRuleSet to add create-session rule.
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
 
addTool(ToolInfo) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Overrides XMLToolboxManager to separate tools by scope.
addToolRules(Digester) - Method in class org.apache.velocity.tools.view.ToolboxRuleSet
Add rules for digesting tool elements.
addToolRules(Digester) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet
Overrides ToolboxRuleSet to add rule for scope element.
anchor - Variable in class org.apache.velocity.tools.view.tools.LinkTool
The anchor set for this link.
app - Variable in class org.apache.velocity.tools.struts.ValidatorTool
A reference to the ServletContext
appTools - Variable in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
 
appendAsArray(StringBuffer, String, Object[]) - Method in class org.apache.velocity.tools.view.tools.LinkTool.QueryPair
 
application - Variable in class org.apache.velocity.tools.struts.MessageResourcesTool
 
application - Variable in class org.apache.velocity.tools.view.ImportSupport
 
application - Variable in class org.apache.velocity.tools.view.context.ChainedContext
A local reference to the servlet context.
application - Variable in class org.apache.velocity.tools.view.tools.LinkTool
A reference to the ServletContext

B

body(String, String, String) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet.BooleanConfigRule
 
bos - Variable in class org.apache.velocity.tools.view.ImportSupport.ImportResponseWrapper
A buffer, alternatively, to accumulate bytes.

C

CONTENT_TYPE - Static variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
The HTTP content type context key.
ChainedContext - class org.apache.velocity.tools.view.context.ChainedContext.
Velocity context implementation specific to the Servlet environment.
ChainedContext(Context, HttpServletRequest, HttpServletResponse, ServletContext) - Constructor for class org.apache.velocity.tools.view.context.ChainedContext
Default constructor.
CommonsLogLogSystem - class org.apache.velocity.tools.generic.log.CommonsLogLogSystem.
Redirects Velocity's LogSystem messages to commons-logging.
CommonsLogLogSystem() - Constructor for class org.apache.velocity.tools.generic.log.CommonsLogLogSystem
 
CookieTool - class org.apache.velocity.tools.view.tools.CookieTool.
View tool for convenient cookie access and creation.
CookieTool() - Constructor for class org.apache.velocity.tools.view.tools.CookieTool
 
cachedNext - Variable in class org.apache.velocity.tools.generic.IteratorTool
 
cdata - Variable in class org.apache.velocity.tools.struts.ValidatorTool
 
ceil(Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
clazz - Variable in class org.apache.velocity.tools.view.ViewToolInfo
 
compare(Object, Object) - Method in class org.apache.velocity.tools.struts.ValidatorTool.ValidatorActionComparator
 
computeURL(HttpServletRequest, ServletContext, String) - Method in class org.apache.velocity.tools.struts.SecureLinkTool
Compute a hyperlink URL based on the specified action link.
context - Variable in class org.apache.velocity.tools.struts.ValidatorTool
A reference to the ViewContext
context - Variable in class org.apache.velocity.tools.view.tools.ViewRenderTool
 
contextStack - Variable in class org.apache.velocity.tools.struts.TilesTool
A stack to hold ComponentContexts while nested tile-definitions are rendered.
copyWith(LinkTool.QueryPair) - Method in class org.apache.velocity.tools.view.tools.LinkTool
For internal use.
copyWith(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
For internal use.
copyWithAnchor(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
For internal use.
createActionList(ValidatorResources, Form) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Get List of actions for the given Form.
createContext(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
Overrides VelocityViewServlet to check the request for an alternate layout
createContext(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Creates and returns an initialized Velocity context.
createMethods(List) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Creates the JavaScript methods list from the given actions.
createSession - Variable in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
 
crit - Variable in class org.apache.velocity.tools.view.tools.AbstractSearchTool.StoredResults
 
criteria - Variable in class org.apache.velocity.tools.view.tools.AbstractSearchTool
 

D

DEFAULT_CONTENT_TYPE - Static variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
The default content type for the response
DEFAULT_DEFAULT_LAYOUT - Static variable in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
The default filename for the servlet's default layout
DEFAULT_ENCODING - Static variable in class org.apache.velocity.tools.view.ImportSupport
Default character encoding for response.
DEFAULT_ERROR_TEMPLATE - Static variable in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
The default error template's filename.
DEFAULT_FORMAT - Static variable in class org.apache.velocity.tools.generic.DateTool
The default format to be used when none is specified.
DEFAULT_FORMAT - Static variable in class org.apache.velocity.tools.generic.NumberTool
The default format to be used when none is specified.
DEFAULT_ITEMS_PER_PAGE - Static variable in class org.apache.velocity.tools.view.tools.AbstractSearchTool
the default number of results shown per page
DEFAULT_LANGUAGE_KEY - Static variable in class org.apache.velocity.tools.view.i18n.MultiViewsTool
The key used to search initialization, context, and JVM parameters for the default language to use.
DEFAULT_LAYOUT_DIR - Static variable in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
The default layout directory
DEFAULT_LOG_NAME - Static variable in class org.apache.velocity.tools.generic.log.CommonsLogLogSystem
Default name for the commons-logging instance
DEFAULT_OUTPUT_ENCODING - Static variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Default encoding for the output stream
DEFAULT_SLIP_SIZE - Static variable in class org.apache.velocity.tools.view.tools.AbstractSearchTool
the default max number of result page indices to list
DataInfo - class org.apache.velocity.tools.view.DataInfo.
ToolInfo implementation to handle "primitive" data types.
DataInfo() - Constructor for class org.apache.velocity.tools.view.DataInfo
 
DateTool - class org.apache.velocity.tools.generic.DateTool.
Tool for working with Date and Calendar in Velocity templates.
DateTool() - Constructor for class org.apache.velocity.tools.generic.DateTool
Default constructor.
data - Variable in class org.apache.velocity.tools.view.DataInfo
 
debug(Object) - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Passes messages to Velocity's LogSystem at "DEBUG" level.
debug(Object, Throwable) - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Passes messages to Velocity's LogSystem at "DEBUG" level.
defaultContentType - Variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
The default content type.
defaultLanguage - Variable in class org.apache.velocity.tools.view.i18n.MultiViewsTool
The two character abbreviation for the request's default language.
defaultLayout - Variable in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
 
div(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Handles GET - calls doRequest()
doInsert(String, String, Controller) - Method in class org.apache.velocity.tools.struts.TilesTool
Use this if there is no nested tile.
doInsert(Map, String, String, Controller) - Method in class org.apache.velocity.tools.struts.TilesTool
Use this if there is a nested tile.
doInsert(ComponentContext, String, String, Controller) - Method in class org.apache.velocity.tools.struts.TilesTool
An extension of the other two doInsert functions
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Handle a POST request - calls doRequest()
doRequest(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Handles with both GET and POST requests
duplicate() - Method in class org.apache.velocity.tools.view.tools.LinkTool
This is just to avoid duplicating this code for both copyWith() methods

E

ErrorsTool - class org.apache.velocity.tools.struts.ErrorsTool.
View tool to work with the Struts error messages.
ErrorsTool() - Constructor for class org.apache.velocity.tools.struts.ErrorsTool
 
encode - Static variable in class org.apache.velocity.tools.view.tools.LinkTool
Java 1.4 encode method to use instead of deprecated 1.3 version.
encodeURL(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Use the new URLEncoder.encode() method from java 1.4 if available, else use the old deprecated version.
error(Object) - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Passes messages to Velocity's LogSystem at "ERROR" level.
error(Object, Throwable) - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Passes messages to Velocity's LogSystem at "ERROR" level.
error(HttpServletRequest, HttpServletResponse, Exception) - Method in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
Overrides VelocityViewServlet to display user's custom error template
error(HttpServletRequest, HttpServletResponse, Exception) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Invoked when there is an error thrown in any part of doRequest() processing.
errorMarkup(String, HttpServletRequest, HttpSession, ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns a formatted error message.
errorMarkup(String, String, HttpServletRequest, HttpSession, ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns a formatted error message.
errorTemplate - Variable in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
 
eval(Context, String) - Method in class org.apache.velocity.tools.generic.RenderTool
Evaluates a String containing VTL using the current context, and returns the result as a String.
eval(String) - Method in class org.apache.velocity.tools.view.tools.ViewRenderTool
Evaluates a String containing VTL using the current context, and returns the result as a String.
executeQuery(Object) - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Executes a query for the specified criteria.
exist() - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns true if there are action messages queued, otherwise false.
exist(String) - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns true if there are action messages queued for the specified category of messages, otherwise false.
exists(String) - Method in class org.apache.velocity.tools.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(String) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
Convenience method for checking whether a certain parameter exists.

F

FormTool - class org.apache.velocity.tools.struts.FormTool.
View tool to work with HTML forms in Struts.
FormTool() - Constructor for class org.apache.velocity.tools.struts.FormTool
Default constructor.
fatal(Object) - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Passes messages to Velocity's LogSystem at "ERROR" level.
fatal(Object, Throwable) - Method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Passes messages to Velocity's LogSystem at "ERROR" level.
findLocalizedResource(String, Locale) - Method in class org.apache.velocity.tools.view.i18n.MultiViewsTool
Calls MultiViewsTool.findLocalizedResource(String, String) using the language extracted from locale.
findLocalizedResource(String) - Method in class org.apache.velocity.tools.view.i18n.MultiViewsTool
Calls MultiViewsTool.findLocalizedResource(String, String) using the default language.
findLocalizedResource(String, String) - Method in class org.apache.velocity.tools.view.i18n.MultiViewsTool
Finds the a localized version of the requested Velocity resource (such as a file or template) which is most appropriate for the locale of the current request.
floor(Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
formName - Variable in class org.apache.velocity.tools.struts.ValidatorTool
 
format(Object) - Method in class org.apache.velocity.tools.generic.DateTool
Converts the specified object to a date and formats it according to the pattern or style returned by DateTool.getFormat().
format(String, Object) - Method in class org.apache.velocity.tools.generic.DateTool
Converts the specified object to a date and returns a formatted string representing that date in the locale returned by DateTool.getLocale().
format(String, Object, Locale) - Method in class org.apache.velocity.tools.generic.DateTool
Converts the specified object to a date and returns a formatted string representing that date in the specified Locale.
format(String, Object, Locale, TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool
Returns a formatted string representing the specified date, Locale, and TimeZone.
format(String, String, Object) - Method in class org.apache.velocity.tools.generic.DateTool
Returns the specified date as a string formatted according to the specified date and/or time styles.
format(String, String, Object, Locale) - Method in class org.apache.velocity.tools.generic.DateTool
Returns the specified date as a string formatted according to the specified Locale and date and/or time styles.
format(String, String, Object, Locale, TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool
Returns the specified date as a string formatted according to the specified Locale and date and/or time styles.
format(Object) - Method in class org.apache.velocity.tools.generic.NumberTool
Converts the specified object to a number and formats it according to the pattern or style returned by NumberTool.getFormat().
format(String, Object) - Method in class org.apache.velocity.tools.generic.NumberTool
Converts the specified object to a number and returns a formatted string representing that number in the locale returned by NumberTool.getLocale().
format(String, Object, Locale) - Method in class org.apache.velocity.tools.generic.NumberTool
Converts the specified object to a number and returns a formatted string representing that number in the specified Locale.

G

get(String) - Method in class org.apache.velocity.tools.generic.DateTool
Returns a formatted string representing the date returned by DateTool.getDate().
get(String, String) - Method in class org.apache.velocity.tools.generic.DateTool
Returns a formatted string representing the date and/or time given by DateTool.getDate() in standard, localized patterns.
get(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, 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(Object) - Method in class org.apache.velocity.tools.struts.TilesTool
A generic tiles insert function.
get(String) - Method in class org.apache.velocity.tools.view.tools.CookieTool
Returns the Cookie with the specified name, if it exists.
get(String) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
Convenience method for use in Velocity templates.
getActionConfig(HttpServletRequest, ServletContext, String) - Static method in class org.apache.velocity.tools.struts.SecureLinkTool
Finds the configuration definition for the specified action link
getActionErrors(HttpServletRequest) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Deprecated. use StrutsUtils.getErrors(HttpServletRequest request).
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.
getActionFormBeans(ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Deprecated. This will be removed in VelocityTools 1.2
getActionForward(String, ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Deprecated. This will be removed in VelocityTools 1.2
getActionForwards(ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Deprecated. This will be removed in VelocityTools 1.2
getActionMapping(String, ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Deprecated. This will be removed in VelocityTools 1.2
getActionMappingName(String) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Deprecated. This will be removed in VelocityTools 1.2
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.
getActionMappings(ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Deprecated. This will be removed in VelocityTools 1.2
getActionMessages(HttpServletRequest) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Deprecated. use StrutsUtils.getMessages(HttpServletRequest request).
getAll() - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns the set of localized action messages as an java.util.List of strings for all actionMsgs queued or null if no messages are queued.
getAll(String) - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns a List of all queued action messages using the specified message resource bundle.
getAll() - Method in class org.apache.velocity.tools.view.tools.CookieTool
Expose array of Cookies for this request to the template.
getAnchor() - Method in class org.apache.velocity.tools.view.tools.LinkTool
Returns the anchor (internal document reference) set for this link.
getApplicationClass(String) - Method in class org.apache.velocity.tools.view.ViewToolInfo
Return the Class object for the specified fully qualified class name, from this web application's class loader.
getAttribute(String) - Method in class org.apache.velocity.tools.struts.TilesTool
Fetches a named attribute-value from the current tiles-context.
getAttribute(String) - Method in class org.apache.velocity.tools.view.context.ChainedContext
Searches for the named attribute in request, session (if valid), and application scope(s) in order and returns the value associated or null.
getAttribute(String) - Method in interface org.apache.velocity.tools.view.context.ViewContext
Searches for the named attribute in request, session (if valid), and application scope(s) in order and returns the value associated or null.
getBaseRef() - Method in class org.apache.velocity.tools.view.tools.LinkTool
Returns the full URI of this template without any query data.
getBean() - Method in class org.apache.velocity.tools.struts.FormTool
Returns the form bean associated with this action mapping.
getBoolean(String) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
 
getBoolean(String, boolean) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
 
getBoolean(String, Boolean) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
 
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.
getCancelName() - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Deprecated. This will be removed in VelocityTools 1.2
getCdata() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Returns the cdata setting "true" or "false".
getClassname() - Method in class org.apache.velocity.tools.view.DataInfo
 
getClassname() - Method in interface org.apache.velocity.tools.view.ToolInfo
 
getClassname() - Method in class org.apache.velocity.tools.view.ViewToolInfo
 
getContentTypeAttribute(String, String) - Static method in class org.apache.velocity.tools.view.ImportSupport
Get the value associated with a content-type attribute.
getContextPath() - Method in class org.apache.velocity.tools.view.tools.LinkTool
Returns the context path that addresses this web application, e.g.
getContextURL() - Method in class org.apache.velocity.tools.view.tools.LinkTool
Returns the URI that addresses this web application.
getCriteria() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool.StoredResults
 
getCriteria() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Return the criteria object for this request.
getCurrentContext() - Method in class org.apache.velocity.tools.struts.TilesTool
Retrieve the current tiles component context.
getDataInfoClass() - Method in class org.apache.velocity.tools.view.ToolboxRuleSet
Return the bean class to be created for data elements.
getDataSource(ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Deprecated. This will be removed in VelocityTools 1.2
getDate() - Method in class org.apache.velocity.tools.generic.DateTool
Returns a Date derived from the result of DateTool.getCalendar()
getDateFormat(String, Locale, TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool
Returns a DateFormat instance for the specified format, Locale, and TimeZone.
getDateFormat(String, String, Locale, TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool
Returns a DateFormat instance for the specified date style, time style, Locale, and TimeZone.
getDateFormat(int, int, Locale, TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool
Returns a DateFormat instance for the specified time style, date style, Locale, and TimeZone.
getDouble(String, double) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
 
getDoubles(String) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
 
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.
getErrors(HttpServletRequest) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the Struts errors for this request or null if none exist.
getException(HttpServletRequest) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Deprecated. This will be removed in VelocityTools 1.2
getFormBean(String, ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Deprecated. This will be removed in VelocityTools 1.2
getFormat() - Method in class org.apache.velocity.tools.generic.DateTool
Return the pattern or style to be used for formatting dates when none is specified.
getFormat() - Method in class org.apache.velocity.tools.generic.NumberTool
Return the pattern or style to be used for formatting numbers when none is specified.
getFormattedDate(String) - Method in class org.apache.velocity.tools.generic.DateTool
Deprecated. use DateTool.get(String format) instead. This will be removed in VelocityTools 1.2
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.
getGlobal() - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
This a convenience method and the equivalent of $messages.get($messages.globalName).
getGlobalErrorName() - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Deprecated. This will be removed in VelocityTools 1.2
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.
getGlobalName() - Method in class org.apache.velocity.tools.struts.ErrorsTool
Deprecated. This will be removed after VelocityTools 1.1.
getHtmlComment() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Gets whether or not to delimit the JavaScript with html comments.
getIndex() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Return the current search result index.
getInstance(Object) - Method in class org.apache.velocity.tools.view.DataInfo
Returns the data.
getInstance(Object) - Method in interface org.apache.velocity.tools.view.ToolInfo
Returns an instance of the tool.
getInstance(Object) - Method in class org.apache.velocity.tools.view.ViewToolInfo
Returns a new instance of the tool.
getInstance(ServletContext, String) - Static method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
ServletToolboxManager factory method.
getInt(String, int) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
 
getIntegerInstance(Locale) - Method in class org.apache.velocity.tools.generic.NumberTool
Since we wish to continue supporting Java 1.3, for the present we cannot use Java 1.4's NumberFormat.getIntegerInstance(Locale) method.
getInts(String) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
 
getItemsPerPage() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Return the set number of items to be displayed per page of results
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.
getJavascriptBegin(String) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Returns the opening script element and some initial javascript.
getJavascriptEnd() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Returns the closing script element.
getJavascriptStaticMethods(ValidatorResources) - Method in class org.apache.velocity.tools.struts.ValidatorTool
 
getKey() - Method in class org.apache.velocity.tools.view.DataInfo
Accessors
getKey() - Method in interface org.apache.velocity.tools.view.ToolInfo
 
getKey() - Method in class org.apache.velocity.tools.view.ViewToolInfo
Accessors
getLastModified(Resource) - Method in class org.apache.velocity.tools.view.servlet.WebappLoader
Defaults to return 0
getList() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool.StoredResults
 
getLocale() - Method in class org.apache.velocity.tools.generic.DateTool
This implementation returns the default locale.
getLocale() - Method in class org.apache.velocity.tools.generic.NumberTool
This implementation returns the default locale.
getLocale() - Method in class org.apache.velocity.tools.struts.MessageTool
Deprecated. This does not fit the purpose of MessageTool and will be removed in VelocityTools 1.2
getLocale(HttpServletRequest, HttpSession) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the java.util.Locale for the user.
getMessageResources(ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Deprecated. This will be removed in VelocityTools 1.2
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.
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.
getMultipartRequestWrapper(HttpServletRequest) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Deprecated. This will be removed in VelocityTools 1.2
getMutex(HttpSession) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Returns a mutex (lock object) unique to the specified session to allow for reliable synchronization on the session.
getNextIndex() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Return the index for the next page of results (as determined by the current index, items per page, and the number of results).
getNextVar(String) - Method in class org.apache.velocity.tools.struts.ValidatorTool
The value null will be returned at the end of the sequence.
getNumber(String) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
 
getNumber(String, Number) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
 
getNumberFormat(String, Locale) - Method in class org.apache.velocity.tools.generic.NumberTool
Returns a NumberFormat instance for the specified format and Locale.
getNumberFormat(int, Locale) - Method in class org.apache.velocity.tools.generic.NumberTool
Returns a NumberFormat instance for the specified number style and Locale.
getNumbers(String) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
 
getOutputStream() - Method in class org.apache.velocity.tools.view.ImportSupport.ImportResponseWrapper
 
getPage() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Gets the current page number of a multi-part form.
getPage() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Return the current "page" of search results.
getPageDescription() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Returns a description of the current page.
getPageNumber(int) - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Returns the "page number" for the specified index.
getPageNumber() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Returns the "page number" for the current index.
getPagesAvailable() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Return the number of pages that can be made from this list given the set number of items per page.
getPrevIndex() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Return the index for the previous page of results (as determined by the current index, items per page, and the number of results).
getQueryData() - Method in class org.apache.velocity.tools.view.tools.LinkTool
Returns this link's query data as a url-encoded string e.g.
getRandom() - Method in class org.apache.velocity.tools.generic.MathTool
 
getRequest() - Method in class org.apache.velocity.tools.view.context.ChainedContext
Returns the current servlet request.
getRequest() - Method in interface org.apache.velocity.tools.view.context.ViewContext
Returns the instance of HttpServletRequest for this request.
getRequest() - Method in class org.apache.velocity.tools.view.tools.ParameterParser
Returns the current ServletRequest for this instance.
getResourceStream(String) - Method in class org.apache.velocity.tools.view.servlet.WebappLoader
Get an InputStream so that the Runtime can build a template with it.
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.
getResponse() - Method in class org.apache.velocity.tools.view.context.ChainedContext
Returns the current servlet response.
getResponse() - Method in interface org.apache.velocity.tools.view.context.ViewContext
Returns the instance of HttpServletResponse for this request.
getResponseWriter(HttpServletResponse) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Procure a Writer with correct encoding which can be used even if HttpServletResponse's getOutputStream() method has already been called.
getResults() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Return the results for the given criteria.
getRuleSet() - Method in class org.apache.velocity.tools.view.XMLToolboxManager
For subclassing convienence.
getRuleSet() - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
For subclassing convienence.
getScope() - Method in class org.apache.velocity.tools.view.servlet.ServletToolInfo
 
getServletContext() - Method in class org.apache.velocity.tools.view.context.ChainedContext
Returns the servlet context.
getServletContext() - Method in interface org.apache.velocity.tools.view.context.ViewContext
Returns the instance of ServletContext for this request.
getServletMapping(ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Deprecated. This will be removed in VelocityTools 1.2
getSize() - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns the number of action messages queued.
getSize(String) - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns the number of action messages queued for a particular property.
getSlip() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Return a Sliding List of Indices for Pages of search results.
getSlipSize() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Returns the number of result page indices AbstractSearchTool.getSlip() will return per request (if available).
getSrc() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Gets the src attribute's value when defining the html script element.
getStartElement() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Constructs the beginning
Copyright (c) 2003 Apache Software Foundation