Package org.opencms.ade.containerpage.client

Class CmsContainerpageUtil

java.lang.Object

org.opencms.ade.containerpage.client.CmsContainerpageUtil

public class CmsContainerpageUtil
extends java.lang.Object

Utility class for the container-page editor.

Since:

8.0.0

Constructor Summary

Constructors

Constructor	Description
CmsContainerpageUtil(CmsContainerpageController controller, A_CmsToolbarOptionButton... optionButtons)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addOptionBar(CmsContainerPageElementPanel element)	Adds an option bar to the given drag element.
void	consumeContainerElements(I_CmsDropContainer container)	Transforms all contained elements into CmsContainerPageElementPanel.
java.util.Map<java.lang.String,CmsContainerPageContainer>	consumeContainers(java.util.Map<java.lang.String,org.opencms.ade.containerpage.shared.CmsContainer> containers, com.google.gwt.dom.client.Element context)	The method will create CmsContainerPageContainer object for all given containers by converting the associated DOM elements.
CmsContainerPageElementPanel	createElement(org.opencms.ade.containerpage.shared.CmsContainerElementData containerElement, I_CmsDropContainer container, boolean isNew)	Creates an drag container element.
CmsContainerPageElementPanel	createGroupcontainerElement(org.opencms.ade.containerpage.shared.CmsContainerElementData containerElement, java.util.List<org.opencms.ade.containerpage.shared.CmsContainerElementData> subElements, I_CmsDropContainer container)	Creates a drag container element for group-container elements.
CmsMenuListItem	createListItem(org.opencms.ade.containerpage.shared.CmsContainerElementData containerElement)	Creates a list item.
protected CmsContainerpageController	getController()	Returns the container page controller.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsContainerpageUtil

public CmsContainerpageUtil(CmsContainerpageController controller,
                            A_CmsToolbarOptionButton... optionButtons)

Constructor.

Parameters:

controller - the container page controller

optionButtons - the tool-bar option buttons

Method Detail

addOptionBar

public void addOptionBar(CmsContainerPageElementPanel element)

Adds an option bar to the given drag element.

Parameters:

element - the element

consumeContainerElements

public void consumeContainerElements(I_CmsDropContainer container)

Transforms all contained elements into CmsContainerPageElementPanel.

Parameters:

container - the container

consumeContainers

public java.util.Map<java.lang.String,CmsContainerPageContainer> consumeContainers(java.util.Map<java.lang.String,org.opencms.ade.containerpage.shared.CmsContainer> containers,
                                                                                         com.google.gwt.dom.client.Element context)

The method will create CmsContainerPageContainer object for all given containers by converting the associated DOM elements. The contained elements will be transformed into CmsContainerPageElementPanel.

Parameters:

containers - the container data

context - the parent element to the containers

Returns:

the drag target containers

createElement

public CmsContainerPageElementPanel createElement(org.opencms.ade.containerpage.shared.CmsContainerElementData containerElement,
                                                  I_CmsDropContainer container,
                                                  boolean isNew)
                                           throws java.lang.Exception

Creates an drag container element.

Parameters:

containerElement - the container element data

container - the container parent

isNew - in case of a newly created element

Returns:

the draggable element

Throws:

java.lang.Exception - if something goes wrong

createGroupcontainerElement

public CmsContainerPageElementPanel createGroupcontainerElement(org.opencms.ade.containerpage.shared.CmsContainerElementData containerElement,
                                                                java.util.List<org.opencms.ade.containerpage.shared.CmsContainerElementData> subElements,
                                                                I_CmsDropContainer container)
                                                         throws java.lang.Exception

Creates a drag container element for group-container elements.

Parameters:

containerElement - the container element data

subElements - the sub-elements

container - the drag parent

Returns:

the draggable element

Throws:

java.lang.Exception - if something goes wrong

createListItem

public CmsMenuListItem createListItem(org.opencms.ade.containerpage.shared.CmsContainerElementData containerElement)

Creates a list item.

Parameters:

containerElement - the element data

Returns:

the list item widget

getController

protected CmsContainerpageController getController()

Returns the container page controller.

Returns:

the container page controller