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 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 final int	HIGHLIGHTING_OFFSET	The container highlighting offset.
protected CmsContainerpageController	m_controller	The container page controller.
protected String	m_draggableId	The id of the dragged element.
static final String	OC_PLACEMENT_BUTTON	CSS class.
static final String	OC_PLACEMENT_BUTTONS_VERTICAL	CSS class.
static final String	OC_PLACEMENT_DOWN	CSS class.
static final String	OC_PLACEMENT_LAYER	CSS class.
static final String	OC_PLACEMENT_LEFT	CSS class.
static final String	OC_PLACEMENT_MODE	CSS class.
static final String	OC_PLACEMENT_PLACEHOLDER	CSS class.
static final String	OC_PLACEMENT_RIGHT	CSS class.
static final String	OC_PLACEMENT_SELECTED_ELEMENT	CSS class.
static final String	OC_PLACEMENT_UP	CSS class.
static final int	PLACEMENT_BUTTON_BIG	The bigger size for the placement buttons.
static final int	PLACEMENT_BUTTON_SMALL	The smaller size for the placement buttons.

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.
static final String	placementButtonBig()	Placement button big.
static final String	placementButtonSmall()	Placement button small.
void	postClear(I_CmsDraggable draggable, I_CmsDropTarget target)	Called after the CSS styles are changed back to normal after a DnD operation.
protected void	prepareHelperElements(org.opencms.ade.containerpage.shared.CmsContainerElementData elementData, CmsDNDHandler handler, I_CmsDraggable draggable)	Prepares all helper elements for the different drop targets.
static boolean	segmentBefore(int start, int size, int pos)	Checks if a 1D line segment comes before a position.
static boolean	segmentIntersect(int start1, int size1, int start2, int size2)	Checks if two 1D line segments with given start positions and sizes intersect.
boolean	startPlacementMode(I_CmsDraggable draggable, CmsDNDHandler handler)	Starts placement mode for the given draggable.

Methods inherited from class java.lang.Object

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

Field Details

HIGHLIGHTING_OFFSET

public static final int HIGHLIGHTING_OFFSET

The container highlighting offset.

See Also:

• Constant Field Values

OC_PLACEMENT_BUTTON

public static final String OC_PLACEMENT_BUTTON

CSS class.

See Also:

• Constant Field Values

OC_PLACEMENT_BUTTONS_VERTICAL

public static final String OC_PLACEMENT_BUTTONS_VERTICAL

CSS class.

See Also:

• Constant Field Values

OC_PLACEMENT_DOWN

public static final String OC_PLACEMENT_DOWN

CSS class.

See Also:

• Constant Field Values

OC_PLACEMENT_LAYER

public static final String OC_PLACEMENT_LAYER

CSS class.

See Also:

• Constant Field Values

OC_PLACEMENT_LEFT

public static final String OC_PLACEMENT_LEFT

CSS class.

See Also:

• Constant Field Values

OC_PLACEMENT_MODE

public static final String OC_PLACEMENT_MODE

CSS class.

See Also:

• Constant Field Values

OC_PLACEMENT_PLACEHOLDER

public static final String OC_PLACEMENT_PLACEHOLDER

CSS class.

See Also:

• Constant Field Values

OC_PLACEMENT_RIGHT

public static final String OC_PLACEMENT_RIGHT

CSS class.

See Also:

• Constant Field Values

OC_PLACEMENT_SELECTED_ELEMENT

public static final String OC_PLACEMENT_SELECTED_ELEMENT

CSS class.

See Also:

• Constant Field Values

OC_PLACEMENT_UP

public static final String OC_PLACEMENT_UP

CSS class.

See Also:

• Constant Field Values

PLACEMENT_BUTTON_BIG

public static final int PLACEMENT_BUTTON_BIG

The bigger size for the placement buttons.

See Also:

• Constant Field Values

PLACEMENT_BUTTON_SMALL

public static final int PLACEMENT_BUTTON_SMALL

The smaller size for the placement buttons.

See Also:

• Constant Field Values

m_controller

protected CmsContainerpageController m_controller

The container page controller.

m_draggableId

protected String m_draggableId

The id of the dragged element.

Constructor Details

CmsContainerpageDNDController

public CmsContainerpageDNDController(CmsContainerpageController controller)

Constructor.

Parameters:

controller - the container page controller

Method Details

placementButtonBig

public static final String placementButtonBig()

Placement button big.

Returns:

the string

placementButtonSmall

public static final String placementButtonSmall()

Placement button small.

Returns:

the string

segmentBefore

public static boolean segmentBefore(int start,
 int size,
 int pos)

Checks if a 1D line segment comes before a position.

Parameters:

start - the start position of the segment

size - the width of the segment

pos - the position to check

Returns:

true, if successful

segmentIntersect

public static boolean segmentIntersect(int start1,
 int size1,
 int start2,
 int size2)

Checks if two 1D line segments with given start positions and sizes intersect.

Parameters:

start1 - start position of the first segment

size1 - size of the first segment

start2 - start position of the second segment

size2 - size of the second segment

Returns:

true, if successful

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)

postClear

public void postClear(I_CmsDraggable draggable,
 I_CmsDropTarget target)

Description copied from interface: I_CmsDNDController

Called after the CSS styles are changed back to normal after a DnD operation.

Specified by:

postClear in interface I_CmsDNDController

Parameters:

draggable - the draggable

target - the drag target (null if drag cancelled)

See Also:

• I_CmsDNDController.postClear(org.opencms.gwt.client.dnd.I_CmsDraggable, org.opencms.gwt.client.dnd.I_CmsDropTarget)

startPlacementMode

public boolean startPlacementMode(I_CmsDraggable draggable,
 CmsDNDHandler handler)

Starts placement mode for the given draggable.

Specified by:

startPlacementMode in interface I_CmsDNDController

Parameters:

draggable - the draggable element

handler - the handler

Returns:

true, if successful

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