Apache Struts API Documentation: Class ErrorsTag

org.apache.struts.taglib.html Class ErrorsTag

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport
        |
        +--org.apache.struts.taglib.html.ErrorsTag

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:

NestedErrorsTag

public class ErrorsTag

extends javax.servlet.jsp.tagext.TagSupport

Custom tag that renders error messages if an appropriate request attribute has been created. The tag looks for a request attribute with a reserved key, and assumes that it is either a String, a String array, containing message keys to be looked up in the module's MessageResources, or an object of type org.apache.struts.action.ActionErrors.

The following optional message keys will be utilized if corresponding messages exist for them in the application resources:

• errors.header - If present, the corresponding message will be rendered prior to the individual list of error messages.
• errors.footer - If present, the corresponding message will be rendered following the individual list of error messages.
• errors.prefix - If present, the corresponding message will be rendered before each individual error message.
• errors.suffix - If present, the corresponding message will be rendered after each individual error message.

Version:

$Rev: 164530 $ $Date: 2005-04-25 04:11:07 +0100 (Mon, 25 Apr 2005) $

See Also:

Serialized Form

bundle

protected java.lang.String bundle

The servlet context attribute key for our resources.

defaultLocale

protected static java.util.Locale defaultLocale

Deprecated. Use Locale.getDefault() directly.

The default locale on our server.

lineEnd

protected static java.lang.String lineEnd

Deprecated. No longer used.

The line ending string.

locale

protected java.lang.String locale

The session attribute key for our locale.

messages

protected static MessageResources messages

The message resources for this package.

name

protected java.lang.String name

The request attribute key for our error messages (if any).

property

protected java.lang.String property

The name of the property for which error messages should be returned, or null to return all errors.

header

protected java.lang.String header

The message resource key for errors header.

footer

protected java.lang.String footer

The message resource key for errors footer.

prefix

protected java.lang.String prefix

The message resource key for errors prefix.

suffix

protected java.lang.String suffix

The message resource key for errors suffix.

ErrorsTag

public ErrorsTag()

getBundle

public java.lang.String getBundle()

setBundle

public void setBundle(java.lang.String bundle)

getLocale

public java.lang.String getLocale()

setLocale

public void setLocale(java.lang.String locale)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getProperty

public java.lang.String getProperty()

setProperty

public void setProperty(java.lang.String property)

getHeader

public java.lang.String getHeader()

setHeader

public void setHeader(java.lang.String header)

getFooter

public java.lang.String getFooter()

setFooter

public void setFooter(java.lang.String footer)

getPrefix

public java.lang.String getPrefix()

setPrefix

public void setPrefix(java.lang.String prefix)

getSuffix

public java.lang.String getSuffix()

setSuffix

public void setSuffix(java.lang.String suffix)

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Render the specified error messages if there are any.

Overrides:

doStartTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException - if a JSP exception has occurred

release

public void release()

Release any acquired resources.

Overrides:

release in class javax.servlet.jsp.tagext.TagSupport