org.opencms.ade.containerpage

类 CmsElementUtil

java.lang.Object

org.opencms.ade.containerpage.CmsElementUtil

public class CmsElementUtil
extends java.lang.Object

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

从以下版本开始:

8.0.0

构造器概要

构造器

构造器和说明
CmsElementUtil(CmsObject cms, java.lang.String currentPageUri, CmsUUID detailContentId, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.util.Locale locale) Creates a new instance.
CmsElementUtil(CmsObject cms, java.lang.String currentPageUri, CmsUUID detailContentId, java.lang.String requestParameters, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.util.Locale locale) Creates a new instance.

方法概要

方法

限定符和类型	方法和说明
java.lang.String	getContentByContainer(CmsFile elementFile, java.lang.String elementId, CmsContainer container) Returns the HTML content for the given resource and container.
java.util.Map<java.lang.String,java.lang.String>	getContentsByContainerName(CmsContainerElementBean element, java.util.Collection<CmsContainer> containers) Returns the rendered element content for all the given containers.
CmsContainerElementData	getElementData(CmsContainerElementBean element, java.util.Collection<CmsContainer> containers) Returns the data for an element.
CmsContainerElement	setElementInfo(CmsContainerElementBean elementBean, CmsContainerElement result) Sets the data to the given container element.

从类继承的方法 java.lang.Object

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

构造器详细资料

CmsElementUtil

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

Creates a new instance.

参数:

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

抛出:

CmsException - if something goes wrong

CmsElementUtil

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

Creates a new instance.

参数:

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

抛出:

CmsException - if something goes wrong

方法详细资料

getContentByContainer

public java.lang.String getContentByContainer(CmsFile elementFile,
                                     java.lang.String elementId,
                                     CmsContainer container)

Returns the HTML content for the given resource and container.

参数:

elementFile - the element resource file

elementId - the element id

container - the container

返回:

the HTML content

getContentsByContainerName

public java.util.Map<java.lang.String,java.lang.String> getContentsByContainerName(CmsContainerElementBean element,
                                                                          java.util.Collection<CmsContainer> containers)

Returns the rendered element content for all the given containers.

参数:

element - the element to render

containers - the containers the element appears in

返回:

a map from container names to rendered page contents

getElementData

public CmsContainerElementData getElementData(CmsContainerElementBean element,
                                     java.util.Collection<CmsContainer> containers)
                                       throws CmsException

Returns the data for an element.

参数:

element - the resource

containers - the containers on the current container page

返回:

the data for an element

抛出:

CmsException - if something goes wrong

setElementInfo

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

Sets the data to the given container element.

参数:

elementBean - the element bean

result - the container element to set the data to

返回:

the container element

抛出:

CmsException - if something goes wrong