Package org.opencms.xml.xml2json.document

Class CmsJsonDocumentEmbeddedXmlContent

java.lang.Object

org.opencms.xml.xml2json.document.A_CmsJsonDocument

org.opencms.xml.xml2json.document.CmsJsonDocumentResource

org.opencms.xml.xml2json.document.CmsJsonDocumentXmlContent

org.opencms.xml.xml2json.document.CmsJsonDocumentEmbeddedXmlContent

All Implemented Interfaces:

I_CmsJsonDocument

public class CmsJsonDocumentEmbeddedXmlContent
extends CmsJsonDocumentXmlContent

Class representing a JSON document for an embedded XML content.

Field Summary

Fields inherited from class org.opencms.xml.xml2json.document.CmsJsonDocumentXmlContent

m_embedLinkedModelgroup, m_throwException, m_xmlContent

Fields inherited from class org.opencms.xml.xml2json.document.CmsJsonDocumentResource

m_helper, m_resource

Fields inherited from class org.opencms.xml.xml2json.document.A_CmsJsonDocument

FIELD_LINKED_CONTENTS, m_context, m_json, m_jsonRequest

Constructor Summary

Constructors

Constructor	Description
CmsJsonDocumentEmbeddedXmlContent(CmsJsonRequest jsonRequest, CmsXmlContent xmlContent)	Creates a new JSON document.

Method Summary

Modifier and Type	Method	Description
protected boolean	isShowWrapperRequest()	Whether to show the wrapper with resource information.

Methods inherited from class org.opencms.xml.xml2json.document.CmsJsonDocumentXmlContent

getJson, insertJsonLinkedContent, insertJsonLinkedContents, insertJsonWrapper, isLocaleAllRequest, isLocalePathRequest, isLocaleRequest, isShowFallbackLocaleRequest, isShowLinkedContentsRequest

Methods inherited from class org.opencms.xml.xml2json.document.CmsJsonDocumentResource

insertJsonResource, insertJsonResourceAttributes, insertJsonResourceFile, insertJsonResourceParams, insertJsonResourcePathAndLink, insertJsonResourceProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsJsonDocumentEmbeddedXmlContent

public CmsJsonDocumentEmbeddedXmlContent(CmsJsonRequest jsonRequest,
                                         CmsXmlContent xmlContent)
                                  throws java.lang.Exception

Creates a new JSON document.

Parameters:

jsonRequest - the JSON request

xmlContent - the XML content

Throws:

java.lang.Exception - if something goes wrong

Method Detail

isShowWrapperRequest

protected boolean isShowWrapperRequest()

Description copied from class: CmsJsonDocumentXmlContent

Whether to show the wrapper with resource information. For backward compatibility the wrapper is shown for the all locale request but not for the locale and locale path request as a default. This default behavior can be changed by means of the "wrapper" request parameter. For locale path requests, wrapper information is not available.

Overrides:

isShowWrapperRequest in class CmsJsonDocumentXmlContent

Returns:

whether to show the wrapper or not

See Also:

CmsJsonDocumentXmlContent.isShowWrapperRequest()