org.opencms.gwt.client.dnd.I_CmsDraggable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opencms-gwt Show documentation

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0

Show newest version

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (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;

import com.google.common.base.Optional;
import com.google.gwt.dom.client.Element;

/**
 * Interface defining all methods used by drag and drop on a draggable element.
 *
 * @since 8.0.0
 */
public interface I_CmsDraggable {

    /**
     * Gets an optional pair of integers which are to be used as an "offset delta" for the drag and drop process.

     *
     * @return an optional array containing exactly 2 entries [x,y]
     */
    Optional getCursorOffsetDelta();

    /**
     * Creates the drag helper element and attaches it into the DOM.

     *
     * @param target the drop target
     *
     * @return the drag helper element
     */
    Element getDragHelper(I_CmsDropTarget target);

    /**
     * Returns the draggable element.

     *
     * @return the element
     */
    Element getElement();

    /**
     * Returns the draggable id.

     *
     * @return the id
     */
    String getId();

    /**
     * Returns the parent drop target or null if there is none.

     *
     * @return the parent drop target
     */
    I_CmsDropTarget getParentTarget();

    /**
     * Creates the drag placeholder element.

     *
     * @param target the drop target
     *
     * @return the drag placeholder element
     */
    Element getPlaceholder(I_CmsDropTarget target);

    /**
     * Executed on drag cancel.

     */
    void onDragCancel();

    /**
     * Executed on drop.

     *
     * @param target the drop target
     */
    void onDrop(I_CmsDropTarget target);

    /**
     * Executed on drag start.
     *
     * @param target the current drop target
     */
    void onStartDrag(I_CmsDropTarget target);
}