docs/source/DragDrop2.html

   1 <!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-grid.plugin.DragDrop'>/**
   2 </span> * @class Ext.grid.plugin.DragDrop
   3  * &lt;p&gt;This plugin provides drag and/or drop functionality for a GridView.&lt;/p&gt;
   4  * &lt;p&gt;It creates a specialized instance of {@link Ext.dd.DragZone DragZone} which knows how to drag out of a {@link Ext.grid.View GridView}
   5  * and loads the data object which is passed to a cooperating {@link Ext.dd.DragZone DragZone}'s methods with the following properties:&lt;ul&gt;
   6  * &lt;li&gt;copy : Boolean
   7  *  &lt;div class=&quot;sub-desc&quot;&gt;The value of the GridView's &lt;code&gt;copy&lt;/code&gt; property, or &lt;code&gt;true&lt;/code&gt; if the GridView was configured
   8  *  with &lt;code&gt;allowCopy: true&lt;/code&gt; &lt;u&gt;and&lt;/u&gt; the control key was pressed when the drag operation was begun.&lt;/div&gt;&lt;/li&gt;
   9  * &lt;li&gt;view : GridView
  10  *  &lt;div class=&quot;sub-desc&quot;&gt;The source GridView from which the drag originated.&lt;/div&gt;&lt;/li&gt;
  11  * &lt;li&gt;ddel : HtmlElement
  12  *  &lt;div class=&quot;sub-desc&quot;&gt;The drag proxy element which moves with the mouse&lt;/div&gt;&lt;/li&gt;
  13  * &lt;li&gt;item : HtmlElement
  14  *  &lt;div class=&quot;sub-desc&quot;&gt;The GridView node upon which the mousedown event was registered.&lt;/div&gt;&lt;/li&gt;
  15  * &lt;li&gt;records : Array
  16  *  &lt;div class=&quot;sub-desc&quot;&gt;An Array of {@link Ext.data.Model Model}s representing the selected data being dragged from the source GridView.&lt;/div&gt;&lt;/li&gt;
  17  * &lt;/ul&gt;&lt;/p&gt;
  18  * &lt;p&gt;It also creates a specialized instance of {@link Ext.dd.DropZone} which cooperates with other DropZones which are members of the same
  19  * ddGroup which processes such data objects.&lt;/p&gt;
  20  * &lt;p&gt;Adding this plugin to a view means that two new events may be fired from the client GridView, &lt;code&gt;{@link #event-beforedrop beforedrop}&lt;/code&gt; and
  21  * &lt;code&gt;{@link #event-drop drop}&lt;/code&gt;&lt;/p&gt;
  22  */
  23 Ext.define('Ext.grid.plugin.DragDrop', {
  24     extend: 'Ext.AbstractPlugin',
  25     alias: 'plugin.gridviewdragdrop',
  26
  27     uses: [
  28         'Ext.view.DragZone',
  29         'Ext.grid.ViewDropZone'
  30     ],
  31
  32 <span id='Ext-grid.plugin.DragDrop-event-beforedrop'>    /**
  33 </span>     * @event beforedrop
  34      * &lt;p&gt;&lt;b&gt;This event is fired through the GridView. Add listeners to the GridView object&lt;/b&gt;&lt;/p&gt;
  35      * &lt;p&gt;Fired when a drop gesture has been triggered by a mouseup event in a valid drop position in the GridView.
  36      * @param {HtmlElement} node The GridView node &lt;b&gt;if any&lt;/b&gt; over which the mouse was positioned.&lt;/p&gt;
  37      * &lt;p&gt;Returning &lt;code&gt;false&lt;/code&gt; to this event signals that the drop gesture was invalid, and if the drag proxy
  38      * will animate back to the point from which the drag began.&lt;/p&gt;
  39      * &lt;p&gt;Returning &lt;code&gt;0&lt;/code&gt; To this event signals that the data transfer operation should not take place, but
  40      * that the gesture was valid, and that the repair operation should not take place.&lt;/p&gt;
  41      * &lt;p&gt;Any other return value continues with the data transfer operation.&lt;/p&gt;
  42      * @param {Object} data The data object gathered at mousedown time by the cooperating {@link Ext.dd.DragZone DragZone}'s
  43      * {@link Ext.dd.DragZone#getDragData getDragData} method it contains the following properties:&lt;ul&gt;
  44      * &lt;li&gt;copy : Boolean
  45      *  &lt;div class=&quot;sub-desc&quot;&gt;The value of the GridView's &lt;code&gt;copy&lt;/code&gt; property, or &lt;code&gt;true&lt;/code&gt; if the GridView was configured
  46      *  with &lt;code&gt;allowCopy: true&lt;/code&gt; and the control key was pressed when the drag operation was begun&lt;/div&gt;&lt;/li&gt;
  47      * &lt;li&gt;view : GridView
  48      *  &lt;div class=&quot;sub-desc&quot;&gt;The source GridView from which the drag originated.&lt;/div&gt;&lt;/li&gt;
  49      * &lt;li&gt;ddel : HtmlElement
  50      *  &lt;div class=&quot;sub-desc&quot;&gt;The drag proxy element which moves with the mouse&lt;/div&gt;&lt;/li&gt;
  51      * &lt;li&gt;item : HtmlElement
  52      *  &lt;div class=&quot;sub-desc&quot;&gt;The GridView node upon which the mousedown event was registered.&lt;/div&gt;&lt;/li&gt;
  53      * &lt;li&gt;records : Array
  54      *  &lt;div class=&quot;sub-desc&quot;&gt;An Array of {@link Ext.data.Model Model}s representing the selected data being dragged from the source GridView.&lt;/div&gt;&lt;/li&gt;
  55      * &lt;/ul&gt;
  56      * @param {Ext.data.Model} overModel The Model over which the drop gesture took place.
  57      * @param {String} dropPosition &lt;code&gt;&quot;before&quot;&lt;/code&gt; or &lt;code&gt;&quot;after&quot;&lt;/code&gt; depending on whether the mouse is above or below the midline of the node.
  58      * @param {Function} dropFunction &lt;p&gt;A function to call to complete the data transfer operation and either move or copy Model instances from the source
  59      * View's Store to the destination View's Store.&lt;/p&gt;
  60      * &lt;p&gt;This is useful when you want to perform some kind of asynchronous processing before confirming
  61      * the drop, such as an {@link Ext.window.MessageBox#confirm confirm} call, or an Ajax request.&lt;/p&gt;
  62      * &lt;p&gt;Return &lt;code&gt;0&lt;/code&gt; from this event handler, and call the &lt;code&gt;dropFunction&lt;/code&gt; at any time to perform the data transfer.&lt;/p&gt;
  63      */
  64
  65 <span id='Ext-grid.plugin.DragDrop-event-drop'>    /**
  66 </span>     * @event drop
  67      * &lt;b&gt;This event is fired through the GridView. Add listeners to the GridView object&lt;/b&gt;
  68      * Fired when a drop operation has been completed and the data has been moved or copied.
  69      * @param {HtmlElement} node The GridView node &lt;b&gt;if any&lt;/b&gt; over which the mouse was positioned.
  70      * @param {Object} data The data object gathered at mousedown time by the cooperating {@link Ext.dd.DragZone DragZone}'s
  71      * {@link Ext.dd.DragZone#getDragData getDragData} method it contains the following properties:&lt;ul&gt;
  72      * &lt;li&gt;copy : Boolean
  73      *  &lt;div class=&quot;sub-desc&quot;&gt;The value of the GridView's &lt;code&gt;copy&lt;/code&gt; property, or &lt;code&gt;true&lt;/code&gt; if the GridView was configured
  74      *  with &lt;code&gt;allowCopy: true&lt;/code&gt; and the control key was pressed when the drag operation was begun&lt;/div&gt;&lt;/li&gt;
  75      * &lt;li&gt;view : GridView
  76      *  &lt;div class=&quot;sub-desc&quot;&gt;The source GridView from which the drag originated.&lt;/div&gt;&lt;/li&gt;
  77      * &lt;li&gt;ddel : HtmlElement
  78      *  &lt;div class=&quot;sub-desc&quot;&gt;The drag proxy element which moves with the mouse&lt;/div&gt;&lt;/li&gt;
  79      * &lt;li&gt;item : HtmlElement
  80      *  &lt;div class=&quot;sub-desc&quot;&gt;The GridView node upon which the mousedown event was registered.&lt;/div&gt;&lt;/li&gt;
  81      * &lt;li&gt;records : Array
  82      *  &lt;div class=&quot;sub-desc&quot;&gt;An Array of {@link Ext.data.Model Model}s representing the selected data being dragged from the source GridView.&lt;/div&gt;&lt;/li&gt;
  83      * &lt;/ul&gt;
  84      * @param {Ext.data.Model} overModel The Model over which the drop gesture took place.
  85      * @param {String} dropPosition &lt;code&gt;&quot;before&quot;&lt;/code&gt; or &lt;code&gt;&quot;after&quot;&lt;/code&gt; depending on whether the mouse is above or below the midline of the node.
  86      */
  87
  88     dragText : '{0} selected row{1}',
  89
  90 <span id='Ext-grid.plugin.DragDrop-cfg-ddGroup'>    /**
  91 </span>     * @cfg {String} ddGroup
  92      * A named drag drop group to which this object belongs.  If a group is specified, then both the DragZones and DropZone
  93      * used by this plugin will only interact with other drag drop objects in the same group (defaults to 'TreeDD').
  94      */
  95     ddGroup : &quot;GridDD&quot;,
  96
  97 <span id='Ext-grid.plugin.DragDrop-cfg-dragGroup'>    /**
  98 </span>     * @cfg {String} dragGroup
  99      * &lt;p&gt;The ddGroup to which the DragZone will belong.&lt;/p&gt;
 100      * &lt;p&gt;This defines which other DropZones the DragZone will interact with. Drag/DropZones only interact with other Drag/DropZones
 101      * which are members of the same ddGroup.&lt;/p&gt;
 102      */
 103
 104 <span id='Ext-grid.plugin.DragDrop-cfg-dropGroup'>    /**
 105 </span>     * @cfg {String} dropGroup
 106      * &lt;p&gt;The ddGroup to which the DropZone will belong.&lt;/p&gt;
 107      * &lt;p&gt;This defines which other DragZones the DropZone will interact with. Drag/DropZones only interact with other Drag/DropZones
 108      * which are members of the same ddGroup.&lt;/p&gt;
 109      */
 110
 111 <span id='Ext-grid.plugin.DragDrop-cfg-enableDrop'>    /**
 112 </span>     * @cfg {Boolean} enableDrop
 113      * &lt;p&gt;Defaults to &lt;code&gt;true&lt;/code&gt;&lt;/p&gt;
 114      * &lt;p&gt;Set to &lt;code&gt;false&lt;/code&gt; to disallow the View from accepting drop gestures&lt;/p&gt;
 115      */
 116     enableDrop: true,
 117
 118 <span id='Ext-grid.plugin.DragDrop-cfg-enableDrag'>    /**
 119 </span>     * @cfg {Boolean} enableDrag
 120      * &lt;p&gt;Defaults to &lt;code&gt;true&lt;/code&gt;&lt;/p&gt;
 121      * &lt;p&gt;Set to &lt;code&gt;false&lt;/code&gt; to disallow dragging items from the View &lt;/p&gt;
 122      */
 123     enableDrag: true,
 124
 125     init : function(view) {
 126         view.on('render', this.onViewRender, this, {single: true});
 127     },
 128
 129 <span id='Ext-grid.plugin.DragDrop-method-destroy'>    /**
 130 </span>     * @private
 131      * AbstractComponent calls destroy on all its plugins at destroy time.
 132      */
 133     destroy: function() {
 134         Ext.destroy(this.dragZone, this.dropZone);
 135     },
 136
 137     onViewRender : function(view) {
 138         var me = this;
 139
 140         if (me.enableDrag) {
 141             me.dragZone = Ext.create('Ext.view.DragZone', {
 142                 view: view,
 143                 ddGroup: me.dragGroup || me.ddGroup,
 144                 dragText: me.dragText
 145             });
 146         }
 147
 148         if (me.enableDrop) {
 149             me.dropZone = Ext.create('Ext.grid.ViewDropZone', {
 150                 view: view,
 151                 ddGroup: me.dropGroup || me.ddGroup
 152             });
 153         }
 154     }
 155 });</pre></pre></body></html>