git.roojs.org Git - roojs1/blob - docs/src/Roo_dd_DragZone.js.html

   1 <html><head><title>Roo/dd/DragZone.js</title><link rel="stylesheet" type="text/css" href="../../css/highlight-js.css"/></head><body class="highlightpage"><code class="jsdoc-pretty"><span class="jsdoc-comment">/*
   2  * Based on:
   3  * Ext JS Library 1.1.1
   4  * Copyright(c) 2006-2007, Ext JS, LLC.
   5  *
   6  * Originally Released Under LGPL - original licence link has changed is not relivant.
   7  *
   8  * Fork - LGPL
   9  * &lt;script type=&quot;text/javascript&quot;&gt;
  10  */
  11
  12
  13 /**
  14  * @class Roo.dd.DragZone
  15  * @extends Roo.dd.DragSource
  16  * This class provides a container DD instance that proxies for multiple child node sources.&lt;br /&gt;
  17  * By default, this class requires that draggable child nodes are registered with {@link Roo.dd.Registry}.
  18  * @constructor
  19  * @param {String/HTMLElement/Element} el The container element
  20  * @param {Object} config
  21  */
  22 </span><span class="jsdoc-var">Roo.dd.DragZone </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">el</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">){
  23     </span><span class="jsdoc-var">Roo.dd.DragZone.superclass.constructor.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">el</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">);
  24     </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.containerScroll</span><span class="jsdoc-syntax">){
  25         </span><span class="jsdoc-var">Roo.dd.ScrollManager.register</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.el</span><span class="jsdoc-syntax">);
  26     }
  27 };
  28
  29 </span><span class="jsdoc-var">Roo.extend</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.dd.DragZone</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">Roo.dd.DragSource</span><span class="jsdoc-syntax">, {
  30     </span><span class="jsdoc-comment">/**
  31      * @cfg {Boolean} containerScroll True to register this container with the Scrollmanager
  32      * for auto scrolling during drag operations.
  33      */
  34     /**
  35      * @cfg {String} hlColor The color to use when visually highlighting the drag source in the afterRepair
  36      * method after a failed drop (defaults to &quot;c3daf9&quot; - light blue)
  37      */
  38
  39     /**
  40      * Called when a mousedown occurs in this container. Looks in {@link Roo.dd.Registry}
  41      * for a valid target to drag based on the mouse down. Override this method
  42      * to provide your own lookup logic (e.g. finding a child by class name). Make sure your returned
  43      * object has a &quot;ddel&quot; attribute (with an HTML Element) for other functions to work.
  44      * @param {EventObject} e The mouse down event
  45      * @return {Object} The dragData
  46      */
  47     </span><span class="jsdoc-var">getDragData </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">e</span><span class="jsdoc-syntax">){
  48         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">Roo.dd.Registry.getHandleFromEvent</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">e</span><span class="jsdoc-syntax">);
  49     },
  50
  51     </span><span class="jsdoc-comment">/**
  52      * Called once drag threshold has been reached to initialize the proxy element. By default, it clones the
  53      * this.dragData.ddel
  54      * @param {Number} x The x position of the click on the dragged object
  55      * @param {Number} y The y position of the click on the dragged object
  56      * @return {Boolean} true to continue the drag, false to cancel
  57      */
  58     </span><span class="jsdoc-var">onInitDrag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">x</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">y</span><span class="jsdoc-syntax">){
  59         </span><span class="jsdoc-var">this.proxy.update</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.dragData.ddel.cloneNode</span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">));
  60         </span><span class="jsdoc-var">this.onStartDrag</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">x</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">y</span><span class="jsdoc-syntax">);
  61         </span><span class="jsdoc-keyword">return true</span><span class="jsdoc-syntax">;
  62     },
  63
  64     </span><span class="jsdoc-comment">/**
  65      * Called after a repair of an invalid drop. By default, highlights this.dragData.ddel
  66      */
  67     </span><span class="jsdoc-var">afterRepair </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
  68         </span><span class="jsdoc-keyword">if</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.enableFx</span><span class="jsdoc-syntax">){
  69             </span><span class="jsdoc-var">Roo.Element.fly</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.dragData.ddel</span><span class="jsdoc-syntax">)</span><span class="jsdoc-var">.highlight</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.hlColor </span><span class="jsdoc-syntax">|| </span><span class="jsdoc-string">&quot;c3daf9&quot;</span><span class="jsdoc-syntax">);
  70         }
  71         </span><span class="jsdoc-var">this.dragging </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">;
  72     },
  73
  74     </span><span class="jsdoc-comment">/**
  75      * Called before a repair of an invalid drop to get the XY to animate to. By default returns
  76      * the XY of this.dragData.ddel
  77      * @param {EventObject} e The mouse up event
  78      * @return {Array} The xy location (e.g. [100, 200])
  79      */
  80     </span><span class="jsdoc-var">getRepairXY </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">e</span><span class="jsdoc-syntax">){
  81         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">Roo.Element.fly</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.dragData.ddel</span><span class="jsdoc-syntax">)</span><span class="jsdoc-var">.getXY</span><span class="jsdoc-syntax">();
  82     }
  83 });</span></code></body></html>