Package org.opencms.jsp

Class CmsJspTagJsonObject

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

javax.servlet.jsp.tagext.BodyTagSupport

org.opencms.jsp.A_CmsJspJsonTag

org.opencms.jsp.CmsJspTagJsonObject

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, I_CmsJspJsonContext

public class CmsJspTagJsonObject
extends A_CmsJspJsonTag
implements I_CmsJspJsonContext

Tag for defining a JSON object. Key-value pairs created by nested JSON tags will be added to the object.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.opencms.jsp.A_CmsJspJsonTag

m_key, m_mode, m_scope, m_target, m_var

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
CmsJspTagJsonObject()	Default constructor explicitly resetting all variables.

Method Summary

Modifier and Type	Method	Description
void	addValue(String key, Object val)	Adds a value to the JSON value being constructed.
int	doStartTag()
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.

Methods inherited from class org.opencms.jsp.A_CmsJspJsonTag

addToTarget, doEndTag, getScope, release, setKey, setMode, setScope, setTarget, setVar

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

doAfterBody, doInitBody, 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 Details

CmsJspTagJsonObject

public CmsJspTagJsonObject()

Default constructor explicitly resetting all variables.

Method Details

addValue

public void addValue(String key,
 Object val)
              throws javax.servlet.jsp.JspException

Description copied from interface: I_CmsJspJsonContext

Adds a value to the JSON value being constructed.

For a JSON object, the key must be not null, and for a JSON array, it must always be null.

Specified by:

addValue in interface I_CmsJspJsonContext

Parameters:

key - the key (or null)

val - the value to add

Throws:

javax.servlet.jsp.JspException - in case the value could not be added

See Also:

• I_CmsJspJsonContext.addValue(java.lang.String, java.lang.Object)

doStartTag

public int doStartTag()

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.BodyTagSupport

See Also:

• BodyTagSupport.doStartTag()

getJsonValue

public Object getJsonValue()

Description copied from class: A_CmsJspJsonTag

Returns the JSON value that should be added to the surrounding context and/or stored in the variable given by the var attribute.

Specified by:

getJsonValue in class A_CmsJspJsonTag

Returns:

the value to add/store

See Also:

• A_CmsJspJsonTag.getJsonValue()

init

protected void init()

Initializes / resets the internal values.

Overrides:

init in class A_CmsJspJsonTag