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

A

abs(Object) - Static method in class org.apache.velocity.tools.generic.MathTool
 
AbstractSearchTool - class org.apache.velocity.tools.view.tools.AbstractSearchTool.
Abstract context tool for doing "searching" and robust pagination of search results.
AbstractSearchTool.StoredResults - class org.apache.velocity.tools.view.tools.AbstractSearchTool.StoredResults.
Simple utility class to hold a criteria and its result list

This class is by default stored in a user's session, so it implements Serializable, but its members are transient.
AbstractSearchTool.StoredResults(Object, List) - Constructor for class org.apache.velocity.tools.view.tools.AbstractSearchTool.StoredResults
Creates a new instance.
AbstractSearchTool() - Constructor for class org.apache.velocity.tools.view.tools.AbstractSearchTool
 
add(Object, Object) - Static method in class org.apache.velocity.tools.generic.MathTool
 
addQueryData(String, Object) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Adds a key=value pair to the query data.
addTool(ToolInfo) - Method in class org.apache.velocity.tools.view.XMLToolboxManager
 
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.servlet.ServletToolboxManager
Overrides XMLToolboxManager to separate tools by scope.
anchor - Variable in class org.apache.velocity.tools.view.tools.LinkTool
The anchor set for this link.
appendAsArray(StringBuffer, String, Object[]) - Method in class org.apache.velocity.tools.view.tools.LinkTool.QueryPair
 
application - Variable in class org.apache.velocity.tools.struts.ErrorsTool
A reference to the ServletContext
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
APPLICATION - Static variable in class org.apache.velocity.tools.view.context.ChainedContext
Key to the servlet context object.
APPLICATION_SCOPE - Static variable in class org.apache.velocity.tools.view.servlet.ServletToolInfo
 
appTools - Variable in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
 
ATTRIBUTE_TYPE - Static variable in class org.apache.velocity.tools.view.XMLToolboxManager
 

B

BASE_NODE - Static variable in class org.apache.velocity.tools.view.XMLToolboxManager
 

C

cachedNext - Variable in class org.apache.velocity.tools.generic.IteratorTool
 
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.
clazz - Variable in class org.apache.velocity.tools.view.ViewToolInfo
 
CONTENT_TYPE - Static variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
The HTTP content type context key.
context - Variable in class org.apache.velocity.tools.view.tools.ViewRenderTool
 
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.
createContext(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Creates and returns an initialized Velocity context.
createContext(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
Overrides VelocityViewServlet to check the request for an alternate layout
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

data - Variable in class org.apache.velocity.tools.view.DataInfo
 
DataInfo - class org.apache.velocity.tools.view.DataInfo.
ToolInfo implementation to handle "primitive" data types.
DataInfo(String, String, String) - Constructor for class org.apache.velocity.tools.view.DataInfo
Parses the value string into a recognized type.
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.
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_ERROR_TEMPLATE - Static variable in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
The default error template's filename.
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_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
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) - Static 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()
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

ELEMENT_CLASS - Static variable in class org.apache.velocity.tools.view.XMLToolboxManager
 
ELEMENT_CREATE_SESSION - Static variable in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
 
ELEMENT_DATA - Static variable in class org.apache.velocity.tools.view.XMLToolboxManager
 
ELEMENT_KEY - Static variable in class org.apache.velocity.tools.view.XMLToolboxManager
 
ELEMENT_SCOPE - Static variable in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
 
ELEMENT_TOOL - Static variable in class org.apache.velocity.tools.view.XMLToolboxManager
 
ELEMENT_VALUE - Static variable in class org.apache.velocity.tools.view.XMLToolboxManager
 
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) - Static 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.
encoding - Variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
The encoding to use when generating outputing.
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.
error(HttpServletRequest, HttpServletResponse, Exception) - Method in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
Overrides VelocityServlet to display user's custom error template
errorMarkup(String, HttpServletRequest, HttpSession, ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns a formatted error message.
errors - Variable in class org.apache.velocity.tools.struts.ErrorsTool
A reference to the queued action messages.
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
Default constructor.
errorTemplate - Variable in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
 
eval(Context, String) - Static 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.ErrorsTool
Returns true if there are action errors queued, otherwise false.
exist(String) - Method in class org.apache.velocity.tools.struts.ErrorsTool
Returns true if there are action errors queued for the specified category of errors, 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) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
Convenience method for checking whether a certain parameter exists.

F

