Package org.opencms.ade.containerpage.client

Class CmsContainerpageDNDController

java.lang.Object

org.opencms.ade.containerpage.client.CmsContainerpageDNDController

All Implemented Interfaces:

I_CmsDNDController

public class CmsContainerpageDNDController
extends java.lang.Object
implements I_CmsDNDController

The container-page editor drag and drop controller.

Since:

8.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static int	HIGHLIGHTING_OFFSET	The container highlighting offset.
protected CmsContainerpageController	m_controller	The container page controller.
protected java.lang.String	m_draggableId	The id of the dragged element.

Constructor Summary

Constructors

Constructor	Description
CmsContainerpageDNDController(CmsContainerpageController controller)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	onAnimationStart(I_CmsDraggable draggable, I_CmsDropTarget target, CmsDNDHandler handler)	Executed when end animation starts.
boolean	onBeforeDrop(I_CmsDraggable draggable, I_CmsDropTarget target, CmsDNDHandler handler)	Executed before drop.
void	onDragCancel(I_CmsDraggable draggable, I_CmsDropTarget target, CmsDNDHandler handler)	Executed on drag cancel.
boolean	onDragStart(I_CmsDraggable draggable, I_CmsDropTarget target, CmsDNDHandler handler)	Executed on drag start.
void	onDrop(I_CmsDraggable draggable, I_CmsDropTarget target, CmsDNDHandler handler)	Executed on drop.
void	onPositionedPlaceholder(I_CmsDraggable draggable, I_CmsDropTarget target, CmsDNDHandler handler)	Executed after the placeholder has been positioned inside a drop target.
boolean	onTargetEnter(I_CmsDraggable draggable, I_CmsDropTarget target, CmsDNDHandler handler)	Executed when the helper is dragged into a drop target.
void	onTargetLeave(I_CmsDraggable draggable, I_CmsDropTarget target, CmsDNDHandler handler)	Executed when the helper is dragged out of a drop target.
protected void	prepareHelperElements(org.opencms.ade.containerpage.shared.CmsContainerElementData elementData, CmsDNDHandler handler, I_CmsDraggable draggable)	Prepares all helper elements for the different drop targets.

Methods inherited from class java.lang.Object

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

Field Detail

HIGHLIGHTING_OFFSET

public static final int HIGHLIGHTING_OFFSET

The container highlighting offset.

See Also:

Constant Field Values

m_controller

protected CmsContainerpageController m_controller

The container page controller.

m_draggableId

protected java.lang.String m_draggableId

The id of the dragged element.

Constructor Detail

CmsContainerpageDNDController

public CmsContainerpageDNDController(CmsContainerpageController controller)

Constructor.

Parameters:

controller - the container page controller

Method Detail

onAnimationStart

public void onAnimationStart(I_CmsDraggable draggable,
                             I_CmsDropTarget target,
                             CmsDNDHandler handler)

Description copied from interface: I_CmsDNDController

Executed when end animation starts.

Specified by:

onAnimationStart in interface I_CmsDNDController

Parameters:

draggable - the draggable item

target - the current drop target

handler - the drag and drop handler instance

See Also:

I_CmsDNDController.onAnimationStart(org.opencms.gwt.client.dnd.I_CmsDraggable, org.opencms.gwt.client.dnd.I_CmsDropTarget, org.opencms.gwt.client.dnd.CmsDNDHandler)

onBeforeDrop

public boolean onBeforeDrop(I_CmsDraggable draggable,
                            I_CmsDropTarget target,
                            CmsDNDHandler handler)

Description copied from interface: I_CmsDNDController

Executed before drop.

Specified by:

onBeforeDrop in interface I_CmsDNDController

Parameters:

draggable - the draggable item

target - the current drop target

handler - the drag and drop handler instance

Returns:

false to cancel dropping

See Also:

I_CmsDNDController.onBeforeDrop(org.opencms.gwt.client.dnd.I_CmsDraggable, org.opencms.gwt.client.dnd.I_CmsDropTarget, org.opencms.gwt.client.dnd.CmsDNDHandler)

onDragCancel

public void onDragCancel(I_CmsDraggable draggable,
                         I_CmsDropTarget target,
                         CmsDNDHandler handler)

