org.apache.struts.taglib.bean
Class MessageTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by org.apache.struts.taglib.bean.MessageTag
All Implemented Interfaces:
Serializable, IterationTag, Tag
Direct Known Subclasses:
NestedMessageTag

public class MessageTag
extends TagSupport

Custom tag that retrieves an internationalized messages string (with optional parametric replacement) from the ActionResources object stored as a context attribute by our associated ActionServlet implementation.

Version:
$Rev: 471754 $ $Date: 2005-09-16 09:38:33 -0400 (Fri, 16 Sep 2005) $
See Also:
Serialized Form

Field Summary
protected  String arg0
          The first optional argument.
protected  String arg1
          The second optional argument.
protected  String arg2
          The third optional argument.
protected  String arg3
          The fourth optional argument.
protected  String arg4
          The fifth optional argument.
protected  String bundle
          The servlet context attribute key for our resources.
protected  String key
          The message key of the message to be retrieved.
protected  String localeKey
          The session scope key under which our Locale is stored.
protected static org.apache.struts.util.MessageResources messages
          The message resources for this package.
protected  String name
          Name of the bean that contains the message key.
protected  String property
          Name of the property to be accessed on the specified bean.
protected  String scope
          The scope to be searched to retrieve the specified bean.
 
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
MessageTag()
           
 
Method Summary
 int doStartTag()
          Process the start tag.
 String getArg0()
           
 String getArg1()
           
 String getArg2()
           
 String getArg3()
           
 String getArg4()
           
 String getBundle()
           
 String getKey()
           
 String getLocale()
           
 String getName()
           
 String getProperty()
           
 String getScope()
           
 void release()
          Release any acquired resources.
 void setArg0(String arg0)
           
 void setArg1(String arg1)
           
 void setArg2(String arg2)
           
 void setArg3(String arg3)
           
 void setArg4(String arg4)
           
 void setBundle(String bundle)
           
 void setKey(String key)
           
 void setLocale(String localeKey)
           
 void setName(String name)
           
 void setProperty(String property)
           
 void setScope(String scope)
           
 
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

messages

protected static org.apache.struts.util.MessageResources messages
The message resources for this package.


arg0

protected String arg0
The first optional argument.


arg1

protected String arg1
The second optional argument.


arg2

protected String arg2
The third optional argument.


arg3

protected String arg3
The fourth optional argument.


arg4

protected String arg4
The fifth optional argument.


bundle

protected String bundle
The servlet context attribute key for our resources.


key

protected String key
The message key of the message to be retrieved.


name

protected String name
Name of the bean that contains the message key.


property

protected String property
Name of the property to be accessed on the specified bean.


scope

protected String scope
The scope to be searched to retrieve the specified bean.


localeKey

protected String localeKey
The session scope key under which our Locale is stored.

Constructor Detail

MessageTag

public MessageTag()
Method Detail

getArg0

public String getArg0()

setArg0

public void setArg0(String arg0)

getArg1

public String getArg1()

setArg1

public void setArg1(String arg1)

getArg2

public String getArg2()

setArg2

public void setArg2(String arg2)

getArg3

public String getArg3()

setArg3

public void setArg3(String arg3)

getArg4

public String getArg4()

setArg4

public void setArg4(String arg4)

getBundle

public String getBundle()

setBundle

public void setBundle(String bundle)

getKey

public String getKey()

setKey

public void setKey(String key)

getName

public String getName()

setName

public void setName(String name)

getProperty

public String getProperty()

setProperty

public void setProperty(String property)

getScope

public String getScope()

setScope

public void setScope(String scope)

getLocale

public String getLocale()

setLocale

public void setLocale(String localeKey)

doStartTag

public int doStartTag()
               throws JspException
Process the start tag.

Specified by:
doStartTag in interface Tag
Overrides:
doStartTag in class TagSupport
Throws:
JspException - if a JSP exception has occurred

release

public void release()
Release any acquired resources.

Specified by:
release in interface Tag
Overrides:
release in class TagSupport


Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.