/*
* This is a derivative of the similarly named class in the YUI Library.
* The original license:
* Copyright (c) 2006, Yahoo! Inc. All rights reserved.
@@ -7,60 +24,66 @@
*/
-/**
- * @class Ext.dd.DragDrop
- * Defines the interface and base operation of items that that can be
+/**
+ * Defines the interface and base operation of items that that can be
* dragged or can be drop targets. It was designed to be extended, overriding
* the event handlers for startDrag, onDrag, onDragOver and onDragOut.
* Up to three html elements can be associated with a DragDrop instance:
- * <ul>
- * <li>linked element: the element that is passed into the constructor.
- * This is the element which defines the boundaries for interaction with
- * other DragDrop objects.</li>
- * <li>handle element(s): The drag operation only occurs if the element that
- * was clicked matches a handle element. By default this is the linked
- * element, but there are times that you will want only a portion of the
- * linked element to initiate the drag operation, and the setHandleElId()
- * method provides a way to define this.</li>
- * <li>drag element: this represents the element that would be moved along
- * with the cursor during a drag operation. By default, this is the linked
- * element itself as in {@link Ext.dd.DD}. setDragElId() lets you define
- * a separate element that would be moved, as in {@link Ext.dd.DDProxy}.
- * </li>
- * </ul>
+ *
+ * - linked element: the element that is passed into the constructor.
+ * This is the element which defines the boundaries for interaction with
+ * other DragDrop objects.
+ *
+ * - handle element(s): The drag operation only occurs if the element that
+ * was clicked matches a handle element. By default this is the linked
+ * element, but there are times that you will want only a portion of the
+ * linked element to initiate the drag operation, and the setHandleElId()
+ * method provides a way to define this.
+ *
+ * - drag element: this represents the element that would be moved along
+ * with the cursor during a drag operation. By default, this is the linked
+ * element itself as in {@link Ext.dd.DD}. setDragElId() lets you define
+ * a separate element that would be moved, as in {@link Ext.dd.DDProxy}.
+ *
* This class should not be instantiated until the onload event to ensure that
* the associated elements are available.
* The following would define a DragDrop obj that would interact with any
* other DragDrop obj in the "group1" group:
- * <pre>
- * dd = new Ext.dd.DragDrop("div1", "group1");
- * </pre>
+ *
+ * dd = new Ext.dd.DragDrop("div1", "group1");
+ *
* Since none of the event handlers have been implemented, nothing would
* actually happen if you were to run the code above. Normally you would
* override this class or one of the default implementations, but you can
* also override the methods you want on an instance of the class...
- * <pre>
- * dd.onDragDrop = function(e, id) {
- * alert("dd was dropped on " + id);
- * }
- * </pre>
- * @constructor
- * @param {String} id of the element that is linked to this instance
- * @param {String} sGroup the group of related DragDrop objects
- * @param {object} config an object containing configurable attributes
- * Valid properties for DragDrop:
- * padding, isTarget, maintainOffset, primaryButtonOnly
+ *
+ * dd.onDragDrop = function(e, id) {
+ * alert("dd was dropped on " + id);
+ * }
+ *
*/
-
Ext.define('Ext.dd.DragDrop', {
requires: ['Ext.dd.DragDropManager'],
+
+ /**
+ * Creates new DragDrop.
+ * @param {String} id of the element that is linked to this instance
+ * @param {String} sGroup the group of related DragDrop objects
+ * @param {Object} config an object containing configurable attributes.
+ * Valid properties for DragDrop:
+ *
+ * - padding
+ * - isTarget
+ * - maintainOffset
+ * - primaryButtonOnly
+ */
constructor: function(id, sGroup, config) {
if(id) {
this.init(id, sGroup, config);
}
},
-
- /**
+
+ /**
* Set to false to enable a DragDrop object to fire drag events while dragging
* over its own Element. Defaults to true - DragDrop objects do not by default
* fire drag events to themselves.
@@ -68,7 +91,7 @@ Ext.define('Ext.dd.DragDrop', {
* @type Boolean
*/
- /**
+ /**
* The id of the element associated with this object. This is what we
* refer to as the "linked element" because the size and position of
* this element is used to determine when the drag and drop objects have
@@ -78,14 +101,14 @@ Ext.define('Ext.dd.DragDrop', {
*/
id: null,
- /**
+ /**
* Configuration attributes passed into the constructor
* @property config
- * @type object
+ * @type Object
*/
config: null,
- /**
+ /**
* The id of the element that will be dragged. By default this is same
* as the linked element, but could be changed to another element. Ex:
* Ext.dd.DDProxy
@@ -95,7 +118,7 @@ Ext.define('Ext.dd.DragDrop', {
*/
dragElId: null,
- /**
+ /**
* The ID of the element that initiates the drag operation. By default
* this is the linked element, but could be changed to be a child of this
* element. This lets us do things like only starting the drag when the
@@ -106,9 +129,9 @@ Ext.define('Ext.dd.DragDrop', {
*/
handleElId: null,
- /**
+ /**
* An object who's property names identify HTML tags to be considered invalid as drag handles.
- * A non-null property value identifies the tag as invalid. Defaults to the
+ * A non-null property value identifies the tag as invalid. Defaults to the
* following value which prevents drag operations from being initiated by <a> elements:<pre><code>
{
A: "A"
@@ -118,7 +141,7 @@ Ext.define('Ext.dd.DragDrop', {
*/
invalidHandleTypes: null,
- /**
+ /**
* An object who's property names identify the IDs of elements to be considered invalid as drag handles.
* A non-null property value identifies the ID as invalid. For example, to prevent
* dragging from being initiated on element ID "foo", use:<pre><code>
@@ -130,360 +153,336 @@ Ext.define('Ext.dd.DragDrop', {
*/
invalidHandleIds: null,
- /**
+ /**
* An Array of CSS class names for elements to be considered in valid as drag handles.
- * @property invalidHandleClasses
- * @type Array
+ * @property {String[]} invalidHandleClasses
*/
invalidHandleClasses: null,
- /**
+ /**
* The linked element's absolute X position at the time the drag was
* started
* @property startPageX
- * @type int
+ * @type Number
* @private
*/
startPageX: 0,
- /**
+ /**
* The linked element's absolute X position at the time the drag was
* started
* @property startPageY
- * @type int
+ * @type Number
* @private
*/
startPageY: 0,
- /**
+ /**
* The group defines a logical collection of DragDrop objects that are
* related. Instances only get events when interacting with other
* DragDrop object in the same group. This lets us define multiple
* groups using a single DragDrop subclass if we want.
* @property groups
- * @type object An object in the format {'group1':true, 'group2':true}
+ * @type Object An object in the format {'group1':true, 'group2':true}
*/
groups: null,
- /**
+ /**
* Individual drag/drop instances can be locked. This will prevent
* onmousedown start drag.
* @property locked
- * @type boolean
+ * @type Boolean
* @private
*/
locked: false,
- /**
- * Lock this instance
- * @method lock
+ /**
+ * Locks this instance
*/
lock: function() {
this.locked = true;
},
- /**
+ /**
* When set to true, other DD objects in cooperating DDGroups do not receive
* notification events when this DD object is dragged over them. Defaults to false.
* @property moveOnly
- * @type boolean
+ * @type Boolean
*/
moveOnly: false,
- /**
- * Unlock this instace
- * @method unlock
+ /**
+ * Unlocks this instace
*/
unlock: function() {
this.locked = false;
},
- /**
+ /**
* By default, all instances can be a drop target. This can be disabled by
* setting isTarget to false.
* @property isTarget
- * @type boolean
+ * @type Boolean
*/
isTarget: true,
- /**
+ /**
* The padding configured for this drag and drop object for calculating
* the drop zone intersection with this object.
- * @property padding
- * @type int[] An array containing the 4 padding values: [top, right, bottom, left]
+ * An array containing the 4 padding values: [top, right, bottom, left]
+ * @property {Number[]} padding
*/
padding: null,
- /**
+ /**
* Cached reference to the linked element
* @property _domRef
* @private
*/
_domRef: null,
- /**
+ /**
* Internal typeof flag
* @property __ygDragDrop
* @private
*/
__ygDragDrop: true,
- /**
+ /**
* Set to true when horizontal contraints are applied
* @property constrainX
- * @type boolean
+ * @type Boolean
* @private
*/
constrainX: false,
- /**
+ /**
* Set to true when vertical contraints are applied
* @property constrainY
- * @type boolean
+ * @type Boolean
* @private
*/
constrainY: false,
- /**
+ /**
* The left constraint
* @property minX
- * @type int
+ * @type Number
* @private
*/
minX: 0,
- /**
+ /**
* The right constraint
* @property maxX
- * @type int
+ * @type Number
* @private
*/
maxX: 0,
- /**
+ /**
* The up constraint
* @property minY
- * @type int
+ * @type Number
* @private
*/
minY: 0,
- /**
+ /**
* The down constraint
* @property maxY
- * @type int
+ * @type Number
* @private
*/
maxY: 0,
- /**
+ /**
* Maintain offsets when we resetconstraints. Set to true when you want
* the position of the element relative to its parent to stay the same
* when the page changes
*
* @property maintainOffset
- * @type boolean
+ * @type Boolean
*/
maintainOffset: false,
- /**
+ /**
* Array of pixel locations the element will snap to if we specified a
* horizontal graduation/interval. This array is generated automatically
* when you define a tick interval.
- * @property xTicks
- * @type int[]
+ * @property {Number[]} xTicks
*/
xTicks: null,
- /**
+ /**
* Array of pixel locations the element will snap to if we specified a
* vertical graduation/interval. This array is generated automatically
* when you define a tick interval.
- * @property yTicks
- * @type int[]
+ * @property {Number[]} yTicks
*/
yTicks: null,
- /**
+ /**
* By default the drag and drop instance will only respond to the primary
* button click (left button for a right-handed mouse). Set to true to
* allow drag and drop to start with any mouse click that is propogated
* by the browser
* @property primaryButtonOnly
- * @type boolean
+ * @type Boolean
*/
primaryButtonOnly: true,
- /**
+ /**
* The available property is false until the linked dom element is accessible.
* @property available
- * @type boolean
+ * @type Boolean
*/
available: false,
- /**
+ /**
* By default, drags can only be initiated if the mousedown occurs in the
* region the linked element is. This is done in part to work around a
* bug in some browsers that mis-report the mousedown if the previous
* mouseup happened outside of the window. This property is set to true
- * if outer handles are defined.
+ * if outer handles are defined. Defaults to false.
*
* @property hasOuterHandles
- * @type boolean
- * @default false
+ * @type Boolean
*/
hasOuterHandles: false,
- /**
+ /**
* Code that executes immediately before the startDrag event
- * @method b4StartDrag
* @private
*/
b4StartDrag: function(x, y) { },
- /**
+ /**
* Abstract method called after a drag/drop object is clicked
* and the drag or mousedown time thresholds have beeen met.
- * @method startDrag
- * @param {int} X click location
- * @param {int} Y click location
+ * @param {Number} X click location
+ * @param {Number} Y click location
*/
startDrag: function(x, y) { /* override this */ },
- /**
+ /**
* Code that executes immediately before the onDrag event
- * @method b4Drag
* @private
*/
b4Drag: function(e) { },
- /**
+ /**
* Abstract method called during the onMouseMove event while dragging an
* object.
- * @method onDrag
* @param {Event} e the mousemove event
*/
onDrag: function(e) { /* override this */ },
- /**
+ /**
* Abstract method called when this element fist begins hovering over
* another DragDrop obj
- * @method onDragEnter
* @param {Event} e the mousemove event
- * @param {String|DragDrop[]} id In POINT mode, the element
+ * @param {String/Ext.dd.DragDrop[]} id In POINT mode, the element
* id this is hovering over. In INTERSECT mode, an array of one or more
* dragdrop items being hovered over.
*/
onDragEnter: function(e, id) { /* override this */ },
- /**
+ /**
* Code that executes immediately before the onDragOver event
- * @method b4DragOver
* @private
*/
b4DragOver: function(e) { },
- /**
+ /**
* Abstract method called when this element is hovering over another
* DragDrop obj
- * @method onDragOver
* @param {Event} e the mousemove event
- * @param {String|DragDrop[]} id In POINT mode, the element
+ * @param {String/Ext.dd.DragDrop[]} id In POINT mode, the element
* id this is hovering over. In INTERSECT mode, an array of dd items
* being hovered over.
*/
onDragOver: function(e, id) { /* override this */ },
- /**
+ /**
* Code that executes immediately before the onDragOut event
- * @method b4DragOut
* @private
*/
b4DragOut: function(e) { },
- /**
+ /**
* Abstract method called when we are no longer hovering over an element
- * @method onDragOut
* @param {Event} e the mousemove event
- * @param {String|DragDrop[]} id In POINT mode, the element
+ * @param {String/Ext.dd.DragDrop[]} id In POINT mode, the element
* id this was hovering over. In INTERSECT mode, an array of dd items
* that the mouse is no longer over.
*/
onDragOut: function(e, id) { /* override this */ },
- /**
+ /**
* Code that executes immediately before the onDragDrop event
- * @method b4DragDrop
* @private
*/
b4DragDrop: function(e) { },
- /**
+ /**
* Abstract method called when this item is dropped on another DragDrop
* obj
- * @method onDragDrop
* @param {Event} e the mouseup event
- * @param {String|DragDrop[]} id In POINT mode, the element
+ * @param {String/Ext.dd.DragDrop[]} id In POINT mode, the element
* id this was dropped on. In INTERSECT mode, an array of dd items this
* was dropped on.
*/
onDragDrop: function(e, id) { /* override this */ },
- /**
+ /**
* Abstract method called when this item is dropped on an area with no
* drop target
- * @method onInvalidDrop
* @param {Event} e the mouseup event
*/
onInvalidDrop: function(e) { /* override this */ },
- /**
+ /**
* Code that executes immediately before the endDrag event
- * @method b4EndDrag
* @private
*/
b4EndDrag: function(e) { },
- /**
- * Fired when we are done dragging the object
- * @method endDrag
+ /**
+ * Called when we are done dragging the object
* @param {Event} e the mouseup event
*/
endDrag: function(e) { /* override this */ },
- /**
+ /**
* Code executed immediately before the onMouseDown event
- * @method b4MouseDown
* @param {Event} e the mousedown event
* @private
*/
b4MouseDown: function(e) { },
- /**
- * Event handler that fires when a drag/drop obj gets a mousedown
- * @method onMouseDown
+ /**
+ * Called when a drag/drop obj gets a mousedown
* @param {Event} e the mousedown event
*/
onMouseDown: function(e) { /* override this */ },
- /**
- * Event handler that fires when a drag/drop obj gets a mouseup
- * @method onMouseUp
+ /**
+ * Called when a drag/drop obj gets a mouseup
* @param {Event} e the mouseup event
*/
onMouseUp: function(e) { /* override this */ },
- /**
+ /**
* Override the onAvailable method to do what is needed after the initial
* position was determined.
- * @method onAvailable
*/
onAvailable: function () {
},
- /**
- * Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}).
- * @type Object
+ /**
+ * @property {Object} defaultPadding
+ * Provides default constraint padding to "constrainTo" elements.
*/
defaultPadding: {
left: 0,
@@ -492,29 +491,29 @@ Ext.define('Ext.dd.DragDrop', {
bottom: 0
},
- /**
+ /**
* Initializes the drag drop object's constraints to restrict movement to a certain element.
- *
- * Usage:
- <pre><code>
- var dd = new Ext.dd.DDProxy("dragDiv1", "proxytest",
- { dragElId: "existingProxyDiv" });
- dd.startDrag = function(){
- this.constrainTo("parent-id");
- };
- </code></pre>
- * Or you can initalize it using the {@link Ext.core.Element} object:
- <pre><code>
- Ext.get("dragDiv1").initDDProxy("proxytest", {dragElId: "existingProxyDiv"}, {
- startDrag : function(){
- this.constrainTo("parent-id");
- }
- });
- </code></pre>
- * @param {Mixed} constrainTo The element to constrain to.
+ *
+ * Usage:
+ *
+ * var dd = new Ext.dd.DDProxy("dragDiv1", "proxytest",
+ * { dragElId: "existingProxyDiv" });
+ * dd.startDrag = function(){
+ * this.constrainTo("parent-id");
+ * };
+ *
+ * Or you can initalize it using the {@link Ext.Element} object:
+ *
+ * Ext.get("dragDiv1").initDDProxy("proxytest", {dragElId: "existingProxyDiv"}, {
+ * startDrag : function(){
+ * this.constrainTo("parent-id");
+ * }
+ * });
+ *
+ * @param {String/HTMLElement/Ext.Element} constrainTo The element or element ID to constrain to.
* @param {Object/Number} pad (optional) Pad provides a way to specify "padding" of the constraints,
- * and can be either a number for symmetrical padding (4 would be equal to {left:4, right:4, top:4, bottom:4}) or
- * an object containing the sides to pad. For example: {right:10, bottom:10}
+ * and can be either a number for symmetrical padding (4 would be equal to `{left:4, right:4, top:4, bottom:4}`) or
+ * an object containing the sides to pad. For example: `{right:10, bottom:10}`
* @param {Boolean} inContent (optional) Constrain the draggable in the content box of the element (inside padding and borders)
*/
constrainTo : function(constrainTo, pad, inContent){
@@ -525,10 +524,10 @@ Ext.define('Ext.dd.DragDrop', {
var b = Ext.get(this.getEl()).getBox(),
ce = Ext.get(constrainTo),
s = ce.getScroll(),
- c,
+ c,
cd = ce.dom;
if(cd == document.body){
- c = { x: s.left, y: s.top, width: Ext.core.Element.getViewWidth(), height: Ext.core.Element.getViewHeight()};
+ c = { x: s.left, y: s.top, width: Ext.Element.getViewWidth(), height: Ext.Element.getViewHeight()};
}else{
var xy = ce.getXY();
c = {x : xy[0], y: xy[1], width: cd.clientWidth, height: cd.clientHeight};
@@ -549,9 +548,8 @@ Ext.define('Ext.dd.DragDrop', {
);
},
- /**
+ /**
* Returns a reference to the linked element
- * @method getEl
* @return {HTMLElement} the html element
*/
getEl: function() {
@@ -562,24 +560,22 @@ Ext.define('Ext.dd.DragDrop', {
return this._domRef;
},
- /**
+ /**
* Returns a reference to the actual element to drag. By default this is
* the same as the html element, but it can be assigned to another
* element. An example of this can be found in Ext.dd.DDProxy
- * @method getDragEl
* @return {HTMLElement} the html element
*/
getDragEl: function() {
return Ext.getDom(this.dragElId);
},
- /**
+ /**
* Sets up the DragDrop object. Must be called in the constructor of any
* Ext.dd.DragDrop subclass
- * @method init
- * @param id the id of the linked element
+ * @param {String} id the id of the linked element
* @param {String} sGroup the group of related items
- * @param {object} config configuration attributes
+ * @param {Object} config configuration attributes
*/
init: function(id, sGroup, config) {
this.initTarget(id, sGroup, config);
@@ -587,16 +583,14 @@ Ext.define('Ext.dd.DragDrop', {
// Ext.EventManager.on(this.id, "selectstart", Event.preventDefault);
},
- /**
+ /**
* Initializes Targeting functionality only... the object does not
* get a mousedown handler.
- * @method initTarget
- * @param id the id of the linked element
+ * @param {String} id the id of the linked element
* @param {String} sGroup the group of related items
- * @param {object} config configuration attributes
+ * @param {Object} config configuration attributes
*/
initTarget: function(id, sGroup, config) {
-
// configuration attributes
this.config = config || {};
@@ -634,13 +628,12 @@ Ext.define('Ext.dd.DragDrop', {
this.handleOnAvailable();
},
- /**
+ /**
* Applies the configuration parameters that were passed into the constructor.
* This is supposed to happen at each level through the inheritance chain. So
* a DDProxy implentation will execute apply config on DDProxy, DD, and
* DragDrop in order to get all of the parameters that are available in
* each object.
- * @method applyConfig
*/
applyConfig: function() {
@@ -653,9 +646,8 @@ Ext.define('Ext.dd.DragDrop', {
},
- /**
+ /**
* Executed when the linked element is available
- * @method handleOnAvailable
* @private
*/
handleOnAvailable: function() {
@@ -664,17 +656,16 @@ Ext.define('Ext.dd.DragDrop', {
this.onAvailable();
},
- /**
+ /**
* Configures the padding for the target zone in px. Effectively expands
* (or reduces) the virtual object size for targeting calculations.
* Supports css-style shorthand; if only one parameter is passed, all sides
* will have that padding, and if only two are passed, the top and bottom
* will have the first param, the left and right the second.
- * @method setPadding
- * @param {int} iTop Top pad
- * @param {int} iRight Right pad
- * @param {int} iBot Bot pad
- * @param {int} iLeft Left pad
+ * @param {Number} iTop Top pad
+ * @param {Number} iRight Right pad
+ * @param {Number} iBot Bot pad
+ * @param {Number} iLeft Left pad
*/
setPadding: function(iTop, iRight, iBot, iLeft) {
// this.padding = [iLeft, iRight, iTop, iBot];
@@ -687,11 +678,10 @@ Ext.define('Ext.dd.DragDrop', {
}
},
- /**
+ /**
* Stores the initial placement of the linked element.
- * @method setInitPosition
- * @param {int} diffX the X offset, default 0
- * @param {int} diffY the Y offset, default 0
+ * @param {Number} diffX the X offset, default 0
+ * @param {Number} diffY the Y offset, default 0
*/
setInitPosition: function(diffX, diffY) {
var el = this.getEl();
@@ -703,7 +693,7 @@ Ext.define('Ext.dd.DragDrop', {
var dx = diffX || 0;
var dy = diffY || 0;
- var p = Ext.core.Element.getXY( el );
+ var p = Ext.Element.getXY( el );
this.initPageX = p[0] - dx;
this.initPageY = p[1] - dy;
@@ -714,37 +704,34 @@ Ext.define('Ext.dd.DragDrop', {
this.setStartPosition(p);
},
- /**
+ /**
* Sets the start position of the element. This is set when the obj
* is initialized, the reset when a drag is started.
- * @method setStartPosition
* @param pos current position (from previous lookup)
* @private
*/
setStartPosition: function(pos) {
- var p = pos || Ext.core.Element.getXY( this.getEl() );
+ var p = pos || Ext.Element.getXY( this.getEl() );
this.deltaSetXY = null;
this.startPageX = p[0];
this.startPageY = p[1];
},
- /**
- * Add this instance to a group of related drag/drop objects. All
+ /**
+ * Adds this instance to a group of related drag/drop objects. All
* instances belong to at least one group, and can belong to as many
* groups as needed.
- * @method addToGroup
- * @param sGroup {string} the name of the group
+ * @param {String} sGroup the name of the group
*/
addToGroup: function(sGroup) {
this.groups[sGroup] = true;
this.DDMInstance.regDragDrop(this, sGroup);
},
- /**
- * Remove's this instance from the supplied interaction group
- * @method removeFromGroup
- * @param {string} sGroup The group to drop
+ /**
+ * Removes this instance from the supplied interaction group
+ * @param {String} sGroup The group to drop
*/
removeFromGroup: function(sGroup) {
if (this.groups[sGroup]) {
@@ -754,25 +741,23 @@ Ext.define('Ext.dd.DragDrop', {
this.DDMInstance.removeDDFromGroup(this, sGroup);
},
- /**
+ /**
* Allows you to specify that an element other than the linked element
* will be moved with the cursor during a drag
- * @method setDragElId
- * @param id {string} the id of the element that will be used to initiate the drag
+ * @param {String} id the id of the element that will be used to initiate the drag
*/
setDragElId: function(id) {
this.dragElId = id;
},
- /**
+ /**
* Allows you to specify a child of the linked element that should be
* used to initiate the drag operation. An example of this would be if
* you have a content div with text and links. Clicking anywhere in the
* content area would normally start the drag operation. Use this method
* to specify that an element inside of the content div is the element
* that starts the drag operation.
- * @method setHandleElId
- * @param id {string} the id of the element that will be used to
+ * @param {String} id the id of the element that will be used to
* initiate the drag.
*/
setHandleElId: function(id) {
@@ -783,11 +768,10 @@ Ext.define('Ext.dd.DragDrop', {
this.DDMInstance.regHandle(this.id, id);
},
- /**
+ /**
* Allows you to set an element outside of the linked element as a drag
* handle
- * @method setOuterHandleElId
- * @param id the id of the element that will be used to initiate the drag
+ * @param {String} id the id of the element that will be used to initiate the drag
*/
setOuterHandleElId: function(id) {
if (typeof id !== "string") {
@@ -799,9 +783,8 @@ Ext.define('Ext.dd.DragDrop', {
this.hasOuterHandles = true;
},
- /**
- * Remove all drag and drop hooks for this element
- * @method unreg
+ /**
+ * Removes all drag and drop hooks for this element
*/
unreg: function() {
Ext.EventManager.un(this.id, "mousedown", this.handleMouseDown, this);
@@ -813,20 +796,18 @@ Ext.define('Ext.dd.DragDrop', {
this.unreg();
},
- /**
+ /**
* Returns true if this instance is locked, or the drag drop mgr is locked
* (meaning that all drag/drop is disabled on the page.)
- * @method isLocked
- * @return {boolean} true if this obj or all drag/drop is locked, else
+ * @return {Boolean} true if this obj or all drag/drop is locked, else
* false
*/
isLocked: function() {
return (this.DDMInstance.isLocked() || this.locked);
},
- /**
- * Fired when this object is clicked
- * @method handleMouseDown
+ /**
+ * Called when this object is clicked
* @param {Event} e
* @param {Ext.dd.DragDrop} oDD the clicked dd object (this dd obj)
* @private
@@ -868,23 +849,23 @@ Ext.define('Ext.dd.DragDrop', {
this.DDMInstance.handleWasClicked(target, this.id)) );
},
- /**
+ /**
* Allows you to specify a tag name that should not start a drag operation
* when clicked. This is designed to facilitate embedding links within a
* drag handle that do something other than start the drag.
* @method addInvalidHandleType
- * @param {string} tagName the type of element to exclude
+ * @param {String} tagName the type of element to exclude
*/
addInvalidHandleType: function(tagName) {
var type = tagName.toUpperCase();
this.invalidHandleTypes[type] = type;
},
- /**
+ /**
* Lets you to specify an element id for a child of a drag handle
* that should not initiate a drag
* @method addInvalidHandleId
- * @param {string} id the element id of the element you wish to ignore
+ * @param {String} id the element id of the element you wish to ignore
*/
addInvalidHandleId: function(id) {
if (typeof id !== "string") {
@@ -893,19 +874,17 @@ Ext.define('Ext.dd.DragDrop', {
this.invalidHandleIds[id] = id;
},
- /**
+ /**
* Lets you specify a css class of elements that will not initiate a drag
- * @method addInvalidHandleClass
- * @param {string} cssClass the class of the elements you wish to ignore
+ * @param {String} cssClass the class of the elements you wish to ignore
*/
addInvalidHandleClass: function(cssClass) {
this.invalidHandleClasses.push(cssClass);
},
- /**
+ /**
* Unsets an excluded tag name set by addInvalidHandleType
- * @method removeInvalidHandleType
- * @param {string} tagName the type of element to unexclude
+ * @param {String} tagName the type of element to unexclude
*/
removeInvalidHandleType: function(tagName) {
var type = tagName.toUpperCase();
@@ -913,10 +892,9 @@ Ext.define('Ext.dd.DragDrop', {
delete this.invalidHandleTypes[type];
},
- /**
+ /**
* Unsets an invalid handle id
- * @method removeInvalidHandleId
- * @param {string} id the id of the element to re-enable
+ * @param {String} id the id of the element to re-enable
*/
removeInvalidHandleId: function(id) {
if (typeof id !== "string") {
@@ -925,10 +903,9 @@ Ext.define('Ext.dd.DragDrop', {
delete this.invalidHandleIds[id];
},
- /**
+ /**
* Unsets an invalid css class
- * @method removeInvalidHandleClass
- * @param {string} cssClass the class of the element(s) you wish to
+ * @param {String} cssClass the class of the element(s) you wish to
* re-enable
*/
removeInvalidHandleClass: function(cssClass) {
@@ -939,11 +916,10 @@ Ext.define('Ext.dd.DragDrop', {
}
},
- /**
+ /**
* Checks the tag exclusion list to see if this click should be ignored
- * @method isValidHandleChild
* @param {HTMLElement} node the HTMLElement to evaluate
- * @return {boolean} true if this is a valid tag type, false if not
+ * @return {Boolean} true if this is a valid tag type, false if not
*/
isValidHandleChild: function(node) {
@@ -967,10 +943,9 @@ Ext.define('Ext.dd.DragDrop', {
},
- /**
- * Create the array of horizontal tick marks if an interval was specified
+ /**
+ * Creates the array of horizontal tick marks if an interval was specified
* in setXConstraint().
- * @method setXTicks
* @private
*/
setXTicks: function(iStartX, iTickSize) {
@@ -996,10 +971,9 @@ Ext.define('Ext.dd.DragDrop', {
Ext.Array.sort(this.xTicks, this.DDMInstance.numericSort);
},
- /**
- * Create the array of vertical tick marks if an interval was specified in
+ /**
+ * Creates the array of vertical tick marks if an interval was specified in
* setYConstraint().
- * @method setYTicks
* @private
*/
setYTicks: function(iStartY, iTickSize) {
@@ -1025,17 +999,15 @@ Ext.define('Ext.dd.DragDrop', {
Ext.Array.sort(this.yTicks, this.DDMInstance.numericSort);
},
- /**
+ /**
* By default, the element can be dragged any place on the screen. Use
* this method to limit the horizontal travel of the element. Pass in
* 0,0 for the parameters if you want to lock the drag to the y axis.
- * @method setXConstraint
- * @param {int} iLeft the number of pixels the element can move to the left
- * @param {int} iRight the number of pixels the element can move to the
+ * @param {Number} iLeft the number of pixels the element can move to the left
+ * @param {Number} iRight the number of pixels the element can move to the
* right
- * @param {int} iTickSize optional parameter for specifying that the
- * element
- * should move iTickSize pixels at a time.
+ * @param {Number} iTickSize (optional) parameter for specifying that the
+ * element should move iTickSize pixels at a time.
*/
setXConstraint: function(iLeft, iRight, iTickSize) {
this.leftConstraint = iLeft;
@@ -1048,10 +1020,9 @@ Ext.define('Ext.dd.DragDrop', {
this.constrainX = true;
},
- /**
+ /**
* Clears any constraints applied to this instance. Also clears ticks
* since they can't exist independent of a constraint at this time.
- * @method clearConstraints
*/
clearConstraints: function() {
this.constrainX = false;
@@ -1059,9 +1030,8 @@ Ext.define('Ext.dd.DragDrop', {
this.clearTicks();
},
- /**
+ /**
* Clears any tick interval defined for this instance
- * @method clearTicks
*/
clearTicks: function() {
this.xTicks = null;
@@ -1070,14 +1040,13 @@ Ext.define('Ext.dd.DragDrop', {
this.yTickSize = 0;
},
- /**
+ /**
* By default, the element can be dragged any place on the screen. Set
* this to limit the vertical travel of the element. Pass in 0,0 for the
* parameters if you want to lock the drag to the x axis.
- * @method setYConstraint
- * @param {int} iUp the number of pixels the element can move up
- * @param {int} iDown the number of pixels the element can move down
- * @param {int} iTickSize optional parameter for specifying that the
+ * @param {Number} iUp the number of pixels the element can move up
+ * @param {Number} iDown the number of pixels the element can move down
+ * @param {Number} iTickSize (optional) parameter for specifying that the
* element should move iTickSize pixels at a time.
*/
setYConstraint: function(iUp, iDown, iTickSize) {
@@ -1092,10 +1061,9 @@ Ext.define('Ext.dd.DragDrop', {
},
- /**
- * resetConstraints must be called if you manually reposition a dd element.
- * @method resetConstraints
- * @param {boolean} maintainOffset
+ /**
+ * Must be called if you manually reposition a dd element.
+ * @param {Boolean} maintainOffset
*/
resetConstraints: function() {
// Maintain offsets if necessary
@@ -1124,14 +1092,13 @@ Ext.define('Ext.dd.DragDrop', {
}
},
- /**
+ /**
* Normally the drag element is moved pixel by pixel, but we can specify
* that it move a number of pixels at a time. This method resolves the
* location when we have it set up like this.
- * @method getTick
- * @param {int} val where we want to place the object
- * @param {int[]} tickArray sorted array of valid points
- * @return {int} the closest tick
+ * @param {Number} val where we want to place the object
+ * @param {Number[]} tickArray sorted array of valid points
+ * @return {Number} the closest tick
* @private
*/
getTick: function(val, tickArray) {
@@ -1159,13 +1126,15 @@ Ext.define('Ext.dd.DragDrop', {
}
},
- /**
+ /**
* toString method
- * @method toString
- * @return {string} string representation of the dd obj
+ * @return {String} string representation of the dd obj
*/
toString: function() {
return ("DragDrop " + this.id);
}
-});