Package org.opencms.ade.containerpage.client

Class CmsContainerpageController.PageStateVisitor

java.lang.Object

org.opencms.ade.containerpage.client.CmsContainerpageController.PageStateVisitor

All Implemented Interfaces:

CmsContainerpageController.I_PageContentVisitor

Enclosing class:

CmsContainerpageController

protected class CmsContainerpageController.PageStateVisitor
extends Object
implements CmsContainerpageController.I_PageContentVisitor

Visitor implementation which is used to gather the container contents for saving.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_containerName	The current container name.
protected org.opencms.ade.containerpage.shared.CmsContainer	m_currentContainer	The contaienr which is currently being processed.
protected List<org.opencms.ade.containerpage.shared.CmsContainer>	m_resultContainers	The list of collected containers.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PageStateVisitor()

Method Summary

Modifier and Type	Method	Description
boolean	beginContainer(String name, org.opencms.ade.containerpage.shared.CmsContainer container)	This method is called before a container is processed.
void	endContainer()	This method is called after all elements of a container have been processed.
List<org.opencms.ade.containerpage.shared.CmsContainer>	getContainers()	Gets the list of collected containers.
void	handleElement(CmsContainerPageElementPanel elementWidget)	This method is called for each element of a container.

Methods inherited from class java.lang.Object

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

Field Details

m_containerName

protected String m_containerName

The current container name.

m_currentContainer

protected org.opencms.ade.containerpage.shared.CmsContainer m_currentContainer

The contaienr which is currently being processed.

m_resultContainers

protected List<org.opencms.ade.containerpage.shared.CmsContainer> m_resultContainers

The list of collected containers.

Constructor Details

PageStateVisitor

protected PageStateVisitor()

Method Details

beginContainer

public boolean beginContainer(String name,
 org.opencms.ade.containerpage.shared.CmsContainer container)

Description copied from interface: CmsContainerpageController.I_PageContentVisitor

This method is called before a container is processed.

If the method returns false, the container will be skipped.

Specified by:

beginContainer in interface CmsContainerpageController.I_PageContentVisitor

Parameters:

name - the container name

container - the container data object

Returns:

true if the container should be processed, true if it should be skipped

See Also:

• CmsContainerpageController.I_PageContentVisitor.beginContainer(java.lang.String, org.opencms.ade.containerpage.shared.CmsContainer)

endContainer

public void endContainer()

Description copied from interface: CmsContainerpageController.I_PageContentVisitor

This method is called after all elements of a container have been processed.

Specified by:

endContainer in interface CmsContainerpageController.I_PageContentVisitor

See Also:

• CmsContainerpageController.I_PageContentVisitor.endContainer()

getContainers

public List<org.opencms.ade.containerpage.shared.CmsContainer> getContainers()

Gets the list of collected containers.

Returns:

the list of containers

handleElement

public void handleElement(CmsContainerPageElementPanel elementWidget)

Description copied from interface: CmsContainerpageController.I_PageContentVisitor

This method is called for each element of a container.

Specified by:

handleElement in interface CmsContainerpageController.I_PageContentVisitor

Parameters:

elementWidget - the container element

See Also:

• CmsContainerpageController.I_PageContentVisitor.handleElement(org.opencms.ade.containerpage.client.ui.CmsContainerPageElementPanel)