org.opencms.ade.containerpage.shared
Class CmsContainer

java.lang.Object
  org.opencms.ade.containerpage.shared.CmsContainer

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable

public class CmsContainer
extends java.lang.Object
implements com.google.gwt.user.client.rpc.IsSerializable

Container bean.

Since:

8.0.0

Field Summary

static java.lang.String

KEY_CONTAINER_DATA Key for container data.

Constructor Summary

protected	CmsContainer() Hidden default constructor (for GWT serialization).
	CmsContainer(java.lang.String name, java.lang.String type, int width, int maxElements, java.util.List<CmsContainerElement> elements) Constructor.

Method Summary

java.util.List<CmsContainerElement>	getElements() Returns the list of the contained elements id's.
int	getMaxElements() Returns the maximum number of elements allowed in this container.
java.lang.String	getName() Returns the container name, also used as HTML-id for the container DOM-element.
java.lang.String	getType() Returns the container type.
int	getWidth() Returns the container width.
void	setElements(java.util.List<CmsContainerElement> elements) Sets the elements contained in this container.
void	setMaxElements(int maxElements) Sets the maxElements.
void	setName(java.lang.String name) Sets the name.
void	setType(java.lang.String type) Sets the type.

Methods inherited from class java.lang.Object

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

Field Detail

KEY_CONTAINER_DATA

public static final java.lang.String KEY_CONTAINER_DATA

Key for container data. This has to be identical with CmsJspTagContainer.KEY_CONTAINER_DATA.

See Also:

Constant Field Values

Constructor Detail

CmsContainer

public CmsContainer(java.lang.String name,
                    java.lang.String type,
                    int width,
                    int maxElements,
                    java.util.List<CmsContainerElement> elements)

Constructor.

Parameters:

name - the container name, also used as id within a container-page

type - the container type

width - the width of the container

maxElements - the maximum number of elements displayed by this container

elements - the container elements id's

CmsContainer

protected CmsContainer()

Hidden default constructor (for GWT serialization).

Method Detail

getElements

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

Returns the list of the contained elements id's.

Returns:

the list of the contained elements id's

getMaxElements

public int getMaxElements()

Returns the maximum number of elements allowed in this container.

Returns:

the maximum number of elements allowed in this container

getName

public java.lang.String getName()

Returns the container name, also used as HTML-id for the container DOM-element. Has to be unique within the template.

Returns:

the container name

getType

public java.lang.String getType()

Returns the container type. Used to determine the formatter used to render the contained elements.

Returns:

the container type

getWidth

public int getWidth()

Returns the container width.

Returns:

the container width

setElements

public void setElements(java.util.List<CmsContainerElement> elements)

Sets the elements contained in this container.

Parameters:

elements - the elements

setMaxElements

public void setMaxElements(int maxElements)

Sets the maxElements.

Parameters:

maxElements - the maxElements to set

setName

public void setName(java.lang.String name)

Sets the name.

Parameters:

name - the name to set

setType

public void setType(java.lang.String type)

Sets the type.

Parameters:

type - the type to set