org.opencms.xml.containerpage
Class CmsContainerBean

java.lang.Object
  org.opencms.xml.containerpage.CmsContainerBean

public class CmsContainerBean
extends Object

One container of a container page.

Since:

8.0

Constructor Summary

CmsContainerBean(String name, String type, int maxElements, List<CmsContainerElementBean> elements)
Creates a new container bean.

CmsContainerBean(String name, String type, List<CmsContainerElementBean> elements)
Creates a new container bean with an unlimited number of elements.

Method Summary

boolean	containsElement(CmsUUID elementId) Returns true if the element with the provided id is contained in this container.
Map<CmsUUID,Boolean>	getContainsElement() Returns a lazy initialized map that describes if a certain element if part of this container.
List<CmsUUID>	getElementIds() Returns the id's of all elements in this container.
List<CmsContainerElementBean>	getElements() Returns the elements in this container.
int	getMaxElements() Returns the maximal number of elements in this container.
String	getName() Returns the name of this container.
String	getType() Returns the type of this container.
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	setWidth(String width) Sets the client side render with of this container.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsContainerBean

public CmsContainerBean(String name,
                        String type,
                        int maxElements,
                        List<CmsContainerElementBean> elements)

Creates a new container bean.

Parameters:

name - the container name

type - the container type

maxElements - the maximal number of elements in the container

elements - the elements

CmsContainerBean

public CmsContainerBean(String name,
                        String type,
                        List<CmsContainerElementBean> elements)

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

Parameters:

name - the container name

type - the container type

elements - the elements

Method Detail

containsElement

public boolean containsElement(CmsUUID elementId)

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

Parameters:

elementId - the element id to check

Returns:

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

getContainsElement

public Map<CmsUUID,Boolean> getContainsElement()

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

Returns:

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

getElementIds

public List<CmsUUID> getElementIds()

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

Returns:

the id's of all elements in this container

getElements

public List<CmsContainerElementBean> getElements()

Returns the elements in this container.

Returns:

the elements in this container

getMaxElements

public int getMaxElements()

Returns the maximal number of elements in this container.

Returns:

the maximal number of elements in this container

getName

public String getName()

Returns the name of this container.

Returns:

the name of this container

getType

public String getType()

Returns the type of this container.

Returns:

the type of this container

getWidth

public String getWidth()

Returns the container width set by the rendering container tag.

Returns:

the container width

setMaxElements

public void setMaxElements(int maxElements)

Sets the maximal number of elements in the container.

Parameters:

maxElements - the maximal number of elements to set

setWidth

public void setWidth(String width)

Sets the client side render with of this container.

Parameters:

width - the client side render with of this container