org.opencms.xml.containerpage

类 CmsContainerBean

java.lang.Object

org.opencms.xml.containerpage.CmsContainerBean

public class CmsContainerBean
extends java.lang.Object

One container of a container page.

从以下版本开始:

8.0

构造器概要

构造器

构造器和说明
CmsContainerBean(java.lang.String name, java.lang.String type, int maxElements, java.util.List<CmsContainerElementBean> elements) Creates a new container bean.
CmsContainerBean(java.lang.String name, java.lang.String type, java.util.List<CmsContainerElementBean> elements) Creates a new container bean with an unlimited number of elements.

方法概要

方法

限定符和类型	方法和说明
boolean	containsElement(CmsUUID elementId) Returns true if the element with the provided id is contained in this container.
java.util.Map<CmsUUID,java.lang.Boolean>	getContainsElement() Returns a lazy initialized map that describes if a certain element if part of this container.
java.util.List<CmsUUID>	getElementIds() Returns the id's of all elements in this container.
java.util.List<CmsContainerElementBean>	getElements() Returns the elements in this container.
int	getMaxElements() Returns the maximal number of elements in this container.
java.lang.String	getName() Returns the name of this container.
java.lang.String	getType() Returns the type of this container.
java.lang.String	getWidth() Returns the container width set by the rendering container tag.
void	setMaxElements(int maxElements) Sets the maximal number of elements in the container.
void	setType(java.lang.String type) Sets the container type.
void	setWidth(java.lang.String width) Sets the client side render with of this container.

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

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

构造器详细资料

CmsContainerBean

public CmsContainerBean(java.lang.String name,
                java.lang.String type,
                int maxElements,
                java.util.List<CmsContainerElementBean> elements)

Creates a new container bean.

参数:

name - the container name

type - the container type

maxElements - the maximal number of elements in the container

elements - the elements

CmsContainerBean

public CmsContainerBean(java.lang.String name,
                java.lang.String type,
                java.util.List<CmsContainerElementBean> elements)

Creates a new container bean with an unlimited number of elements.

参数:

name - the container name

type - the container type

elements - the elements

方法详细资料

containsElement

public boolean containsElement(CmsUUID elementId)

Returns true if the element with the provided id is contained in this container.

参数:

elementId - the element id to check

返回:

true if the element with the provided id is contained in this container

getContainsElement

public java.util.Map<CmsUUID,java.lang.Boolean> getContainsElement()

Returns a lazy initialized map that describes if a certain element if part of this container.

返回:

a lazy initialized map that describes if a certain element if part of this container

getElementIds

public java.util.List<CmsUUID> getElementIds()

Returns the id's of all elements in this container.

返回:

the id's of all elements in this container

getElements

public java.util.List<CmsContainerElementBean> getElements()

Returns the elements in this container.

返回:

the elements in this container

getMaxElements

public int getMaxElements()

Returns the maximal number of elements in this container.

返回:

the maximal number of elements in this container

getName

public java.lang.String getName()

Returns the name of this container.

返回:

the name of this container

getType

public java.lang.String getType()

Returns the type of this container.

返回:

the type of this container

getWidth

public java.lang.String getWidth()

Returns the container width set by the rendering container tag.

返回:

the container width

setMaxElements

public void setMaxElements(int maxElements)

Sets the maximal number of elements in the container.

参数:

maxElements - the maximal number of elements to set

setType

public void setType(java.lang.String type)

Sets the container type.

参数:

type - the container type

setWidth

public void setWidth(java.lang.String width)

Sets the client side render with of this container.

参数:

width - the client side render with of this container