Package org.opencms.ade.containerpage

Class CmsElementUtil

java.lang.Object

org.opencms.ade.containerpage.CmsElementUtil

public class CmsElementUtil
extends Object

Utility class to generate the element data objects used within the container-page editor.

Since:

8.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_NESTING_LEVEL	The maximum number of nested container levels.

Constructor Summary

Constructors

Constructor	Description
CmsElementUtil(CmsObject cms, String currentPageUri, CmsUUID detailContentId, String requestParameters, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, Locale locale)	Creates a new instance.
CmsElementUtil(CmsObject cms, String currentPageUri, CmsUUID detailContentId, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, Locale locale)	Creates a new instance.
CmsElementUtil(CmsObject cms, String currentPageUri, CmsContainerPageBean containerPage, CmsUUID detailContentId, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, boolean isDragMode, Locale locale)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
static boolean	checkGroupAllowed(String containerType, CmsGroupContainerBean groupContainer)	Checks if a group element is allowed in a container with a given type.
static CmsContainerBean	clientToServerContainer(CmsContainer container, List<CmsContainerElementBean> elements)	Converts a client container bean to a server container bean.
static Function<String,String>	createStringTemplateSource(I_CmsFormatterBean formatter, com.google.common.base.Supplier<CmsXmlContent> contentSupplier)	Helper method to create a string template source for a given formatter and content.
String	getContentByContainer(CmsFile elementFile, String elementId, CmsContainer container)	Returns the HTML content for the given resource and container.
CmsContainerElementData	getElementData(CmsResource page, CmsContainerElementBean element, Collection<CmsContainer> containers)	Returns the data for an element.
CmsElementSettingsConfig	getElementSettingsConfig(CmsResource page, CmsContainerElementBean element, String containerId, Collection<CmsContainer> containers)	Returns the formatter and settings config data for an element.
static I_CmsFormatterBean	getFormatterForContainer(CmsObject cms, CmsContainerElementBean element, CmsContainer container, CmsADEConfigData config, CmsADESessionCache cache)	Returns the formatter bean for the given element and container.
CmsResource	getPage()	Gets the container page.
static Set<CmsUUID>	getPageAndDetailOnlyIds(CmsObject cms, CmsUUID pageId, CmsResource detailContent)	Gets the ids for the current page and potentially detail-only containers.
static final boolean	isSystemSetting(String name)	Checks if the given setting name is a system setting.
CmsContainerElement	setElementInfo(CmsContainerElementBean elementBean, CmsContainerElement result)	Sets the data to the given container element.

Methods inherited from class java.lang.Object

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

Field Details

MAX_NESTING_LEVEL

public static final int MAX_NESTING_LEVEL

The maximum number of nested container levels.

See Also:

• Constant Field Values

Constructor Details

CmsElementUtil

public CmsElementUtil(CmsObject cms,
 String currentPageUri,
 CmsContainerPageBean containerPage,
 CmsUUID detailContentId,
 javax.servlet.http.HttpServletRequest req,
 javax.servlet.http.HttpServletResponse res,
 boolean isDragMode,
 Locale locale)
               throws CmsException

Creates a new instance.

Use this constructor to set the current container page state.

Parameters:

cms - the cms context

currentPageUri - the current page uri

containerPage - the container page bean with the current container state

detailContentId - the detail content structure id

req - the http request

res - the http response

isDragMode - if the page is in drag mode

locale - the content locale

Throws:

CmsException - if something goes wrong

CmsElementUtil

public CmsElementUtil(CmsObject cms,
 String currentPageUri,
 CmsUUID detailContentId,
 javax.servlet.http.HttpServletRequest req,
 javax.servlet.http.HttpServletResponse res,
 Locale locale)
               throws CmsException

Creates a new instance.

Parameters:

cms - the cms context

currentPageUri - the current page uri

detailContentId - the detail content structure id

req - the http request

res - the http response

locale - the content locale

Throws:

CmsException - if something goes wrong

