4 * Copyright(c) 2006-2007, Ext JS, LLC.
6 * Originally Released Under LGPL - original licence link has changed is not relivant.
9 * <script type="text/javascript">
15 * These classes are derivatives of the similarly named classes in the YUI Library.
16 * The original license:
17 * Copyright (c) 2006, Yahoo! Inc. All rights reserved.
18 * Code licensed under the BSD License:
19 * http://developer.yahoo.net/yui/license.txt
24 var Event=Roo.EventManager;
28 * @class Roo.dd.DragDrop
29 * @extends Roo.util.Observable
30 * Defines the interface and base operation of items that that can be
31 * dragged or can be drop targets. It was designed to be extended, overriding
32 * the event handlers for startDrag, onDrag, onDragOver and onDragOut.
33 * Up to three html elements can be associated with a DragDrop instance:
35 * <li>linked element: the element that is passed into the constructor.
36 * This is the element which defines the boundaries for interaction with
37 * other DragDrop objects.</li>
38 * <li>handle element(s): The drag operation only occurs if the element that
39 * was clicked matches a handle element. By default this is the linked
40 * element, but there are times that you will want only a portion of the
41 * linked element to initiate the drag operation, and the setHandleElId()
42 * method provides a way to define this.</li>
43 * <li>drag element: this represents the element that would be moved along
44 * with the cursor during a drag operation. By default, this is the linked
45 * element itself as in {@link Roo.dd.DD}. setDragElId() lets you define
46 * a separate element that would be moved, as in {@link Roo.dd.DDProxy}.
49 * This class should not be instantiated until the onload event to ensure that
50 * the associated elements are available.
51 * The following would define a DragDrop obj that would interact with any
52 * other DragDrop obj in the "group1" group:
54 * dd = new Roo.dd.DragDrop("div1", "group1");
56 * Since none of the event handlers have been implemented, nothing would
57 * actually happen if you were to run the code above. Normally you would
58 * override this class or one of the default implementations, but you can
59 * also override the methods you want on an instance of the class...
61 * dd.onDragDrop = function(e, id) {
62 * alert("dd was dropped on " + id);
66 * @param {String} id of the element that is linked to this instance
67 * @param {String} sGroup the group of related DragDrop objects
68 * @param {object} config an object containing configurable attributes
69 * Valid properties for DragDrop:
70 * padding, isTarget, maintainOffset, primaryButtonOnly
72 Roo.dd.DragDrop = function(id, sGroup, config) {
74 this.init(id, sGroup, config);
79 Roo.extend(Roo.dd.DragDrop, Roo.util.Observable , {
82 * The id of the element associated with this object. This is what we
83 * refer to as the "linked element" because the size and position of
84 * this element is used to determine when the drag and drop objects have
92 * Configuration attributes passed into the constructor
99 * The id of the element that will be dragged. By default this is same
100 * as the linked element , but could be changed to another element. Ex:
109 * the id of the element that initiates the drag operation. By default
110 * this is the linked element, but could be changed to be a child of this
111 * element. This lets us do things like only starting the drag when the
112 * header element within the linked html element is clicked.
113 * @property handleElId
120 * An associative array of HTML tags that will be ignored if clicked.
121 * @property invalidHandleTypes
122 * @type {string: string}
124 invalidHandleTypes: null,
127 * An associative array of ids for elements that will be ignored if clicked
128 * @property invalidHandleIds
129 * @type {string: string}
131 invalidHandleIds: null,
134 * An indexted array of css class names for elements that will be ignored
136 * @property invalidHandleClasses
139 invalidHandleClasses: null,
142 * The linked element's absolute X position at the time the drag was
144 * @property startPageX
151 * The linked element's absolute X position at the time the drag was
153 * @property startPageY
160 * The group defines a logical collection of DragDrop objects that are
161 * related. Instances only get events when interacting with other
162 * DragDrop object in the same group. This lets us define multiple
163 * groups using a single DragDrop subclass if we want.
165 * @type {string: string}
170 * Individual drag/drop instances can be locked. This will prevent
171 * onmousedown start drag.
182 lock: function() { this.locked = true; },
185 * Unlock this instace
188 unlock: function() { this.locked = false; },
191 * By default, all insances can be a drop target. This can be disabled by
192 * setting isTarget to false.
199 * The padding configured for this drag and drop object for calculating
200 * the drop zone intersection with this object.
207 * Cached reference to the linked element
214 * Internal typeof flag
215 * @property __ygDragDrop
221 * Set to true when horizontal contraints are applied
222 * @property constrainX
229 * Set to true when vertical contraints are applied
230 * @property constrainY
237 * The left constraint
245 * The right constraint
262 * The down constraint
270 * Maintain offsets when we resetconstraints. Set to true when you want
271 * the position of the element relative to its parent to stay the same
272 * when the page changes
274 * @property maintainOffset
277 maintainOffset: false,
280 * Array of pixel locations the element will snap to if we specified a
281 * horizontal graduation/interval. This array is generated automatically
282 * when you define a tick interval.
289 * Array of pixel locations the element will snap to if we specified a
290 * vertical graduation/interval. This array is generated automatically
291 * when you define a tick interval.
298 * By default the drag and drop instance will only respond to the primary
299 * button click (left button for a right-handed mouse). Set to true to
300 * allow drag and drop to start with any mouse click that is propogated
302 * @property primaryButtonOnly
305 primaryButtonOnly: true,
308 * The availabe property is false until the linked dom element is accessible.
309 * @property available
315 * By default, drags can only be initiated if the mousedown occurs in the
316 * region the linked element is. This is done in part to work around a
317 * bug in some browsers that mis-report the mousedown if the previous
318 * mouseup happened outside of the window. This property is set to true
319 * if outer handles are defined.
321 * @property hasOuterHandles
325 hasOuterHandles: false,
328 * Code that executes immediately before the startDrag event
329 * @method b4StartDrag
332 b4StartDrag: function(x, y) { },
335 * Abstract method called after a drag/drop object is clicked
336 * and the drag or mousedown time thresholds have beeen met.
338 * @param {int} X click location
339 * @param {int} Y click location
341 startDrag: function(x, y) { /* override this */ },
344 * Code that executes immediately before the onDrag event
348 b4Drag: function(e) { },
351 * Abstract method called during the onMouseMove event while dragging an
354 * @param {Event} e the mousemove event
356 onDrag: function(e) { /* override this */ },
359 * Abstract method called when this element fist begins hovering over
360 * another DragDrop obj
361 * @method onDragEnter
362 * @param {Event} e the mousemove event
363 * @param {String|DragDrop[]} id In POINT mode, the element
364 * id this is hovering over. In INTERSECT mode, an array of one or more
365 * dragdrop items being hovered over.
367 onDragEnter: function(e, id) { /* override this */ },
370 * Code that executes immediately before the onDragOver event
374 b4DragOver: function(e) { },
377 * Abstract method called when this element is hovering over another
380 * @param {Event} e the mousemove event
381 * @param {String|DragDrop[]} id In POINT mode, the element
382 * id this is hovering over. In INTERSECT mode, an array of dd items
383 * being hovered over.
385 onDragOver: function(e, id) { /* override this */ },
388 * Code that executes immediately before the onDragOut event
392 b4DragOut: function(e) { },
395 * Abstract method called when we are no longer hovering over an element
397 * @param {Event} e the mousemove event
398 * @param {String|DragDrop[]} id In POINT mode, the element
399 * id this was hovering over. In INTERSECT mode, an array of dd items
400 * that the mouse is no longer over.
402 onDragOut: function(e, id) { /* override this */ },
405 * Code that executes immediately before the onDragDrop event
409 b4DragDrop: function(e) { },
412 * Abstract method called when this item is dropped on another DragDrop
415 * @param {Event} e the mouseup event
416 * @param {String|DragDrop[]} id In POINT mode, the element
417 * id this was dropped on. In INTERSECT mode, an array of dd items this
420 onDragDrop: function(e, id) { /* override this */ },
423 * Abstract method called when this item is dropped on an area with no
425 * @method onInvalidDrop
426 * @param {Event} e the mouseup event
428 onInvalidDrop: function(e) { /* override this */ },
431 * Code that executes immediately before the endDrag event
435 b4EndDrag: function(e) { },
438 * Fired when we are done dragging the object
440 * @param {Event} e the mouseup event
442 endDrag: function(e) { /* override this */ },
445 * Code executed immediately before the onMouseDown event
446 * @method b4MouseDown
447 * @param {Event} e the mousedown event
450 b4MouseDown: function(e) { },
453 * Event handler that fires when a drag/drop obj gets a mousedown
454 * @method onMouseDown
455 * @param {Event} e the mousedown event
457 onMouseDown: function(e) { /* override this */ },
460 * Event handler that fires when a drag/drop obj gets a mouseup
462 * @param {Event} e the mouseup event
464 onMouseUp: function(e) { /* override this */ },
467 * Override the onAvailable method to do what is needed after the initial
468 * position was determined.
469 * @method onAvailable
471 onAvailable: function () {
475 * Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}).
478 defaultPadding : {left:0, right:0, top:0, bottom:0},
481 * Initializes the drag drop object's constraints to restrict movement to a certain element.
485 var dd = new Roo.dd.DDProxy("dragDiv1", "proxytest",
486 { dragElId: "existingProxyDiv" });
487 dd.startDrag = function(){
488 this.constrainTo("parent-id");
491 * Or you can initalize it using the {@link Roo.Element} object:
493 Roo.get("dragDiv1").initDDProxy("proxytest", {dragElId: "existingProxyDiv"}, {
494 startDrag : function(){
495 this.constrainTo("parent-id");
499 * @param {String/HTMLElement/Element} constrainTo The element to constrain to.
500 * @param {Object/Number} pad (optional) Pad provides a way to specify "padding" of the constraints,
501 * and can be either a number for symmetrical padding (4 would be equal to {left:4, right:4, top:4, bottom:4}) or
502 * an object containing the sides to pad. For example: {right:10, bottom:10}
503 * @param {Boolean} inContent (optional) Constrain the draggable in the content box of the element (inside padding and borders)
505 constrainTo : function(constrainTo, pad, inContent){
506 if(typeof pad == "number"){
507 pad = {left: pad, right:pad, top:pad, bottom:pad};
509 pad = pad || this.defaultPadding;
510 var b = Roo.get(this.getEl()).getBox();
511 var ce = Roo.get(constrainTo);
512 var s = ce.getScroll();
514 if(cd == document.body){
515 c = { x: s.left, y: s.top, width: Roo.lib.Dom.getViewWidth(), height: Roo.lib.Dom.getViewHeight()};
518 c = {x : xy[0]+s.left, y: xy[1]+s.top, width: cd.clientWidth, height: cd.clientHeight};
522 var topSpace = b.y - c.y;
523 var leftSpace = b.x - c.x;
525 this.resetConstraints();
526 this.setXConstraint(leftSpace - (pad.left||0), // left
527 c.width - leftSpace - b.width - (pad.right||0) //right
529 this.setYConstraint(topSpace - (pad.top||0), //top
530 c.height - topSpace - b.height - (pad.bottom||0) //bottom
535 * Returns a reference to the linked element
537 * @return {HTMLElement} the html element
541 this._domRef = Roo.getDom(this.id);
548 * Returns a reference to the actual element to drag. By default this is
549 * the same as the html element, but it can be assigned to another
550 * element. An example of this can be found in Roo.dd.DDProxy
552 * @return {HTMLElement} the html element
554 getDragEl: function() {
555 return Roo.getDom(this.dragElId);
559 * Sets up the DragDrop object. Must be called in the constructor of any
560 * Roo.dd.DragDrop subclass
562 * @param id the id of the linked element
563 * @param {String} sGroup the group of related items
564 * @param {object} config configuration attributes
566 init: function(id, sGroup, config) {
567 this.initTarget(id, sGroup, config);
569 Event.on(this.id, "mousedown", this.handleMouseDown, this);
571 Event.on(this.id, "touchstart", this.handleMouseDown, this);
572 // Event.on(this.id, "selectstart", Event.preventDefault);
576 * Initializes Targeting functionality only... the object does not
577 * get a mousedown handler.
579 * @param id the id of the linked element
580 * @param {String} sGroup the group of related items
581 * @param {object} config configuration attributes
583 initTarget: function(id, sGroup, config) {
585 // configuration attributes
586 this.config = config || {};
588 // create a local reference to the drag and drop manager
589 this.DDM = Roo.dd.DDM;
590 // initialize the groups array
593 // assume that we have an element reference instead of an id if the
594 // parameter is not a string
595 if (typeof id !== "string") {
602 // add to an interaction group
603 this.addToGroup((sGroup) ? sGroup : "default");
605 // We don't want to register this as the handle with the manager
606 // so we just set the id rather than calling the setter.
607 this.handleElId = id;
609 // the linked element is the element that gets dragged by default
610 this.setDragElId(id);
612 // by default, clicked anchors will not start drag operations.
613 this.invalidHandleTypes = { A: "A" };
614 this.invalidHandleIds = {};
615 this.invalidHandleClasses = [];
619 this.handleOnAvailable();
623 * Applies the configuration parameters that were passed into the constructor.
624 * This is supposed to happen at each level through the inheritance chain. So
625 * a DDProxy implentation will execute apply config on DDProxy, DD, and
626 * DragDrop in order to get all of the parameters that are available in
628 * @method applyConfig
630 applyConfig: function() {
632 // configurable properties:
633 // padding, isTarget, maintainOffset, primaryButtonOnly
634 this.padding = this.config.padding || [0, 0, 0, 0];
635 this.isTarget = (this.config.isTarget !== false);
636 this.maintainOffset = (this.config.maintainOffset);
637 this.primaryButtonOnly = (this.config.primaryButtonOnly !== false);
642 * Executed when the linked element is available
643 * @method handleOnAvailable
646 handleOnAvailable: function() {
647 this.available = true;
648 this.resetConstraints();
653 * Configures the padding for the target zone in px. Effectively expands
654 * (or reduces) the virtual object size for targeting calculations.
655 * Supports css-style shorthand; if only one parameter is passed, all sides
656 * will have that padding, and if only two are passed, the top and bottom
657 * will have the first param, the left and right the second.
659 * @param {int} iTop Top pad
660 * @param {int} iRight Right pad
661 * @param {int} iBot Bot pad
662 * @param {int} iLeft Left pad
664 setPadding: function(iTop, iRight, iBot, iLeft) {
665 // this.padding = [iLeft, iRight, iTop, iBot];
666 if (!iRight && 0 !== iRight) {
667 this.padding = [iTop, iTop, iTop, iTop];
668 } else if (!iBot && 0 !== iBot) {
669 this.padding = [iTop, iRight, iTop, iRight];
671 this.padding = [iTop, iRight, iBot, iLeft];
676 * Stores the initial placement of the linked element.
677 * @method setInitialPosition
678 * @param {int} diffX the X offset, default 0
679 * @param {int} diffY the Y offset, default 0
681 setInitPosition: function(diffX, diffY) {
682 var el = this.getEl();
684 if (!this.DDM.verifyEl(el)) {
691 var p = Dom.getXY( el );
693 this.initPageX = p[0] - dx;
694 this.initPageY = p[1] - dy;
696 this.lastPageX = p[0];
697 this.lastPageY = p[1];
700 this.setStartPosition(p);
704 * Sets the start position of the element. This is set when the obj
705 * is initialized, the reset when a drag is started.
706 * @method setStartPosition
707 * @param pos current position (from previous lookup)
710 setStartPosition: function(pos) {
711 var p = pos || Dom.getXY( this.getEl() );
712 this.deltaSetXY = null;
714 this.startPageX = p[0];
715 this.startPageY = p[1];
719 * Add this instance to a group of related drag/drop objects. All
720 * instances belong to at least one group, and can belong to as many
723 * @param sGroup {string} the name of the group
725 addToGroup: function(sGroup) {
726 this.groups[sGroup] = true;
727 this.DDM.regDragDrop(this, sGroup);
731 * Remove's this instance from the supplied interaction group
732 * @method removeFromGroup
733 * @param {string} sGroup The group to drop
735 removeFromGroup: function(sGroup) {
736 if (this.groups[sGroup]) {
737 delete this.groups[sGroup];
740 this.DDM.removeDDFromGroup(this, sGroup);
744 * Allows you to specify that an element other than the linked element
745 * will be moved with the cursor during a drag
746 * @method setDragElId
747 * @param id {string} the id of the element that will be used to initiate the drag
749 setDragElId: function(id) {
754 * Allows you to specify a child of the linked element that should be
755 * used to initiate the drag operation. An example of this would be if
756 * you have a content div with text and links. Clicking anywhere in the
757 * content area would normally start the drag operation. Use this method
758 * to specify that an element inside of the content div is the element
759 * that starts the drag operation.
760 * @method setHandleElId
761 * @param id {string} the id of the element that will be used to
764 setHandleElId: function(id) {
765 if (typeof id !== "string") {
768 this.handleElId = id;
769 this.DDM.regHandle(this.id, id);
773 * Allows you to set an element outside of the linked element as a drag
775 * @method setOuterHandleElId
776 * @param id the id of the element that will be used to initiate the drag
778 setOuterHandleElId: function(id) {
779 if (typeof id !== "string") {
782 Event.on(id, "mousedown",
783 this.handleMouseDown, this);
784 this.setHandleElId(id);
786 this.hasOuterHandles = true;
790 * Remove all drag and drop hooks for this element
794 Event.un(this.id, "mousedown",
795 this.handleMouseDown);
796 Event.un(this.id, "touchstart",
797 this.handleMouseDown);
799 this.DDM._remove(this);
802 destroy : function(){
807 * Returns true if this instance is locked, or the drag drop mgr is locked
808 * (meaning that all drag/drop is disabled on the page.)
810 * @return {boolean} true if this obj or all drag/drop is locked, else
813 isLocked: function() {
814 return (this.DDM.isLocked() || this.locked);
818 * Fired when this object is clicked
819 * @method handleMouseDown
821 * @param {Roo.dd.DragDrop} oDD the clicked dd object (this dd obj)
824 handleMouseDown: function(e, oDD){
826 if (!Roo.isTouch && this.primaryButtonOnly && e.button != 0) {
827 //Roo.log('not touch/ button !=0');
830 if (e.browserEvent.touches && e.browserEvent.touches.length != 1) {
831 return; // double touch..
835 if (this.isLocked()) {
840 this.DDM.refreshCache(this.groups);
841 // Roo.log([Roo.lib.Event.getPageX(e), Roo.lib.Event.getPageY(e)]);
842 var pt = new Roo.lib.Point(Roo.lib.Event.getPageX(e), Roo.lib.Event.getPageY(e));
843 if (!this.hasOuterHandles && !this.DDM.isOverTarget(pt, this) ) {
844 //Roo.log('no outer handes or not over target');
847 // Roo.log('check validator');
848 if (this.clickValidator(e)) {
849 // Roo.log('validate success');
850 // set the initial element position
851 this.setStartPosition();
857 this.DDM.handleMouseDown(e, this);
859 this.DDM.stopEvent(e);
867 clickValidator: function(e) {
868 var target = e.getTarget();
869 return ( this.isValidHandleChild(target) &&
870 (this.id == this.handleElId ||
871 this.DDM.handleWasClicked(target, this.id)) );
875 * Allows you to specify a tag name that should not start a drag operation
876 * when clicked. This is designed to facilitate embedding links within a
877 * drag handle that do something other than start the drag.
878 * @method addInvalidHandleType
879 * @param {string} tagName the type of element to exclude
881 addInvalidHandleType: function(tagName) {
882 var type = tagName.toUpperCase();
883 this.invalidHandleTypes[type] = type;
887 * Lets you to specify an element id for a child of a drag handle
888 * that should not initiate a drag
889 * @method addInvalidHandleId
890 * @param {string} id the element id of the element you wish to ignore
892 addInvalidHandleId: function(id) {
893 if (typeof id !== "string") {
896 this.invalidHandleIds[id] = id;
900 * Lets you specify a css class of elements that will not initiate a drag
901 * @method addInvalidHandleClass
902 * @param {string} cssClass the class of the elements you wish to ignore
904 addInvalidHandleClass: function(cssClass) {
905 this.invalidHandleClasses.push(cssClass);
909 * Unsets an excluded tag name set by addInvalidHandleType
910 * @method removeInvalidHandleType
911 * @param {string} tagName the type of element to unexclude
913 removeInvalidHandleType: function(tagName) {
914 var type = tagName.toUpperCase();
915 // this.invalidHandleTypes[type] = null;
916 delete this.invalidHandleTypes[type];
920 * Unsets an invalid handle id
921 * @method removeInvalidHandleId
922 * @param {string} id the id of the element to re-enable
924 removeInvalidHandleId: function(id) {
925 if (typeof id !== "string") {
928 delete this.invalidHandleIds[id];
932 * Unsets an invalid css class
933 * @method removeInvalidHandleClass
934 * @param {string} cssClass the class of the element(s) you wish to
937 removeInvalidHandleClass: function(cssClass) {
938 for (var i=0, len=this.invalidHandleClasses.length; i<len; ++i) {
939 if (this.invalidHandleClasses[i] == cssClass) {
940 delete this.invalidHandleClasses[i];
946 * Checks the tag exclusion list to see if this click should be ignored
947 * @method isValidHandleChild
948 * @param {HTMLElement} node the HTMLElement to evaluate
949 * @return {boolean} true if this is a valid tag type, false if not
951 isValidHandleChild: function(node) {
954 // var n = (node.nodeName == "#text") ? node.parentNode : node;
957 nodeName = node.nodeName.toUpperCase();
959 nodeName = node.nodeName;
961 valid = valid && !this.invalidHandleTypes[nodeName];
962 valid = valid && !this.invalidHandleIds[node.id];
964 for (var i=0, len=this.invalidHandleClasses.length; valid && i<len; ++i) {
965 valid = !Dom.hasClass(node, this.invalidHandleClasses[i]);
974 * Create the array of horizontal tick marks if an interval was specified
975 * in setXConstraint().
979 setXTicks: function(iStartX, iTickSize) {
981 this.xTickSize = iTickSize;
985 for (var i = this.initPageX; i >= this.minX; i = i - iTickSize) {
987 this.xTicks[this.xTicks.length] = i;
992 for (i = this.initPageX; i <= this.maxX; i = i + iTickSize) {
994 this.xTicks[this.xTicks.length] = i;
999 this.xTicks.sort(this.DDM.numericSort) ;
1003 * Create the array of vertical tick marks if an interval was specified in
1008 setYTicks: function(iStartY, iTickSize) {
1010 this.yTickSize = iTickSize;
1014 for (var i = this.initPageY; i >= this.minY; i = i - iTickSize) {
1016 this.yTicks[this.yTicks.length] = i;
1021 for (i = this.initPageY; i <= this.maxY; i = i + iTickSize) {
1023 this.yTicks[this.yTicks.length] = i;
1028 this.yTicks.sort(this.DDM.numericSort) ;
1032 * By default, the element can be dragged any place on the screen. Use
1033 * this method to limit the horizontal travel of the element. Pass in
1034 * 0,0 for the parameters if you want to lock the drag to the y axis.
1035 * @method setXConstraint
1036 * @param {int} iLeft the number of pixels the element can move to the left
1037 * @param {int} iRight the number of pixels the element can move to the
1039 * @param {int} iTickSize optional parameter for specifying that the
1041 * should move iTickSize pixels at a time.
1043 setXConstraint: function(iLeft, iRight, iTickSize) {
1044 this.leftConstraint = iLeft;
1045 this.rightConstraint = iRight;
1047 this.minX = this.initPageX - iLeft;
1048 this.maxX = this.initPageX + iRight;
1049 if (iTickSize) { this.setXTicks(this.initPageX, iTickSize); }
1051 this.constrainX = true;
1055 * Clears any constraints applied to this instance. Also clears ticks
1056 * since they can't exist independent of a constraint at this time.
1057 * @method clearConstraints
1059 clearConstraints: function() {
1060 this.constrainX = false;
1061 this.constrainY = false;
1066 * Clears any tick interval defined for this instance
1067 * @method clearTicks
1069 clearTicks: function() {
1077 * By default, the element can be dragged any place on the screen. Set
1078 * this to limit the vertical travel of the element. Pass in 0,0 for the
1079 * parameters if you want to lock the drag to the x axis.
1080 * @method setYConstraint
1081 * @param {int} iUp the number of pixels the element can move up
1082 * @param {int} iDown the number of pixels the element can move down
1083 * @param {int} iTickSize optional parameter for specifying that the
1084 * element should move iTickSize pixels at a time.
1086 setYConstraint: function(iUp, iDown, iTickSize) {
1087 this.topConstraint = iUp;
1088 this.bottomConstraint = iDown;
1090 this.minY = this.initPageY - iUp;
1091 this.maxY = this.initPageY + iDown;
1092 if (iTickSize) { this.setYTicks(this.initPageY, iTickSize); }
1094 this.constrainY = true;
1099 * resetConstraints must be called if you manually reposition a dd element.
1100 * @method resetConstraints
1101 * @param {boolean} maintainOffset
1103 resetConstraints: function() {
1106 // Maintain offsets if necessary
1107 if (this.initPageX || this.initPageX === 0) {
1108 // figure out how much this thing has moved
1109 var dx = (this.maintainOffset) ? this.lastPageX - this.initPageX : 0;
1110 var dy = (this.maintainOffset) ? this.lastPageY - this.initPageY : 0;
1112 this.setInitPosition(dx, dy);
1114 // This is the first time we have detected the element's position
1116 this.setInitPosition();
1119 if (this.constrainX) {
1120 this.setXConstraint( this.leftConstraint,
1121 this.rightConstraint,
1125 if (this.constrainY) {
1126 this.setYConstraint( this.topConstraint,
1127 this.bottomConstraint,
1133 * Normally the drag element is moved pixel by pixel, but we can specify
1134 * that it move a number of pixels at a time. This method resolves the
1135 * location when we have it set up like this.
1137 * @param {int} val where we want to place the object
1138 * @param {int[]} tickArray sorted array of valid points
1139 * @return {int} the closest tick
1142 getTick: function(val, tickArray) {
1145 // If tick interval is not defined, it is effectively 1 pixel,
1146 // so we return the value passed to us.
1148 } else if (tickArray[0] >= val) {
1149 // The value is lower than the first tick, so we return the first
1151 return tickArray[0];
1153 for (var i=0, len=tickArray.length; i<len; ++i) {
1155 if (tickArray[next] && tickArray[next] >= val) {
1156 var diff1 = val - tickArray[i];
1157 var diff2 = tickArray[next] - val;
1158 return (diff2 > diff1) ? tickArray[i] : tickArray[next];
1162 // The value is larger than the last tick, so we return the last
1164 return tickArray[tickArray.length - 1];
1171 * @return {string} string representation of the dd obj
1173 toString: function() {
1174 return ("DragDrop " + this.id);
1182 * Ext JS Library 1.1.1
1183 * Copyright(c) 2006-2007, Ext JS, LLC.
1185 * Originally Released Under LGPL - original licence link has changed is not relivant.
1188 * <script type="text/javascript">
1193 * The drag and drop utility provides a framework for building drag and drop
1194 * applications. In addition to enabling drag and drop for specific elements,
1195 * the drag and drop elements are tracked by the manager class, and the
1196 * interactions between the various elements are tracked during the drag and
1197 * the implementing code is notified about these important moments.
1200 // Only load the library once. Rewriting the manager class would orphan
1201 // existing drag and drop instances.
1202 if (!Roo.dd.DragDropMgr) {
1205 * @class Roo.dd.DragDropMgr
1206 * DragDropMgr is a singleton that tracks the element interaction for
1207 * all DragDrop items in the window. Generally, you will not call
1208 * this class directly, but it does have helper methods that could
1209 * be useful in your DragDrop implementations.
1212 Roo.dd.DragDropMgr = function() {
1214 var Event = Roo.EventManager;
1219 * Two dimensional Array of registered DragDrop objects. The first
1220 * dimension is the DragDrop item group, the second the DragDrop
1223 * @type {string: string}
1230 * Array of element ids defined as drag handles. Used to determine
1231 * if the element that generated the mousedown event is actually the
1232 * handle and not the html element itself.
1233 * @property handleIds
1234 * @type {string: string}
1241 * the DragDrop object that is currently being dragged
1242 * @property dragCurrent
1250 * the DragDrop object(s) that are being hovered over
1251 * @property dragOvers
1259 * the X distance between the cursor and the object being dragged
1268 * the Y distance between the cursor and the object being dragged
1277 * Flag to determine if we should prevent the default behavior of the
1278 * events we define. By default this is true, but this can be set to
1279 * false if you need the default behavior (not recommended)
1280 * @property preventDefault
1284 preventDefault: true,
1287 * Flag to determine if we should stop the propagation of the events
1288 * we generate. This is true by default but you may want to set it to
1289 * false if the html element contains other features that require the
1291 * @property stopPropagation
1295 stopPropagation: true,
1298 * Internal flag that is set to true when drag and drop has been
1300 * @property initialized
1307 * All drag and drop can be disabled.
1315 * Called the first time an element is registered.
1321 this.initialized = true;
1325 * In point mode, drag and drop interaction is defined by the
1326 * location of the cursor during the drag/drop
1334 * In intersect mode, drag and drop interactio nis defined by the
1335 * overlap of two or more drag and drop objects.
1336 * @property INTERSECT
1343 * The current drag and drop mode. Default: POINT
1351 * Runs method on all drag and drop objects
1352 * @method _execOnAll
1356 _execOnAll: function(sMethod, args) {
1357 for (var i in this.ids) {
1358 for (var j in this.ids[i]) {
1359 var oDD = this.ids[i][j];
1360 if (! this.isTypeOfDD(oDD)) {
1363 oDD[sMethod].apply(oDD, args);
1369 * Drag and drop initialization. Sets up the global event handlers
1374 _onLoad: function() {
1379 Event.on(document, "mouseup", this.handleMouseUp, this, true);
1380 Event.on(document, "mousemove", this.handleMouseMove, this, true);
1382 Event.on(document, "touchend", this.handleMouseUp, this, true);
1383 Event.on(document, "touchmove", this.handleMouseMove, this, true);
1385 Event.on(window, "unload", this._onUnload, this, true);
1386 Event.on(window, "resize", this._onResize, this, true);
1387 // Event.on(window, "mouseout", this._test);
1392 * Reset constraints on all drag and drop objs
1397 _onResize: function(e) {
1398 this._execOnAll("resetConstraints", []);
1402 * Lock all drag and drop functionality
1406 lock: function() { this.locked = true; },
1409 * Unlock all drag and drop functionality
1413 unlock: function() { this.locked = false; },
1416 * Is drag and drop locked?
1418 * @return {boolean} True if drag and drop is locked, false otherwise.
1421 isLocked: function() { return this.locked; },
1424 * Location cache that is set for all drag drop objects when a drag is
1425 * initiated, cleared when the drag is finished.
1426 * @property locationCache
1433 * Set useCache to false if you want to force object the lookup of each
1434 * drag and drop linked element constantly during a drag.
1435 * @property useCache
1442 * The number of pixels that the mouse needs to move after the
1443 * mousedown before the drag is initiated. Default=3;
1444 * @property clickPixelThresh
1448 clickPixelThresh: 3,
1451 * The number of milliseconds after the mousedown event to initiate the
1452 * drag if we don't get a mouseup event. Default=1000
1453 * @property clickTimeThresh
1457 clickTimeThresh: 350,
1460 * Flag that indicates that either the drag pixel threshold or the
1461 * mousdown time threshold has been met
1462 * @property dragThreshMet
1467 dragThreshMet: false,
1470 * Timeout used for the click time threshold
1471 * @property clickTimeout
1479 * The X position of the mousedown event stored for later use when a
1480 * drag threshold is met.
1489 * The Y position of the mousedown event stored for later use when a
1490 * drag threshold is met.
1499 * Each DragDrop instance must be registered with the DragDropMgr.
1500 * This is executed in DragDrop.init()
1501 * @method regDragDrop
1502 * @param {DragDrop} oDD the DragDrop object to register
1503 * @param {String} sGroup the name of the group this element belongs to
1506 regDragDrop: function(oDD, sGroup) {
1507 if (!this.initialized) { this.init(); }
1509 if (!this.ids[sGroup]) {
1510 this.ids[sGroup] = {};
1512 this.ids[sGroup][oDD.id] = oDD;
1516 * Removes the supplied dd instance from the supplied group. Executed
1517 * by DragDrop.removeFromGroup, so don't call this function directly.
1518 * @method removeDDFromGroup
1522 removeDDFromGroup: function(oDD, sGroup) {
1523 if (!this.ids[sGroup]) {
1524 this.ids[sGroup] = {};
1527 var obj = this.ids[sGroup];
1528 if (obj && obj[oDD.id]) {
1534 * Unregisters a drag and drop item. This is executed in
1535 * DragDrop.unreg, use that method instead of calling this directly.
1540 _remove: function(oDD) {
1541 for (var g in oDD.groups) {
1542 if (g && this.ids[g][oDD.id]) {
1543 delete this.ids[g][oDD.id];
1546 delete this.handleIds[oDD.id];
1550 * Each DragDrop handle element must be registered. This is done
1551 * automatically when executing DragDrop.setHandleElId()
1553 * @param {String} sDDId the DragDrop id this element is a handle for
1554 * @param {String} sHandleId the id of the element that is the drag
1558 regHandle: function(sDDId, sHandleId) {
1559 if (!this.handleIds[sDDId]) {
1560 this.handleIds[sDDId] = {};
1562 this.handleIds[sDDId][sHandleId] = sHandleId;
1566 * Utility function to determine if a given element has been
1567 * registered as a drag drop item.
1568 * @method isDragDrop
1569 * @param {String} id the element id to check
1570 * @return {boolean} true if this element is a DragDrop item,
1574 isDragDrop: function(id) {
1575 return ( this.getDDById(id) ) ? true : false;
1579 * Returns the drag and drop instances that are in all groups the
1580 * passed in instance belongs to.
1581 * @method getRelated
1582 * @param {DragDrop} p_oDD the obj to get related data for
1583 * @param {boolean} bTargetsOnly if true, only return targetable objs
1584 * @return {DragDrop[]} the related instances
1587 getRelated: function(p_oDD, bTargetsOnly) {
1589 for (var i in p_oDD.groups) {
1590 for (j in this.ids[i]) {
1591 var dd = this.ids[i][j];
1592 if (! this.isTypeOfDD(dd)) {
1595 if (!bTargetsOnly || dd.isTarget) {
1596 oDDs[oDDs.length] = dd;
1605 * Returns true if the specified dd target is a legal target for
1606 * the specifice drag obj
1607 * @method isLegalTarget
1608 * @param {DragDrop} the drag obj
1609 * @param {DragDrop} the target
1610 * @return {boolean} true if the target is a legal target for the
1614 isLegalTarget: function (oDD, oTargetDD) {
1615 var targets = this.getRelated(oDD, true);
1616 for (var i=0, len=targets.length;i<len;++i) {
1617 if (targets[i].id == oTargetDD.id) {
1626 * My goal is to be able to transparently determine if an object is
1627 * typeof DragDrop, and the exact subclass of DragDrop. typeof
1628 * returns "object", oDD.constructor.toString() always returns
1629 * "DragDrop" and not the name of the subclass. So for now it just
1630 * evaluates a well-known variable in DragDrop.
1631 * @method isTypeOfDD
1632 * @param {Object} the object to evaluate
1633 * @return {boolean} true if typeof oDD = DragDrop
1636 isTypeOfDD: function (oDD) {
1637 return (oDD && oDD.__ygDragDrop);
1641 * Utility function to determine if a given element has been
1642 * registered as a drag drop handle for the given Drag Drop object.
1644 * @param {String} id the element id to check
1645 * @return {boolean} true if this element is a DragDrop handle, false
1649 isHandle: function(sDDId, sHandleId) {
1650 return ( this.handleIds[sDDId] &&
1651 this.handleIds[sDDId][sHandleId] );
1655 * Returns the DragDrop instance for a given id
1657 * @param {String} id the id of the DragDrop object
1658 * @return {DragDrop} the drag drop object, null if it is not found
1661 getDDById: function(id) {
1662 for (var i in this.ids) {
1663 if (this.ids[i][id]) {
1664 return this.ids[i][id];
1671 * Fired after a registered DragDrop object gets the mousedown event.
1672 * Sets up the events required to track the object being dragged
1673 * @method handleMouseDown
1674 * @param {Event} e the event
1675 * @param oDD the DragDrop object being dragged
1679 handleMouseDown: function(e, oDD) {
1681 Roo.QuickTips.disable();
1683 this.currentTarget = e.getTarget();
1685 this.dragCurrent = oDD;
1687 var el = oDD.getEl();
1689 // track start position
1690 this.startX = e.getPageX();
1691 this.startY = e.getPageY();
1693 this.deltaX = this.startX - el.offsetLeft;
1694 this.deltaY = this.startY - el.offsetTop;
1696 this.dragThreshMet = false;
1698 this.clickTimeout = setTimeout(
1700 var DDM = Roo.dd.DDM;
1701 DDM.startDrag(DDM.startX, DDM.startY);
1703 this.clickTimeThresh );
1707 * Fired when either the drag pixel threshol or the mousedown hold
1708 * time threshold has been met.
1710 * @param x {int} the X position of the original mousedown
1711 * @param y {int} the Y position of the original mousedown
1714 startDrag: function(x, y) {
1715 clearTimeout(this.clickTimeout);
1716 if (this.dragCurrent) {
1717 this.dragCurrent.b4StartDrag(x, y);
1718 this.dragCurrent.startDrag(x, y);
1720 this.dragThreshMet = true;
1724 * Internal function to handle the mouseup event. Will be invoked
1725 * from the context of the document.
1726 * @method handleMouseUp
1727 * @param {Event} e the event
1731 handleMouseUp: function(e) {
1734 Roo.QuickTips.enable();
1736 if (! this.dragCurrent) {
1740 clearTimeout(this.clickTimeout);
1742 if (this.dragThreshMet) {
1743 this.fireEvents(e, true);
1753 * Utility to stop event propagation and event default, if these
1754 * features are turned on.
1756 * @param {Event} e the event as returned by this.getEvent()
1759 stopEvent: function(e){
1760 if(this.stopPropagation) {
1761 e.stopPropagation();
1764 if (this.preventDefault) {
1770 * Internal function to clean up event handlers after the drag
1771 * operation is complete
1773 * @param {Event} e the event
1777 stopDrag: function(e) {
1778 // Fire the drag end event for the item that was dragged
1779 if (this.dragCurrent) {
1780 if (this.dragThreshMet) {
1781 this.dragCurrent.b4EndDrag(e);
1782 this.dragCurrent.endDrag(e);
1785 this.dragCurrent.onMouseUp(e);
1788 this.dragCurrent = null;
1789 this.dragOvers = {};
1793 * Internal function to handle the mousemove event. Will be invoked
1794 * from the context of the html element.
1796 * @TODO figure out what we can do about mouse events lost when the
1797 * user drags objects beyond the window boundary. Currently we can
1798 * detect this in internet explorer by verifying that the mouse is
1799 * down during the mousemove event. Firefox doesn't give us the
1800 * button state on the mousemove event.
1801 * @method handleMouseMove
1802 * @param {Event} e the event
1806 handleMouseMove: function(e) {
1807 if (! this.dragCurrent) {
1811 // var button = e.which || e.button;
1813 // check for IE mouseup outside of page boundary
1814 if (Roo.isIE && (e.button !== 0 && e.button !== 1 && e.button !== 2)) {
1816 return this.handleMouseUp(e);
1819 if (!this.dragThreshMet) {
1820 var diffX = Math.abs(this.startX - e.getPageX());
1821 var diffY = Math.abs(this.startY - e.getPageY());
1822 if (diffX > this.clickPixelThresh ||
1823 diffY > this.clickPixelThresh) {
1824 this.startDrag(this.startX, this.startY);
1828 if (this.dragThreshMet) {
1829 this.dragCurrent.b4Drag(e);
1830 this.dragCurrent.onDrag(e);
1831 if(!this.dragCurrent.moveOnly){
1832 this.fireEvents(e, false);
1842 * Iterates over all of the DragDrop elements to find ones we are
1843 * hovering over or dropping on
1844 * @method fireEvents
1845 * @param {Event} e the event
1846 * @param {boolean} isDrop is this a drop op or a mouseover op?
1850 fireEvents: function(e, isDrop) {
1851 var dc = this.dragCurrent;
1853 // If the user did the mouse up outside of the window, we could
1854 // get here even though we have ended the drag.
1855 if (!dc || dc.isLocked()) {
1859 var pt = e.getPoint();
1861 // cache the previous dragOver array
1869 // Check to see if the object(s) we were hovering over is no longer
1870 // being hovered over so we can fire the onDragOut event
1871 for (var i in this.dragOvers) {
1873 var ddo = this.dragOvers[i];
1875 if (! this.isTypeOfDD(ddo)) {
1879 if (! this.isOverTarget(pt, ddo, this.mode)) {
1880 outEvts.push( ddo );
1884 delete this.dragOvers[i];
1887 for (var sGroup in dc.groups) {
1889 if ("string" != typeof sGroup) {
1893 for (i in this.ids[sGroup]) {
1894 var oDD = this.ids[sGroup][i];
1895 if (! this.isTypeOfDD(oDD)) {
1899 if (oDD.isTarget && !oDD.isLocked() && oDD != dc) {
1900 if (this.isOverTarget(pt, oDD, this.mode)) {
1901 // look for drop interactions
1903 dropEvts.push( oDD );
1904 // look for drag enter and drag over interactions
1907 // initial drag over: dragEnter fires
1908 if (!oldOvers[oDD.id]) {
1909 enterEvts.push( oDD );
1910 // subsequent drag overs: dragOver fires
1912 overEvts.push( oDD );
1915 this.dragOvers[oDD.id] = oDD;
1923 if (outEvts.length) {
1924 dc.b4DragOut(e, outEvts);
1925 dc.onDragOut(e, outEvts);
1928 if (enterEvts.length) {
1929 dc.onDragEnter(e, enterEvts);
1932 if (overEvts.length) {
1933 dc.b4DragOver(e, overEvts);
1934 dc.onDragOver(e, overEvts);
1937 if (dropEvts.length) {
1938 dc.b4DragDrop(e, dropEvts);
1939 dc.onDragDrop(e, dropEvts);
1943 // fire dragout events
1945 for (i=0, len=outEvts.length; i<len; ++i) {
1946 dc.b4DragOut(e, outEvts[i].id);
1947 dc.onDragOut(e, outEvts[i].id);
1950 // fire enter events
1951 for (i=0,len=enterEvts.length; i<len; ++i) {
1952 // dc.b4DragEnter(e, oDD.id);
1953 dc.onDragEnter(e, enterEvts[i].id);
1957 for (i=0,len=overEvts.length; i<len; ++i) {
1958 dc.b4DragOver(e, overEvts[i].id);
1959 dc.onDragOver(e, overEvts[i].id);
1963 for (i=0, len=dropEvts.length; i<len; ++i) {
1964 dc.b4DragDrop(e, dropEvts[i].id);
1965 dc.onDragDrop(e, dropEvts[i].id);
1970 // notify about a drop that did not find a target
1971 if (isDrop && !dropEvts.length) {
1972 dc.onInvalidDrop(e);
1978 * Helper function for getting the best match from the list of drag
1979 * and drop objects returned by the drag and drop events when we are
1980 * in INTERSECT mode. It returns either the first object that the
1981 * cursor is over, or the object that has the greatest overlap with
1982 * the dragged element.
1983 * @method getBestMatch
1984 * @param {DragDrop[]} dds The array of drag and drop objects
1986 * @return {DragDrop} The best single match
1989 getBestMatch: function(dds) {
1991 // Return null if the input is not what we expect
1992 //if (!dds || !dds.length || dds.length == 0) {
1994 // If there is only one item, it wins
1995 //} else if (dds.length == 1) {
1997 var len = dds.length;
2002 // Loop through the targeted items
2003 for (var i=0; i<len; ++i) {
2005 // If the cursor is over the object, it wins. If the
2006 // cursor is over multiple matches, the first one we come
2008 if (dd.cursorIsOver) {
2011 // Otherwise the object with the most overlap wins
2014 winner.overlap.getArea() < dd.overlap.getArea()) {
2025 * Refreshes the cache of the top-left and bottom-right points of the
2026 * drag and drop objects in the specified group(s). This is in the
2027 * format that is stored in the drag and drop instance, so typical
2030 * Roo.dd.DragDropMgr.refreshCache(ddinstance.groups);
2034 * Roo.dd.DragDropMgr.refreshCache({group1:true, group2:true});
2036 * @TODO this really should be an indexed array. Alternatively this
2037 * method could accept both.
2038 * @method refreshCache
2039 * @param {Object} groups an associative array of groups to refresh
2042 refreshCache: function(groups) {
2043 for (var sGroup in groups) {
2044 if ("string" != typeof sGroup) {
2047 for (var i in this.ids[sGroup]) {
2048 var oDD = this.ids[sGroup][i];
2050 if (this.isTypeOfDD(oDD)) {
2051 // if (this.isTypeOfDD(oDD) && oDD.isTarget) {
2052 var loc = this.getLocation(oDD);
2054 this.locationCache[oDD.id] = loc;
2056 delete this.locationCache[oDD.id];
2057 // this will unregister the drag and drop object if
2058 // the element is not in a usable state
2067 * This checks to make sure an element exists and is in the DOM. The
2068 * main purpose is to handle cases where innerHTML is used to remove
2069 * drag and drop objects from the DOM. IE provides an 'unspecified
2070 * error' when trying to access the offsetParent of such an element
2072 * @param {HTMLElement} el the element to check
2073 * @return {boolean} true if the element looks usable
2076 verifyEl: function(el) {
2081 parent = el.offsetParent;
2084 parent = el.offsetParent;
2095 * Returns a Region object containing the drag and drop element's position
2096 * and size, including the padding configured for it
2097 * @method getLocation
2098 * @param {DragDrop} oDD the drag and drop object to get the
2100 * @return {Roo.lib.Region} a Region object representing the total area
2101 * the element occupies, including any padding
2102 * the instance is configured for.
2105 getLocation: function(oDD) {
2106 if (! this.isTypeOfDD(oDD)) {
2110 var el = oDD.getEl(), pos, x1, x2, y1, y2, t, r, b, l;
2113 pos= Roo.lib.Dom.getXY(el);
2121 x2 = x1 + el.offsetWidth;
2123 y2 = y1 + el.offsetHeight;
2125 t = y1 - oDD.padding[0];
2126 r = x2 + oDD.padding[1];
2127 b = y2 + oDD.padding[2];
2128 l = x1 - oDD.padding[3];
2130 return new Roo.lib.Region( t, r, b, l );
2134 * Checks the cursor location to see if it over the target
2135 * @method isOverTarget
2136 * @param {Roo.lib.Point} pt The point to evaluate
2137 * @param {DragDrop} oTarget the DragDrop object we are inspecting
2138 * @return {boolean} true if the mouse is over the target
2142 isOverTarget: function(pt, oTarget, intersect) {
2143 // use cache if available
2144 var loc = this.locationCache[oTarget.id];
2145 if (!loc || !this.useCache) {
2146 loc = this.getLocation(oTarget);
2147 this.locationCache[oTarget.id] = loc;
2155 oTarget.cursorIsOver = loc.contains( pt );
2157 // DragDrop is using this as a sanity check for the initial mousedown
2158 // in this case we are done. In POINT mode, if the drag obj has no
2159 // contraints, we are also done. Otherwise we need to evaluate the
2160 // location of the target as related to the actual location of the
2162 var dc = this.dragCurrent;
2163 if (!dc || !dc.getTargetCoord ||
2164 (!intersect && !dc.constrainX && !dc.constrainY)) {
2165 return oTarget.cursorIsOver;
2168 oTarget.overlap = null;
2170 // Get the current location of the drag element, this is the
2171 // location of the mouse event less the delta that represents
2172 // where the original mousedown happened on the element. We
2173 // need to consider constraints and ticks as well.
2174 var pos = dc.getTargetCoord(pt.x, pt.y);
2176 var el = dc.getDragEl();
2177 var curRegion = new Roo.lib.Region( pos.y,
2178 pos.x + el.offsetWidth,
2179 pos.y + el.offsetHeight,
2182 var overlap = curRegion.intersect(loc);
2185 oTarget.overlap = overlap;
2186 return (intersect) ? true : oTarget.cursorIsOver;
2193 * unload event handler
2198 _onUnload: function(e, me) {
2199 Roo.dd.DragDropMgr.unregAll();
2203 * Cleans up the drag and drop events and objects.
2208 unregAll: function() {
2210 if (this.dragCurrent) {
2212 this.dragCurrent = null;
2215 this._execOnAll("unreg", []);
2217 for (i in this.elementCache) {
2218 delete this.elementCache[i];
2221 this.elementCache = {};
2226 * A cache of DOM elements
2227 * @property elementCache
2234 * Get the wrapper for the DOM element specified
2235 * @method getElWrapper
2236 * @param {String} id the id of the element to get
2237 * @return {Roo.dd.DDM.ElementWrapper} the wrapped element
2239 * @deprecated This wrapper isn't that useful
2242 getElWrapper: function(id) {
2243 var oWrapper = this.elementCache[id];
2244 if (!oWrapper || !oWrapper.el) {
2245 oWrapper = this.elementCache[id] =
2246 new this.ElementWrapper(Roo.getDom(id));
2252 * Returns the actual DOM element
2253 * @method getElement
2254 * @param {String} id the id of the elment to get
2255 * @return {Object} The element
2256 * @deprecated use Roo.getDom instead
2259 getElement: function(id) {
2260 return Roo.getDom(id);
2264 * Returns the style property for the DOM element (i.e.,
2265 * document.getElById(id).style)
2267 * @param {String} id the id of the elment to get
2268 * @return {Object} The style property of the element
2269 * @deprecated use Roo.getDom instead
2272 getCss: function(id) {
2273 var el = Roo.getDom(id);
2274 return (el) ? el.style : null;
2278 * Inner class for cached elements
2279 * @class DragDropMgr.ElementWrapper
2284 ElementWrapper: function(el) {
2289 this.el = el || null;
2294 this.id = this.el && el.id;
2296 * A reference to the style property
2299 this.css = this.el && el.style;
2303 * Returns the X position of an html element
2305 * @param el the element for which to get the position
2306 * @return {int} the X coordinate
2308 * @deprecated use Roo.lib.Dom.getX instead
2311 getPosX: function(el) {
2312 return Roo.lib.Dom.getX(el);
2316 * Returns the Y position of an html element
2318 * @param el the element for which to get the position
2319 * @return {int} the Y coordinate
2320 * @deprecated use Roo.lib.Dom.getY instead
2323 getPosY: function(el) {
2324 return Roo.lib.Dom.getY(el);
2328 * Swap two nodes. In IE, we use the native method, for others we
2329 * emulate the IE behavior
2331 * @param n1 the first node to swap
2332 * @param n2 the other node to swap
2335 swapNode: function(n1, n2) {
2339 var p = n2.parentNode;
2340 var s = n2.nextSibling;
2343 p.insertBefore(n1, n2);
2344 } else if (n2 == n1.nextSibling) {
2345 p.insertBefore(n2, n1);
2347 n1.parentNode.replaceChild(n2, n1);
2348 p.insertBefore(n1, s);
2354 * Returns the current scroll position
2359 getScroll: function () {
2360 var t, l, dde=document.documentElement, db=document.body;
2361 if (dde && (dde.scrollTop || dde.scrollLeft)) {
2370 return { top: t, left: l };
2374 * Returns the specified element style property
2376 * @param {HTMLElement} el the element
2377 * @param {string} styleProp the style property
2378 * @return {string} The value of the style property
2379 * @deprecated use Roo.lib.Dom.getStyle
2382 getStyle: function(el, styleProp) {
2383 return Roo.fly(el).getStyle(styleProp);
2387 * Gets the scrollTop
2388 * @method getScrollTop
2389 * @return {int} the document's scrollTop
2392 getScrollTop: function () { return this.getScroll().top; },
2395 * Gets the scrollLeft
2396 * @method getScrollLeft
2397 * @return {int} the document's scrollTop
2400 getScrollLeft: function () { return this.getScroll().left; },
2403 * Sets the x/y position of an element to the location of the
2406 * @param {HTMLElement} moveEl The element to move
2407 * @param {HTMLElement} targetEl The position reference element
2410 moveToEl: function (moveEl, targetEl) {
2411 var aCoord = Roo.lib.Dom.getXY(targetEl);
2412 Roo.lib.Dom.setXY(moveEl, aCoord);
2416 * Numeric array sort function
2417 * @method numericSort
2420 numericSort: function(a, b) { return (a - b); },
2424 * @property _timeoutCount
2431 * Trying to make the load order less important. Without this we get
2432 * an error if this file is loaded before the Event Utility.
2433 * @method _addListeners
2437 _addListeners: function() {
2438 var DDM = Roo.dd.DDM;
2439 if ( Roo.lib.Event && document ) {
2442 if (DDM._timeoutCount > 2000) {
2444 setTimeout(DDM._addListeners, 10);
2445 if (document && document.body) {
2446 DDM._timeoutCount += 1;
2453 * Recursively searches the immediate parent and all child nodes for
2454 * the handle element in order to determine wheter or not it was
2456 * @method handleWasClicked
2457 * @param node the html element to inspect
2460 handleWasClicked: function(node, id) {
2461 if (this.isHandle(id, node.id)) {
2464 // check to see if this is a text node child of the one we want
2465 var p = node.parentNode;
2468 if (this.isHandle(id, p.id)) {
2483 // shorter alias, save a few bytes
2484 Roo.dd.DDM = Roo.dd.DragDropMgr;
2485 Roo.dd.DDM._addListeners();
2489 * Ext JS Library 1.1.1
2490 * Copyright(c) 2006-2007, Ext JS, LLC.
2492 * Originally Released Under LGPL - original licence link has changed is not relivant.
2495 * <script type="text/javascript">
2500 * A DragDrop implementation where the linked element follows the
2501 * mouse cursor during a drag.
2502 * @extends Roo.dd.DragDrop
2504 * @param {String} id the id of the linked element
2505 * @param {String} sGroup the group of related DragDrop items
2506 * @param {object} config an object containing configurable attributes
2507 * Valid properties for DD:
2510 Roo.dd.DD = function(id, sGroup, config) {
2512 this.init(id, sGroup, config);
2516 Roo.extend(Roo.dd.DD, Roo.dd.DragDrop, {
2519 * When set to true, the utility automatically tries to scroll the browser
2520 * window wehn a drag and drop element is dragged near the viewport boundary.
2528 * Sets the pointer offset to the distance between the linked element's top
2529 * left corner and the location the element was clicked
2530 * @method autoOffset
2531 * @param {int} iPageX the X coordinate of the click
2532 * @param {int} iPageY the Y coordinate of the click
2534 autoOffset: function(iPageX, iPageY) {
2535 var x = iPageX - this.startPageX;
2536 var y = iPageY - this.startPageY;
2537 this.setDelta(x, y);
2541 * Sets the pointer offset. You can call this directly to force the
2542 * offset to be in a particular location (e.g., pass in 0,0 to set it
2543 * to the center of the object)
2545 * @param {int} iDeltaX the distance from the left
2546 * @param {int} iDeltaY the distance from the top
2548 setDelta: function(iDeltaX, iDeltaY) {
2549 this.deltaX = iDeltaX;
2550 this.deltaY = iDeltaY;
2554 * Sets the drag element to the location of the mousedown or click event,
2555 * maintaining the cursor location relative to the location on the element
2556 * that was clicked. Override this if you want to place the element in a
2557 * location other than where the cursor is.
2558 * @method setDragElPos
2559 * @param {int} iPageX the X coordinate of the mousedown or drag event
2560 * @param {int} iPageY the Y coordinate of the mousedown or drag event
2562 setDragElPos: function(iPageX, iPageY) {
2563 // the first time we do this, we are going to check to make sure
2564 // the element has css positioning
2566 var el = this.getDragEl();
2567 this.alignElWithMouse(el, iPageX, iPageY);
2571 * Sets the element to the location of the mousedown or click event,
2572 * maintaining the cursor location relative to the location on the element
2573 * that was clicked. Override this if you want to place the element in a
2574 * location other than where the cursor is.
2575 * @method alignElWithMouse
2576 * @param {HTMLElement} el the element to move
2577 * @param {int} iPageX the X coordinate of the mousedown or drag event
2578 * @param {int} iPageY the Y coordinate of the mousedown or drag event
2580 alignElWithMouse: function(el, iPageX, iPageY) {
2581 var oCoord = this.getTargetCoord(iPageX, iPageY);
2582 var fly = el.dom ? el : Roo.fly(el);
2583 if (!this.deltaSetXY) {
2584 var aCoord = [oCoord.x, oCoord.y];
2586 var newLeft = fly.getLeft(true);
2587 var newTop = fly.getTop(true);
2588 this.deltaSetXY = [ newLeft - oCoord.x, newTop - oCoord.y ];
2590 fly.setLeftTop(oCoord.x + this.deltaSetXY[0], oCoord.y + this.deltaSetXY[1]);
2593 this.cachePosition(oCoord.x, oCoord.y);
2594 this.autoScroll(oCoord.x, oCoord.y, el.offsetHeight, el.offsetWidth);
2599 * Saves the most recent position so that we can reset the constraints and
2600 * tick marks on-demand. We need to know this so that we can calculate the
2601 * number of pixels the element is offset from its original position.
2602 * @method cachePosition
2603 * @param iPageX the current x position (optional, this just makes it so we
2604 * don't have to look it up again)
2605 * @param iPageY the current y position (optional, this just makes it so we
2606 * don't have to look it up again)
2608 cachePosition: function(iPageX, iPageY) {
2610 this.lastPageX = iPageX;
2611 this.lastPageY = iPageY;
2613 var aCoord = Roo.lib.Dom.getXY(this.getEl());
2614 this.lastPageX = aCoord[0];
2615 this.lastPageY = aCoord[1];
2620 * Auto-scroll the window if the dragged object has been moved beyond the
2621 * visible window boundary.
2622 * @method autoScroll
2623 * @param {int} x the drag element's x position
2624 * @param {int} y the drag element's y position
2625 * @param {int} h the height of the drag element
2626 * @param {int} w the width of the drag element
2629 autoScroll: function(x, y, h, w) {
2632 // The client height
2633 var clientH = Roo.lib.Dom.getViewWidth();
2636 var clientW = Roo.lib.Dom.getViewHeight();
2638 // The amt scrolled down
2639 var st = this.DDM.getScrollTop();
2641 // The amt scrolled right
2642 var sl = this.DDM.getScrollLeft();
2644 // Location of the bottom of the element
2647 // Location of the right of the element
2650 // The distance from the cursor to the bottom of the visible area,
2651 // adjusted so that we don't scroll if the cursor is beyond the
2652 // element drag constraints
2653 var toBot = (clientH + st - y - this.deltaY);
2655 // The distance from the cursor to the right of the visible area
2656 var toRight = (clientW + sl - x - this.deltaX);
2659 // How close to the edge the cursor must be before we scroll
2660 // var thresh = (document.all) ? 100 : 40;
2663 // How many pixels to scroll per autoscroll op. This helps to reduce
2664 // clunky scrolling. IE is more sensitive about this ... it needs this
2665 // value to be higher.
2666 var scrAmt = (document.all) ? 80 : 30;
2668 // Scroll down if we are near the bottom of the visible page and the
2669 // obj extends below the crease
2670 if ( bot > clientH && toBot < thresh ) {
2671 window.scrollTo(sl, st + scrAmt);
2674 // Scroll up if the window is scrolled down and the top of the object
2675 // goes above the top border
2676 if ( y < st && st > 0 && y - st < thresh ) {
2677 window.scrollTo(sl, st - scrAmt);
2680 // Scroll right if the obj is beyond the right border and the cursor is
2682 if ( right > clientW && toRight < thresh ) {
2683 window.scrollTo(sl + scrAmt, st);
2686 // Scroll left if the window has been scrolled to the right and the obj
2687 // extends past the left border
2688 if ( x < sl && sl > 0 && x - sl < thresh ) {
2689 window.scrollTo(sl - scrAmt, st);
2695 * Finds the location the element should be placed if we want to move
2696 * it to where the mouse location less the click offset would place us.
2697 * @method getTargetCoord
2698 * @param {int} iPageX the X coordinate of the click
2699 * @param {int} iPageY the Y coordinate of the click
2700 * @return an object that contains the coordinates (Object.x and Object.y)
2703 getTargetCoord: function(iPageX, iPageY) {
2706 var x = iPageX - this.deltaX;
2707 var y = iPageY - this.deltaY;
2709 if (this.constrainX) {
2710 if (x < this.minX) { x = this.minX; }
2711 if (x > this.maxX) { x = this.maxX; }
2714 if (this.constrainY) {
2715 if (y < this.minY) { y = this.minY; }
2716 if (y > this.maxY) { y = this.maxY; }
2719 x = this.getTick(x, this.xTicks);
2720 y = this.getTick(y, this.yTicks);
2727 * Sets up config options specific to this class. Overrides
2728 * Roo.dd.DragDrop, but all versions of this method through the
2729 * inheritance chain are called
2731 applyConfig: function() {
2732 Roo.dd.DD.superclass.applyConfig.call(this);
2733 this.scroll = (this.config.scroll !== false);
2737 * Event that fires prior to the onMouseDown event. Overrides
2740 b4MouseDown: function(e) {
2741 // this.resetConstraints();
2742 this.autoOffset(e.getPageX(),
2747 * Event that fires prior to the onDrag event. Overrides
2750 b4Drag: function(e) {
2751 this.setDragElPos(e.getPageX(),
2755 toString: function() {
2756 return ("DD " + this.id);
2759 //////////////////////////////////////////////////////////////////////////
2760 // Debugging ygDragDrop events that can be overridden
2761 //////////////////////////////////////////////////////////////////////////
2763 startDrag: function(x, y) {
2766 onDrag: function(e) {
2769 onDragEnter: function(e, id) {
2772 onDragOver: function(e, id) {
2775 onDragOut: function(e, id) {
2778 onDragDrop: function(e, id) {
2781 endDrag: function(e) {
2788 * Ext JS Library 1.1.1
2789 * Copyright(c) 2006-2007, Ext JS, LLC.
2791 * Originally Released Under LGPL - original licence link has changed is not relivant.
2794 * <script type="text/javascript">
2798 * @class Roo.dd.DDProxy
2799 * A DragDrop implementation that inserts an empty, bordered div into
2800 * the document that follows the cursor during drag operations. At the time of
2801 * the click, the frame div is resized to the dimensions of the linked html
2802 * element, and moved to the exact location of the linked element.
2804 * References to the "frame" element refer to the single proxy element that
2805 * was created to be dragged in place of all DDProxy elements on the
2808 * @extends Roo.dd.DD
2810 * @param {String} id the id of the linked html element
2811 * @param {String} sGroup the group of related DragDrop objects
2812 * @param {object} config an object containing configurable attributes
2813 * Valid properties for DDProxy in addition to those in DragDrop:
2814 * resizeFrame, centerFrame, dragElId
2816 Roo.dd.DDProxy = function(id, sGroup, config) {
2818 this.init(id, sGroup, config);
2824 * The default drag frame div id
2825 * @property Roo.dd.DDProxy.dragElId
2829 Roo.dd.DDProxy.dragElId = "ygddfdiv";
2831 Roo.extend(Roo.dd.DDProxy, Roo.dd.DD, {
2834 * By default we resize the drag frame to be the same size as the element
2835 * we want to drag (this is to get the frame effect). We can turn it off
2836 * if we want a different behavior.
2837 * @property resizeFrame
2843 * By default the frame is positioned exactly where the drag element is, so
2844 * we use the cursor offset provided by Roo.dd.DD. Another option that works only if
2845 * you do not have constraints on the obj is to have the drag frame centered
2846 * around the cursor. Set centerFrame to true for this effect.
2847 * @property centerFrame
2853 * Creates the proxy element if it does not yet exist
2854 * @method createFrame
2856 createFrame: function() {
2858 var body = document.body;
2860 if (!body || !body.firstChild) {
2861 setTimeout( function() { self.createFrame(); }, 50 );
2865 var div = this.getDragEl();
2868 div = document.createElement("div");
2869 div.id = this.dragElId;
2872 s.position = "absolute";
2873 s.visibility = "hidden";
2875 s.border = "2px solid #aaa";
2878 // appendChild can blow up IE if invoked prior to the window load event
2879 // while rendering a table. It is possible there are other scenarios
2880 // that would cause this to happen as well.
2881 body.insertBefore(div, body.firstChild);
2886 * Initialization for the drag frame element. Must be called in the
2887 * constructor of all subclasses
2890 initFrame: function() {
2894 applyConfig: function() {
2895 Roo.dd.DDProxy.superclass.applyConfig.call(this);
2897 this.resizeFrame = (this.config.resizeFrame !== false);
2898 this.centerFrame = (this.config.centerFrame);
2899 this.setDragElId(this.config.dragElId || Roo.dd.DDProxy.dragElId);
2903 * Resizes the drag frame to the dimensions of the clicked object, positions
2904 * it over the object, and finally displays it
2906 * @param {int} iPageX X click position
2907 * @param {int} iPageY Y click position
2910 showFrame: function(iPageX, iPageY) {
2911 var el = this.getEl();
2912 var dragEl = this.getDragEl();
2913 var s = dragEl.style;
2915 this._resizeProxy();
2917 if (this.centerFrame) {
2918 this.setDelta( Math.round(parseInt(s.width, 10)/2),
2919 Math.round(parseInt(s.height, 10)/2) );
2922 this.setDragElPos(iPageX, iPageY);
2924 Roo.fly(dragEl).show();
2928 * The proxy is automatically resized to the dimensions of the linked
2929 * element when a drag is initiated, unless resizeFrame is set to false
2930 * @method _resizeProxy
2933 _resizeProxy: function() {
2934 if (this.resizeFrame) {
2935 var el = this.getEl();
2936 Roo.fly(this.getDragEl()).setSize(el.offsetWidth, el.offsetHeight);
2940 // overrides Roo.dd.DragDrop
2941 b4MouseDown: function(e) {
2942 var x = e.getPageX();
2943 var y = e.getPageY();
2944 this.autoOffset(x, y);
2945 this.setDragElPos(x, y);
2948 // overrides Roo.dd.DragDrop
2949 b4StartDrag: function(x, y) {
2950 // show the drag frame
2951 this.showFrame(x, y);
2954 // overrides Roo.dd.DragDrop
2955 b4EndDrag: function(e) {
2956 Roo.fly(this.getDragEl()).hide();
2959 // overrides Roo.dd.DragDrop
2960 // By default we try to move the element to the last location of the frame.
2961 // This is so that the default behavior mirrors that of Roo.dd.DD.
2962 endDrag: function(e) {
2964 var lel = this.getEl();
2965 var del = this.getDragEl();
2967 // Show the drag frame briefly so we can get its position
2968 del.style.visibility = "";
2971 // Hide the linked element before the move to get around a Safari
2973 lel.style.visibility = "hidden";
2974 Roo.dd.DDM.moveToEl(lel, del);
2975 del.style.visibility = "hidden";
2976 lel.style.visibility = "";
2981 beforeMove : function(){
2985 afterDrag : function(){
2989 toString: function() {
2990 return ("DDProxy " + this.id);
2996 * Ext JS Library 1.1.1
2997 * Copyright(c) 2006-2007, Ext JS, LLC.
2999 * Originally Released Under LGPL - original licence link has changed is not relivant.
3002 * <script type="text/javascript">
3006 * @class Roo.dd.DDTarget
3007 * A DragDrop implementation that does not move, but can be a drop
3008 * target. You would get the same result by simply omitting implementation
3009 * for the event callbacks, but this way we reduce the processing cost of the
3010 * event listener and the callbacks.
3011 * @extends Roo.dd.DragDrop
3013 * @param {String} id the id of the element that is a drop target
3014 * @param {String} sGroup the group of related DragDrop objects
3015 * @param {object} config an object containing configurable attributes
3016 * Valid properties for DDTarget in addition to those in
3020 Roo.dd.DDTarget = function(id, sGroup, config) {
3022 this.initTarget(id, sGroup, config);
3024 if (config.listeners || config.events) {
3025 Roo.dd.DragDrop.superclass.constructor.call(this, {
3026 listeners : config.listeners || {},
3027 events : config.events || {}
3032 // Roo.dd.DDTarget.prototype = new Roo.dd.DragDrop();
3033 Roo.extend(Roo.dd.DDTarget, Roo.dd.DragDrop, {
3034 toString: function() {
3035 return ("DDTarget " + this.id);
3040 * Ext JS Library 1.1.1
3041 * Copyright(c) 2006-2007, Ext JS, LLC.
3043 * Originally Released Under LGPL - original licence link has changed is not relivant.
3046 * <script type="text/javascript">
3051 * @class Roo.dd.ScrollManager
3052 * Provides automatic scrolling of overflow regions in the page during drag operations.<br><br>
3053 * <b>Note: This class uses "Point Mode" and is untested in "Intersect Mode".</b>
3056 Roo.dd.ScrollManager = function(){
3057 var ddm = Roo.dd.DragDropMgr;
3064 var onStop = function(e){
3069 var triggerRefresh = function(){
3070 if(ddm.dragCurrent){
3071 ddm.refreshCache(ddm.dragCurrent.groups);
3075 var doScroll = function(){
3076 if(ddm.dragCurrent){
3077 var dds = Roo.dd.ScrollManager;
3079 if(proc.el.scroll(proc.dir, dds.increment)){
3083 proc.el.scroll(proc.dir, dds.increment, true, dds.animDuration, triggerRefresh);
3088 var clearProc = function(){
3090 clearInterval(proc.id);
3097 var startProc = function(el, dir){
3098 Roo.log('scroll startproc');
3102 proc.id = setInterval(doScroll, Roo.dd.ScrollManager.frequency);
3105 var onFire = function(e, isDrop){
3107 if(isDrop || !ddm.dragCurrent){ return; }
3108 var dds = Roo.dd.ScrollManager;
3109 if(!dragEl || dragEl != ddm.dragCurrent){
3110 dragEl = ddm.dragCurrent;
3111 // refresh regions on drag start
3115 var xy = Roo.lib.Event.getXY(e);
3116 var pt = new Roo.lib.Point(xy[0], xy[1]);
3118 var el = els[id], r = el._region;
3119 if(r && r.contains(pt) && el.isScrollable()){
3120 if(r.bottom - pt.y <= dds.thresh){
3122 startProc(el, "down");
3125 }else if(r.right - pt.x <= dds.thresh){
3127 startProc(el, "left");
3130 }else if(pt.y - r.top <= dds.thresh){
3132 startProc(el, "up");
3135 }else if(pt.x - r.left <= dds.thresh){
3137 startProc(el, "right");
3146 ddm.fireEvents = ddm.fireEvents.createSequence(onFire, ddm);
3147 ddm.stopDrag = ddm.stopDrag.createSequence(onStop, ddm);
3151 * Registers new overflow element(s) to auto scroll
3152 * @param {String/HTMLElement/Element/Array} el The id of or the element to be scrolled or an array of either
3154 register : function(el){
3155 if(el instanceof Array){
3156 for(var i = 0, len = el.length; i < len; i++) {
3157 this.register(el[i]);
3163 Roo.dd.ScrollManager.els = els;
3167 * Unregisters overflow element(s) so they are no longer scrolled
3168 * @param {String/HTMLElement/Element/Array} el The id of or the element to be removed or an array of either
3170 unregister : function(el){
3171 if(el instanceof Array){
3172 for(var i = 0, len = el.length; i < len; i++) {
3173 this.unregister(el[i]);
3182 * The number of pixels from the edge of a container the pointer needs to be to
3183 * trigger scrolling (defaults to 25)
3189 * The number of pixels to scroll in each scroll increment (defaults to 50)
3195 * The frequency of scrolls in milliseconds (defaults to 500)
3201 * True to animate the scroll (defaults to true)
3207 * The animation duration in seconds -
3208 * MUST BE less than Roo.dd.ScrollManager.frequency! (defaults to .4)
3214 * Manually trigger a cache refresh.
3216 refreshCache : function(){
3218 if(typeof els[id] == 'object'){ // for people extending the object prototype
3219 els[id]._region = els[id].getRegion();
3226 * Ext JS Library 1.1.1
3227 * Copyright(c) 2006-2007, Ext JS, LLC.
3229 * Originally Released Under LGPL - original licence link has changed is not relivant.
3232 * <script type="text/javascript">
3237 * @class Roo.dd.Registry
3238 * Provides easy access to all drag drop components that are registered on a page. Items can be retrieved either
3239 * directly by DOM node id, or by passing in the drag drop event that occurred and looking up the event target.
3242 Roo.dd.Registry = function(){
3247 var getId = function(el, autogen){
3248 if(typeof el == "string"){
3252 if(!id && autogen !== false){
3253 id = "roodd-" + (++autoIdSeed);
3261 * Register a drag drop element
3262 * @param {String|HTMLElement} element The id or DOM node to register
3263 * @param {Object} data (optional) A custom data object that will be passed between the elements that are involved
3264 * in drag drop operations. You can populate this object with any arbitrary properties that your own code
3265 * knows how to interpret, plus there are some specific properties known to the Registry that should be
3266 * populated in the data object (if applicable):
3268 Value Description<br />
3269 --------- ------------------------------------------<br />
3270 handles Array of DOM nodes that trigger dragging<br />
3271 for the element being registered<br />
3272 isHandle True if the element passed in triggers<br />
3273 dragging itself, else false
3276 register : function(el, data){
3278 if(typeof el == "string"){
3279 el = document.getElementById(el);
3282 elements[getId(el)] = data;
3283 if(data.isHandle !== false){
3284 handles[data.ddel.id] = data;
3287 var hs = data.handles;
3288 for(var i = 0, len = hs.length; i < len; i++){
3289 handles[getId(hs[i])] = data;
3295 * Unregister a drag drop element
3296 * @param {String|HTMLElement} element The id or DOM node to unregister
3298 unregister : function(el){
3299 var id = getId(el, false);
3300 var data = elements[id];
3302 delete elements[id];
3304 var hs = data.handles;
3305 for(var i = 0, len = hs.length; i < len; i++){
3306 delete handles[getId(hs[i], false)];
3313 * Returns the handle registered for a DOM Node by id
3314 * @param {String|HTMLElement} id The DOM node or id to look up
3315 * @return {Object} handle The custom handle data
3317 getHandle : function(id){
3318 if(typeof id != "string"){ // must be element?
3325 * Returns the handle that is registered for the DOM node that is the target of the event
3326 * @param {Event} e The event
3327 * @return {Object} handle The custom handle data
3329 getHandleFromEvent : function(e){
3330 var t = Roo.lib.Event.getTarget(e);
3331 return t ? handles[t.id] : null;
3335 * Returns a custom data object that is registered for a DOM node by id
3336 * @param {String|HTMLElement} id The DOM node or id to look up
3337 * @return {Object} data The custom data
3339 getTarget : function(id){
3340 if(typeof id != "string"){ // must be element?
3343 return elements[id];
3347 * Returns a custom data object that is registered for the DOM node that is the target of the event
3348 * @param {Event} e The event
3349 * @return {Object} data The custom data
3351 getTargetFromEvent : function(e){
3352 var t = Roo.lib.Event.getTarget(e);
3353 return t ? elements[t.id] || handles[t.id] : null;
3358 * Ext JS Library 1.1.1
3359 * Copyright(c) 2006-2007, Ext JS, LLC.
3361 * Originally Released Under LGPL - original licence link has changed is not relivant.
3364 * <script type="text/javascript">
3369 * @class Roo.dd.StatusProxy
3370 * A specialized drag proxy that supports a drop status icon, {@link Roo.Layer} styles and auto-repair. This is the
3371 * default drag proxy used by all Roo.dd components.
3373 * @param {Object} config
3375 Roo.dd.StatusProxy = function(config){
3376 Roo.apply(this, config);
3377 this.id = this.id || Roo.id();
3378 this.el = new Roo.Layer({
3380 id: this.id, tag: "div", cls: "x-dd-drag-proxy "+this.dropNotAllowed, children: [
3381 {tag: "div", cls: "x-dd-drop-icon"},
3382 {tag: "div", cls: "x-dd-drag-ghost"}
3385 shadow: !config || config.shadow !== false
3387 this.ghost = Roo.get(this.el.dom.childNodes[1]);
3388 this.dropStatus = this.dropNotAllowed;
3391 Roo.dd.StatusProxy.prototype = {
3393 * @cfg {String} dropAllowed
3394 * The CSS class to apply to the status element when drop is allowed (defaults to "x-dd-drop-ok").
3396 dropAllowed : "x-dd-drop-ok",
3398 * @cfg {String} dropNotAllowed
3399 * The CSS class to apply to the status element when drop is not allowed (defaults to "x-dd-drop-nodrop").
3401 dropNotAllowed : "x-dd-drop-nodrop",
3404 * Updates the proxy's visual element to indicate the status of whether or not drop is allowed
3405 * over the current target element.
3406 * @param {String} cssClass The css class for the new drop status indicator image
3408 setStatus : function(cssClass){
3409 cssClass = cssClass || this.dropNotAllowed;
3410 if(this.dropStatus != cssClass){
3411 this.el.replaceClass(this.dropStatus, cssClass);
3412 this.dropStatus = cssClass;
3417 * Resets the status indicator to the default dropNotAllowed value
3418 * @param {Boolean} clearGhost True to also remove all content from the ghost, false to preserve it
3420 reset : function(clearGhost){
3421 this.el.dom.className = "x-dd-drag-proxy " + this.dropNotAllowed;
3422 this.dropStatus = this.dropNotAllowed;
3424 this.ghost.update("");
3429 * Updates the contents of the ghost element
3430 * @param {String} html The html that will replace the current innerHTML of the ghost element
3432 update : function(html){
3433 if(typeof html == "string"){
3434 this.ghost.update(html);
3436 this.ghost.update("");
3437 html.style.margin = "0";
3438 this.ghost.dom.appendChild(html);
3440 // ensure float = none set?? cant remember why though.
3441 var el = this.ghost.dom.firstChild;
3443 Roo.fly(el).setStyle('float', 'none');
3448 * Returns the underlying proxy {@link Roo.Layer}
3449 * @return {Roo.Layer} el
3456 * Returns the ghost element
3457 * @return {Roo.Element} el
3459 getGhost : function(){
3465 * @param {Boolean} clear True to reset the status and clear the ghost contents, false to preserve them
3467 hide : function(clear){
3475 * Stops the repair animation if it's currently running
3478 if(this.anim && this.anim.isAnimated && this.anim.isAnimated()){
3484 * Displays this proxy
3491 * Force the Layer to sync its shadow and shim positions to the element
3498 * Causes the proxy to return to its position of origin via an animation. Should be called after an
3499 * invalid drop operation by the item being dragged.
3500 * @param {Array} xy The XY position of the element ([x, y])
3501 * @param {Function} callback The function to call after the repair is complete
3502 * @param {Object} scope The scope in which to execute the callback
3504 repair : function(xy, callback, scope){
3505 this.callback = callback;
3507 if(xy && this.animRepair !== false){
3508 this.el.addClass("x-dd-drag-repair");
3509 this.el.hideUnders(true);
3510 this.anim = this.el.shift({
3511 duration: this.repairDuration || .5,
3515 callback: this.afterRepair,
3524 afterRepair : function(){
3526 if(typeof this.callback == "function"){
3527 this.callback.call(this.scope || this);
3529 this.callback = null;
3534 * Ext JS Library 1.1.1
3535 * Copyright(c) 2006-2007, Ext JS, LLC.
3537 * Originally Released Under LGPL - original licence link has changed is not relivant.
3540 * <script type="text/javascript">
3544 * @class Roo.dd.DragSource
3545 * @extends Roo.dd.DDProxy
3546 * A simple class that provides the basic implementation needed to make any element draggable.
3548 * @param {String/HTMLElement/Element} el The container element
3549 * @param {Object} config
3551 Roo.dd.DragSource = function(el, config){
3552 this.el = Roo.get(el);
3555 Roo.apply(this, config);
3558 this.proxy = new Roo.dd.StatusProxy();
3561 Roo.dd.DragSource.superclass.constructor.call(this, this.el.dom, this.ddGroup || this.group,
3562 {dragElId : this.proxy.id, resizeFrame: false, isTarget: false, scroll: this.scroll === true});
3564 this.dragging = false;
3567 Roo.extend(Roo.dd.DragSource, Roo.dd.DDProxy, {
3569 * @cfg {String} dropAllowed
3570 * The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").
3572 dropAllowed : "x-dd-drop-ok",
3574 * @cfg {String} dropNotAllowed
3575 * The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").
3577 dropNotAllowed : "x-dd-drop-nodrop",
3580 * Returns the data object associated with this drag source
3581 * @return {Object} data An object containing arbitrary data
3583 getDragData : function(e){
3584 return this.dragData;
3588 onDragEnter : function(e, id){
3589 var target = Roo.dd.DragDropMgr.getDDById(id);
3590 this.cachedTarget = target;
3591 if(this.beforeDragEnter(target, e, id) !== false){
3592 if(target.isNotifyTarget){
3593 var status = target.notifyEnter(this, e, this.dragData);
3594 this.proxy.setStatus(status);
3596 this.proxy.setStatus(this.dropAllowed);
3599 if(this.afterDragEnter){
3601 * An empty function by default, but provided so that you can perform a custom action
3602 * when the dragged item enters the drop target by providing an implementation.
3603 * @param {Roo.dd.DragDrop} target The drop target
3604 * @param {Event} e The event object
3605 * @param {String} id The id of the dragged element
3606 * @method afterDragEnter
3608 this.afterDragEnter(target, e, id);
3614 * An empty function by default, but provided so that you can perform a custom action
3615 * before the dragged item enters the drop target and optionally cancel the onDragEnter.
3616 * @param {Roo.dd.DragDrop} target The drop target
3617 * @param {Event} e The event object
3618 * @param {String} id The id of the dragged element
3619 * @return {Boolean} isValid True if the drag event is valid, else false to cancel
3621 beforeDragEnter : function(target, e, id){
3626 alignElWithMouse: function() {
3627 Roo.dd.DragSource.superclass.alignElWithMouse.apply(this, arguments);
3632 onDragOver : function(e, id){
3633 var target = this.cachedTarget || Roo.dd.DragDropMgr.getDDById(id);
3634 if(this.beforeDragOver(target, e, id) !== false){
3635 if(target.isNotifyTarget){
3636 var status = target.notifyOver(this, e, this.dragData);
3637 this.proxy.setStatus(status);
3640 if(this.afterDragOver){
3642 * An empty function by default, but provided so that you can perform a custom action
3643 * while the dragged item is over the drop target by providing an implementation.
3644 * @param {Roo.dd.DragDrop} target The drop target
3645 * @param {Event} e The event object
3646 * @param {String} id The id of the dragged element
3647 * @method afterDragOver
3649 this.afterDragOver(target, e, id);
3655 * An empty function by default, but provided so that you can perform a custom action
3656 * while the dragged item is over the drop target and optionally cancel the onDragOver.
3657 * @param {Roo.dd.DragDrop} target The drop target
3658 * @param {Event} e The event object
3659 * @param {String} id The id of the dragged element
3660 * @return {Boolean} isValid True if the drag event is valid, else false to cancel
3662 beforeDragOver : function(target, e, id){
3667 onDragOut : function(e, id){
3668 var target = this.cachedTarget || Roo.dd.DragDropMgr.getDDById(id);
3669 if(this.beforeDragOut(target, e, id) !== false){
3670 if(target.isNotifyTarget){
3671 target.notifyOut(this, e, this.dragData);
3674 if(this.afterDragOut){
3676 * An empty function by default, but provided so that you can perform a custom action
3677 * after the dragged item is dragged out of the target without dropping.
3678 * @param {Roo.dd.DragDrop} target The drop target
3679 * @param {Event} e The event object
3680 * @param {String} id The id of the dragged element
3681 * @method afterDragOut
3683 this.afterDragOut(target, e, id);
3686 this.cachedTarget = null;
3690 * An empty function by default, but provided so that you can perform a custom action before the dragged
3691 * item is dragged out of the target without dropping, and optionally cancel the onDragOut.
3692 * @param {Roo.dd.DragDrop} target The drop target
3693 * @param {Event} e The event object
3694 * @param {String} id The id of the dragged element
3695 * @return {Boolean} isValid True if the drag event is valid, else false to cancel
3697 beforeDragOut : function(target, e, id){
3702 onDragDrop : function(e, id){
3703 var target = this.cachedTarget || Roo.dd.DragDropMgr.getDDById(id);
3704 if(this.beforeDragDrop(target, e, id) !== false){
3705 if(target.isNotifyTarget){
3706 if(target.notifyDrop(this, e, this.dragData)){ // valid drop?
3707 this.onValidDrop(target, e, id);
3709 this.onInvalidDrop(target, e, id);
3712 this.onValidDrop(target, e, id);
3715 if(this.afterDragDrop){
3717 * An empty function by default, but provided so that you can perform a custom action
3718 * after a valid drag drop has occurred by providing an implementation.
3719 * @param {Roo.dd.DragDrop} target The drop target
3720 * @param {Event} e The event object
3721 * @param {String} id The id of the dropped element
3722 * @method afterDragDrop
3724 this.afterDragDrop(target, e, id);
3727 delete this.cachedTarget;
3731 * An empty function by default, but provided so that you can perform a custom action before the dragged
3732 * item is dropped onto the target and optionally cancel the onDragDrop.
3733 * @param {Roo.dd.DragDrop} target The drop target
3734 * @param {Event} e The event object
3735 * @param {String} id The id of the dragged element
3736 * @return {Boolean} isValid True if the drag drop event is valid, else false to cancel
3738 beforeDragDrop : function(target, e, id){
3743 onValidDrop : function(target, e, id){
3745 if(this.afterValidDrop){
3747 * An empty function by default, but provided so that you can perform a custom action
3748 * after a valid drop has occurred by providing an implementation.
3749 * @param {Object} target The target DD
3750 * @param {Event} e The event object
3751 * @param {String} id The id of the dropped element
3752 * @method afterInvalidDrop
3754 this.afterValidDrop(target, e, id);
3759 getRepairXY : function(e, data){
3760 return this.el.getXY();
3764 onInvalidDrop : function(target, e, id){
3765 this.beforeInvalidDrop(target, e, id);
3766 if(this.cachedTarget){
3767 if(this.cachedTarget.isNotifyTarget){
3768 this.cachedTarget.notifyOut(this, e, this.dragData);
3770 this.cacheTarget = null;
3772 this.proxy.repair(this.getRepairXY(e, this.dragData), this.afterRepair, this);
3774 if(this.afterInvalidDrop){
3776 * An empty function by default, but provided so that you can perform a custom action
3777 * after an invalid drop has occurred by providing an implementation.
3778 * @param {Event} e The event object
3779 * @param {String} id The id of the dropped element
3780 * @method afterInvalidDrop
3782 this.afterInvalidDrop(e, id);
3787 afterRepair : function(){
3789 this.el.highlight(this.hlColor || "c3daf9");
3791 this.dragging = false;
3795 * An empty function by default, but provided so that you can perform a custom action after an invalid
3796 * drop has occurred.
3797 * @param {Roo.dd.DragDrop} target The drop target
3798 * @param {Event} e The event object
3799 * @param {String} id The id of the dragged element
3800 * @return {Boolean} isValid True if the invalid drop should proceed, else false to cancel
3802 beforeInvalidDrop : function(target, e, id){
3807 handleMouseDown : function(e){
3811 var data = this.getDragData(e);
3812 if(data && this.onBeforeDrag(data, e) !== false){
3813 this.dragData = data;
3815 Roo.dd.DragSource.superclass.handleMouseDown.apply(this, arguments);
3820 * An empty function by default, but provided so that you can perform a custom action before the initial
3821 * drag event begins and optionally cancel it.
3822 * @param {Object} data An object containing arbitrary data to be shared with drop targets
3823 * @param {Event} e The event object
3824 * @return {Boolean} isValid True if the drag event is valid, else false to cancel
3826 onBeforeDrag : function(data, e){
3831 * An empty function by default, but provided so that you can perform a custom action once the initial
3832 * drag event has begun. The drag cannot be canceled from this function.
3833 * @param {Number} x The x position of the click on the dragged object
3834 * @param {Number} y The y position of the click on the dragged object
3836 onStartDrag : Roo.emptyFn,
3838 // private - YUI override
3839 startDrag : function(x, y){
3841 this.dragging = true;
3842 this.proxy.update("");
3843 this.onInitDrag(x, y);
3848 onInitDrag : function(x, y){
3849 var clone = this.el.dom.cloneNode(true);
3850 clone.id = Roo.id(); // prevent duplicate ids
3851 this.proxy.update(clone);
3852 this.onStartDrag(x, y);
3857 * Returns the drag source's underlying {@link Roo.dd.StatusProxy}
3858 * @return {Roo.dd.StatusProxy} proxy The StatusProxy
3860 getProxy : function(){
3865 * Hides the drag source's {@link Roo.dd.StatusProxy}
3867 hideProxy : function(){
3869 this.proxy.reset(true);
3870 this.dragging = false;
3874 triggerCacheRefresh : function(){
3875 Roo.dd.DDM.refreshCache(this.groups);
3878 // private - override to prevent hiding
3879 b4EndDrag: function(e) {
3882 // private - override to prevent moving
3883 endDrag : function(e){
3884 this.onEndDrag(this.dragData, e);
3888 onEndDrag : function(data, e){
3891 // private - pin to cursor
3892 autoOffset : function(x, y) {
3893 this.setDelta(-12, -20);
3897 * Ext JS Library 1.1.1
3898 * Copyright(c) 2006-2007, Ext JS, LLC.
3900 * Originally Released Under LGPL - original licence link has changed is not relivant.
3903 * <script type="text/javascript">
3908 * @class Roo.dd.DropTarget
3909 * @extends Roo.dd.DDTarget
3910 * A simple class that provides the basic implementation needed to make any element a drop target that can have
3911 * draggable items dropped onto it. The drop has no effect until an implementation of notifyDrop is provided.
3913 * @param {String/HTMLElement/Element} el The container element
3914 * @param {Object} config
3916 Roo.dd.DropTarget = function(el, config){
3917 this.el = Roo.get(el);
3919 var listeners = false; ;
3920 if (config && config.listeners) {
3921 listeners= config.listeners;
3922 delete config.listeners;
3924 Roo.apply(this, config);
3926 if(this.containerScroll){
3927 Roo.dd.ScrollManager.register(this.el);
3931 * @scope Roo.dd.DropTarget
3936 * The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the
3937 * target. This default implementation adds the CSS class specified by overClass (if any) to the drop element
3938 * and returns the dropAllowed config value. This method should be overridden if drop validation is required.
3940 * IMPORTANT : it should set this.overClass and this.dropAllowed
3942 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
3943 * @param {Event} e The event
3944 * @param {Object} data An object containing arbitrary data supplied by the drag source
3950 * The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.
3951 * This method will be called on every mouse movement while the drag source is over the drop target.
3952 * This default implementation simply returns the dropAllowed config value.
3954 * IMPORTANT : it should set this.dropAllowed
3956 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
3957 * @param {Event} e The event
3958 * @param {Object} data An object containing arbitrary data supplied by the drag source
3964 * The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged
3965 * out of the target without dropping. This default implementation simply removes the CSS class specified by
3966 * overClass (if any) from the drop element.
3968 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
3969 * @param {Event} e The event
3970 * @param {Object} data An object containing arbitrary data supplied by the drag source
3976 * The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has
3977 * been dropped on it. This method has no default implementation and returns false, so you must provide an
3978 * implementation that does something to process the drop event and returns true so that the drag source's
3979 * repair action does not run.
3981 * IMPORTANT : it should set this.success
3983 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
3984 * @param {Event} e The event
3985 * @param {Object} data An object containing arbitrary data supplied by the drag source
3991 Roo.dd.DropTarget.superclass.constructor.call( this,
3993 this.ddGroup || this.group,
3996 listeners : listeners || {}
4004 Roo.extend(Roo.dd.DropTarget, Roo.dd.DDTarget, {
4006 * @cfg {String} overClass
4007 * The CSS class applied to the drop target element while the drag source is over it (defaults to "").
4010 * @cfg {String} ddGroup
4011 * The drag drop group to handle drop events for
4015 * @cfg {String} dropAllowed
4016 * The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").
4018 dropAllowed : "x-dd-drop-ok",
4020 * @cfg {String} dropNotAllowed
4021 * The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").
4023 dropNotAllowed : "x-dd-drop-nodrop",
4025 * @cfg {boolean} success
4026 * set this after drop listener..
4030 * @cfg {boolean|String} valid true/false or string (ok-add/ok-sub/ok/nodrop)
4031 * if the drop point is valid for over/enter..
4038 isNotifyTarget : true,
4043 notifyEnter : function(dd, e, data)
4046 this.fireEvent('enter', dd, e, data);
4048 this.el.addClass(this.overClass);
4050 return typeof(this.valid) == 'string' ? 'x-dd-drop-' + this.valid : (
4051 this.valid ? this.dropAllowed : this.dropNotAllowed
4058 notifyOver : function(dd, e, data)
4061 this.fireEvent('over', dd, e, data);
4062 return typeof(this.valid) == 'string' ? 'x-dd-drop-' + this.valid : (
4063 this.valid ? this.dropAllowed : this.dropNotAllowed
4070 notifyOut : function(dd, e, data)
4072 this.fireEvent('out', dd, e, data);
4074 this.el.removeClass(this.overClass);
4081 notifyDrop : function(dd, e, data)
4083 this.success = false;
4084 this.fireEvent('drop', dd, e, data);
4085 return this.success;
4089 * Ext JS Library 1.1.1
4090 * Copyright(c) 2006-2007, Ext JS, LLC.
4092 * Originally Released Under LGPL - original licence link has changed is not relivant.
4095 * <script type="text/javascript">
4100 * @class Roo.dd.DragZone
4101 * @extends Roo.dd.DragSource
4102 * This class provides a container DD instance that proxies for multiple child node sources.<br />
4103 * By default, this class requires that draggable child nodes are registered with {@link Roo.dd.Registry}.
4105 * @param {String/HTMLElement/Element} el The container element
4106 * @param {Object} config
4108 Roo.dd.DragZone = function(el, config){
4109 Roo.dd.DragZone.superclass.constructor.call(this, el, config);
4110 if(this.containerScroll){
4111 Roo.dd.ScrollManager.register(this.el);
4115 Roo.extend(Roo.dd.DragZone, Roo.dd.DragSource, {
4117 * @cfg {Boolean} containerScroll True to register this container with the Scrollmanager
4118 * for auto scrolling during drag operations.
4121 * @cfg {String} hlColor The color to use when visually highlighting the drag source in the afterRepair
4122 * method after a failed drop (defaults to "c3daf9" - light blue)
4126 * Called when a mousedown occurs in this container. Looks in {@link Roo.dd.Registry}
4127 * for a valid target to drag based on the mouse down. Override this method
4128 * to provide your own lookup logic (e.g. finding a child by class name). Make sure your returned
4129 * object has a "ddel" attribute (with an HTML Element) for other functions to work.
4130 * @param {EventObject} e The mouse down event
4131 * @return {Object} The dragData
4133 getDragData : function(e){
4134 return Roo.dd.Registry.getHandleFromEvent(e);
4138 * Called once drag threshold has been reached to initialize the proxy element. By default, it clones the
4139 * this.dragData.ddel
4140 * @param {Number} x The x position of the click on the dragged object
4141 * @param {Number} y The y position of the click on the dragged object
4142 * @return {Boolean} true to continue the drag, false to cancel
4144 onInitDrag : function(x, y){
4145 this.proxy.update(this.dragData.ddel.cloneNode(true));
4146 this.onStartDrag(x, y);
4151 * Called after a repair of an invalid drop. By default, highlights this.dragData.ddel
4153 afterRepair : function(){
4155 Roo.Element.fly(this.dragData.ddel).highlight(this.hlColor || "c3daf9");
4157 this.dragging = false;
4161 * Called before a repair of an invalid drop to get the XY to animate to. By default returns
4162 * the XY of this.dragData.ddel
4163 * @param {EventObject} e The mouse up event
4164 * @return {Array} The xy location (e.g. [100, 200])
4166 getRepairXY : function(e){
4167 return Roo.Element.fly(this.dragData.ddel).getXY();
4171 * Ext JS Library 1.1.1
4172 * Copyright(c) 2006-2007, Ext JS, LLC.
4174 * Originally Released Under LGPL - original licence link has changed is not relivant.
4177 * <script type="text/javascript">
4180 * @class Roo.dd.DropZone
4181 * @extends Roo.dd.DropTarget
4182 * This class provides a container DD instance that proxies for multiple child node targets.<br />
4183 * By default, this class requires that child nodes accepting drop are registered with {@link Roo.dd.Registry}.
4185 * @param {String/HTMLElement/Element} el The container element
4186 * @param {Object} config
4188 Roo.dd.DropZone = function(el, config){
4189 Roo.dd.DropZone.superclass.constructor.call(this, el, config);
4192 Roo.extend(Roo.dd.DropZone, Roo.dd.DropTarget, {
4194 * Returns a custom data object associated with the DOM node that is the target of the event. By default
4195 * this looks up the event target in the {@link Roo.dd.Registry}, although you can override this method to
4196 * provide your own custom lookup.
4197 * @param {Event} e The event
4198 * @return {Object} data The custom data
4200 getTargetFromEvent : function(e){
4201 return Roo.dd.Registry.getTargetFromEvent(e);
4205 * Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has entered a drop node
4206 * that it has registered. This method has no default implementation and should be overridden to provide
4207 * node-specific processing if necessary.
4208 * @param {Object} nodeData The custom data associated with the drop node (this is the same value returned from
4209 * {@link #getTargetFromEvent} for this node)
4210 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone
4211 * @param {Event} e The event
4212 * @param {Object} data An object containing arbitrary data supplied by the drag source
4214 onNodeEnter : function(n, dd, e, data){
4219 * Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is over a drop node
4220 * that it has registered. The default implementation returns this.dropNotAllowed, so it should be
4221 * overridden to provide the proper feedback.
4222 * @param {Object} nodeData The custom data associated with the drop node (this is the same value returned from
4223 * {@link #getTargetFromEvent} for this node)
4224 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone
4225 * @param {Event} e The event
4226 * @param {Object} data An object containing arbitrary data supplied by the drag source
4227 * @return {String} status The CSS class that communicates the drop status back to the source so that the
4228 * underlying {@link Roo.dd.StatusProxy} can be updated
4230 onNodeOver : function(n, dd, e, data){
4231 return this.dropAllowed;
4235 * Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dragged out of
4236 * the drop node without dropping. This method has no default implementation and should be overridden to provide
4237 * node-specific processing if necessary.
4238 * @param {Object} nodeData The custom data associated with the drop node (this is the same value returned from
4239 * {@link #getTargetFromEvent} for this node)
4240 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone
4241 * @param {Event} e The event
4242 * @param {Object} data An object containing arbitrary data supplied by the drag source
4244 onNodeOut : function(n, dd, e, data){
4249 * Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped onto
4250 * the drop node. The default implementation returns false, so it should be overridden to provide the
4251 * appropriate processing of the drop event and return true so that the drag source's repair action does not run.
4252 * @param {Object} nodeData The custom data associated with the drop node (this is the same value returned from
4253 * {@link #getTargetFromEvent} for this node)
4254 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone
4255 * @param {Event} e The event
4256 * @param {Object} data An object containing arbitrary data supplied by the drag source
4257 * @return {Boolean} True if the drop was valid, else false
4259 onNodeDrop : function(n, dd, e, data){
4264 * Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is being dragged over it,
4265 * but not over any of its registered drop nodes. The default implementation returns this.dropNotAllowed, so
4266 * it should be overridden to provide the proper feedback if necessary.
4267 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone
4268 * @param {Event} e The event
4269 * @param {Object} data An object containing arbitrary data supplied by the drag source
4270 * @return {String} status The CSS class that communicates the drop status back to the source so that the
4271 * underlying {@link Roo.dd.StatusProxy} can be updated
4273 onContainerOver : function(dd, e, data){
4274 return this.dropNotAllowed;
4278 * Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped on it,
4279 * but not on any of its registered drop nodes. The default implementation returns false, so it should be
4280 * overridden to provide the appropriate processing of the drop event if you need the drop zone itself to
4281 * be able to accept drops. It should return true when valid so that the drag source's repair action does not run.
4282 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone
4283 * @param {Event} e The event
4284 * @param {Object} data An object containing arbitrary data supplied by the drag source
4285 * @return {Boolean} True if the drop was valid, else false
4287 onContainerDrop : function(dd, e, data){
4292 * The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source is now over
4293 * the zone. The default implementation returns this.dropNotAllowed and expects that only registered drop
4294 * nodes can process drag drop operations, so if you need the drop zone itself to be able to process drops
4295 * you should override this method and provide a custom implementation.
4296 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone
4297 * @param {Event} e The event
4298 * @param {Object} data An object containing arbitrary data supplied by the drag source
4299 * @return {String} status The CSS class that communicates the drop status back to the source so that the
4300 * underlying {@link Roo.dd.StatusProxy} can be updated
4302 notifyEnter : function(dd, e, data){
4303 return this.dropNotAllowed;
4307 * The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the drop zone.
4308 * This method will be called on every mouse movement while the drag source is over the drop zone.
4309 * It will call {@link #onNodeOver} while the drag source is over a registered node, and will also automatically
4310 * delegate to the appropriate node-specific methods as necessary when the drag source enters and exits
4311 * registered nodes ({@link #onNodeEnter}, {@link #onNodeOut}). If the drag source is not currently over a
4312 * registered node, it will call {@link #onContainerOver}.
4313 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone
4314 * @param {Event} e The event
4315 * @param {Object} data An object containing arbitrary data supplied by the drag source
4316 * @return {String} status The CSS class that communicates the drop status back to the source so that the
4317 * underlying {@link Roo.dd.StatusProxy} can be updated
4319 notifyOver : function(dd, e, data){
4320 var n = this.getTargetFromEvent(e);
4321 if(!n){ // not over valid drop target
4322 if(this.lastOverNode){
4323 this.onNodeOut(this.lastOverNode, dd, e, data);
4324 this.lastOverNode = null;
4326 return this.onContainerOver(dd, e, data);
4328 if(this.lastOverNode != n){
4329 if(this.lastOverNode){
4330 this.onNodeOut(this.lastOverNode, dd, e, data);
4332 this.onNodeEnter(n, dd, e, data);
4333 this.lastOverNode = n;
4335 return this.onNodeOver(n, dd, e, data);
4339 * The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source has been dragged
4340 * out of the zone without dropping. If the drag source is currently over a registered node, the notification
4341 * will be delegated to {@link #onNodeOut} for node-specific handling, otherwise it will be ignored.
4342 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop target
4343 * @param {Event} e The event
4344 * @param {Object} data An object containing arbitrary data supplied by the drag zone
4346 notifyOut : function(dd, e, data){
4347 if(this.lastOverNode){
4348 this.onNodeOut(this.lastOverNode, dd, e, data);
4349 this.lastOverNode = null;
4354 * The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the dragged item has
4355 * been dropped on it. The drag zone will look up the target node based on the event passed in, and if there
4356 * is a node registered for that event, it will delegate to {@link #onNodeDrop} for node-specific handling,
4357 * otherwise it will call {@link #onContainerDrop}.
4358 * @param {Roo.dd.DragSource} source The drag source that was dragged over this drop zone
4359 * @param {Event} e The event
4360 * @param {Object} data An object containing arbitrary data supplied by the drag source
4361 * @return {Boolean} True if the drop was valid, else false
4363 notifyDrop : function(dd, e, data){
4364 if(this.lastOverNode){
4365 this.onNodeOut(this.lastOverNode, dd, e, data);
4366 this.lastOverNode = null;
4368 var n = this.getTargetFromEvent(e);
4370 this.onNodeDrop(n, dd, e, data) :
4371 this.onContainerDrop(dd, e, data);
4375 triggerCacheRefresh : function(){
4376 Roo.dd.DDM.refreshCache(this.groups);
4380 * Ext JS Library 1.1.1
4381 * Copyright(c) 2006-2007, Ext JS, LLC.
4383 * Originally Released Under LGPL - original licence link has changed is not relivant.
4386 * <script type="text/javascript">
4391 * @class Roo.data.SortTypes
4393 * Defines the default sorting (casting?) comparison functions used when sorting data.
4395 Roo.data.SortTypes = {
4397 * Default sort that does nothing
4398 * @param {Mixed} s The value being converted
4399 * @return {Mixed} The comparison value
4406 * The regular expression used to strip tags
4410 stripTagsRE : /<\/?[^>]+>/gi,
4413 * Strips all HTML tags to sort on text only
4414 * @param {Mixed} s The value being converted
4415 * @return {String} The comparison value
4417 asText : function(s){
4418 return String(s).replace(this.stripTagsRE, "");
4422 * Strips all HTML tags to sort on text only - Case insensitive
4423 * @param {Mixed} s The value being converted
4424 * @return {String} The comparison value
4426 asUCText : function(s){
4427 return String(s).toUpperCase().replace(this.stripTagsRE, "");
4431 * Case insensitive string
4432 * @param {Mixed} s The value being converted
4433 * @return {String} The comparison value
4435 asUCString : function(s) {
4436 return String(s).toUpperCase();
4441 * @param {Mixed} s The value being converted
4442 * @return {Number} The comparison value
4444 asDate : function(s) {
4448 if(s instanceof Date){
4451 return Date.parse(String(s));
4456 * @param {Mixed} s The value being converted
4457 * @return {Float} The comparison value
4459 asFloat : function(s) {
4460 var val = parseFloat(String(s).replace(/,/g, ""));
4461 if(isNaN(val)) val = 0;
4467 * @param {Mixed} s The value being converted
4468 * @return {Number} The comparison value
4470 asInt : function(s) {
4471 var val = parseInt(String(s).replace(/,/g, ""));
4472 if(isNaN(val)) val = 0;
4477 * Ext JS Library 1.1.1
4478 * Copyright(c) 2006-2007, Ext JS, LLC.
4480 * Originally Released Under LGPL - original licence link has changed is not relivant.
4483 * <script type="text/javascript">
4487 * @class Roo.data.Record
4488 * Instances of this class encapsulate both record <em>definition</em> information, and record
4489 * <em>value</em> information for use in {@link Roo.data.Store} objects, or any code which needs
4490 * to access Records cached in an {@link Roo.data.Store} object.<br>
4492 * Constructors for this class are generated by passing an Array of field definition objects to {@link #create}.
4493 * Instances are usually only created by {@link Roo.data.Reader} implementations when processing unformatted data
4496 * Record objects generated by this constructor inherit all the methods of Roo.data.Record listed below.
4498 * This constructor should not be used to create Record objects. Instead, use the constructor generated by
4499 * {@link #create}. The parameters are the same.
4500 * @param {Array} data An associative Array of data values keyed by the field name.
4501 * @param {Object} id (Optional) The id of the record. This id should be unique, and is used by the
4502 * {@link Roo.data.Store} object which owns the Record to index its collection of Records. If
4503 * not specified an integer id is generated.
4505 Roo.data.Record = function(data, id){
4506 this.id = (id || id === 0) ? id : ++Roo.data.Record.AUTO_ID;
4511 * Generate a constructor for a specific record layout.
4512 * @param {Array} o An Array of field definition objects which specify field names, and optionally,
4513 * data types, and a mapping for an {@link Roo.data.Reader} to extract the field's value from a data object.
4514 * Each field definition object may contain the following properties: <ul>
4515 * <li><b>name</b> : String<p style="margin-left:1em">The name by which the field is referenced within the Record. This is referenced by,
4516 * for example the <em>dataIndex</em> property in column definition objects passed to {@link Roo.grid.ColumnModel}</p></li>
4517 * <li><b>mapping</b> : String<p style="margin-left:1em">(Optional) A path specification for use by the {@link Roo.data.Reader} implementation
4518 * that is creating the Record to access the data value from the data object. If an {@link Roo.data.JsonReader}
4519 * is being used, then this is a string containing the javascript expression to reference the data relative to
4520 * the record item's root. If an {@link Roo.data.XmlReader} is being used, this is an {@link Roo.DomQuery} path
4521 * to the data item relative to the record element. If the mapping expression is the same as the field name,
4522 * this may be omitted.</p></li>
4523 * <li><b>type</b> : String<p style="margin-left:1em">(Optional) The data type for conversion to displayable value. Possible values are
4524 * <ul><li>auto (Default, implies no conversion)</li>
4529 * <li>date</li></ul></p></li>
4530 * <li><b>sortType</b> : Mixed<p style="margin-left:1em">(Optional) A member of {@link Roo.data.SortTypes}.</p></li>
4531 * <li><b>sortDir</b> : String<p style="margin-left:1em">(Optional) Initial direction to sort. "ASC" or "DESC"</p></li>
4532 * <li><b>convert</b> : Function<p style="margin-left:1em">(Optional) A function which converts the value provided
4533 * by the Reader into an object that will be stored in the Record. It is passed the
4534 * following parameters:<ul>
4535 * <li><b>v</b> : Mixed<p style="margin-left:1em">The data value as read by the Reader.</p></li>
4537 * <li><b>dateFormat</b> : String<p style="margin-left:1em">(Optional) A format String for the Date.parseDate function.</p></li>
4539 * <br>usage:<br><pre><code>
4540 var TopicRecord = Roo.data.Record.create(
4541 {name: 'title', mapping: 'topic_title'},
4542 {name: 'author', mapping: 'username'},
4543 {name: 'totalPosts', mapping: 'topic_replies', type: 'int'},
4544 {name: 'lastPost', mapping: 'post_time', type: 'date'},
4545 {name: 'lastPoster', mapping: 'user2'},
4546 {name: 'excerpt', mapping: 'post_text'}
4549 var myNewRecord = new TopicRecord({
4550 title: 'Do my job please',
4553 lastPost: new Date(),
4554 lastPoster: 'Animal',
4555 excerpt: 'No way dude!'
4557 myStore.add(myNewRecord);
4562 Roo.data.Record.create = function(o){
4564 f.superclass.constructor.apply(this, arguments);
4566 Roo.extend(f, Roo.data.Record);
4567 var p = f.prototype;
4568 p.fields = new Roo.util.MixedCollection(false, function(field){
4571 for(var i = 0, len = o.length; i < len; i++){
4572 p.fields.add(new Roo.data.Field(o[i]));
4574 f.getField = function(name){
4575 return p.fields.get(name);
4580 Roo.data.Record.AUTO_ID = 1000;
4581 Roo.data.Record.EDIT = 'edit';
4582 Roo.data.Record.REJECT = 'reject';
4583 Roo.data.Record.COMMIT = 'commit';
4585 Roo.data.Record.prototype = {
4587 * Readonly flag - true if this record has been modified.
4596 join : function(store){
4601 * Set the named field to the specified value.
4602 * @param {String} name The name of the field to set.
4603 * @param {Object} value The value to set the field to.
4605 set : function(name, value){
4606 if(this.data[name] == value){
4613 if(typeof this.modified[name] == 'undefined'){
4614 this.modified[name] = this.data[name];
4616 this.data[name] = value;
4617 if(!this.editing && this.store){
4618 this.store.afterEdit(this);
4623 * Get the value of the named field.
4624 * @param {String} name The name of the field to get the value of.
4625 * @return {Object} The value of the field.
4627 get : function(name){
4628 return this.data[name];
4632 beginEdit : function(){
4633 this.editing = true;
4638 cancelEdit : function(){
4639 this.editing = false;
4640 delete this.modified;
4644 endEdit : function(){
4645 this.editing = false;
4646 if(this.dirty && this.store){
4647 this.store.afterEdit(this);
4652 * Usually called by the {@link Roo.data.Store} which owns the Record.
4653 * Rejects all changes made to the Record since either creation, or the last commit operation.
4654 * Modified fields are reverted to their original values.
4656 * Developers should subscribe to the {@link Roo.data.Store#update} event to have their code notified
4657 * of reject operations.
4659 reject : function(){
4660 var m = this.modified;
4662 if(typeof m[n] != "function"){
4663 this.data[n] = m[n];
4667 delete this.modified;
4668 this.editing = false;
4670 this.store.afterReject(this);
4675 * Usually called by the {@link Roo.data.Store} which owns the Record.
4676 * Commits all changes made to the Record since either creation, or the last commit operation.
4678 * Developers should subscribe to the {@link Roo.data.Store#update} event to have their code notified
4679 * of commit operations.
4681 commit : function(){
4683 delete this.modified;
4684 this.editing = false;
4686 this.store.afterCommit(this);
4691 hasError : function(){
4692 return this.error != null;
4696 clearError : function(){
4701 * Creates a copy of this record.
4702 * @param {String} id (optional) A new record id if you don't want to use this record's id
4705 copy : function(newId) {
4706 return new this.constructor(Roo.apply({}, this.data), newId || this.id);
4710 * Ext JS Library 1.1.1
4711 * Copyright(c) 2006-2007, Ext JS, LLC.
4713 * Originally Released Under LGPL - original licence link has changed is not relivant.
4716 * <script type="text/javascript">
4722 * @class Roo.data.Store
4723 * @extends Roo.util.Observable
4724 * The Store class encapsulates a client side cache of {@link Roo.data.Record} objects which provide input data
4725 * for widgets such as the Roo.grid.Grid, or the Roo.form.ComboBox.<br>
4727 * A Store object uses an implementation of {@link Roo.data.DataProxy} to access a data object unless you call loadData() directly and pass in your data. The Store object
4728 * has no knowledge of the format of the data returned by the Proxy.<br>
4730 * A Store object uses its configured implementation of {@link Roo.data.DataReader} to create {@link Roo.data.Record}
4731 * instances from the data object. These records are cached and made available through accessor functions.
4733 * Creates a new Store.
4734 * @param {Object} config A config object containing the objects needed for the Store to access data,
4735 * and read the data into Records.
4737 Roo.data.Store = function(config){
4738 this.data = new Roo.util.MixedCollection(false);
4739 this.data.getKey = function(o){
4742 this.baseParams = {};
4749 "multisort" : "_multisort"
4752 if(config && config.data){
4753 this.inlineData = config.data;
4757 Roo.apply(this, config);
4759 if(this.reader){ // reader passed
4760 this.reader = Roo.factory(this.reader, Roo.data);
4761 this.reader.xmodule = this.xmodule || false;
4762 if(!this.recordType){
4763 this.recordType = this.reader.recordType;
4765 if(this.reader.onMetaChange){
4766 this.reader.onMetaChange = this.onMetaChange.createDelegate(this);
4770 if(this.recordType){
4771 this.fields = this.recordType.prototype.fields;
4777 * @event datachanged
4778 * Fires when the data cache has changed, and a widget which is using this Store
4779 * as a Record cache should refresh its view.
4780 * @param {Store} this
4785 * Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.
4786 * @param {Store} this
4787 * @param {Object} meta The JSON metadata
4792 * Fires when Records have been added to the Store
4793 * @param {Store} this
4794 * @param {Roo.data.Record[]} records The array of Records added
4795 * @param {Number} index The index at which the record(s) were added
4800 * Fires when a Record has been removed from the Store
4801 * @param {Store} this
4802 * @param {Roo.data.Record} record The Record that was removed
4803 * @param {Number} index The index at which the record was removed
4808 * Fires when a Record has been updated
4809 * @param {Store} this
4810 * @param {Roo.data.Record} record The Record that was updated
4811 * @param {String} operation The update operation being performed. Value may be one of:
4813 Roo.data.Record.EDIT
4814 Roo.data.Record.REJECT
4815 Roo.data.Record.COMMIT
4821 * Fires when the data cache has been cleared.
4822 * @param {Store} this
4827 * Fires before a request is made for a new data object. If the beforeload handler returns false
4828 * the load action will be canceled.
4829 * @param {Store} this
4830 * @param {Object} options The loading options that were specified (see {@link #load} for details)
4834 * @event beforeloadadd
4835 * Fires after a new set of Records has been loaded.
4836 * @param {Store} this
4837 * @param {Roo.data.Record[]} records The Records that were loaded
4838 * @param {Object} options The loading options that were specified (see {@link #load} for details)
4840 beforeloadadd : true,
4843 * Fires after a new set of Records has been loaded, before they are added to the store.
4844 * @param {Store} this
4845 * @param {Roo.data.Record[]} records The Records that were loaded
4846 * @param {Object} options The loading options that were specified (see {@link #load} for details)
4847 * @params {Object} return from reader
4851 * @event loadexception
4852 * Fires if an exception occurs in the Proxy during loading.
4853 * Called with the signature of the Proxy's "loadexception" event.
4854 * If you return Json { data: [] , success: false, .... } then this will be thrown with the following args
4857 * @param {Object} return from JsonData.reader() - success, totalRecords, records
4858 * @param {Object} load options
4859 * @param {Object} jsonData from your request (normally this contains the Exception)
4861 loadexception : true
4865 this.proxy = Roo.factory(this.proxy, Roo.data);
4866 this.proxy.xmodule = this.xmodule || false;
4867 this.relayEvents(this.proxy, ["loadexception"]);
4869 this.sortToggle = {};
4870 this.sortOrder = []; // array of order of sorting - updated by grid if multisort is enabled.
4872 Roo.data.Store.superclass.constructor.call(this);
4874 if(this.inlineData){
4875 this.loadData(this.inlineData);
4876 delete this.inlineData;
4880 Roo.extend(Roo.data.Store, Roo.util.Observable, {
4882 * @cfg {boolean} isLocal flag if data is locally available (and can be always looked up
4883 * without a remote query - used by combo/forms at present.
4887 * @cfg {Roo.data.DataProxy} proxy The Proxy object which provides access to a data object.
4890 * @cfg {Array} data Inline data to be loaded when the store is initialized.
4893 * @cfg {Roo.data.Reader} reader The Reader object which processes the data object and returns
4894 * an Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.
4897 * @cfg {Object} baseParams An object containing properties which are to be sent as parameters
4898 * on any HTTP request
4901 * @cfg {Object} sortInfo A config object in the format: {field: "fieldName", direction: "ASC|DESC"}
4904 * @cfg {Boolean} multiSort enable multi column sorting (sort is based on the order of columns, remote only at present)
4908 * @cfg {boolean} remoteSort True if sorting is to be handled by requesting the Proxy to provide a refreshed
4909 * version of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).
4914 * @cfg {boolean} pruneModifiedRecords True to clear all modified record information each time the store is
4915 * loaded or when a record is removed. (defaults to false).
4917 pruneModifiedRecords : false,
4923 * Add Records to the Store and fires the add event.
4924 * @param {Roo.data.Record[]} records An Array of Roo.data.Record objects to add to the cache.
4926 add : function(records){
4927 records = [].concat(records);
4928 for(var i = 0, len = records.length; i < len; i++){
4929 records[i].join(this);
4931 var index = this.data.length;
4932 this.data.addAll(records);
4933 this.fireEvent("add", this, records, index);
4937 * Remove a Record from the Store and fires the remove event.
4938 * @param {Ext.data.Record} record The Roo.data.Record object to remove from the cache.
4940 remove : function(record){
4941 var index = this.data.indexOf(record);
4942 this.data.removeAt(index);
4943 if(this.pruneModifiedRecords){
4944 this.modified.remove(record);
4946 this.fireEvent("remove", this, record, index);
4950 * Remove all Records from the Store and fires the clear event.
4952 removeAll : function(){
4954 if(this.pruneModifiedRecords){
4957 this.fireEvent("clear", this);
4961 * Inserts Records to the Store at the given index and fires the add event.
4962 * @param {Number} index The start index at which to insert the passed Records.
4963 * @param {Roo.data.Record[]} records An Array of Roo.data.Record objects to add to the cache.
4965 insert : function(index, records){
4966 records = [].concat(records);
4967 for(var i = 0, len = records.length; i < len; i++){
4968 this.data.insert(index, records[i]);
4969 records[i].join(this);
4971 this.fireEvent("add", this, records, index);
4975 * Get the index within the cache of the passed Record.
4976 * @param {Roo.data.Record} record The Roo.data.Record object to to find.
4977 * @return {Number} The index of the passed Record. Returns -1 if not found.
4979 indexOf : function(record){
4980 return this.data.indexOf(record);
4984 * Get the index within the cache of the Record with the passed id.
4985 * @param {String} id The id of the Record to find.
4986 * @return {Number} The index of the Record. Returns -1 if not found.
4988 indexOfId : function(id){
4989 return this.data.indexOfKey(id);
4993 * Get the Record with the specified id.
4994 * @param {String} id The id of the Record to find.
4995 * @return {Roo.data.Record} The Record with the passed id. Returns undefined if not found.
4997 getById : function(id){
4998 return this.data.key(id);
5002 * Get the Record at the specified index.
5003 * @param {Number} index The index of the Record to find.
5004 * @return {Roo.data.Record} The Record at the passed index. Returns undefined if not found.
5006 getAt : function(index){
5007 return this.data.itemAt(index);
5011 * Returns a range of Records between specified indices.
5012 * @param {Number} startIndex (optional) The starting index (defaults to 0)
5013 * @param {Number} endIndex (optional) The ending index (defaults to the last Record in the Store)
5014 * @return {Roo.data.Record[]} An array of Records
5016 getRange : function(start, end){
5017 return this.data.getRange(start, end);
5021 storeOptions : function(o){
5022 o = Roo.apply({}, o);
5025 this.lastOptions = o;
5029 * Loads the Record cache from the configured Proxy using the configured Reader.
5031 * If using remote paging, then the first load call must specify the <em>start</em>
5032 * and <em>limit</em> properties in the options.params property to establish the initial
5033 * position within the dataset, and the number of Records to cache on each read from the Proxy.
5035 * <strong>It is important to note that for remote data sources, loading is asynchronous,
5036 * and this call will return before the new data has been loaded. Perform any post-processing
5037 * in a callback function, or in a "load" event handler.</strong>
5039 * @param {Object} options An object containing properties which control loading options:<ul>
5040 * <li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li>
5041 * <li>callback {Function} A function to be called after the Records have been loaded. The callback is
5042 * passed the following arguments:<ul>
5043 * <li>r : Roo.data.Record[]</li>
5044 * <li>options: Options object from the load call</li>
5045 * <li>success: Boolean success indicator</li></ul></li>
5046 * <li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li>
5047 * <li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li>
5050 load : function(options){
5051 options = options || {};
5052 if(this.fireEvent("beforeload", this, options) !== false){
5053 this.storeOptions(options);
5054 var p = Roo.apply(options.params || {}, this.baseParams);
5055 // if meta was not loaded from remote source.. try requesting it.
5056 if (!this.reader.metaFromRemote) {
5059 if(this.sortInfo && this.remoteSort){
5060 var pn = this.paramNames;
5061 p[pn["sort"]] = this.sortInfo.field;
5062 p[pn["dir"]] = this.sortInfo.direction;
5064 if (this.multiSort) {
5065 var pn = this.paramNames;
5066 p[pn["multisort"]] = Roo.encode( { sort : this.sortToggle, order: this.sortOrder });
5069 this.proxy.load(p, this.reader, this.loadRecords, this, options);
5074 * Reloads the Record cache from the configured Proxy using the configured Reader and
5075 * the options from the last load operation performed.
5076 * @param {Object} options (optional) An object containing properties which may override the options
5077 * used in the last load operation. See {@link #load} for details (defaults to null, in which case
5078 * the most recently used options are reused).
5080 reload : function(options){
5081 this.load(Roo.applyIf(options||{}, this.lastOptions));
5085 // Called as a callback by the Reader during a load operation.
5086 loadRecords : function(o, options, success){
5087 if(!o || success === false){
5088 if(success !== false){
5089 this.fireEvent("load", this, [], options, o);
5091 if(options.callback){
5092 options.callback.call(options.scope || this, [], options, false);
5096 // if data returned failure - throw an exception.
5097 if (o.success === false) {
5098 // show a message if no listener is registered.
5099 if (!this.hasListener('loadexception') && typeof(o.raw.errorMsg) != 'undefined') {
5100 Roo.MessageBox.alert("Error loading",o.raw.errorMsg);
5102 // loadmask wil be hooked into this..
5103 this.fireEvent("loadexception", this, o, options, o.raw.errorMsg);
5106 var r = o.records, t = o.totalRecords || r.length;
5108 this.fireEvent("beforeloadadd", this, r, options, o);
5110 if(!options || options.add !== true){
5111 if(this.pruneModifiedRecords){
5114 for(var i = 0, len = r.length; i < len; i++){
5118 this.data = this.snapshot;
5119 delete this.snapshot;
5122 this.data.addAll(r);
5123 this.totalLength = t;
5125 this.fireEvent("datachanged", this);
5127 this.totalLength = Math.max(t, this.data.length+r.length);
5130 this.fireEvent("load", this, r, options, o);
5131 if(options.callback){
5132 options.callback.call(options.scope || this, r, options, true);
5138 * Loads data from a passed data block. A Reader which understands the format of the data
5139 * must have been configured in the constructor.
5140 * @param {Object} data The data block from which to read the Records. The format of the data expected
5141 * is dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.
5142 * @param {Boolean} append (Optional) True to append the new Records rather than replace the existing cache.
5144 loadData : function(o, append){
5145 var r = this.reader.readRecords(o);
5146 this.loadRecords(r, {add: append}, true);
5150 * Gets the number of cached records.
5152 * <em>If using paging, this may not be the total size of the dataset. If the data object
5153 * used by the Reader contains the dataset size, then the getTotalCount() function returns
5154 * the data set size</em>
5156 getCount : function(){
5157 return this.data.length || 0;
5161 * Gets the total number of records in the dataset as returned by the server.
5163 * <em>If using paging, for this to be accurate, the data object used by the Reader must contain
5164 * the dataset size</em>
5166 getTotalCount : function(){
5167 return this.totalLength || 0;
5171 * Returns the sort state of the Store as an object with two properties:
5173 field {String} The name of the field by which the Records are sorted
5174 direction {String} The sort order, "ASC" or "DESC"
5177 getSortState : function(){
5178 return this.sortInfo;
5182 applySort : function(){
5183 if(this.sortInfo && !this.remoteSort){
5184 var s = this.sortInfo, f = s.field;
5185 var st = this.fields.get(f).sortType;
5186 var fn = function(r1, r2){
5187 var v1 = st(r1.data[f]), v2 = st(r2.data[f]);
5188 return v1 > v2 ? 1 : (v1 < v2 ? -1 : 0);
5190 this.data.sort(s.direction, fn);
5191 if(this.snapshot && this.snapshot != this.data){
5192 this.snapshot.sort(s.direction, fn);
5198 * Sets the default sort column and order to be used by the next load operation.
5199 * @param {String} fieldName The name of the field to sort by.
5200 * @param {String} dir (optional) The sort order, "ASC" or "DESC" (defaults to "ASC")
5202 setDefaultSort : function(field, dir){
5203 this.sortInfo = {field: field, direction: dir ? dir.toUpperCase() : "ASC"};
5208 * If remote sorting is used, the sort is performed on the server, and the cache is
5209 * reloaded. If local sorting is used, the cache is sorted internally.
5210 * @param {String} fieldName The name of the field to sort by.
5211 * @param {String} dir (optional) The sort order, "ASC" or "DESC" (defaults to "ASC")
5213 sort : function(fieldName, dir){
5214 var f = this.fields.get(fieldName);
5216 this.sortToggle[f.name] = this.sortToggle[f.name] || f.sortDir;
5218 if(this.multiSort || (this.sortInfo && this.sortInfo.field == f.name) ){ // toggle sort dir
5219 dir = (this.sortToggle[f.name] || "ASC").toggle("ASC", "DESC");
5224 this.sortToggle[f.name] = dir;
5225 this.sortInfo = {field: f.name, direction: dir};
5226 if(!this.remoteSort){
5228 this.fireEvent("datachanged", this);
5230 this.load(this.lastOptions);
5235 * Calls the specified function for each of the Records in the cache.
5236 * @param {Function} fn The function to call. The Record is passed as the first parameter.
5237 * Returning <em>false</em> aborts and exits the iteration.
5238 * @param {Object} scope (optional) The scope in which to call the function (defaults to the Record).
5240 each : function(fn, scope){
5241 this.data.each(fn, scope);
5245 * Gets all records modified since the last commit. Modified records are persisted across load operations
5246 * (e.g., during paging).
5247 * @return {Roo.data.Record[]} An array of Records containing outstanding modifications.
5249 getModifiedRecords : function(){
5250 return this.modified;
5254 createFilterFn : function(property, value, anyMatch){
5255 if(!value.exec){ // not a regex
5256 value = String(value);
5257 if(value.length == 0){
5260 value = new RegExp((anyMatch === true ? '' : '^') + Roo.escapeRe(value), "i");
5263 return value.test(r.data[property]);
5268 * Sums the value of <i>property</i> for each record between start and end and returns the result.
5269 * @param {String} property A field on your records
5270 * @param {Number} start The record index to start at (defaults to 0)
5271 * @param {Number} end The last record index to include (defaults to length - 1)
5272 * @return {Number} The sum
5274 sum : function(property, start, end){
5275 var rs = this.data.items, v = 0;
5277 end = (end || end === 0) ? end : rs.length-1;
5279 for(var i = start; i <= end; i++){
5280 v += (rs[i].data[property] || 0);
5286 * Filter the records by a specified property.
5287 * @param {String} field A field on your records
5288 * @param {String/RegExp} value Either a string that the field
5289 * should start with or a RegExp to test against the field
5290 * @param {Boolean} anyMatch True to match any part not just the beginning
5292 filter : function(property, value, anyMatch){
5293 var fn = this.createFilterFn(property, value, anyMatch);
5294 return fn ? this.filterBy(fn) : this.clearFilter();
5298 * Filter by a function. The specified function will be called with each
5299 * record in this data source. If the function returns true the record is included,
5300 * otherwise it is filtered.
5301 * @param {Function} fn The function to be called, it will receive 2 args (record, id)
5302 * @param {Object} scope (optional) The scope of the function (defaults to this)
5304 filterBy : function(fn, scope){
5305 this.snapshot = this.snapshot || this.data;
5306 this.data = this.queryBy(fn, scope||this);
5307 this.fireEvent("datachanged", this);
5311 * Query the records by a specified property.
5312 * @param {String} field A field on your records
5313 * @param {String/RegExp} value Either a string that the field
5314 * should start with or a RegExp to test against the field
5315 * @param {Boolean} anyMatch True to match any part not just the beginning
5316 * @return {MixedCollection} Returns an Roo.util.MixedCollection of the matched records
5318 query : function(property, value, anyMatch){
5319 var fn = this.createFilterFn(property, value, anyMatch);
5320 return fn ? this.queryBy(fn) : this.data.clone();
5324 * Query by a function. The specified function will be called with each
5325 * record in this data source. If the function returns true the record is included
5327 * @param {Function} fn The function to be called, it will receive 2 args (record, id)
5328 * @param {Object} scope (optional) The scope of the function (defaults to this)
5329 @return {MixedCollection} Returns an Roo.util.MixedCollection of the matched records
5331 queryBy : function(fn, scope){
5332 var data = this.snapshot || this.data;
5333 return data.filterBy(fn, scope||this);
5337 * Collects unique values for a particular dataIndex from this store.
5338 * @param {String} dataIndex The property to collect
5339 * @param {Boolean} allowNull (optional) Pass true to allow null, undefined or empty string values
5340 * @param {Boolean} bypassFilter (optional) Pass true to collect from all records, even ones which are filtered
5341 * @return {Array} An array of the unique values
5343 collect : function(dataIndex, allowNull, bypassFilter){
5344 var d = (bypassFilter === true && this.snapshot) ?
5345 this.snapshot.items : this.data.items;
5346 var v, sv, r = [], l = {};
5347 for(var i = 0, len = d.length; i < len; i++){
5348 v = d[i].data[dataIndex];
5350 if((allowNull || !Roo.isEmpty(v)) && !l[sv]){
5359 * Revert to a view of the Record cache with no filtering applied.
5360 * @param {Boolean} suppressEvent If true the filter is cleared silently without notifying listeners
5362 clearFilter : function(suppressEvent){
5363 if(this.snapshot && this.snapshot != this.data){
5364 this.data = this.snapshot;
5365 delete this.snapshot;
5366 if(suppressEvent !== true){
5367 this.fireEvent("datachanged", this);
5373 afterEdit : function(record){
5374 if(this.modified.indexOf(record) == -1){
5375 this.modified.push(record);
5377 this.fireEvent("update", this, record, Roo.data.Record.EDIT);
5381 afterReject : function(record){
5382 this.modified.remove(record);
5383 this.fireEvent("update", this, record, Roo.data.Record.REJECT);
5387 afterCommit : function(record){
5388 this.modified.remove(record);
5389 this.fireEvent("update", this, record, Roo.data.Record.COMMIT);
5393 * Commit all Records with outstanding changes. To handle updates for changes, subscribe to the
5394 * Store's "update" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.
5396 commitChanges : function(){
5397 var m = this.modified.slice(0);
5399 for(var i = 0, len = m.length; i < len; i++){
5405 * Cancel outstanding changes on all changed records.
5407 rejectChanges : function(){
5408 var m = this.modified.slice(0);
5410 for(var i = 0, len = m.length; i < len; i++){
5415 onMetaChange : function(meta, rtype, o){
5416 this.recordType = rtype;
5417 this.fields = rtype.prototype.fields;
5418 delete this.snapshot;
5419 this.sortInfo = meta.sortInfo || this.sortInfo;
5421 this.fireEvent('metachange', this, this.reader.meta);
5424 moveIndex : function(data, type)
5426 var index = this.indexOf(data);
5428 var newIndex = index + type;
5432 this.insert(newIndex, data);