Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base.tags
Class ArgTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by javax.servlet.jsp.tagext.BodyTagSupport
          extended by com.jivesoftware.base.tags.I18nTag
              extended by com.jivesoftware.base.tags.ArgTag
All Implemented Interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class ArgTag
extends I18nTag

A simple Argument tag to be used with the i18n tag

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.jivesoftware.base.tags.I18nTag
arguments
 
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport
bodyContent
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id
 
Fields inherited from interface javax.servlet.jsp.tagext.BodyTag
EVAL_BODY_BUFFERED, EVAL_BODY_TAG
 
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
ArgTag()
          Constructor
 
Method Summary
 int doEndTag()
          Handles the actual work of getting and returning a localized string given the parameters and arguments passed in.
 int doStartTag()
          Always returns Tag.EVAL_BODY_BUFFERED.
 java.lang.String getValue()
          Returns the value of the i18n parameter for the parent i18n tag.
 void setBodyContent(javax.servlet.jsp.tagext.BodyContent bodyContent)
           
 void setValue(java.lang.String value)
          Sets the value of the i18n paramenter for the i18n tag.
 
Methods inherited from class com.jivesoftware.base.tags.I18nTag
addArgument, getBasename, getKey, setBasename, setKey, setPageContext
 
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doAfterBody, doInitBody, getBodyContent, getPreviousOut, release
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.servlet.jsp.tagext.Tag
getParent, setParent
 

Constructor Detail

ArgTag

public ArgTag()
Constructor

Method Detail

getValue

public java.lang.String getValue()
Returns the value of the i18n parameter for the parent i18n tag. See the class description for complete tag attribute description.

Returns:
the value of the i18n parameter for the parent i18n tag.

setValue

public void setValue(java.lang.String value)
Sets the value of the i18n paramenter for the i18n tag. See the class description for complete tag attribute description.

Parameters:
value - the value of the i18n parameter for the parent i18n tag.

setBodyContent

public void setBodyContent(javax.servlet.jsp.tagext.BodyContent bodyContent)
Specified by:
setBodyContent in interface javax.servlet.jsp.tagext.BodyTag
Overrides:
setBodyContent in class javax.servlet.jsp.tagext.BodyTagSupport

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspTagException
Description copied from class: I18nTag
Always returns Tag.EVAL_BODY_BUFFERED.

Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag in class I18nTag
Returns:
Always returns BodyTag.EVAL_BODY_BUFFERED
Throws:
javax.servlet.jsp.JspTagException
See Also:
BodyTag.EVAL_BODY_BUFFERED

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspTagException
Description copied from class: I18nTag
Handles the actual work of getting and returning a localized string given the parameters and arguments passed in.

Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doEndTag in class I18nTag
Returns:
Always returns Tag.EVAL_PAGE
Throws:
javax.servlet.jsp.JspTagException
See Also:
Tag.EVAL_PAGE

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.