Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.apache.struts.taglib.wml
Class ErrorsTag  view ErrorsTag download ErrorsTag.java

java.lang.Object
  extended byjavax.servlet.jsp.tagext.TagSupport
      extended byorg.apache.struts.taglib.wml.ErrorsTag
All Implemented Interfaces:
javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, 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 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:

Version:
$Revision: 1.2 $

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.
private static java.lang.String FOOTER
           
private static java.lang.String HEADER
           
protected  java.lang.String locale
          The session attribute key for our locale.
protected static org.apache.struts.util.MessageResources messages
          The message resources for this package.
protected  java.lang.String name
          The request attribute key for our error messages (if any).
private static java.lang.String NEW_LINE
           
private static java.lang.String PREFIX
           
protected  java.lang.String property
          The name of the property for which error messages should be returned, or null to return all errors.
private static java.lang.String SUFFIX
           
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
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, toString, wait, wait, wait
 

Field Detail

HEADER

private static java.lang.String HEADER

FOOTER

private static java.lang.String FOOTER

PREFIX

private static java.lang.String PREFIX

SUFFIX

private static java.lang.String SUFFIX

NEW_LINE

private static java.lang.String NEW_LINE

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 org.apache.struts.util.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.


release

public void release()
Release any acquired resources.