org.opencms.gwt.client.dnd.I_CmsDNDController Maven / Gradle / Ivy
Show all versions of opencms-gwt Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.gwt.client.dnd;
/**
* Drag and drop controller.
*
* Implement and assign to the {@link CmsDNDHandler} to control the drag process as well as the underlying model.
*
* @since 8.0.0
*/
public interface I_CmsDNDController {
/**
* Executed when end animation starts.
*
* @param draggable the draggable item
* @param target the current drop target
* @param handler the drag and drop handler instance
*/
void onAnimationStart(I_CmsDraggable draggable, I_CmsDropTarget target, CmsDNDHandler handler);
/**
* Executed before drop.
*
* @param draggable the draggable item
* @param target the current drop target
* @param handler the drag and drop handler instance
*
* @return false
to cancel dropping
*/
boolean onBeforeDrop(I_CmsDraggable draggable, I_CmsDropTarget target, CmsDNDHandler handler);
/**
* Executed on drag cancel.
*
* @param draggable the draggable item
* @param target the current drop target
* @param handler the drag and drop handler instance
*/
void onDragCancel(I_CmsDraggable draggable, I_CmsDropTarget target, CmsDNDHandler handler);
/**
* Executed on drag start.
*
* @param draggable the draggable item
* @param target the current drop target
* @param handler the drag and drop handler instance
*
* @return false
to cancel dragging
*/
boolean onDragStart(I_CmsDraggable draggable, I_CmsDropTarget target, CmsDNDHandler handler);
/**
* Executed on drop.
*
* @param draggable the draggable item
* @param target the current drop target
* @param handler the drag and drop handler instance
*/
void onDrop(I_CmsDraggable draggable, I_CmsDropTarget target, CmsDNDHandler handler);
/**
* Executed after the placeholder has been positioned inside a drop target.
*
* @param draggable the draggable item
* @param target the current drop target
* @param handler the drag and drop handler instance
*/
void onPositionedPlaceholder(I_CmsDraggable draggable, I_CmsDropTarget target, CmsDNDHandler handler);
/**
* Executed when the helper is dragged into a drop target.
*
* @param draggable the draggable item
* @param target the current drop target
* @param handler the drag and drop handler instance
*
* @return false
to cancel entering target (placeholder will not positioned inside target)
*/
boolean onTargetEnter(I_CmsDraggable draggable, I_CmsDropTarget target, CmsDNDHandler handler);
/**
* Executed when the helper is dragged out of a drop target.
*
* @param draggable the draggable item
* @param target the current drop target
* @param handler the drag and drop handler instance
*/
void onTargetLeave(I_CmsDraggable draggable, I_CmsDropTarget target, CmsDNDHandler handler);
}