org.apache.beehive.netui.tags.html
Class Parameter

Object
  extended by TagSupport
      extended by BodyTagSupport
          extended by AbstractClassicTag
              extended by Parameter
All Implemented Interfaces:
Serializable, BodyTag, IterationTag, JspTag, Tag, INetuiTag

public class Parameter
extends AbstractClassicTag

Writes a URL parameter to a URL on its parent tag. The parent tag must implement IUrlParams.

See Also:
Serialized Form
Example
In this sample, the hyperlink is amended with the parameter q=Socrates
      <netui:anchor href="http://www.google.com/search">
          Search Google with the query "Socrates"
          <netui:parameter name="q" value="Socrates" />
      </netui:anchor>
The URL produced appears below:
      http://www.google.com/search?q=Socrates

Field Summary
 
Fields inherited from class AbstractClassicTag
DefaultNamingChain, EMPTY_STRING, NETUI_UNIQUE_CNT
 
Fields inherited from class BodyTagSupport
bodyContent
 
Fields inherited from class TagSupport
id, pageContext
 
Fields inherited from interface BodyTag
EVAL_BODY_BUFFERED, EVAL_BODY_TAG
 
Fields inherited from interface IterationTag
EVAL_BODY_AGAIN
 
Fields inherited from interface Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
Parameter()
           
 
Method Summary
 int doStartTag()
          Add the URL parameter to the Parameter's parent.
 String getTagName()
          Return the name of the Tag.
protected  void localRelease()
          Release any acquired resources.
 void setName(String name)
          Sets the name of the URL parameter.
 void setValue(Object value)
          Sets the value of the URL parameter.
 
Methods inherited from class AbstractClassicTag
applyNamingChain, getErrorsReport, getIdForTagId, getNamingChain, getNearestForm, getNextId, getScriptReporter, getUserLocale, hasErrors, qualifyAttribute, registerTagError, registerTagError, reportAndExit, reportErrors, rewriteName, setNonEmptyValueAttribute, setRequiredValueAttribute, write
 
Methods inherited from class BodyTagSupport
doAfterBody, doEndTag, doInitBody, getBodyContent, getPreviousOut, release, setBodyContent
 
Methods inherited from class TagSupport
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface Tag
getParent, setPageContext, setParent
 

Constructor Detail

Parameter

public Parameter()
Method Detail

getTagName

public String getTagName()
Return the name of the Tag.

Specified by:
getTagName in interface INetuiTag
Specified by:
getTagName in class AbstractClassicTag
Returns:
the name of the tag.

setName

public void setName(String name)
Sets the name of the URL parameter.

Parameters:
name - the parameter name.

setValue

public void setValue(Object value)
              throws JspException
Sets the value of the URL parameter. This can be an expression.

Parameters:
value - the parameter value.
Throws:
JspException

doStartTag

public int doStartTag()
               throws JspException
Add the URL parameter to the Parameter's parent.

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

localRelease

protected void localRelease()
Release any acquired resources.

Overrides:
localRelease in class AbstractClassicTag