Apache Struts API Documentation: Class ErrorsTag

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.struts.taglib.html
Class ErrorsTag

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

All Implemented Interfaces:
  javax.servlet.jsp.tagext.IterationTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag

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 application'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.

Version:
  $Revision: 1.1 $ $Date: 2001-09-17 21:13:30 +0100 (Mon, 17 Sep 2001) $
Author:
  Craig R. McClanahan
See Also:
  Serialized Form

Field Summary
`protected java.lang.String` | `bundle` The servlet context attribute key for our resources.
`protected static java.util.Locale` | `defaultLocale` The default locale on our server.
`protected java.lang.String` | `locale` The session attribute key for our locale.
`protected static MessageResources` | `messages` The message resources for this package.
`protected java.lang.String` | `name` The request attribute key for our error messages (if any).
`protected java.lang.String` | `property` The name of the property for which error messages should be returned, or `null` to return all errors.

Fields inherited from class javax.servlet.jsp.tagext.TagSupport
`id, pageContext, parent, values`

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
`EVAL_BODY_AGAIN`

Fields inherited from interface javax.servlet.jsp.tagext.Tag
`EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE`

Constructor Summary
`ErrorsTag()`

Method Summary
`int` | `doStartTag()` Render the specified error messages if there are any.
`java.lang.String` | `getBundle()`
`java.lang.String` | `getLocale()`
`java.lang.String` | `getName()`
`java.lang.String` | `getProperty()`
`void` | `release()` Release any acquired resources.
`void` | `setBundle(java.lang.String bundle)`
`void` | `setLocale(java.lang.String locale)`
`void` | `setName(java.lang.String name)`
`void` | `setProperty(java.lang.String property)`

Methods inherited from class javax.servlet.jsp.tagext.TagSupport
`doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue`

Methods inherited from class java.lang.Object
`, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait`

Field Detail

### bundle

    protected java.lang.String bundle

  The servlet context attribute key for our resources.

### defaultLocale

    protected static java.util.Locale defaultLocale

  The default locale on our server.

### 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.

Constructor Detail

### ErrorsTag

    public ErrorsTag()

Method Detail

### 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)

### 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`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2001 - Apache Software Foundation