Package org.opencms.jsp

Class CmsJspTagAddParams

java.lang.Object
javax.servlet.jsp.tagext.TagSupport
org.opencms.jsp.CmsJspTagAddParams
All Implemented Interfaces:
Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, javax.servlet.jsp.tagext.TryCatchFinally, I_CmsJspTagParamParent
public class CmsJspTagAddParams extends javax.servlet.jsp.tagext.TagSupport implements I_CmsJspTagParamParent, javax.servlet.jsp.tagext.TryCatchFinally
This tag is used to dynamically add request parameters which are available during the execution of its body.

Request parameters are added with the <cms:param> tag.

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    CmsJspTagAddParams.ParamState
    Keeps track of the runtime state of a single execution of this tag.

  • Field Summary

    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

    Constructors
    Constructor
    Description
    CmsJspTagAddParams()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addParameter(String name, String value)
    Add a parameter to this tag.
    void
    doCatch(Throwable t)
     
    void
    doFinally()
     
    int
    doStartTag()
     

    Methods inherited from class javax.servlet.jsp.tagext.TagSupport

    doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

  • Method Details

    • addParameter

      public void addParameter(String name, String value)
      Description copied from interface: I_CmsJspTagParamParent
      Add a parameter to this tag. The intent is that the <param> subtag will call this to register parameters. Assumes that 'name' and 'value' are appropriately encoded and do not contain any meaningful metacharacters; in order words, escaping is the responsibility of the caller.
      Specified by:
      addParameter in interface I_CmsJspTagParamParent
      Parameters:
      name - the name of the parameter
      value - the value of the parameter
      See Also:

    • doCatch

      public void doCatch(Throwable t) throws Throwable
      Specified by:
      doCatch in interface javax.servlet.jsp.tagext.TryCatchFinally
      Throws:
      Throwable
      See Also:
      • TryCatchFinally.doCatch(java.lang.Throwable)

    • doFinally

      public void doFinally()
      Specified by:
      doFinally in interface javax.servlet.jsp.tagext.TryCatchFinally
      See Also:
      • TryCatchFinally.doFinally()

    • doStartTag

      public int doStartTag()
      Specified by:
      doStartTag in interface javax.servlet.jsp.tagext.Tag
      Overrides:
      doStartTag in class javax.servlet.jsp.tagext.TagSupport
      See Also:
      • TagSupport.doStartTag()