Package org.opencms.jsp.util

Class CmsJspContainerPageWrapper

java.lang.Object

org.opencms.jsp.util.CmsJspContainerPageWrapper

public class CmsJspContainerPageWrapper
extends Object

Wrapper for using container pages in JSPs.

Constructor Summary

Constructors

Constructor	Description
CmsJspContainerPageWrapper(CmsObject cms, CmsContainerPageBean page)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
boolean	containsElement(CmsUUID elementId)	Checks if the page contains an element with a given id.
Map<String,CmsContainerBean>	getContainers()	Gets the containers.
Map<CmsUUID,Boolean>	getContainsElement()	Returns a map which tracks which element ids are part of the page.
List<CmsUUID>	getElementIds()	Gets the element ids.
List<CmsContainerElementBean>	getElements()	Gets the container elements
List<String>	getNames()	Gets the container names.
Map<?,?>	getSettingsForElement(String elementInstanceId)	Gets the element settings for the element with the specific instance id.
Set<String>	getTypes()
String	renderContainer(CmsJspStandardContextBean context, String name)	Renders the element in the container with the given name or name prefix.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsJspContainerPageWrapper

public CmsJspContainerPageWrapper(CmsObject cms,
 CmsContainerPageBean page)

Creates a new instance.

Parameters:

page - the container page to wrap

Method Details

containsElement

public boolean containsElement(CmsUUID elementId)

Checks if the page contains an element with a given id.

Parameters:

elementId - the element id to check

Returns:

true if the page contains the element

getContainers

public Map<String,CmsContainerBean> getContainers()

Gets the containers.

Returns:

the containers

getContainsElement

public Map<CmsUUID,Boolean> getContainsElement()

Returns a map which tracks which element ids are part of the page.

Returns:

a map from element ids to their page membership

getElementIds

public List<CmsUUID> getElementIds()

Gets the element ids.

Returns:

the container element ids

getElements

public List<CmsContainerElementBean> getElements()

Gets the container elements

Returns:

the container elements

getNames

public List<String> getNames()

Gets the container names.

Returns:

the container names

getSettingsForElement

public Map<?,?> getSettingsForElement(String elementInstanceId)

Gets the element settings for the element with the specific instance id.

The returned map contains the setting names as keys and the corresponding setting values as wrapper objects.

Parameters:

elementInstanceId - the element instance id

Returns:

the map of setting wrappers

getTypes

public Set<String> getTypes()

renderContainer

public String renderContainer(CmsJspStandardContextBean context,
 String name)

Renders the element in the container with the given name or name prefix.

Parameters:

context - the context bean

name - the container name or name prefix

Returns:

the rendered HTML