Description copied from interface: I_CmsDNDController

Executed on drag cancel.

Specified by:

onDragCancel in interface I_CmsDNDController

Parameters:

draggable - the draggable item

target - the current drop target

handler - the drag and drop handler instance

See Also:

I_CmsDNDController.onDragCancel(org.opencms.gwt.client.dnd.I_CmsDraggable, org.opencms.gwt.client.dnd.I_CmsDropTarget, org.opencms.gwt.client.dnd.CmsDNDHandler)

onDragStart

public boolean onDragStart(I_CmsDraggable draggable,
                           I_CmsDropTarget target,
                           CmsDNDHandler handler)

Description copied from interface: I_CmsDNDController

Executed on drag start.

Specified by:

onDragStart in interface I_CmsDNDController

Parameters:

draggable - the draggable item

target - the current drop target

handler - the drag and drop handler instance

Returns:

false to cancel dragging

See Also:

I_CmsDNDController.onDragStart(org.opencms.gwt.client.dnd.I_CmsDraggable, org.opencms.gwt.client.dnd.I_CmsDropTarget, org.opencms.gwt.client.dnd.CmsDNDHandler)

onDrop

public void onDrop(I_CmsDraggable draggable,
                   I_CmsDropTarget target,
                   CmsDNDHandler handler)

Description copied from interface: I_CmsDNDController

Executed on drop.

Specified by:

onDrop in interface I_CmsDNDController

Parameters:

draggable - the draggable item

target - the current drop target

handler - the drag and drop handler instance

See Also:

I_CmsDNDController.onDrop(org.opencms.gwt.client.dnd.I_CmsDraggable, org.opencms.gwt.client.dnd.I_CmsDropTarget, org.opencms.gwt.client.dnd.CmsDNDHandler)

onPositionedPlaceholder

public void onPositionedPlaceholder(I_CmsDraggable draggable,
                                    I_CmsDropTarget target,
                                    CmsDNDHandler handler)

Description copied from interface: I_CmsDNDController

Executed after the placeholder has been positioned inside a drop target.

Specified by:

onPositionedPlaceholder in interface I_CmsDNDController

Parameters:

draggable - the draggable item

target - the current drop target

handler - the drag and drop handler instance

See Also:

I_CmsDNDController.onPositionedPlaceholder(org.opencms.gwt.client.dnd.I_CmsDraggable, org.opencms.gwt.client.dnd.I_CmsDropTarget, org.opencms.gwt.client.dnd.CmsDNDHandler)

onTargetEnter

public boolean onTargetEnter(I_CmsDraggable draggable,
                             I_CmsDropTarget target,
                             CmsDNDHandler handler)

Description copied from interface: I_CmsDNDController

Executed when the helper is dragged into a drop target.

Specified by:

onTargetEnter in interface I_CmsDNDController

Parameters:

draggable - the draggable item

target - the current drop target

handler - the drag and drop handler instance

Returns:

false to cancel entering target (placeholder will not positioned inside target)

See Also:

I_CmsDNDController.onTargetEnter(org.opencms.gwt.client.dnd.I_CmsDraggable, org.opencms.gwt.client.dnd.I_CmsDropTarget, org.opencms.gwt.client.dnd.CmsDNDHandler)

onTargetLeave

public void onTargetLeave(I_CmsDraggable draggable,
                          I_CmsDropTarget target,
                          CmsDNDHandler handler)

Description copied from interface: I_CmsDNDController

Executed when the helper is dragged out of a drop target.

Specified by:

onTargetLeave in interface I_CmsDNDController

Parameters:

draggable - the draggable item

target - the current drop target

handler - the drag and drop handler instance

See Also:

I_CmsDNDController.onTargetLeave(org.opencms.gwt.client.dnd.I_CmsDraggable, org.opencms.gwt.client.dnd.I_CmsDropTarget, org.opencms.gwt.client.dnd.CmsDNDHandler)

prepareHelperElements

protected void prepareHelperElements(org.opencms.ade.containerpage.shared.CmsContainerElementData elementData,
                                     CmsDNDHandler handler,
                                     I_CmsDraggable draggable)

Prepares all helper elements for the different drop targets.

Parameters:

elementData - the element data

handler - the drag and drop handler

draggable - the draggable