CmsElementUtil

public CmsElementUtil(CmsObject cms,
 String currentPageUri,
 CmsUUID detailContentId,
 String requestParameters,
 javax.servlet.http.HttpServletRequest req,
 javax.servlet.http.HttpServletResponse res,
 Locale locale)
               throws CmsException

Creates a new instance.

Parameters:

cms - the cms context

currentPageUri - the current page uri

detailContentId - the detail content structure id

requestParameters - the request parameters to use while rendering the elements

req - the http request

res - the http response

locale - the content locale

Throws:

CmsException - if something goes wrong

Method Details

checkGroupAllowed

public static boolean checkGroupAllowed(String containerType,
 CmsGroupContainerBean groupContainer)

Checks if a group element is allowed in a container with a given type.

Parameters:

containerType - the container type spec (comma separated)

groupContainer - the group

Returns:

true if the group is allowed in the container

clientToServerContainer

public static CmsContainerBean clientToServerContainer(CmsContainer container,
 List<CmsContainerElementBean> elements)

Converts a client container bean to a server container bean.

Parameters:

container - the client container

elements - the elements of the container

Returns:

the server container bean

createStringTemplateSource

public static Function<String,String> createStringTemplateSource(I_CmsFormatterBean formatter,
 com.google.common.base.Supplier<CmsXmlContent> contentSupplier)

Helper method to create a string template source for a given formatter and content.

Parameters:

formatter - the formatter

contentSupplier - the content supplier

Returns:

the string template provider

getFormatterForContainer

public static I_CmsFormatterBean getFormatterForContainer(CmsObject cms,
 CmsContainerElementBean element,
 CmsContainer container,
 CmsADEConfigData config,
 CmsADESessionCache cache)

Returns the formatter bean for the given element and container.

Parameters:

cms - the cms context

element - the element to render

container - the container

config - the configuration data

cache - the session cache

Returns:

the formatter bean

getPageAndDetailOnlyIds

public static Set<CmsUUID> getPageAndDetailOnlyIds(CmsObject cms,
 CmsUUID pageId,
 CmsResource detailContent)

Gets the ids for the current page and potentially detail-only containers.

Parameters:

cms - the CMS context

pageId - the id for the current page

detailContent - the current detail content

Returns:

the set of ids for the current page and detail-only containers

isSystemSetting

public static final boolean isSystemSetting(String name)

Checks if the given setting name is a system setting.

Parameters:

name - the setting name

Returns:

true if the name corresponds to a system setting

getContentByContainer

public String getContentByContainer(CmsFile elementFile,
 String elementId,
 CmsContainer container)

Returns the HTML content for the given resource and container.

Parameters:

elementFile - the element resource file

elementId - the element id

container - the container

Returns:

the HTML content

getElementData

public CmsContainerElementData getElementData(CmsResource page,
 CmsContainerElementBean element,
 Collection<CmsContainer> containers)
                                       throws CmsException

Returns the data for an element.

Parameters:

page - the current container page

element - the resource

containers - the containers on the current container page

Returns:

the data for an element

Throws:

CmsException - if something goes wrong

getElementSettingsConfig

public CmsElementSettingsConfig getElementSettingsConfig(CmsResource page,
 CmsContainerElementBean element,
 String containerId,
 Collection<CmsContainer> containers)
                                                  throws CmsException

Returns the formatter and settings config data for an element.

Parameters:

page - the current container page

element - the resource

containerId - the parent container id

containers - the containers on the current container page

Returns:

the data for an element

Throws:

CmsException - if something goes wrong

getPage

public CmsResource getPage()

Gets the container page.

Returns:

the container page resource

setElementInfo

public CmsContainerElement setElementInfo(CmsContainerElementBean elementBean,
 CmsContainerElement result)
                                   throws CmsException

Sets the data to the given container element.

Parameters:

elementBean - the element bean

result - the container element to set the data to

Returns:

the container element

Throws:

CmsException - if something goes wrong