|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.struts.taglib.TagUtils
Provides helper methods for JSP tags.
Field Summary | |
private static TagUtils |
instance
The Singleton instance. |
private static org.apache.commons.logging.Log |
log
Commons logging instance. |
private static MessageResources |
messages
The message resources for this package. |
private static java.util.Map |
scopes
Maps lowercase JSP scope names to their PageContext integer constant values. |
Constructor Summary | |
protected |
TagUtils()
Constructor for TagUtils. |
Method Summary | |
(package private) static void |
Initialize the scope names map. |
java.util.Map |
computeParameters(javax.servlet.jsp.PageContext pageContext,
java.lang.String paramId,
java.lang.String paramName,
java.lang.String paramProperty,
java.lang.String paramScope,
java.lang.String name,
java.lang.String property,
java.lang.String scope,
boolean transaction)
Compute a set of query parameters that will be dynamically added to a generated URL. |
java.lang.String |
computeURL(javax.servlet.jsp.PageContext pageContext,
java.lang.String forward,
java.lang.String href,
java.lang.String page,
java.lang.String action,
java.lang.String module,
java.util.Map params,
java.lang.String anchor,
boolean redirect)
|
java.lang.String |
computeURL(javax.servlet.jsp.PageContext pageContext,
java.lang.String forward,
java.lang.String href,
java.lang.String page,
java.lang.String action,
java.lang.String module,
java.util.Map params,
java.lang.String anchor,
boolean redirect,
boolean encodeSeparator)
|
java.lang.String |
computeURLWithCharEncoding(javax.servlet.jsp.PageContext pageContext,
java.lang.String forward,
java.lang.String href,
java.lang.String page,
java.lang.String action,
java.lang.String module,
java.util.Map params,
java.lang.String anchor,
boolean redirect,
boolean useLocalEncoding)
Compute a hyperlink URL based on the forward ,
href , action or page parameter
that is not null. |
java.lang.String |
computeURLWithCharEncoding(javax.servlet.jsp.PageContext pageContext,
java.lang.String forward,
java.lang.String href,
java.lang.String page,
java.lang.String action,
java.lang.String module,
java.util.Map params,
java.lang.String anchor,
boolean redirect,
boolean encodeSeparator,
boolean useLocalEncoding)
Compute a hyperlink URL based on the forward ,
href , action or page parameter
that is not null. |
java.lang.String |
encodeURL(java.lang.String url)
URLencodes a string assuming the character encoding is UTF-8. |
java.lang.String |
encodeURL(java.lang.String url,
java.lang.String enc)
Use the new URLEncoder.encode() method from Java 1.4 if available, else use the old deprecated version. |
java.lang.String |
filter(java.lang.String value)
Filter the specified string for characters that are sensitive to HTML interpreters, returning the string with these characters replaced by the corresponding character entities. |
ActionErrors |
getActionErrors(javax.servlet.jsp.PageContext pageContext,
java.lang.String paramName)
Deprecated. Use getActionMessages() instead. This will be removed after Struts 1.2. |
java.lang.String |
getActionMappingName(java.lang.String action)
Return the form action converted into an action mapping path. |
java.lang.String |
getActionMappingURL(java.lang.String action,
javax.servlet.jsp.PageContext pageContext)
Return the form action converted into a server-relative URL. |
java.lang.String |
getActionMappingURL(java.lang.String action,
java.lang.String module,
javax.servlet.jsp.PageContext pageContext,
boolean contextRelative)
Return the form action converted into a server-relative URL. |
ActionMessages |
getActionMessages(javax.servlet.jsp.PageContext pageContext,
java.lang.String paramName)
Retrieves the value from request scope and if it isn't already an ActionMessages , some classes are converted to one. |
static TagUtils |
getInstance()
Returns the Singleton instance of TagUtils. |
ModuleConfig |
getModuleConfig(javax.servlet.jsp.PageContext pageContext)
Return the ModuleConfig object if it exists, null if otherwise. |
ModuleConfig |
getModuleConfig(java.lang.String module,
javax.servlet.jsp.PageContext pageContext)
Return the ModuleConfig object for the given prefix if it exists, null if otherwise. |
int |
getScope(java.lang.String scopeName)
Converts the scope name into its corresponding PageContext constant value. |
java.util.Locale |
getUserLocale(javax.servlet.jsp.PageContext pageContext,
java.lang.String locale)
Look up and return current user locale, based on the specified parameters. |
boolean |
isXhtml(javax.servlet.jsp.PageContext pageContext)
Returns true if the custom tags are in XHTML mode. |
java.lang.Object |
lookup(javax.servlet.jsp.PageContext pageContext,
java.lang.String name,
java.lang.String scopeName)
Locate and return the specified bean, from an optionally specified scope, in the specified page context. |
java.lang.Object |
lookup(javax.servlet.jsp.PageContext pageContext,
java.lang.String name,
java.lang.String property,
java.lang.String scope)
Locate and return the specified property of the specified bean, from an optionally specified scope, in the specified page context. |
java.lang.String |
message(javax.servlet.jsp.PageContext pageContext,
java.lang.String bundle,
java.lang.String locale,
java.lang.String key)
Look up and return a message string, based on the specified parameters. |
java.lang.String |
message(javax.servlet.jsp.PageContext pageContext,
java.lang.String bundle,
java.lang.String locale,
java.lang.String key,
java.lang.Object[] args)
Look up and return a message string, based on the specified parameters. |
java.lang.String |
pageURL(javax.servlet.http.HttpServletRequest request,
java.lang.String page,
ModuleConfig moduleConfig)
Return the context-relative URL that corresponds to the specified page attribute value, calculated based on the
pagePattern property of the current module's
ModuleConfig . |
boolean |
present(javax.servlet.jsp.PageContext pageContext,
java.lang.String bundle,
java.lang.String locale,
java.lang.String key)
Return true if a message string for the specified message key is present for the specified Locale. |
MessageResources |
retrieveMessageResources(javax.servlet.jsp.PageContext pageContext,
java.lang.String bundle,
boolean checkPageScope)
Returns the appropriate MessageResources object for the current module and the given bundle. |
void |
saveException(javax.servlet.jsp.PageContext pageContext,
java.lang.Throwable exception)
Save the specified exception as a request attribute for later use. |
void |
write(javax.servlet.jsp.PageContext pageContext,
java.lang.String text)
Write the specified text as the response to the writer associated with this page. |
void |
writePrevious(javax.servlet.jsp.PageContext pageContext,
java.lang.String text)
Write the specified text as the response to the writer associated with the body content for the tag within which we are currently nested. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait |
Field Detail |
private static final TagUtils instance
private static final org.apache.commons.logging.Log log
private static final MessageResources messages
private static final java.util.Map scopes
Constructor Detail |
protected TagUtils()
Method Detail |
static void()
public static TagUtils getInstance()
public java.util.Map computeParameters(javax.servlet.jsp.PageContext pageContext, java.lang.String paramId, java.lang.String paramName, java.lang.String paramProperty, java.lang.String paramScope, java.lang.String name, java.lang.String property, java.lang.String scope, boolean transaction) throws javax.servlet.jsp.JspException
<html:link>
tag. If no query parameters are
identified, return null
.pageContext
- PageContext we are operating inparamId
- Single-value request parameter name (if any)paramName
- Bean containing single-value parameter valueparamProperty
- Property (of bean named by paramName
containing single-value parameter valueparamScope
- Scope containing bean named by
paramName
name
- Bean containing multi-value parameters Map (if any)property
- Property (of bean named by name
containing multi-value parameters Mapscope
- Scope containing bean named by
name
transaction
- Should we add our transaction control token?javax.servlet.jsp.JspException
- if we cannot look up the required beansjavax.servlet.jsp.JspException
- if a class cast exception occurs on a
looked-up bean or propertypublic java.lang.String computeURL(javax.servlet.jsp.PageContext pageContext, java.lang.String forward, java.lang.String href, java.lang.String page, java.lang.String action, java.lang.String module, java.util.Map params, java.lang.String anchor, boolean redirect) throws java.net.MalformedURLException
public java.lang.String computeURLWithCharEncoding(javax.servlet.jsp.PageContext pageContext, java.lang.String forward, java.lang.String href, java.lang.String page, java.lang.String action, java.lang.String module, java.util.Map params, java.lang.String anchor, boolean redirect, boolean useLocalEncoding) throws java.net.MalformedURLException
forward
,
href
, action
or page
parameter
that is not null.
The returned URL will have already been passed to
response.encodeURL()
for adding a session identifier.pageContext
- PageContext for the tag making this callforward
- Logical forward name for which to look up
the context-relative URI (if specified)href
- URL to be utilized unmodified (if specified)page
- Module-relative page for which a URL should
be created (if specified)action
- Logical action name for which to look up
the context-relative URI (if specified)params
- Map of parameters to be dynamically included (if any)anchor
- Anchor to be dynamically included (if any)redirect
- Is this URL for a response.sendRedirect()
?java.net.MalformedURLException
- if a URL cannot be created
for the specified parameterspublic java.lang.String computeURL(javax.servlet.jsp.PageContext pageContext, java.lang.String forward, java.lang.String href, java.lang.String page, java.lang.String action, java.lang.String module, java.util.Map params, java.lang.String anchor, boolean redirect, boolean encodeSeparator) throws java.net.MalformedURLException
public java.lang.String computeURLWithCharEncoding(javax.servlet.jsp.PageContext pageContext, java.lang.String forward, java.lang.String href, java.lang.String page, java.lang.String action, java.lang.String module, java.util.Map params, java.lang.String anchor, boolean redirect, boolean encodeSeparator, boolean useLocalEncoding) throws java.net.MalformedURLException
forward
,
href
, action
or page
parameter
that is not null.
The returned URL will have already been passed to
response.encodeURL()
for adding a session identifier.pageContext
- PageContext for the tag making this callforward
- Logical forward name for which to look up
the context-relative URI (if specified)href
- URL to be utilized unmodified (if specified)page
- Module-relative page for which a URL should
be created (if specified)action
- Logical action name for which to look up
the context-relative URI (if specified)params
- Map of parameters to be dynamically included (if any)anchor
- Anchor to be dynamically included (if any)redirect
- Is this URL for a response.sendRedirect()
?encodeSeparator
- This is only checked if redirect is set to false (never
encoded for a redirect). If true, query string parameter separators are encoded
as >amp;, else & is used.useLocalEncoding
- If set to true, urlencoding is done on the bytes of
character encoding from ServletResponse#getCharacterEncoding. Use UTF-8
otherwise.java.net.MalformedURLException
- if a URL cannot be created
for the specified parameterspublic java.lang.String encodeURL(java.lang.String url)
url
- public java.lang.String encodeURL(java.lang.String url, java.lang.String enc)
enc
- The character encoding the urlencode is performed on.public java.lang.String filter(java.lang.String value)
value
- The string to be filtered and returnedpublic ActionErrors getActionErrors(javax.servlet.jsp.PageContext pageContext, java.lang.String paramName) throws javax.servlet.jsp.JspException
ErrorMessages
some classes are converted to one.pageContext
- The PageContext for the current pageparamName
- Key for parameter valuejavax.servlet.jsp.JspException
- public java.lang.String getActionMappingName(java.lang.String action)
action
property is manipulated as follows in
computing the name of the requested mapping:
public java.lang.String getActionMappingURL(java.lang.String action, javax.servlet.jsp.PageContext pageContext)
public java.lang.String getActionMappingURL(java.lang.String action, java.lang.String module, javax.servlet.jsp.PageContext pageContext, boolean contextRelative)
public ActionMessages getActionMessages(javax.servlet.jsp.PageContext pageContext, java.lang.String paramName) throws javax.servlet.jsp.JspException
ActionMessages
, some classes are converted to one.pageContext
- The PageContext for the current pageparamName
- Key for parameter valuejavax.servlet.jsp.JspException
- public ModuleConfig getModuleConfig(javax.servlet.jsp.PageContext pageContext)
pageContext
- The page context.public ModuleConfig getModuleConfig(java.lang.String module, javax.servlet.jsp.PageContext pageContext)
module
- The module prefixpageContext
- The page context.public int getScope(java.lang.String scopeName) throws javax.servlet.jsp.JspException
scopeName
- Can be "page", "request", "session", or "application" in any
case.javax.servlet.jsp.JspException
- if the scopeName is not a valid name.public java.util.Locale getUserLocale(javax.servlet.jsp.PageContext pageContext, java.lang.String locale)
pageContext
- The PageContext associated with this requestlocale
- Name of the session attribute for our user's Locale. If this is
null
, the default locale key is used for the lookup.public boolean isXhtml(javax.servlet.jsp.PageContext pageContext)
public java.lang.Object lookup(javax.servlet.jsp.PageContext pageContext, java.lang.String name, java.lang.String scopeName) throws javax.servlet.jsp.JspException
null
instead. If an exception is thrown, it will
have already been saved via a call to saveException()
.pageContext
- Page context to be searchedname
- Name of the bean to be retrievedscopeName
- Scope to be searched (page, request, session, application)
or null
to use findAttribute()
insteadjavax.servlet.jsp.JspException
- if an invalid scope name
is requestedpublic java.lang.Object lookup(javax.servlet.jsp.PageContext pageContext, java.lang.String name, java.lang.String property, java.lang.String scope) throws javax.servlet.jsp.JspException
saveException()
.pageContext
- Page context to be searchedname
- Name of the bean to be retrievedproperty
- Name of the property to be retrieved, or
null
to retrieve the bean itselfscope
- Scope to be searched (page, request, session, application)
or null
to use findAttribute()
insteadjavax.servlet.jsp.JspException
- if an invalid scope name
is requestedjavax.servlet.jsp.JspException
- if the specified bean is not foundjavax.servlet.jsp.JspException
- if accessing this property causes an
IllegalAccessException, IllegalArgumentException,
InvocationTargetException, or NoSuchMethodExceptionpublic java.lang.String message(javax.servlet.jsp.PageContext pageContext, java.lang.String bundle, java.lang.String locale, java.lang.String key) throws javax.servlet.jsp.JspException
pageContext
- The PageContext associated with this requestbundle
- Name of the servlet context attribute for our
message resources bundlelocale
- Name of the session attribute for our user's Localekey
- Message key to be looked up and returnedjavax.servlet.jsp.JspException
- if a lookup error occurs (will have been
saved in the request already)public java.lang.String message(javax.servlet.jsp.PageContext pageContext, java.lang.String bundle, java.lang.String locale, java.lang.String key, java.lang.Object[] args) throws javax.servlet.jsp.JspException
pageContext
- The PageContext associated with this requestbundle
- Name of the servlet context attribute for our
message resources bundlelocale
- Name of the session attribute for our user's Localekey
- Message key to be looked up and returnedargs
- Replacement parameters for this messagejavax.servlet.jsp.JspException
- if a lookup error occurs (will have been
saved in the request already)public java.lang.String pageURL(javax.servlet.http.HttpServletRequest request, java.lang.String page, ModuleConfig moduleConfig)
Return the context-relative URL that corresponds to the specified
page
attribute value, calculated based on the
pagePattern
property of the current module's
ModuleConfig
.
request
- The servlet request we are processingpage
- The module-relative URL to be substituted in
to the pagePattern
pattern for the current module
(MUST start with a slash)public boolean present(javax.servlet.jsp.PageContext pageContext, java.lang.String bundle, java.lang.String locale, java.lang.String key) throws javax.servlet.jsp.JspException
pageContext
- The PageContext associated with this requestbundle
- Name of the servlet context attribute for our
message resources bundlelocale
- Name of the session attribute for our user's Localekey
- Message key to be looked up and returnedjavax.servlet.jsp.JspException
- if a lookup error occurs (will have been
saved in the request already)public MessageResources retrieveMessageResources(javax.servlet.jsp.PageContext pageContext, java.lang.String bundle, boolean checkPageScope) throws javax.servlet.jsp.JspException
pageContext
- Search the context's scopes for the resources.bundle
- The bundle name to look for. If this is null
, the
default bundle name is used.javax.servlet.jsp.JspException
- if the MessageResources object could not be found.public void saveException(javax.servlet.jsp.PageContext pageContext, java.lang.Throwable exception)
pageContext
- The PageContext for the current pageexception
- The exception to be savedpublic void write(javax.servlet.jsp.PageContext pageContext, java.lang.String text) throws javax.servlet.jsp.JspException
doAfterBody()
method of a custom tag class that
implements BodyTag
, you should be calling
writePrevious()
instead.pageContext
- The PageContext object for this pagetext
- The text to be writtenjavax.servlet.jsp.JspException
- if an input/output error occurs (already saved)public void writePrevious(javax.servlet.jsp.PageContext pageContext, java.lang.String text) throws javax.servlet.jsp.JspException
pageContext
- The PageContext object for this pagetext
- The text to be writtenjavax.servlet.jsp.JspException
- if an input/output error occurs (already saved)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |