Package org.opencms.ade.containerpage.client

Class CmsImageDndController

java.lang.Object

org.opencms.ade.containerpage.client.CmsImageDndController

All Implemented Interfaces:

I_CmsDNDController

public class CmsImageDndController
extends Object
implements I_CmsDNDController

DND controller for drag/drop of images from the gallery menu.

Since the image drag and drop logic is mostly separate from the container drag and drop logic, the container page DND controller delegates most of the drag and drop logic to this class if it detects that an image is being dragged.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_DATA_IMAGEDND	The attribute used to mark image drop zones.

Constructor Summary

Constructors

Constructor	Description
CmsImageDndController(CmsContainerpageController controller)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected List<org.opencms.ade.containerpage.client.CmsImageDndController.ImageDropTarget>	findImageTargets()	Collects the valid drop targets for images from the page and initializes them.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.gwt.client.dnd.I_CmsDNDController

postClear, startPlacementMode

Field Details

ATTR_DATA_IMAGEDND

public static final String ATTR_DATA_IMAGEDND

The attribute used to mark image drop zones.

See Also:

• Constant Field Values

Constructor Details

CmsImageDndController

public CmsImageDndController(CmsContainerpageController controller)

Creates a new instance.

Parameters:

controller - the container page controller

Method Details

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)

findImageTargets

protected List<org.opencms.ade.containerpage.client.CmsImageDndController.ImageDropTarget> findImageTargets()

Collects the valid drop targets for images from the page and initializes them.

Returns:

the list of drop targets