findLocalizedResource(String) - Method in class org.apache.velocity.tools.view.i18n.MultiViewsTool
Calls MultiViewsTool.findLocalizedResource(String, String) using the default language.
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, 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.
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 using the locale returned by DateTool.getLocale().
format(String, Object, Locale) - Static method in class org.apache.velocity.tools.generic.DateTool
Returns a formatted string representing the specified date and locale.
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.

G

get(String) - 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.ErrorsTool
Returns the set of localized error messages as an java.util.ArrayList of java.lang.String for all errors queued of the specified category or null if no error are queued for the specified category.
get(String) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
Convenience method for use in Velocity templates.
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, Object[]) - Method in class org.apache.velocity.tools.struts.MessageTool
Looks up and returns the localized message for the specified key.
getActionErrors(HttpServletRequest) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the org.apache.struts.action.ActionErrors object for this request or null if none exists.
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
Returns the org.apache.struts.action.ActionFormBeans collection for this application or null if not found.
getActionForward(String, ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the forwarding associated with the specified logical name or null if not found.
getActionForwards(ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the org.apache.struts.action.ActionForwards collection for this application or null if not found.
getActionMapping(String, ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the mapping associated with the specified request path, or null if not found.
getActionMappingName(String) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the form action converted into an action mapping path.
getActionMappings(ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the org.apache.struts.action.ActionMappings collection for this application or null if not found.
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.
getAll() - Method in class org.apache.velocity.tools.struts.ErrorsTool
Returns the set of localized error messages as an java.util.ArrayList of java.lang.String for all errors queued or null if no errors are queued.
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() - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the query parameter name under which a cancel button press must be reported if form validation is to be skipped.
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.
getClassname() - Method in class org.apache.velocity.tools.view.ViewToolInfo
 
getClassname() - Method in interface org.apache.velocity.tools.view.ToolInfo
 
getClassname() - Method in class org.apache.velocity.tools.view.DataInfo
 
getContextPath() - Method in class org.apache.velocity.tools.view.tools.LinkTool
Returns the context path that addresses this web application, e.g.
getContextURL() - Method in class org.apache.velocity.tools.view.tools.LinkTool
Returns the URI that addresses this web application.
getCriteria() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Return the criteria object for this request.
getCriteria() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool.StoredResults
 
getDataSource(ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the default configured data source (which must implement javax.sql.DataSource) or null if not found.
getDate() - Method in class org.apache.velocity.tools.generic.DateTool
Returns a Date derived from the result of DateTool.getCalendar()
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
 
getException(HttpServletRequest) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the runtime Exception that may have been thrown by a Struts view tool or compatible presentation extension, and placed in the request.
getFormattedDate(String) - Method in class org.apache.velocity.tools.generic.DateTool
Returns a formatted string representing the date as returned by DateTool.getDate().
getFormBean(String, ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the form bean definition associated with the specified logical name or null if not found.
getGlobal() - Method in class org.apache.velocity.tools.struts.ErrorsTool
This a convenience method and the equivalent of $errors.get($errors.globalName).
getGlobalErrorName() - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the default "GLOBAL" category name that can be used with messages that are not associated with a particular property.
getGlobalName() - Method in class org.apache.velocity.tools.struts.ErrorsTool
Returns the default "GLOBAL" category name that can be used for messages that are not associated with a particular property.
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.ViewToolInfo
Returns a new instance of the tool.
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.DataInfo
Returns the data.
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
 
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
getKey() - Method in class org.apache.velocity.tools.view.ViewToolInfo
 
getKey() - Method in interface org.apache.velocity.tools.view.ToolInfo
 
getKey() - Method in class org.apache.velocity.tools.view.DataInfo
 
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
 
getLocale() - Method in class org.apache.velocity.tools.struts.MessageTool
Returns the user's locale.
getLocale(HttpServletRequest, HttpSession) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the java.util.Locale for the user.
getMapping(HttpServletRequest) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the org.apache.struts.ActionMapping instance for this request or null if none exists.
getMessageResources(ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the message resources for this application or null if not found.
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.
getMultipartRequestWrapper(HttpServletRequest) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the multipart object for this request or null if none exists.
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).
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
 
getNumbers(String) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
 
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() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Returns the "page number" for the current index.
getPageNumber(int) - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Returns the "page number" for the specified 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() - Static method in class org.apache.velocity.tools.generic.MathTool
 
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.context.ChainedContext
Returns the current servlet 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.
getResponse() - Method in interface org.apache.velocity.tools.view.context.ViewContext
Returns the instance of HttpServletResponse for this request.
getResponse() - Method in class org.apache.velocity.tools.view.context.ChainedContext
Returns the current servlet response.
getResults() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Return the results for the given criteria.
getScope() - Method in class org.apache.velocity.tools.view.servlet.ServletToolInfo
 
getServletContext() - Method in interface org.apache.velocity.tools.view.context.ViewContext
Returns the instance of ServletContext for this request.
getServletContext() - Method in class org.apache.velocity.tools.view.context.ChainedContext
Returns the servlet context.
getServletMapping(ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the servlet mapping used for this application or null if not found.
getSize() - Method in class org.apache.velocity.tools.struts.ErrorsTool
Returns the number of action errors queued.
getSize(String) - Method in class org.apache.velocity.tools.struts.ErrorsTool
Returns the number of action errors 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).
getStoredResults() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Retrieves stored search results (if any) from the user's session attributes.
getString(String) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
 
getString(String, String) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
 
getStrings(String) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
 
getSystemCalendar() - Static method in class org.apache.velocity.tools.generic.DateTool
 
getSystemDate() - Static method in class org.apache.velocity.tools.generic.DateTool
 
getTemplate(String) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Retrieves the requested template.
getTemplate(String, String) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Retrieves the requested template with the specified character encoding.
getTimeZone() - Method in class org.apache.velocity.tools.generic.DateTool
 
getToken() - Method in class org.apache.velocity.tools.struts.FormTool
Returns the transaction control token for this session or null if no token exists.
getToken(HttpSession) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the transaction token stored in this session or null if not used.
getTokenName() - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the query parameter name under which a transaction token must be reported.
getTokenName() - Method in class org.apache.velocity.tools.struts.FormTool
Returns the query parameter name under which a transaction token must be reported.
getToolboxContext(Object) - Method in class org.apache.velocity.tools.view.XMLToolboxManager
 
getToolboxContext(Object) - Method in interface org.apache.velocity.tools.view.ToolboxManager
Creates a ToolboxContext from the tools and data in this manager.
getToolboxContext(Object) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Overrides XMLToolboxManager to handle the separate scopes.
getURI() - Method in class org.apache.velocity.tools.view.tools.LinkTool
Returns the current URI of this link as set by the setURI(String) or setRelative(String) methods.
getVelocityContext() - Method in interface org.apache.velocity.tools.view.context.ViewContext
Returns a reference to the current Velocity context.
getVelocityContext() - Method in class org.apache.velocity.tools.view.context.ChainedContext
Returns a reference to the Velocity context (this object).

H

handleRequest(HttpServletRequest, HttpServletResponse, Context) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Handle the template processing request.
hasMore() - Method in class org.apache.velocity.tools.generic.IteratorTool
Returns true if there are more elements in the wrapped list.
hasNext() - Method in class org.apache.velocity.tools.generic.IteratorTool
Returns true if there are more elements in the list and more() was called.
hasResults() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Checks whether or not the result list is empty.
HTML_QUERY_DELIMITER - Static variable in class org.apache.velocity.tools.view.tools.LinkTool
Standard HTML delimiter for query data ('&')

I

index - Variable in class org.apache.velocity.tools.view.tools.AbstractSearchTool
 
INIT_PROPS_KEY - Static variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
This is the string that is looked for when getInitParameter is called ("org.apache.velocity.properties").
init(ExtendedProperties) - Method in class org.apache.velocity.tools.view.servlet.WebappLoader
This is abstract in the base class, so we need it.
init(Object) - Method in class org.apache.velocity.tools.struts.MessageTool
Initializes this tool.
init(Object) - Method in class org.apache.velocity.tools.struts.FormTool
Initializes this tool.
init(Object) - Method in class org.apache.velocity.tools.struts.ErrorsTool
Initializes this tool.
init(Object) - Method in class org.apache.velocity.tools.view.i18n.MultiViewsTool
Extracts the default language from the specified ViewContext, looking first at the Velocity context, then the servlet context, then lastly at the JVM default.
init(Object) - Method in interface org.apache.velocity.tools.view.tools.ViewTool
Initializes this instance using the given data
init(Object) - Method in class org.apache.velocity.tools.view.tools.ViewRenderTool
Initializes this instance.
init(Object) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
Initializes this instance.
init(Object) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Initializes this tool.
init(Object) - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Initializes this instance by grabbing the request and session objects from the current ViewContext.
init(RuntimeServices) - Method in class org.apache.velocity.tools.view.servlet.ServletLogger
init()
init(ServletConfig) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Initializes servlet, toolbox and Velocity template engine.
init(ServletConfig) - Method in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
Initializes Velocity, the view servlet and checks for changes to the initial layout configuration.
initializable - Variable in class org.apache.velocity.tools.view.ViewToolInfo
 
initToolbox(ServletConfig) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Initializes the ServletToolboxManager for this servlet's toolbox (if any).
initVelocity(ServletConfig) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Initializes the Velocity runtime, first calling loadConfiguration(ServletConfig) to get a org.apache.commons.collections.ExtendedProperties of configuration information and then calling Velocity.init().
internalGet(String) - Method in class org.apache.velocity.tools.view.context.ToolboxContext
Get value for key.
internalGet(String) - Method in class org.apache.velocity.tools.view.context.ChainedContext
Looks up and returns the object with the specified key.
internalPut(String, Object) - Method in class org.apache.velocity.tools.view.context.ToolboxContext
Does nothing.
internalWrap(Object) - Method in class org.apache.velocity.tools.generic.IteratorTool
Wraps a list with the tool.
isSourceModified(Resource) - Method in class org.apache.velocity.tools.view.servlet.WebappLoader
Defaults to return false.
itemsPerPage - Variable in class org.apache.velocity.tools.view.tools.AbstractSearchTool
 
iterator - Variable in class org.apache.velocity.tools.generic.IteratorTool
 
IteratorTool - class org.apache.velocity.tools.generic.IteratorTool.
A convenience tool to use with #foreach loops.
IteratorTool() - Constructor for class org.apache.velocity.tools.generic.IteratorTool
Create a IteratorTool instance to use as tool.
IteratorTool(Object) - Constructor for class org.apache.velocity.tools.generic.IteratorTool
Create a IteratorTool instance to use in #foreach.

K

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

L

layoutDir - Variable in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
 
LinkTool - class org.apache.velocity.tools.view.tools.LinkTool.
View tool to make building URIs pleasant and fun! :)
LinkTool.QueryPair - class org.apache.velocity.tools.view.tools.LinkTool.QueryPair.
Internal util class to handle representation and encoding of key/value pairs in the query string
LinkTool.QueryPair(String, Object) - Constructor for class org.apache.velocity.tools.view.tools.LinkTool.QueryPair
Construct a new query pair.
LinkTool() - Constructor for class org.apache.velocity.tools.view.tools.LinkTool
Default constructor.
list - Variable in class org.apache.velocity.tools.view.tools.AbstractSearchTool.StoredResults
 
load(InputStream) - Method in class org.apache.velocity.tools.view.XMLToolboxManager
Reads an XML document from an InputStream using dom4j and sets up the toolbox from that.
load(String) - Method in class org.apache.velocity.tools.generic.ToolLoader
Creates and returns an object of the specified classname.
loadConfiguration(ServletConfig) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Loads the configuration information and returns that information as an ExtendedProperties, which will be used to initialize the Velocity runtime.
locale - Variable in class org.apache.velocity.tools.struts.MessageTool
A reference to the user's locale.
locale - Variable in class org.apache.velocity.tools.struts.ErrorsTool
A reference to the user's locale.
LOG_TAG - Static variable in class org.apache.velocity.tools.generic.RenderTool
 
log(String) - Method in class org.apache.velocity.tools.view.XMLToolboxManager
Default implementation logs messages to Velocity's log system
log(String) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Overrides XMLToolboxManager
logVelocityMessage(int, String) - Method in class org.apache.velocity.tools.view.servlet.ServletLogger
Send a log message from Velocity.

M

managersMap - Static variable in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
 
MathTool - class org.apache.velocity.tools.generic.MathTool.
Tool for performing floating point math in Velocity.
MathTool() - Constructor for class org.apache.velocity.tools.generic.MathTool
 
max(Object, Object) - Static method in class org.apache.velocity.tools.generic.MathTool
 
mergeTemplate(Template, Context, HttpServletResponse) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
merges the template with the context.
mergeTemplate(Template, Context, HttpServletResponse) - Method in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
Overrides VelocityServlet.mergeTemplate to do a two-pass render for handling layouts
MessageTool - class org.apache.velocity.tools.struts.MessageTool.
View tool that provides methods to render Struts message resources.
MessageTool() - Constructor for class org.apache.velocity.tools.struts.MessageTool
Default constructor.
min(Object, Object) - Static method in class org.apache.velocity.tools.generic.MathTool
 
more() - Method in class org.apache.velocity.tools.generic.IteratorTool
Asks for the next element in the list.
mul(Object, Object) - Static method in class org.apache.velocity.tools.generic.MathTool
 
MultiViewsTool - class org.apache.velocity.tools.view.i18n.MultiViewsTool.
Allows for transparent content negotiation in a manner mimicking Apache httpd's MultiViews
MultiViewsTool() - Constructor for class org.apache.velocity.tools.view.i18n.MultiViewsTool
Creates a new uninitialized instance.

N

next - Variable in class org.apache.velocity.tools.generic.IteratorTool
 
next() - Method in class org.apache.velocity.tools.generic.IteratorTool
Gets the next object in the list.

O

org.apache.velocity.tools.generic - package org.apache.velocity.tools.generic
Contains a collection of reusable, general-purpose "tools" for Velocity.
org.apache.velocity.tools.struts - package org.apache.velocity.tools.struts
Provides view tools to integrate Velocity with the Jakarta Struts framework.
org.apache.velocity.tools.view - package org.apache.velocity.tools.view
Contains base interfaces and classes for toolbox management.
org.apache.velocity.tools.view.context - package org.apache.velocity.tools.view.context
Provides special purpose implementations of the VelocityContext class related to the automatic toolbox management in a servlet environment.
org.apache.velocity.tools.view.i18n - package org.apache.velocity.tools.view.i18n
 
org.apache.velocity.tools.view.servlet - package org.apache.velocity.tools.view.servlet
Provides classes to support using Velocity in a servlet environment.
org.apache.velocity.tools.view.tools - package org.apache.velocity.tools.view.tools
Provides the ViewTool interface and several useful implementing classes.

P

ParameterParser - class org.apache.velocity.tools.view.tools.ParameterParser.
Utility class for easy parsing of ServletRequest parameters.
ParameterParser() - Constructor for class org.apache.velocity.tools.view.tools.ParameterParser
Constructs a new instance
ParameterParser(ServletRequest) - Constructor for class org.apache.velocity.tools.view.tools.ParameterParser
Constructs a new instance using the specified request.
parseNumber(String) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
Converts a parameter value into a Number This is used as the base for all numeric parsing methods.
paths - Variable in class org.apache.velocity.tools.view.servlet.WebappLoader
The root paths for templates (relative to webapp's root).
pow(Object, Object) - Static method in class org.apache.velocity.tools.generic.MathTool
 
PREFIX - Static variable in class org.apache.velocity.tools.view.servlet.ServletLogger
 
PROPERTY_DEFAULT_LAYOUT - Static variable in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
The velocity.properties key for specifying the servlet's default layout template's filename.
PROPERTY_ERROR_TEMPLATE - Static variable in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
The velocity.properties key for specifying the servlet's error template.
PROPERTY_LAYOUT_DIR - Static variable in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
The velocity.properties key for specifying the relative directory holding layout templates.

Q

queryData - Variable in class org.apache.velocity.tools.view.tools.LinkTool
A list of query string parameters.
queryDataDelim - Variable in class org.apache.velocity.tools.view.tools.LinkTool
The current delimiter for query data

R

random(Object, Object) - Static method in class org.apache.velocity.tools.generic.MathTool
This returns a random Integer within the specified range.
readCreateSession(Element) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Reads the value for create-session.
readDataInfo(Element) - Method in class org.apache.velocity.tools.view.XMLToolboxManager
 
readElement(Element) - Method in class org.apache.velocity.tools.view.XMLToolboxManager
Delegates the reading of an element's ToolInfo and adds the returned instance to the tool list.
readElement(Element) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Overrides XMLToolboxManager to handle the create-session element.
readToolInfo(Element) - Method in class org.apache.velocity.tools.view.XMLToolboxManager
 
readToolInfo(Element) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Overrides XMLToolboxManager to read a ServletToolInfo instead of a ViewToolInfo.
recurse(Context, String) - Static method in class org.apache.velocity.tools.generic.RenderTool
Recursively evaluates a String containing VTL using the current context, and returns the result as a String.
recurse(String) - Method in class org.apache.velocity.tools.view.tools.ViewRenderTool
Recursively evaluates a String containing VTL using the current context, and returns the result as a String.
remove() - Method in class org.apache.velocity.tools.generic.IteratorTool
Removes the current element from the list.
RenderTool - class org.apache.velocity.tools.generic.RenderTool.
This tool expose static methods to evaluate the given strings as VTL (Velocity Template Language) using the given context.
RenderTool() - Constructor for class org.apache.velocity.tools.generic.RenderTool
Constructs a new instance
request - Variable in class org.apache.velocity.tools.struts.FormTool
A reference to the HtttpServletRequest.
request - Variable in class org.apache.velocity.tools.struts.ErrorsTool
A reference to the HttpServletRequest.
request - Variable in class org.apache.velocity.tools.view.context.ChainedContext
A local reference to the current servlet request.
request - Variable in class org.apache.velocity.tools.view.tools.ParameterParser
 
request - Variable in class org.apache.velocity.tools.view.tools.LinkTool
A reference to the HttpServletRequest.
REQUEST - Static variable in class org.apache.velocity.tools.view.context.ChainedContext
Key to the HTTP request object.
REQUEST_SCOPE - Static variable in class org.apache.velocity.tools.view.servlet.ServletToolInfo
 
requestCleanup(HttpServletRequest, HttpServletResponse, Context) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
cleanup routine called at the end of the request processing sequence allows a derived class to do resource cleanup or other end of process cycle tasks
requestToolInfo - Variable in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
 
reset() - Method in class org.apache.velocity.tools.generic.IteratorTool
Resets the wrapper so that it starts over at the beginning of the list.
reset() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Sets the criteria and results to null, page index to zero, and items per page to the default.
resources - Variable in class org.apache.velocity.tools.struts.MessageTool
A reference to the Struts message resources.
resources - Variable in class org.apache.velocity.tools.struts.ErrorsTool
A reference to the Struts message resources.
response - Variable in class org.apache.velocity.tools.view.context.ChainedContext
A local reference to the current servlet response.
response - Variable in class org.apache.velocity.tools.view.tools.LinkTool
A reference to the HttpServletResponse.
RESPONSE - Static variable in class org.apache.velocity.tools.view.context.ChainedContext
Key to the HTTP response object.
results - Variable in class org.apache.velocity.tools.view.tools.AbstractSearchTool
 
retrieveResults() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Gets the results for the given criteria either in memory or by performing a new query for them.
roundTo(Object, Object) - Static method in class org.apache.velocity.tools.generic.MathTool
Rounds a number to the specified number of decimal places.
roundToInt(Object) - Static method in class org.apache.velocity.tools.generic.MathTool
Rounds a number to the nearest whole Integer

S

scope - Variable in class org.apache.velocity.tools.view.servlet.ServletToolInfo
 
SERVLET_CONTEXT_KEY - Static variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Key used to access the ServletContext in the Velocity application attributes.
servletContext - Variable in class org.apache.velocity.tools.view.servlet.WebappLoader
 
servletContext - Variable in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
 
servletContext - Variable in class org.apache.velocity.tools.view.servlet.ServletLogger
 
ServletLogger - class org.apache.velocity.tools.view.servlet.ServletLogger.
Simple wrapper for the servlet log.
ServletLogger() - Constructor for class org.apache.velocity.tools.view.servlet.ServletLogger
Construct a simple logger for a servlet environment.
ServletToolboxManager - class org.apache.velocity.tools.view.servlet.ServletToolboxManager.
A toolbox manager for the servlet environment.
ServletToolboxManager(ServletContext) - Constructor for class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Use getInstance(ServletContext,String) instead to ensure there is exactly one ServletToolboxManager per xml toolbox configuration file.
ServletToolInfo - class org.apache.velocity.tools.view.servlet.ServletToolInfo.
ToolInfo implementation that holds scope information for tools used in a servlet environment.
ServletToolInfo(String, String, String) - Constructor for class org.apache.velocity.tools.view.servlet.ServletToolInfo
Creates a new tool of the specified class with the given key and scope.
session - Variable in class org.apache.velocity.tools.struts.FormTool
A reference to the HtttpSession.
session - Variable in class org.apache.velocity.tools.struts.ErrorsTool
A reference to the HttpSession.
session - Variable in class org.apache.velocity.tools.view.context.ChainedContext
A local reference to the servlet session.
session - Variable in class org.apache.velocity.tools.view.tools.AbstractSearchTool
 
SESSION - Static variable in class org.apache.velocity.tools.view.context.ChainedContext
Key to the HTTP session object.
SESSION_SCOPE - Static variable in class org.apache.velocity.tools.view.servlet.ServletToolInfo
 
SESSION_TOOLS_KEY - Static variable in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
 
sessionToolInfo - Variable in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
 
setAction(String) - Method in class org.apache.velocity.tools.struts.StrutsLinkTool
Returns a copy of the link with the given action name converted into a server-relative URI reference.
setAnchor(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Returns a copy of the link with the specified anchor to be added to the end of the generated hyperlink.
setContentType(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Sets the content type of the response.
setCreateSession(boolean) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Sets whether or not to create a new session when none exists for the current request and session-scoped tools have been defined for this toolbox.
setCriteria(Object) - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Sets the criteria for this search and clears existing results.
setForward(String) - Method in class org.apache.velocity.tools.struts.StrutsLinkTool
Returns a copy of the link with the given global forward name converted into a server-relative URI reference.
setIndex(int) - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Sets the index of the first result in the current page
setItemsPerPage(int) - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Sets the number of items returned in a page of results
setRelative(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Returns a copy of the link with the specified context-relative URI reference converted to a server-relative URI reference.
setRequest(ServletRequest) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
Sets the current ServletRequest
setSlipSize(int) - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Sets the number of result page indices for AbstractSearchTool.getSlip() to list.
setStoredResults(AbstractSearchTool.StoredResults) - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Stores current search results in the user's session attributes (if one currently exists) in order to do efficient result pagination.
setToolbox(ToolboxContext) - Method in class org.apache.velocity.tools.view.context.ChainedContext
Sets the toolbox of view tools.
setup(HttpServletRequest) - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Abstract method to make it as obvious as possible just where implementing classes should be retrieving and configuring search/display parameters.
setURI(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Returns a copy of the link with the given URI reference set.
setXhtml(boolean) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Controls the delimiter used for separating query data pairs.
slipSize - Variable in class org.apache.velocity.tools.view.tools.AbstractSearchTool
 
stop() - Method in class org.apache.velocity.tools.generic.IteratorTool
Puts a condition to break out of the loop.
STORED_RESULTS_KEY - Static variable in class org.apache.velocity.tools.view.tools.AbstractSearchTool
the key under which StoredResults are kept in session
StrutsLinkTool - class org.apache.velocity.tools.struts.StrutsLinkTool.
View tool to work with URI links in Struts.
StrutsLinkTool() - Constructor for class org.apache.velocity.tools.struts.StrutsLinkTool
 
StrutsUtils - class org.apache.velocity.tools.struts.StrutsUtils.
A package-internal utility class to expose the Struts shared resources.
StrutsUtils() - Constructor for class org.apache.velocity.tools.struts.StrutsUtils
 
sub(Object, Object) - Static method in class org.apache.velocity.tools.generic.MathTool
 

T

toCalendar(Object) - Method in class org.apache.velocity.tools.generic.DateTool
Converts an object to an instance of Calendar using the locale returned by DateTool.getLocale() if necessary.
toCalendar(Object, Locale) - Static method in class org.apache.velocity.tools.generic.DateTool
Converts an object to an instance of Calendar using the locale returned by DateTool.getLocale() if necessary.
toDate(Object) - Static method in class org.apache.velocity.tools.generic.DateTool
Converts an object to an instance of Date.
toDate(String, Object) - Method in class org.apache.velocity.tools.generic.DateTool
Converts an object to an instance of Date using the specified format and the Locale returned by DateTool.getLocale() if the object is not already an instance of Date or Calendar.
toDate(String, Object, Locale) - Static method in class org.apache.velocity.tools.generic.DateTool
Converts an object to an instance of Date using the specified format and Localeif the object is not already an instance of Date or Calendar.
toDouble(Object) - Static method in class org.apache.velocity.tools.generic.MathTool
Converts an object with a numeric value into a Double Valid formats are Number or a String representation of a number
toInteger(Object) - Static method in class org.apache.velocity.tools.generic.MathTool
Converts an object with a numeric value into an Integer Valid formats are Number or a String representation of a number
toolbox - Variable in class org.apache.velocity.tools.view.context.ToolboxContext
The collection of view tools in this toolbox.
TOOLBOX_KEY - Static variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Key used to access the toolbox configuration file path from the Servlet or webapp init parameters ("org.apache.velocity.toolbox").
toolboxContext - Variable in class org.apache.velocity.tools.view.context.ChainedContext
The toolbox.
ToolboxContext - class org.apache.velocity.tools.view.context.ToolboxContext.
Read-only context used to carry a set of view tools.
ToolboxContext(Map) - Constructor for class org.apache.velocity.tools.view.context.ToolboxContext
Default constructor.
toolboxManager - Variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
A reference to the toolbox manager.
ToolboxManager - interface org.apache.velocity.tools.view.ToolboxManager.
Common interface for toolbox manager implementations.
toolinfo - Variable in class org.apache.velocity.tools.view.XMLToolboxManager
 
ToolInfo - interface org.apache.velocity.tools.view.ToolInfo.
Interface to simplify and abstract tool handling.
ToolLoader - class org.apache.velocity.tools.generic.ToolLoader.
A view tool that allows template designers to load an arbitrary object into the context.
ToolLoader() - Constructor for class org.apache.velocity.tools.generic.ToolLoader
 
toString() - Method in class org.apache.velocity.tools.generic.IteratorTool
Returns this object as a String.
toString() - Method in class org.apache.velocity.tools.generic.DateTool
 
toString() - Method in class org.apache.velocity.tools.view.tools.LinkTool
Returns the full URI reference that's been built with this tool, including the query string and anchor, e.g.
toString() - Method in class org.apache.velocity.tools.view.tools.LinkTool.QueryPair
Return the URL-encoded query string.
TYPE_BOOLEAN - Static variable in class org.apache.velocity.tools.view.DataInfo
 
TYPE_NUMBER - Static variable in class org.apache.velocity.tools.view.DataInfo
 
TYPE_STRING - Static variable in class org.apache.velocity.tools.view.DataInfo
 

U

uri - Variable in class org.apache.velocity.tools.view.tools.LinkTool
The URI reference set for this link.

V

value - Variable in class org.apache.velocity.tools.view.tools.LinkTool.QueryPair
 
VALUE_NO - Static variable in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
 
VALUE_YES - Static variable in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
 
VelocityLayoutServlet - class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet.
Extension of the VelocityViewServlet to perform "two-pass" layout rendering and allow for a customized error screen.
VelocityLayoutServlet() - Constructor for class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
 
VelocityViewServlet - class org.apache.velocity.tools.view.servlet.VelocityViewServlet.
A servlet to process Velocity templates.
VelocityViewServlet() - Constructor for class org.apache.velocity.tools.view.servlet.VelocityViewServlet
 
ViewContext - interface org.apache.velocity.tools.view.context.ViewContext.
Objects implementing this interface are passed to view tools upon initialization by the ServletToolboxManager.
ViewRenderTool - class org.apache.velocity.tools.view.tools.ViewRenderTool.
This tool expose methods to evaluate the given strings as VTL (Velocity Template Language) and automatically using the current context.
ViewRenderTool() - Constructor for class org.apache.velocity.tools.view.tools.ViewRenderTool
Constructs a new instance
ViewTool - interface org.apache.velocity.tools.view.tools.ViewTool.
Generic view tool interface to assist in tool management.
ViewToolInfo - class org.apache.velocity.tools.view.ViewToolInfo.
ToolInfo implementation for view tools.
ViewToolInfo(String, String) - Constructor for class org.apache.velocity.tools.view.ViewToolInfo
Constructor.

W

wantMore - Variable in class org.apache.velocity.tools.generic.IteratorTool
 
WebappLoader - class org.apache.velocity.tools.view.servlet.WebappLoader.
Resource loader that uses the ServletContext of a webapp to load Velocity templates.
WebappLoader() - Constructor for class org.apache.velocity.tools.view.servlet.WebappLoader
 
wrap(Object) - Method in class org.apache.velocity.tools.generic.IteratorTool
Wraps a list with the tool.
wrapped - Variable in class org.apache.velocity.tools.generic.IteratorTool
 
writerPool - Static variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Cache of writers

X

XHTML_QUERY_DELIMITER - Static variable in class org.apache.velocity.tools.view.tools.LinkTool
XHTML delimiter for query data ('&')
XMLToolboxManager - class org.apache.velocity.tools.view.XMLToolboxManager.
A ToolboxManager for loading a toolbox from xml.
XMLToolboxManager() - Constructor for class org.apache.velocity.tools.view.XMLToolboxManager
Default constructor

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

Copyright (c) 2003 Apache Software Foundation