Package org.opencms.jsp

Class CmsJspTagJsonValue

  • 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 CmsJspTagJsonValue
extends A_CmsJspJsonTag
    Adds a JSON value to the surrounding context and/or stores it as a variable in the page context.
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

        bodyContent

      • Fields inherited from class javax.servlet.jsp.tagext.TagSupport

        id, pageContext

      • 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

      Constructors 
      Constructor Description
      CmsJspTagJsonValue()
      Default constructor explicitly resetting all variables.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int doEndTag()  
      java.lang.Object getJsonValue()
      Returns the JSON value that should be added to the surrounding context and/or stored in the variable given by the var attribute.
      protected void init()
      Initializes / resets the internal values.
      protected void setError​(java.lang.String errorMessage)
      If an error variable has been specified, store the given error message in that variable.
      void setErrorVar​(java.lang.String errorVar)
      Variable to store errors under in the page scope.
      void setParse​(java.lang.String parse)
      Sets the parse attribute.
      void setValue​(java.lang.Object value)
      Sets the value attribute.

      • Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport

        doAfterBody, doInitBody, doStartTag, getBodyContent, getPreviousOut, setBodyContent

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

        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

      • Methods inherited from interface javax.servlet.jsp.tagext.Tag

        getParent, setPageContext, setParent

    • Constructor Detail

      • CmsJspTagJsonValue

        public CmsJspTagJsonValue()
        Default constructor explicitly resetting all variables.

    • Method Detail

      • setErrorVar

        public void setErrorVar​(java.lang.String errorVar)
        Variable to store errors under in the page scope.
        Parameters:
        errorVar - the error variable

      • setParse

        public void setParse​(java.lang.String parse)
        Sets the parse attribute.

        If set to 'true', the value will be treated as a string and then parsed into JSON.

        Parameters:
        parse - the value being set

      • setValue

        public void setValue​(java.lang.Object value)
        Sets the value attribute.
        Parameters:
        value - the JSON value

      • init

        protected void init()
        Initializes / resets the internal values.

        Overrides:
        init in class A_CmsJspJsonTag

      • setError

        protected void setError​(java.lang.String errorMessage)
        If an error variable has been specified, store the given error message in that variable.
        Parameters:
        errorMessage - the error message