|
||||||||||
PREV NEXT | FRAMES NO FRAMES |
LinkTool.setForceRelative(boolean)
set to false and sets the
scheme to the "http" if no scheme has been set yet.
SafeConfig
insteadLinkTool.addRequestParams(String...)
or LinkTool.addRequestParamsExcept(String...)
or LinkTool.addMissingRequestParams(String...)
ConfigurationUtils.getDefaultTools()
configuration to this
the current configuration.
LinkTool.addRequestParams(String...)
or LinkTool.addRequestParamsExcept(String...)
or LinkTool.addMissingRequestParams(String...)
LinkTool.append(Object,Object)
LinkTool.params(Object)
Digester
instance, associating them with
our namespace URI (if any).
ToolboxRuleSet
to add create-session rule.
Digester
instance, associating them with
our namespace URI (if any).
ToolboxRuleSet
to add rule for scope element.
Alternator
s from varying "list" types or individual
arguments.LinkTool.combinePath(java.lang.String, java.lang.String)
to add the specified value
to the current LinkTool.getPath()
value.
LinkTool.combineQuery(java.lang.String, java.lang.String)
to append the specified value
to the current LinkTool.getQuery()
value.
Node
in the internal Node list for this instance, if that
Node is an Element
.
Map
of all attributes for the first/sole
Node
held internally by this instance.
Alternator
from the specified objects.
ViewToolContext
insteadXmlTool
instance that wraps all the
child Element
s of all the current internally held nodes
that are Element
s themselves.
Class
and its Field
s, Method
s, and Constructor
s.Object
.
Constructor
in an inspected Class.Field
in an inspected Class.Method
in an inspected Class.ConfigurationCleaner
and applies it to the specified
Configuration
.
Toolbox
that is a combination of
this Toolbox with one or more specified Toolbox
es.
Date
and Calendar
values
in Velocity templates.SortedSet
of child Configuration
s
as well as being a Configuration
itself.LoopTool.ActionCondition
for this instance to check
against the elements in the iterator being managed.
Property
s
for whatever thing the instance of this class represents.FactoryConfiguration
previously
placed in the ServletContext attributes.
SafeConfig.isConfigLocked()
returns true
, then this method
does nothing; otherwise, if false
, this will create a new
ValueParser
from the specified Map of params and call
SafeConfig.configure(ValueParser)
with it.
XmlTool.read(String)
to parse the file and set the
resulting Document
as the root node for this
instance.
ViewContext
, looking first at the Velocity
context, then the servlet context, then lastly at the JVM
default.
org.apache.velocity.toolbox
init-param (servlet or servletContext)
If none, config file optionally at /WEB-INF/toolbox.xml
(deprecated conventional location)
If no old toolbox or loadDefaults is true, ConfigurationUtils.getDefaultTools()
ConfigurationUtils.getAutoLoaded()
(false)
Config file optionally specified by servletContext org.apache.velocity.tools
init-param
Config file optionally at /WEB-INF/tools.xml
(new conventional location)
Config file optionally specified by servlet org.apache.velocity.tools
init-param
Remember that as these configurations are added on top of each other,
the newer values will always override the older ones.
true
if the context contains a value for the specified
reference name (aka context key).
Context
data and
meta-data.Cookie
to add some fluid API sugar and
a toString() method that renders the Cookie's value
instead of the usual Object.toString() shenanigans.Digester
used by UiDependencyTool.read(java.lang.String, boolean)
to create
the group info for this instance out of the specified XML file.
ToolboxFactory
configured
with the results of both ConfigurationUtils.getAutoLoaded()
and
ConfigurationUtils.findFromSystemProperty()
.
URI
constructor that is appropriate to the opacity.
Data.setTargetClass(java.lang.Class)
and
converters (Data.setConverter(java.lang.Class)
).Data
Date
and Calendar
in Velocity templates.URLDecoder.decode(java.lang.String)
using the configured character encoding.
Locale
to be used when none is specified.
VelocityView
ComparisonDateTool.Comparison
between the result of
the second specified date and the first specified date.
LinkTool.getDirectory()
and the query and fragment set to null.
FactoryConfiguration
subclass that simplifies the process of
configuring a ToolboxFactory
in Java without the use of an
xml or properties configuration file.URLEncoder.encode(java.lang.String)
using the configured character encoding.
LinkTool.encode(Object)
FactoryConfiguration.toString(boolean)
method, when passed false
,
returns a String equal to that returned by a call to toString(false) on this
instance.
RenderTool.setVelocityContext(org.apache.velocity.context.Context)
method.
true
if there are action messages queued,
otherwise false
.
false
.
ToolboxFactory
.Map
of results for a particular class.Field
and Class
reference for later
retrieval of the value of a field that is not final and may
change at different lookups.ContextTool.getKeys()
here so subclasses can add keys too.
FactoryConfiguration
.
XmlTool.find(String)
with that.
Node
s held by this instance and returns a new
XmlTool
instance that wraps those results.
IncludeTool.find(String, String)
using the
language extracted from locale
.
IncludeTool.find(String, String)
using the
default language.
FactoryConfiguration
loaded from the path specified
in the "org.apache.velocity.tools" system property (if any).
ServletContext
's init-params
for the specified parameter.
LoopTool.ManagedIterator
with the specified name
if it is in this instance's iterator stack.
FormatConfig.getFormat()
.
LocaleConfig.getLocale()
.
Locale
.
Locale
, and TimeZone
.
Locale
and date and/or time styles.
Locale
and date and/or time styles.
FormatConfig.getFormat()
.
LocaleConfig.getLocale()
.
Locale
.
DateTool.getDate()
.
DateTool.getDate()
in standard, localized patterns.
Map
of field names to values (or placeholders).
XmlTool
that wraps the specified
Node
from this instance's internal Node list.
java.util.List
of strings for all actionMsgs
queued of the specified category or null
if no messages are queued for the specified category.
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.
MessageTool.get(String key, Object[] args)
, but takes a
java.util.List
instead of an array.
MessageTool.get(String key, Object[] args)
, but takes a
java.util.List
instead of an array.
ComparisonDateTool.Comparison.abbr(boolean abbr)
with
true
as the argument, thus setting this comparison to be
rendered in abbreviated form.
ActionForm
bean associated with
this request of null
if none exists.
null
if none exists.
java.util.List
of strings for all actionMsgs
queued or null
if no messages are queued.
Annotation
s of the Class being inspected.
Annotation
s of the element being inspected.
LinkTool.param(Object,Object)
appends values;
false if the method overwrites existing value(s) for the specified key.
Class
object for the specified fully qualified
class name, from this web application's class loader.
FactoryConfiguration
including all
ConfigurationUtils.getDefaultTools()
as well as any tools that can be
automatically loaded from "tools.xml" or "tools.properties" found
at the root of the classpath or in the current directory.
FactoryConfiguration
composed, in order of the
following configurations:
ConfigurationUtils.getDefaultTools()
(only if includeDefaults is true
)
All "tools.xml" configurations found in the classpath root, in the order found
All "tools.properties" configurations found in the classpath root, in the order found
The "tools.xml" file in the current directory (if any)
The "tools.properties" file in the current directory (if any)
If the includeDefaults parameter is null and no such files described above
can be found, then the configuration returned by this method will be
empty, but it should never be null
.
ResourceBundle
for the specified baseName
and locale, if such exists.
Calendar
instance created using the timezone and
locale returned by getTimeZone() and getLocale().
true
if this render() and eval() methods will
catch exceptions thrown during rendering.
LinkTool.encode(java.lang.Object)
and
LinkTool.decode(java.lang.Object)
methods.
List
of ClassTool.ConstructorSub
s for each
constructor declared constructor in the inspected class.
LinkTool.getDirectory()
.
LoopTool.ManagedIterator.next()
so far.
Date
derived from the result of DateTool.getCalendar()
DateFormat
instance for the specified
format, Locale
, and TimeZone
.
DateFormat
instance for the specified
date style, time style, Locale
, and TimeZone
.
DateFormat
instance for the specified
time style, date style, Locale
, and TimeZone
.
DateFormat
instance for the specified
format, Locale
, and TimeZone
.
DateFormat
instance for the specified
date style, time style, Locale
, and TimeZone
.
DateTool.getCalendar()
.
FactoryConfiguration
.
List
of files for the specified file type, if any.
ComparisonDateTool.difference(java.lang.Object, java.lang.Object)
.
LinkTool.getPath()
value, by just trimming
off all that follows the last "/".
null
if none exist.
$text.key.exists
syntax.
List
of ClassTool.FieldSub
s for each
field declared field in the inspected class.
LoopTool.isFirst()
.
LoopTool.ManagedIterator.isFirst()
.
XmlTool
that wraps only the
first Node
from this instance's internal Node list.
ComparisonDateTool.Comparison.depth(int depth)
to which this comparison is rendered
to the maximum number of time units available to the tool.
FactoryConfiguration
including all default
"GenericTools" available and no others.
$messages.get($messages.globalName)
.
LoopTool.ManagedIterator.hasNext()
.
ClassUtils.getIterator(java.lang.Object)
is a
nice little try/catch block to prevent exceptions from
escaping into the template.
Set
of the available reference keys in the current
context.
List
of the key strings in the ResourceBundle
with the specified baseName and locale.
List
of the key strings in the specified
ResourceBundles.
LoopTool.isLast()
.
LoopTool.ManagedIterator.isLast()
.
XmlTool
that wraps only the
last Node
from this instance's internal Node list.
Locale
for this tool.
Locale
for this request.
java.util.Locale
for the user.
null
if not found.
null
if not found.
null
if none exist.
List
of ClassTool.MethodSub
s for each
method declared method in the inspected class.
DateTool.getCalendar()
.
XmlTool.get(Object)
for a "name" result.
NumberFormat
instance for the specified
format and Locale
.
NumberFormat
instance for the specified
number style and Locale
.
NumberFormat
instance for the specified
format and Locale
.
XmlTool
instance that wraps
the parent Element
of the first/sole Node
being wrapped by this instance.
Node
represented by this instance.
LinkTool.getQuery()
ComparisonDateTool.whenIs(Object now, Object then)
method.
ServletRequest
for this instance.
HttpServletRequest
for this request.
MessageResources
bundle, or the
application's default MessageResources if no bundle is specified.
HttpServletResponse
for this request.
PagerTool.getItems()
.
ServletContext
for this request.
PagerTool.getSlip()
will return per request (if available).
LoopTool.ManagedIterator
for this instance.
TimeZone
.
null
if no token exists.
null
if not used.
Map
for this context.
Map
of all tools available to this
context.
ToolboxFactory
being used.
Map
link tools' keys to their Class
es.
ToolboxRuleSet
to use ServletToolInfo class.
Class
being inspected by this instance.
Set
of all Class
es that are
part of the signatures (i.e.
URI
representation of this instance,
if any.
LinkTool.getPath()
URI.getUserInfo()
value for this instance.
true
.
DateTool.getCalendar()
or null if the field is invalid.
Map
returned by ValueParser.getSource()
.
Set
of the available values in the current
context.
FactoryConfiguration
including all default
"VelocityStruts" tools available as well as the default "VelocityView"
tools and "GenericTools".
FactoryConfiguration
including all default
"VelocityView" tools available as well as the default "GenericTools".
VelocityView
for the specified
ServletConfig
's context.
VelocityView
for the specified
FilterConfig
's context.
VelocityView
for the specified
JeeConfig
's context.
VelocityView
for the specified
ServletContext
.
VelocityView
for the specified
ServletContext
.
DateTool.getCalendar()
.
VelocityViewServlet.fillContext(org.apache.velocity.context.Context, javax.servlet.http.HttpServletRequest)
to add custom things
to the Context
or override a VelocityViewServlet.getTemplate(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
method to change how Template
s are retrieved.
LoopTool.ActionCondition
s set for this instance.
PagerTool.hasItems()
String
using HTML entities.
FieldTool.FieldToolSub
holding a Map
of all the public static field names to values (or a placeholder
if the value is not final) for the specified class(name).
FieldTool.FieldToolSub
holding a Map
of all the public static field names to values (or a placeholder
if the value is not final) for the Class
of the
specified Object.
FieldTool.FieldToolSub
holding a Map
of all the public static field names to values (or a placeholder
if the value is not final) for the specified Class
.
Object
.
Class
.
FieldTool.MutableField
for
in a Map
under the fields' names.
true
if the SafeConfig.configure(Map)
method
has been locked.
true
if there are no Node
s internally held
by this instance.
true
if the current loop is on its first iteration.
true
if the loop with the specified name
is on its first iteration.
LoopTool.ManagedIterator.next()
.
true
if the current loop is on its last iteration.
true
if the loop with the specified name
is on its last iteration.
LoopTool.ManagedIterator.next()
is the last element available in the iterator being managed
which satisfies any/all LoopTool.ActionCondition
s set for this
instance.
true
if this tool is in "safe mode".
true
if this ManagedIterator has a sync'ed
iterator with the specified name.
&
as the delimiter for query data pairs
or just using &
.
XmlTool.NodeIterator
that returns new XmlTool
instances for each Node
held internally by this instance.
LoopTool
insteadString
using Java String rules.
String
using JavaScript String rules.
JeeConfig
with only a ServletContext
.JeeConfig
with a FilterConfig
.JeeConfig
with a ServletConfig
.Throwable
that
broke the rendering of the requested screen.
MethodInvocationException
that broke the rendering of the requested screen.
LinkTool
FactoryConfiguration
loaded from a configuration file
at the specified path.
InputStream
and sets up the toolbox from that.
Locale
to be configured.Log
to optionally be attached to
a subclass in order to output logging messages.LoopTool.ManagedIterator
when a LoopTool.ActionCondition
is satisfied by the subsequent element.LoopTool.Action
and LoopTool.ActionCondition
for a LoopTool.ManagedIterator
.LoopTool.ManagedIterator
can
pass it's next element to see if an LoopTool.Action
should be taken.Iterator
and allows it to be prematurely stopped, skipped ahead, and
associated with a name for advanced nested loop control.LoopTool.ManagedIterator
.Alternator
from the specifed objects.
ResourceNotFoundException
to send an HTTP 404 result
when needed.
Alternator
from the specified objects.
LoopTool.ActionCondition
DisplayTool.Measurements
of the string value of the specified object.
MessageFormat
to format the specified String with
the specified arguments.
LoopTool.ActionCondition
s
(if any) in the iterator being managed.
Node
from this
instance's internal Node list, if any.
Number
in Velocity templates.org.apache.velocity.tools.view
.ServletRequest
parameters.XmlTool
instance that wraps
the parent Element
s of each of the Node
s
being wrapped by this instance.
Document
as the root Node
.
Boolean
Sub-classes can override to allow for customized boolean parsing.
Date
,
using the configured date parsing format, the configured default
Locale
, and the system's default TimeZone
to parse it.
Date
using the
specified format,the configured default Locale
,
and the system's default TimeZone
to parse it.
Date
using the
configured date format and specified Locale
to parse it.
Date
using the
specified format and Locale
to parse it.
Date
using the
specified format, Locale
, and TimeZone
.
Number
using the
format returned by ConversionTool.getNumberFormat()
and the default Locale
if the object is not already an instance of Number.
Number
using the
specified format and the Locale
returned by
LocaleConfig.getLocale()
.
Number
using the
configured number format and the specified Locale
.
Number
using the
specified format and Locale
.
LinkTool.normalizeQuery(java.lang.String)
to make all delimiters in the
specified query string match the current query delimiter
and then uses LinkTool.parseQuery(String,String)
to parse it
according to that same delimiter.
String#format(Locale,String,Object...
to format the specified String
with the specified arguments.
ExtendedProperties
from Commons-Collections.Data
that treats "name" as an alias
for "key".String
using java.util.Properties rules for escaping property keys.
String
using java.util.Properties rules for escaping property values.
Scope.REQUEST
Toolbox
(if any)
into the ServletRequest
attributes using
Toolbox.KEY
as the key.
Scope.REQUEST
Toolbox
(if any)
into the HttpServletRequest
attributes using
Toolbox.KEY
as the key, places the Scope.SESSION
Toolbox (if any) into the attributes of the HttpSession
(if any)
then ensures that the Scope.APPLICATION
Toolbox (if any)
has been placed in the ServletContext
attributes.
Number
within the
specified range.
FactoryConfiguration
read from a known configuration
file type at the specified URL
.
InputStream
.
InputStream
and uses it to configure this FactoryConfiguration
.
InputStream
and uses it to configure this FactoryConfiguration
.
URL
from the string and passes it to XmlTool.read(URL)
.
Document
from the
given URL
and uses it as the root Node
for this instance.
URL
or the string representation
thereof.
LinkTool.setForceRelative(boolean)
set to true.
LinkTool.setForceRelative(boolean)
set to true.
Tag.doEndTag()
and
Tag.doStartTag()
.
Field
in the specified Class
.
public void configure(Map params)
method after
it is called once.ServletLogChute
insteadXmlFactoryConfiguration
XmlFactoryConfigurationRuleSet
.setCreateSession()
for the top object
on the stack, which must be a
org.apache.velocity.tools.ServletToolboxManager
.setXhtml()
for the top object
on the stack, which must be a
org.apache.velocity.tools.ServletToolboxManager
.ToolInfo
ServletUtils
LinkTool.absolute(Object)
LinkTool.anchor(Object)
instead
LinkTool.setParam(java.lang.Object, java.lang.Object, boolean)
method
will override existing query values for the same key or simply append
the new value to a list of existing values.
Class
parameter because
this class was not created for all-java configuration.
LinkTool.createURI()
method should ignore the
scheme, user, port and host values for non-opaque URIs, thus making
LinkTool.toString()
print the link as a relative one, not an absolute
one.
Log
used for logging messages when Cookie
creation fails due to an invalid name.
LinkTool.setQuery(java.lang.Object)
.
ViewToolContext
should make the various scoped Toolbox
instances available
publically via the HttpServletRequest/HttpSession/ServletContext
attributes or simply add the Toolbox instances directly to the
context.
LinkTool.relative(Object)
HttpServletRequest
.
HttpServletRequest
.
HttpServletRequest
.
ServletRequest
HttpServletResponse
.
HttpServletResponse
.
Node
for this instance.
RuleSet
this loader will use to
digest the xml toolbox.
LinkTool.setForceRelative(boolean)
as reversed
replacement
LinkTool.setIncludeRequestParams(boolean)
instead
ServletContext
.
PagerTool.getSlip()
to list.
Toolbox
.
LinkTool.uri(Object)
Context
to be used by the RenderTool.eval(String)
and RenderTool.recurse(String)
methods.
Node
s internally held by this instance.
ToolInfo
should only use the public void configure(Map) method for configuration of
a tool, and skip over the step of trying to find individual
property setters.String
to be suitable to pass to an SQL query.
LoopTool.stop()
except that the stop command is issued
only to the loop/iterator with the specified name.
LoopTool.stop()
except that the stop command is issued
all the loops being watched by this tool.
LoopTool.stop(String)
except that the stop command is issued
both to the loop/iterator with the specified name and all loops nested within
it.
LinkTool
to add methods
for working with Struts' Actions and Forwards:ConversionUtils.toString(Object)
and Boolean.valueOf(String)
.
Calendar
using the
locale returned by LocaleConfig.getLocale()
if necessary.
Calendar
using the
locale returned by LocaleConfig.getLocale()
if necessary.
Object
into a Date
,
just short of turning it into a string and parsing it.
Date
using the
specified format, Locale
, and TimeZone
if the
object is not already an instance of Date, Calendar, or Long.
Date
using the
specified format, Locale
, and TimeZone
if the
object is not already an instance of Date, Calendar, or Long.
Date
, when necessary
using the configured date parsing format, the configured default
Locale
, and the system's default TimeZone
to parse
the string value of the specified object.
Date
using the
format returned by FormatConfig.getFormat()
,the Locale
returned
by LocaleConfig.getLocale()
, and the TimeZone
returned by
DateTool.getTimeZone()
if the object is not already an instance
of Date, Calendar, or Long.
Date
using the
specified format,the Locale
returned by
LocaleConfig.getLocale()
, and the TimeZone
returned by
DateTool.getTimeZone()
if the object is not already an instance
of Date, Calendar, or Long.
Date
using the
specified format and Locale
if the object is not already
an instance of Date, Calendar, or Long.
Date
using the
specified format, Locale
, and TimeZone
if the
object is not already an instance of Date, Calendar, or Long.
Number
or a String
representation of a number
Number
or a String
representation of a number
Locale
Object
into a Number
,
just short of turning it into a string and parsing it.
ConversionUtils.toNumber(Object)
except that you can tell
this to attempt parsing the object as a String by passing true
as the second parameter.
Number
using the
specified format and Locale
to parse it.
Number
using the
specified format and Locale
to parse it, if necessary.
Number
or a String
representation of a number.
Number
using the
format returned by FormatConfig.getFormat()
and the Locale
returned by LocaleConfig.getLocale()
if the object is not already
an instance of Number.
Number
using the
specified format and the Locale
returned by
LocaleConfig.getLocale()
if the object is not already an instance
of Number.
Number
using the
specified format and Locale
if the object is not already
an instance of Number.
ToolboxFactory
on a one-per-scope basis.VelocityView
ToolboxFactory
.XmlFactoryConfigurationRuleSet
Context
implementation that keeps a list of Toolbox
es
and returns them as requested, using its internal context Map as the
dynamic properties passed to the requested tools when they are first
created.ToolInfo
ConfigurationUtils.getAutoLoaded()
configuration
and any configuration specified via a "org.apache.velocity.tools"
system property.
FactoryConfiguration
previously
placed in the ServletContext attributes.
null
if the current item is null.
Node
s, then this
returns the result of super.toString()
.
UiDependencyTool.on(String)
or UiDependencyTool.on(String,String)
.
URL
.
URL
.
Scope.APPLICATION
Toolbox.
ToolboxFactory
for any changes to
the createSession or publishToolboxes settings.
String
to be suitable to use as an HTTP parameter value.
String
using "poor man's
escaping" for Velocity templates by replacing all '$' characters
with '${esc.d}' and all '#' characters with '${esc.h}'.
VelocityLayoutServlet
Toolbox
es are
available in the request/session/application scopes.VelocityViewServlet
ViewContext
ContextTool
that includes keys and values
from the HttpServletRequest
, HttpSession
and
ServletContext
.ToolContext
implementation specific to the servlet environment.ToolInfo
ConfigurationUtils.getAutoLoaded()()
configuration
and any configuration specified via a "org.apache.velocity.tools"
system property.
LoopTool.watch(Object)
except that it also takes
a name which is given to the LoopTool.ManagedIterator
that is returned.
WebappResourceLoader
instead.ComparisonDateTool.Comparison
between the result of
DateTool.getCalendar()
and the specified date.
ComparisonDateTool.Comparison
between the second specified date
and the first specified date.
String
using XML entities.
Digester
.XmlFactoryConfigurationRuleSet.DataValueInBodyRule
s used by
Commons-Digester
to process configuration info
formatted as XML.XmlFactoryConfiguration
|
||||||||||
PREV NEXT | FRAMES NO FRAMES |