roojs-ui.js
[roojs1] / Roo / Resizable.js
1 /*
2  * Based on:
3  * Ext JS Library 1.1.1
4  * Copyright(c) 2006-2007, Ext JS, LLC.
5  *
6  * Originally Released Under LGPL - original licence link has changed is not relivant.
7  *
8  * Fork - LGPL
9  * <script type="text/javascript">
10  */
11
12 /**
13  * @class Roo.Resizable
14  * @extends Roo.util.Observable
15  * <p>Applies drag handles to an element to make it resizable. The drag handles are inserted into the element
16  * and positioned absolute. Some elements, such as a textarea or image, don't support this. To overcome that, you can wrap
17  * the textarea in a div and set "resizeChild" to true (or to the id of the element), <b>or</b> set wrap:true in your config and
18  * the element will be wrapped for you automatically.</p>
19  * <p>Here is the list of valid resize handles:</p>
20  * <pre>
21 Value   Description
22 ------  -------------------
23  'n'     north
24  's'     south
25  'e'     east
26  'w'     west
27  'nw'    northwest
28  'sw'    southwest
29  'se'    southeast
30  'ne'    northeast
31  'hd'    horizontal drag
32  'all'   all
33 </pre>
34  * <p>Here's an example showing the creation of a typical Resizable:</p>
35  * <pre><code>
36 var resizer = new Roo.Resizable("element-id", {
37     handles: 'all',
38     minWidth: 200,
39     minHeight: 100,
40     maxWidth: 500,
41     maxHeight: 400,
42     pinned: true
43 });
44 resizer.on("resize", myHandler);
45 </code></pre>
46  * <p>To hide a particular handle, set its display to none in CSS, or through script:<br>
47  * resizer.east.setDisplayed(false);</p>
48  * @cfg {Boolean/String/Element} resizeChild True to resize the first child, or id/element to resize (defaults to false)
49  * @cfg {Array/String} adjustments String "auto" or an array [width, height] with values to be <b>added</b> to the
50  * resize operation's new size (defaults to [0, 0])
51  * @cfg {Number} minWidth The minimum width for the element (defaults to 5)
52  * @cfg {Number} minHeight The minimum height for the element (defaults to 5)
53  * @cfg {Number} maxWidth The maximum width for the element (defaults to 10000)
54  * @cfg {Number} maxHeight The maximum height for the element (defaults to 10000)
55  * @cfg {Boolean} enabled False to disable resizing (defaults to true)
56  * @cfg {Boolean} wrap True to wrap an element with a div if needed (required for textareas and images, defaults to false)
57  * @cfg {Number} width The width of the element in pixels (defaults to null)
58  * @cfg {Number} height The height of the element in pixels (defaults to null)
59  * @cfg {Boolean} animate True to animate the resize (not compatible with dynamic sizing, defaults to false)
60  * @cfg {Number} duration Animation duration if animate = true (defaults to .35)
61  * @cfg {Boolean} dynamic True to resize the element while dragging instead of using a proxy (defaults to false)
62  * @cfg {String} handles String consisting of the resize handles to display (defaults to undefined)
63  * @cfg {Boolean} multiDirectional <b>Deprecated</b>.  The old style of adding multi-direction resize handles, deprecated
64  * in favor of the handles config option (defaults to false)
65  * @cfg {Boolean} disableTrackOver True to disable mouse tracking. This is only applied at config time. (defaults to false)
66  * @cfg {String} easing Animation easing if animate = true (defaults to 'easingOutStrong')
67  * @cfg {Number} widthIncrement The increment to snap the width resize in pixels (dynamic must be true, defaults to 0)
68  * @cfg {Number} heightIncrement The increment to snap the height resize in pixels (dynamic must be true, defaults to 0)
69  * @cfg {Boolean} pinned True to ensure that the resize handles are always visible, false to display them only when the
70  * user mouses over the resizable borders. This is only applied at config time. (defaults to false)
71  * @cfg {Boolean} preserveRatio True to preserve the original ratio between height and width during resize (defaults to false)
72  * @cfg {Boolean} transparent True for transparent handles. This is only applied at config time. (defaults to false)
73  * @cfg {Number} minX The minimum allowed page X for the element (only used for west resizing, defaults to 0)
74  * @cfg {Number} minY The minimum allowed page Y for the element (only used for north resizing, defaults to 0)
75  * @cfg {Boolean} draggable Convenience to initialize drag drop (defaults to false)
76  * @constructor
77  * Create a new resizable component
78  * @param {String/HTMLElement/Roo.Element} el The id or element to resize
79  * @param {Object} config configuration options
80   */
81 Roo.Resizable = function(el, config)
82 {
83     this.el = Roo.get(el);
84
85     if(config && config.wrap){
86         config.resizeChild = this.el;
87         this.el = this.el.wrap(typeof config.wrap == "object" ? config.wrap : {cls:"xresizable-wrap"});
88         this.el.id = this.el.dom.id = config.resizeChild.id + "-rzwrap";
89         this.el.setStyle("overflow", "hidden");
90         this.el.setPositioning(config.resizeChild.getPositioning());
91         config.resizeChild.clearPositioning();
92         if(!config.width || !config.height){
93             var csize = config.resizeChild.getSize();
94             this.el.setSize(csize.width, csize.height);
95         }
96         if(config.pinned && !config.adjustments){
97             config.adjustments = "auto";
98         }
99     }
100
101     this.proxy = this.el.createProxy({tag: "div", cls: "x-resizable-proxy", id: this.el.id + "-rzproxy"});
102     this.proxy.unselectable();
103     this.proxy.enableDisplayMode('block');
104
105     Roo.apply(this, config);
106
107     if(this.pinned){
108         this.disableTrackOver = true;
109         this.el.addClass("x-resizable-pinned");
110     }
111     // if the element isn't positioned, make it relative
112     var position = this.el.getStyle("position");
113     if(position != "absolute" && position != "fixed"){
114         this.el.setStyle("position", "relative");
115     }
116     if(!this.handles){ // no handles passed, must be legacy style
117         this.handles = 's,e,se';
118         if(this.multiDirectional){
119             this.handles += ',n,w';
120         }
121     }
122     if(this.handles == "all"){
123         this.handles = "n s e w ne nw se sw";
124     }
125     var hs = this.handles.split(/\s*?[,;]\s*?| /);
126     var ps = Roo.Resizable.positions;
127     for(var i = 0, len = hs.length; i < len; i++){
128         if(hs[i] && ps[hs[i]]){
129             var pos = ps[hs[i]];
130             this[pos] = new Roo.Resizable.Handle(this, pos, this.disableTrackOver, this.transparent);
131         }
132     }
133     // legacy
134     this.corner = this.southeast;
135     
136     // updateBox = the box can move..
137     if(this.handles.indexOf("n") != -1 || this.handles.indexOf("w") != -1 || this.handles.indexOf("hd") != -1) {
138         this.updateBox = true;
139     }
140
141     this.activeHandle = null;
142
143     if(this.resizeChild){
144         if(typeof this.resizeChild == "boolean"){
145             this.resizeChild = Roo.get(this.el.dom.firstChild, true);
146         }else{
147             this.resizeChild = Roo.get(this.resizeChild, true);
148         }
149     }
150     
151     if(this.adjustments == "auto"){
152         var rc = this.resizeChild;
153         var hw = this.west, he = this.east, hn = this.north, hs = this.south;
154         if(rc && (hw || hn)){
155             rc.position("relative");
156             rc.setLeft(hw ? hw.el.getWidth() : 0);
157             rc.setTop(hn ? hn.el.getHeight() : 0);
158         }
159         this.adjustments = [
160             (he ? -he.el.getWidth() : 0) + (hw ? -hw.el.getWidth() : 0),
161             (hn ? -hn.el.getHeight() : 0) + (hs ? -hs.el.getHeight() : 0) -1
162         ];
163     }
164
165     if(this.draggable){
166         this.dd = this.dynamic ?
167             this.el.initDD(null) : this.el.initDDProxy(null, {dragElId: this.proxy.id});
168         this.dd.setHandleElId(this.resizeChild ? this.resizeChild.id : this.el.id);
169     }
170
171     // public events
172     this.addEvents({
173         /**
174          * @event beforeresize
175          * Fired before resize is allowed. Set enabled to false to cancel resize.
176          * @param {Roo.Resizable} this
177          * @param {Roo.EventObject} e The mousedown event
178          */
179         "beforeresize" : true,
180         /**
181          * @event resize
182          * Fired after a resize.
183          * @param {Roo.Resizable} this
184          * @param {Number} width The new width
185          * @param {Number} height The new height
186          * @param {Roo.EventObject} e The mouseup event
187          */
188         "resize" : true
189     });
190
191     if(this.width !== null && this.height !== null){
192         this.resizeTo(this.width, this.height);
193     }else{
194         this.updateChildSize();
195     }
196     if(Roo.isIE){
197         this.el.dom.style.zoom = 1;
198     }
199     Roo.Resizable.superclass.constructor.call(this);
200 };
201
202 Roo.extend(Roo.Resizable, Roo.util.Observable, {
203         resizeChild : false,
204         adjustments : [0, 0],
205         minWidth : 5,
206         minHeight : 5,
207         maxWidth : 10000,
208         maxHeight : 10000,
209         enabled : true,
210         animate : false,
211         duration : .35,
212         dynamic : false,
213         handles : false,
214         multiDirectional : false,
215         disableTrackOver : false,
216         easing : 'easeOutStrong',
217         widthIncrement : 0,
218         heightIncrement : 0,
219         pinned : false,
220         width : null,
221         height : null,
222         preserveRatio : false,
223         transparent: false,
224         minX: 0,
225         minY: 0,
226         draggable: false,
227
228         /**
229          * @cfg {String/HTMLElement/Element} constrainTo Constrain the resize to a particular element
230          */
231         constrainTo: undefined,
232         /**
233          * @cfg {Roo.lib.Region} resizeRegion Constrain the resize to a particular region
234          */
235         resizeRegion: undefined,
236
237
238     /**
239      * Perform a manual resize
240      * @param {Number} width
241      * @param {Number} height
242      */
243     resizeTo : function(width, height){
244         this.el.setSize(width, height);
245         this.updateChildSize();
246         this.fireEvent("resize", this, width, height, null);
247     },
248
249     // private
250     startSizing : function(e, handle){
251         this.fireEvent("beforeresize", this, e);
252         if(this.enabled){ // 2nd enabled check in case disabled before beforeresize handler
253
254             if(!this.overlay){
255                 this.overlay = this.el.createProxy({tag: "div", cls: "x-resizable-overlay", html: "&#160;"});
256                 this.overlay.unselectable();
257                 this.overlay.enableDisplayMode("block");
258                 this.overlay.on("mousemove", this.onMouseMove, this);
259                 this.overlay.on("mouseup", this.onMouseUp, this);
260             }
261             this.overlay.setStyle("cursor", handle.el.getStyle("cursor"));
262
263             this.resizing = true;
264             this.startBox = this.el.getBox();
265             this.startPoint = e.getXY();
266             this.offsets = [(this.startBox.x + this.startBox.width) - this.startPoint[0],
267                             (this.startBox.y + this.startBox.height) - this.startPoint[1]];
268
269             this.overlay.setSize(Roo.lib.Dom.getViewWidth(true), Roo.lib.Dom.getViewHeight(true));
270             this.overlay.show();
271
272             if(this.constrainTo) {
273                 var ct = Roo.get(this.constrainTo);
274                 this.resizeRegion = ct.getRegion().adjust(
275                     ct.getFrameWidth('t'),
276                     ct.getFrameWidth('l'),
277                     -ct.getFrameWidth('b'),
278                     -ct.getFrameWidth('r')
279                 );
280             }
281
282             this.proxy.setStyle('visibility', 'hidden'); // workaround display none
283             this.proxy.show();
284             this.proxy.setBox(this.startBox);
285             if(!this.dynamic){
286                 this.proxy.setStyle('visibility', 'visible');
287             }
288         }
289     },
290
291     // private
292     onMouseDown : function(handle, e){
293         if(this.enabled){
294             e.stopEvent();
295             this.activeHandle = handle;
296             this.startSizing(e, handle);
297         }
298     },
299
300     // private
301     onMouseUp : function(e){
302         var size = this.resizeElement();
303         this.resizing = false;
304         this.handleOut();
305         this.overlay.hide();
306         this.proxy.hide();
307         this.fireEvent("resize", this, size.width, size.height, e);
308     },
309
310     // private
311     updateChildSize : function(){
312         if(this.resizeChild){
313             var el = this.el;
314             var child = this.resizeChild;
315             var adj = this.adjustments;
316             if(el.dom.offsetWidth){
317                 var b = el.getSize(true);
318                 child.setSize(b.width+adj[0], b.height+adj[1]);
319             }
320             // Second call here for IE
321             // The first call enables instant resizing and
322             // the second call corrects scroll bars if they
323             // exist
324             if(Roo.isIE){
325                 setTimeout(function(){
326                     if(el.dom.offsetWidth){
327                         var b = el.getSize(true);
328                         child.setSize(b.width+adj[0], b.height+adj[1]);
329                     }
330                 }, 10);
331             }
332         }
333     },
334
335     // private
336     snap : function(value, inc, min){
337         if(!inc || !value) return value;
338         var newValue = value;
339         var m = value % inc;
340         if(m > 0){
341             if(m > (inc/2)){
342                 newValue = value + (inc-m);
343             }else{
344                 newValue = value - m;
345             }
346         }
347         return Math.max(min, newValue);
348     },
349
350     // private
351     resizeElement : function(){
352         var box = this.proxy.getBox();
353         if(this.updateBox){
354             this.el.setBox(box, false, this.animate, this.duration, null, this.easing);
355         }else{
356             this.el.setSize(box.width, box.height, this.animate, this.duration, null, this.easing);
357         }
358         this.updateChildSize();
359         if(!this.dynamic){
360             this.proxy.hide();
361         }
362         return box;
363     },
364
365     // private
366     constrain : function(v, diff, m, mx){
367         if(v - diff < m){
368             diff = v - m;
369         }else if(v - diff > mx){
370             diff = mx - v;
371         }
372         return diff;
373     },
374
375     // private
376     onMouseMove : function(e){
377         if(this.enabled){
378             try{// try catch so if something goes wrong the user doesn't get hung
379
380             if(this.resizeRegion && !this.resizeRegion.contains(e.getPoint())) {
381                 return;
382             }
383
384             //var curXY = this.startPoint;
385             var curSize = this.curSize || this.startBox;
386             var x = this.startBox.x, y = this.startBox.y;
387             var ox = x, oy = y;
388             var w = curSize.width, h = curSize.height;
389             var ow = w, oh = h;
390             var mw = this.minWidth, mh = this.minHeight;
391             var mxw = this.maxWidth, mxh = this.maxHeight;
392             var wi = this.widthIncrement;
393             var hi = this.heightIncrement;
394
395             var eventXY = e.getXY();
396             var diffX = -(this.startPoint[0] - Math.max(this.minX, eventXY[0]));
397             var diffY = -(this.startPoint[1] - Math.max(this.minY, eventXY[1]));
398
399             var pos = this.activeHandle.position;
400
401             switch(pos){
402                 case "east":
403                     w += diffX;
404                     w = Math.min(Math.max(mw, w), mxw);
405                     break;
406              
407                 case "south":
408                     h += diffY;
409                     h = Math.min(Math.max(mh, h), mxh);
410                     break;
411                 case "southeast":
412                     w += diffX;
413                     h += diffY;
414                     w = Math.min(Math.max(mw, w), mxw);
415                     h = Math.min(Math.max(mh, h), mxh);
416                     break;
417                 case "north":
418                     diffY = this.constrain(h, diffY, mh, mxh);
419                     y += diffY;
420                     h -= diffY;
421                     break;
422                 case "hdrag":
423                     
424                     if (wi) {
425                         var adiffX = Math.abs(diffX);
426                         var sub = (adiffX % wi); // how much 
427                         if (sub > (wi/2)) { // far enough to snap
428                             diffX = (diffX > 0) ? diffX-sub + wi : diffX+sub - wi;
429                         } else {
430                             // remove difference.. 
431                             diffX = (diffX > 0) ? diffX-sub : diffX+sub;
432                         }
433                     }
434                     x += diffX;
435                     x = Math.max(this.minX, x);
436                     break;
437                 case "west":
438                     diffX = this.constrain(w, diffX, mw, mxw);
439                     x += diffX;
440                     w -= diffX;
441                     break;
442                 case "northeast":
443                     w += diffX;
444                     w = Math.min(Math.max(mw, w), mxw);
445                     diffY = this.constrain(h, diffY, mh, mxh);
446                     y += diffY;
447                     h -= diffY;
448                     break;
449                 case "northwest":
450                     diffX = this.constrain(w, diffX, mw, mxw);
451                     diffY = this.constrain(h, diffY, mh, mxh);
452                     y += diffY;
453                     h -= diffY;
454                     x += diffX;
455                     w -= diffX;
456                     break;
457                case "southwest":
458                     diffX = this.constrain(w, diffX, mw, mxw);
459                     h += diffY;
460                     h = Math.min(Math.max(mh, h), mxh);
461                     x += diffX;
462                     w -= diffX;
463                     break;
464             }
465
466             var sw = this.snap(w, wi, mw);
467             var sh = this.snap(h, hi, mh);
468             if(sw != w || sh != h){
469                 switch(pos){
470                     case "northeast":
471                         y -= sh - h;
472                     break;
473                     case "north":
474                         y -= sh - h;
475                         break;
476                     case "southwest":
477                         x -= sw - w;
478                     break;
479                     case "west":
480                         x -= sw - w;
481                         break;
482                     case "northwest":
483                         x -= sw - w;
484                         y -= sh - h;
485                     break;
486                 }
487                 w = sw;
488                 h = sh;
489             }
490
491             if(this.preserveRatio){
492                 switch(pos){
493                     case "southeast":
494                     case "east":
495                         h = oh * (w/ow);
496                         h = Math.min(Math.max(mh, h), mxh);
497                         w = ow * (h/oh);
498                        break;
499                     case "south":
500                         w = ow * (h/oh);
501                         w = Math.min(Math.max(mw, w), mxw);
502                         h = oh * (w/ow);
503                         break;
504                     case "northeast":
505                         w = ow * (h/oh);
506                         w = Math.min(Math.max(mw, w), mxw);
507                         h = oh * (w/ow);
508                     break;
509                     case "north":
510                         var tw = w;
511                         w = ow * (h/oh);
512                         w = Math.min(Math.max(mw, w), mxw);
513                         h = oh * (w/ow);
514                         x += (tw - w) / 2;
515                         break;
516                     case "southwest":
517                         h = oh * (w/ow);
518                         h = Math.min(Math.max(mh, h), mxh);
519                         var tw = w;
520                         w = ow * (h/oh);
521                         x += tw - w;
522                         break;
523                     case "west":
524                         var th = h;
525                         h = oh * (w/ow);
526                         h = Math.min(Math.max(mh, h), mxh);
527                         y += (th - h) / 2;
528                         var tw = w;
529                         w = ow * (h/oh);
530                         x += tw - w;
531                        break;
532                     case "northwest":
533                         var tw = w;
534                         var th = h;
535                         h = oh * (w/ow);
536                         h = Math.min(Math.max(mh, h), mxh);
537                         w = ow * (h/oh);
538                         y += th - h;
539                         x += tw - w;
540                        break;
541
542                 }
543             }
544             if (pos == 'hdrag') {
545                 w = ow;
546             }
547             this.proxy.setBounds(x, y, w, h);
548             if(this.dynamic){
549                 this.resizeElement();
550             }
551             }catch(e){}
552         }
553     },
554
555     // private
556     handleOver : function(){
557         if(this.enabled){
558             this.el.addClass("x-resizable-over");
559         }
560     },
561
562     // private
563     handleOut : function(){
564         if(!this.resizing){
565             this.el.removeClass("x-resizable-over");
566         }
567     },
568
569     /**
570      * Returns the element this component is bound to.
571      * @return {Roo.Element}
572      */
573     getEl : function(){
574         return this.el;
575     },
576
577     /**
578      * Returns the resizeChild element (or null).
579      * @return {Roo.Element}
580      */
581     getResizeChild : function(){
582         return this.resizeChild;
583     },
584
585     /**
586      * Destroys this resizable. If the element was wrapped and
587      * removeEl is not true then the element remains.
588      * @param {Boolean} removeEl (optional) true to remove the element from the DOM
589      */
590     destroy : function(removeEl){
591         this.proxy.remove();
592         if(this.overlay){
593             this.overlay.removeAllListeners();
594             this.overlay.remove();
595         }
596         var ps = Roo.Resizable.positions;
597         for(var k in ps){
598             if(typeof ps[k] != "function" && this[ps[k]]){
599                 var h = this[ps[k]];
600                 h.el.removeAllListeners();
601                 h.el.remove();
602             }
603         }
604         if(removeEl){
605             this.el.update("");
606             this.el.remove();
607         }
608     }
609 });
610
611 // private
612 // hash to map config positions to true positions
613 Roo.Resizable.positions = {
614     n: "north", s: "south", e: "east", w: "west", se: "southeast", sw: "southwest", nw: "northwest", ne: "northeast", 
615     hd: "hdrag"
616 };
617
618 // private
619 Roo.Resizable.Handle = function(rz, pos, disableTrackOver, transparent){
620     if(!this.tpl){
621         // only initialize the template if resizable is used
622         var tpl = Roo.DomHelper.createTemplate(
623             {tag: "div", cls: "x-resizable-handle x-resizable-handle-{0}"}
624         );
625         tpl.compile();
626         Roo.Resizable.Handle.prototype.tpl = tpl;
627     }
628     this.position = pos;
629     this.rz = rz;
630     // show north drag fro topdra
631     var handlepos = pos == 'hdrag' ? 'north' : pos;
632     
633     this.el = this.tpl.append(rz.el.dom, [handlepos], true);
634     if (pos == 'hdrag') {
635         this.el.setStyle('cursor', 'pointer');
636     }
637     this.el.unselectable();
638     if(transparent){
639         this.el.setOpacity(0);
640     }
641     this.el.on("mousedown", this.onMouseDown, this);
642     if(!disableTrackOver){
643         this.el.on("mouseover", this.onMouseOver, this);
644         this.el.on("mouseout", this.onMouseOut, this);
645     }
646 };
647
648 // private
649 Roo.Resizable.Handle.prototype = {
650     afterResize : function(rz){
651         // do nothing
652     },
653     // private
654     onMouseDown : function(e){
655         this.rz.onMouseDown(this, e);
656     },
657     // private
658     onMouseOver : function(e){
659         this.rz.handleOver(this, e);
660     },
661     // private
662     onMouseOut : function(e){
663         this.rz.handleOut(this, e);
664     }
665 };