add extjs 6.0.1 sources

[extjs.git] / extjs / classic / classic / src / dd / DropTarget.js

/**\r
 * A simple class that provides the basic implementation needed to make any element a drop target that can have\r
 * draggable items dropped onto it.  The drop has no effect until an implementation of notifyDrop is provided.\r
 */\r
Ext.define('Ext.dd.DropTarget', {\r
    extend: 'Ext.dd.DDTarget',\r
    requires: ['Ext.dd.ScrollManager'],\r
\r
    /**\r
     * Creates new DropTarget.\r
     * @param {String/HTMLElement/Ext.dom.Element} el The container element or ID of it.\r
     * @param {Object} config\r
     */\r
    constructor : function(el, config){\r
        this.el = Ext.get(el);\r
\r
        Ext.apply(this, config);\r
\r
        if(this.containerScroll){\r
            Ext.dd.ScrollManager.register(this.el);\r
        }\r
\r
        this.callParent([this.el.dom, this.ddGroup || this.group,\r
              {isTarget: true}]);\r
    },\r
\r
    /**\r
     * @cfg {Boolean} containerScroll\r
     * True to register this container with the ScrollManager for auto scrolling during\r
     * drag operations.\r
     */\r
    containerScroll: false,\r
\r
    /**\r
     * @cfg {String} ddGroup\r
     * A named drag drop group to which this object belongs.  If a group is specified, then this object will only\r
     * interact with other drag drop objects in the same group.\r
     */\r
    /**\r
     * @cfg {String} [overClass=""]\r
     * The CSS class applied to the drop target element while the drag source is over it.\r
     */\r
    /**\r
     * @cfg {String} dropAllowed\r
     * The CSS class returned to the drag source when drop is allowed.\r
     */\r
    dropAllowed : Ext.baseCSSPrefix + 'dd-drop-ok',\r
    /**\r
     * @cfg {String} dropNotAllowed\r
     * The CSS class returned to the drag source when drop is not allowed.\r
     */\r
    dropNotAllowed : Ext.baseCSSPrefix + 'dd-drop-nodrop',\r
\r
    /**\r
     * @private\r
     */\r
    isTarget : true,\r
\r
    /**\r
     * @private\r
     */\r
    isNotifyTarget : true,\r
\r
    /**\r
     * The function a {@link Ext.dd.DragSource} calls once to notify this drop target that the source is now over the\r
     * target.  This default implementation adds the CSS class specified by overClass (if any) to the drop element\r
     * and returns the dropAllowed config value.  This method should be overridden if drop validation is required.\r
     * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop target\r
     * @param {Event} e The event\r
     * @param {Object} data An object containing arbitrary data supplied by the drag source\r
     * @return {String} status The CSS class that communicates the drop status back to the source so that the\r
     * underlying {@link Ext.dd.StatusProxy} can be updated\r
     * @template\r
     */\r
    notifyEnter : function(dd, e, data){\r
        if(this.overClass){\r
            this.el.addCls(this.overClass);\r
        }\r
        return this.dropAllowed;\r
    },\r
\r
    /**\r
     * The function a {@link Ext.dd.DragSource} calls continuously while it is being dragged over the target.\r
     * This method will be called on every mouse movement while the drag source is over the drop target.\r
     * This default implementation simply returns the dropAllowed config value.\r
     * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop target\r
     * @param {Event} e The event\r
     * @param {Object} data An object containing arbitrary data supplied by the drag source\r
     * @return {String} status The CSS class that communicates the drop status back to the source so that the\r
     * underlying {@link Ext.dd.StatusProxy} can be updated\r
     * @template\r
     */\r
    notifyOver : function(dd, e, data){\r
        return this.dropAllowed;\r
    },\r
\r
    /**\r
     * The function a {@link Ext.dd.DragSource} calls once to notify this drop target that the source has been dragged\r
     * out of the target without dropping. This default implementation simply removes the CSS class specified by\r
     * `overClass` (if any) from the drop element.\r
     * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop target\r
     * @param {Event} e The event\r
     * @param {Object} data An object containing arbitrary data supplied by the drag source\r
     * @template\r
     */\r
    notifyOut : function(dd, e, data){\r
        if (this.overClass){\r
            this.el.removeCls(this.overClass);\r
        }\r
    },\r
\r
    /**\r
     * The function a {@link Ext.dd.DragSource} calls once to notify this drop target that the dragged item has\r
     * been dropped on it. This method removes any `overClass` and returns false, so you must provide an\r
     * implementation that does something to process the drop event and returns true so that the drag source's\r
     * repair action does not run.\r
     *\r
     * You should `callParent` from an override of this method to ensure proper cleanup is\r
     * performed.\r
     *\r
     * @param {Ext.dd.DragSource} source The drag source that was dragged over this drop target\r
     * @param {Event} e The event\r
     * @param {Object} data An object containing arbitrary data supplied by the drag source\r
     * @return {Boolean} False if the drop was invalid.\r
     * @template\r
     */\r
    notifyDrop : function(dd, e, data){\r
        if (this.overClass){\r
            this.el.removeCls(this.overClass);\r
        }\r
        return false;\r
    },\r
\r
    destroy : function(){\r
        this.callParent();\r
        if (this.containerScroll) {\r
            Ext.dd.ScrollManager.unregister(this.el);\r
        }\r
    }\r
});\r