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">
13 // was in Composite Element!??!?!
17 var E = Roo.lib.Event;
20 // local style camelizing for speed
22 var camelRe = /(-[a-z])/gi;
23 var camelFn = function(m, a){ return a.charAt(1).toUpperCase(); };
24 var view = document.defaultView;
28 * Represents an Element in the DOM.<br><br>
31 var el = Roo.get("my-div");
34 var el = getEl("my-div");
36 // or with a DOM element
37 var el = Roo.get(myDivElement);
39 * Using Roo.get() or getEl() instead of calling the constructor directly ensures you get the same object
40 * each call instead of constructing a new one.<br><br>
41 * <b>Animations</b><br />
42 * Many of the functions for manipulating an element have an optional "animate" parameter. The animate parameter
43 * should either be a boolean (true) or an object literal with animation options. The animation options are:
45 Option Default Description
46 --------- -------- ---------------------------------------------
47 duration .35 The duration of the animation in seconds
48 easing easeOut The YUI easing method
49 callback none A function to execute when the anim completes
50 scope this The scope (this) of the callback function
52 * Also, the Anim object being used for the animation will be set on your options object as "anim", which allows you to stop or
53 * manipulate the animation. Here's an example:
55 var el = Roo.get("my-div");
61 el.setWidth(100, true);
63 // animation with some options set
70 // using the "anim" property to get the Anim object
76 el.setWidth(100, opt);
78 if(opt.anim.isAnimated()){
82 * <b> Composite (Collections of) Elements</b><br />
83 * For working with collections of Elements, see <a href="Roo.CompositeElement.html">Roo.CompositeElement</a>
84 * @constructor Create a new Element directly.
85 * @param {String/HTMLElement} element
86 * @param {Boolean} forceNew (optional) By default the constructor checks to see if there is already an instance of this element in the cache and if there is it returns the same instance. This will skip that check (useful for extending this class).
88 Roo.Element = function(element, forceNew){
89 var dom = typeof element == "string" ?
90 document.getElementById(element) : element;
91 if(!dom){ // invalid id/element
95 if(forceNew !== true && id && Roo.Element.cache[id]){ // element object already exists
96 return Roo.Element.cache[id];
109 this.id = id || Roo.id(dom);
112 var El = Roo.Element;
116 * The element's default display mode (defaults to "")
119 originalDisplay : "",
123 * The default unit to append to CSS values where a unit isn't provided (defaults to px).
128 pxReg : /^\d+(?:\.\d*)?px$/i,
130 * Sets the element's visibility mode. When setVisible() is called it
131 * will use this to determine whether to set the visibility or the display property.
132 * @param visMode Element.VISIBILITY or Element.DISPLAY
133 * @return {Roo.Element} this
135 setVisibilityMode : function(visMode){
136 this.visibilityMode = visMode;
140 * Convenience method for setVisibilityMode(Element.DISPLAY)
141 * @param {String} display (optional) What to set display to when visible
142 * @return {Roo.Element} this
144 enableDisplayMode : function(display){
145 this.setVisibilityMode(El.DISPLAY);
146 if(typeof display != "undefined") this.originalDisplay = display;
151 * Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)
152 * @param {String} selector The simple selector to test
153 * @param {Number/String/HTMLElement/Element} maxDepth (optional) The max depth to
154 search as a number or element (defaults to 10 || document.body)
155 * @param {Boolean} returnEl (optional) True to return a Roo.Element object instead of DOM node
156 * @return {HTMLElement} The matching DOM node (or null if no match was found)
158 findParent : function(simpleSelector, maxDepth, returnEl){
159 var p = this.dom, b = document.body, depth = 0, dq = Roo.DomQuery, stopEl;
160 maxDepth = maxDepth || 50;
161 if(typeof maxDepth != "number"){
162 stopEl = Roo.getDom(maxDepth);
165 while(p && p.nodeType == 1 && depth < maxDepth && p != b && p != stopEl){
166 if(dq.is(p, simpleSelector)){
167 return returnEl ? Roo.get(p) : p;
177 * Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)
178 * @param {String} selector The simple selector to test
179 * @param {Number/String/HTMLElement/Element} maxDepth (optional) The max depth to
180 search as a number or element (defaults to 10 || document.body)
181 * @param {Boolean} returnEl (optional) True to return a Roo.Element object instead of DOM node
182 * @return {HTMLElement} The matching DOM node (or null if no match was found)
184 findParentNode : function(simpleSelector, maxDepth, returnEl){
185 var p = Roo.fly(this.dom.parentNode, '_internal');
186 return p ? p.findParent(simpleSelector, maxDepth, returnEl) : null;
190 * Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first-child).
191 * This is a shortcut for findParentNode() that always returns an Roo.Element.
192 * @param {String} selector The simple selector to test
193 * @param {Number/String/HTMLElement/Element} maxDepth (optional) The max depth to
194 search as a number or element (defaults to 10 || document.body)
195 * @return {Roo.Element} The matching DOM node (or null if no match was found)
197 up : function(simpleSelector, maxDepth){
198 return this.findParentNode(simpleSelector, maxDepth, true);
204 * Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child)
205 * @param {String} selector The simple selector to test
206 * @return {Boolean} True if this element matches the selector, else false
208 is : function(simpleSelector){
209 return Roo.DomQuery.is(this.dom, simpleSelector);
213 * Perform animation on this element.
214 * @param {Object} args The YUI animation control args
215 * @param {Float} duration (optional) How long the animation lasts in seconds (defaults to .35)
216 * @param {Function} onComplete (optional) Function to call when animation completes
217 * @param {String} easing (optional) Easing method to use (defaults to 'easeOut')
218 * @param {String} animType (optional) 'run' is the default. Can also be 'color', 'motion', or 'scroll'
219 * @return {Roo.Element} this
221 animate : function(args, duration, onComplete, easing, animType){
222 this.anim(args, {duration: duration, callback: onComplete, easing: easing}, animType);
227 * @private Internal animation call
229 anim : function(args, opt, animType, defaultDur, defaultEase, cb){
230 animType = animType || 'run';
232 var anim = Roo.lib.Anim[animType](
234 (opt.duration || defaultDur) || .35,
235 (opt.easing || defaultEase) || 'easeOut',
237 Roo.callback(cb, this);
238 Roo.callback(opt.callback, opt.scope || this, [this, opt]);
246 // private legacy anim prep
247 preanim : function(a, i){
248 return !a[i] ? false : (typeof a[i] == "object" ? a[i]: {duration: a[i+1], callback: a[i+2], easing: a[i+3]});
252 * Removes worthless text nodes
253 * @param {Boolean} forceReclean (optional) By default the element
254 * keeps track if it has been cleaned already so
255 * you can call this over and over. However, if you update the element and
256 * need to force a reclean, you can pass true.
258 clean : function(forceReclean){
259 if(this.isCleaned && forceReclean !== true){
263 var d = this.dom, n = d.firstChild, ni = -1;
265 var nx = n.nextSibling;
266 if(n.nodeType == 3 && !ns.test(n.nodeValue)){
273 this.isCleaned = true;
278 calcOffsetsTo : function(el){
281 var restorePos = false;
282 if(el.getStyle('position') == 'static'){
283 el.position('relative');
288 while(op && op != d && op.tagName != 'HTML'){
291 op = op.offsetParent;
294 el.position('static');
300 * Scrolls this element into view within the passed container.
301 * @param {String/HTMLElement/Element} container (optional) The container element to scroll (defaults to document.body)
302 * @param {Boolean} hscroll (optional) False to disable horizontal scroll (defaults to true)
303 * @return {Roo.Element} this
305 scrollIntoView : function(container, hscroll){
306 var c = Roo.getDom(container) || document.body;
309 var o = this.calcOffsetsTo(c),
312 b = t+el.offsetHeight,
313 r = l+el.offsetWidth;
315 var ch = c.clientHeight;
316 var ct = parseInt(c.scrollTop, 10);
317 var cl = parseInt(c.scrollLeft, 10);
319 var cr = cl + c.clientWidth;
327 if(hscroll !== false){
331 c.scrollLeft = r-c.clientWidth;
338 scrollChildIntoView : function(child, hscroll){
339 Roo.fly(child, '_scrollChildIntoView').scrollIntoView(this, hscroll);
343 * Measures the element's content height and updates height to match. Note: this function uses setTimeout so
344 * the new height may not be available immediately.
345 * @param {Boolean} animate (optional) Animate the transition (defaults to false)
346 * @param {Float} duration (optional) Length of the animation in seconds (defaults to .35)
347 * @param {Function} onComplete (optional) Function to call when animation completes
348 * @param {String} easing (optional) Easing method to use (defaults to easeOut)
349 * @return {Roo.Element} this
351 autoHeight : function(animate, duration, onComplete, easing){
352 var oldHeight = this.getHeight();
354 this.setHeight(1); // force clipping
355 setTimeout(function(){
356 var height = parseInt(this.dom.scrollHeight, 10); // parseInt for Safari
358 this.setHeight(height);
360 if(typeof onComplete == "function"){
364 this.setHeight(oldHeight); // restore original height
365 this.setHeight(height, animate, duration, function(){
367 if(typeof onComplete == "function") onComplete();
368 }.createDelegate(this), easing);
370 }.createDelegate(this), 0);
375 * Returns true if this element is an ancestor of the passed element
376 * @param {HTMLElement/String} el The element to check
377 * @return {Boolean} True if this element is an ancestor of el, else false
379 contains : function(el){
380 if(!el){return false;}
381 return D.isAncestor(this.dom, el.dom ? el.dom : el);
385 * Checks whether the element is currently visible using both visibility and display properties.
386 * @param {Boolean} deep (optional) True to walk the dom and see if parent elements are hidden (defaults to false)
387 * @return {Boolean} True if the element is currently visible, else false
389 isVisible : function(deep) {
390 var vis = !(this.getStyle("visibility") == "hidden" || this.getStyle("display") == "none");
391 if(deep !== true || !vis){
394 var p = this.dom.parentNode;
395 while(p && p.tagName.toLowerCase() != "body"){
396 if(!Roo.fly(p, '_isVisible').isVisible()){
405 * Creates a {@link Roo.CompositeElement} for child nodes based on the passed CSS selector (the selector should not contain an id).
406 * @param {String} selector The CSS selector
407 * @param {Boolean} unique (optional) True to create a unique Roo.Element for each child (defaults to false, which creates a single shared flyweight object)
408 * @return {CompositeElement/CompositeElementLite} The composite element
410 select : function(selector, unique){
411 return El.select(selector, unique, this.dom);
415 * Selects child nodes based on the passed CSS selector (the selector should not contain an id).
416 * @param {String} selector The CSS selector
417 * @return {Array} An array of the matched nodes
419 query : function(selector, unique){
420 return Roo.DomQuery.select(selector, this.dom);
424 * Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id).
425 * @param {String} selector The CSS selector
426 * @param {Boolean} returnDom (optional) True to return the DOM node instead of Roo.Element (defaults to false)
427 * @return {HTMLElement/Roo.Element} The child Roo.Element (or DOM node if returnDom = true)
429 child : function(selector, returnDom){
430 var n = Roo.DomQuery.selectNode(selector, this.dom);
431 return returnDom ? n : Roo.get(n);
435 * Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id).
436 * @param {String} selector The CSS selector
437 * @param {Boolean} returnDom (optional) True to return the DOM node instead of Roo.Element (defaults to false)
438 * @return {HTMLElement/Roo.Element} The child Roo.Element (or DOM node if returnDom = true)
440 down : function(selector, returnDom){
441 var n = Roo.DomQuery.selectNode(" > " + selector, this.dom);
442 return returnDom ? n : Roo.get(n);
446 * Initializes a {@link Roo.dd.DD} drag drop object for this element.
447 * @param {String} group The group the DD object is member of
448 * @param {Object} config The DD config object
449 * @param {Object} overrides An object containing methods to override/implement on the DD object
450 * @return {Roo.dd.DD} The DD object
452 initDD : function(group, config, overrides){
453 var dd = new Roo.dd.DD(Roo.id(this.dom), group, config);
454 return Roo.apply(dd, overrides);
458 * Initializes a {@link Roo.dd.DDProxy} object for this element.
459 * @param {String} group The group the DDProxy object is member of
460 * @param {Object} config The DDProxy config object
461 * @param {Object} overrides An object containing methods to override/implement on the DDProxy object
462 * @return {Roo.dd.DDProxy} The DDProxy object
464 initDDProxy : function(group, config, overrides){
465 var dd = new Roo.dd.DDProxy(Roo.id(this.dom), group, config);
466 return Roo.apply(dd, overrides);
470 * Initializes a {@link Roo.dd.DDTarget} object for this element.
471 * @param {String} group The group the DDTarget object is member of
472 * @param {Object} config The DDTarget config object
473 * @param {Object} overrides An object containing methods to override/implement on the DDTarget object
474 * @return {Roo.dd.DDTarget} The DDTarget object
476 initDDTarget : function(group, config, overrides){
477 var dd = new Roo.dd.DDTarget(Roo.id(this.dom), group, config);
478 return Roo.apply(dd, overrides);
482 * Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use
483 * the display property to hide the element, otherwise it uses visibility. The default is to hide and show using the visibility property.
484 * @param {Boolean} visible Whether the element is visible
485 * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object
486 * @return {Roo.Element} this
488 setVisible : function(visible, animate){
490 if(this.visibilityMode == El.DISPLAY){
491 this.setDisplayed(visible);
494 this.dom.style.visibility = visible ? "visible" : "hidden";
497 // closure for composites
499 var visMode = this.visibilityMode;
501 this.setOpacity(.01);
502 this.setVisible(true);
504 this.anim({opacity: { to: (visible?1:0) }},
505 this.preanim(arguments, 1),
506 null, .35, 'easeIn', function(){
508 if(visMode == El.DISPLAY){
509 dom.style.display = "none";
511 dom.style.visibility = "hidden";
513 Roo.get(dom).setOpacity(1);
521 * Returns true if display is not "none"
524 isDisplayed : function() {
525 return this.getStyle("display") != "none";
529 * Toggles the element's visibility or display, depending on visibility mode.
530 * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object
531 * @return {Roo.Element} this
533 toggle : function(animate){
534 this.setVisible(!this.isVisible(), this.preanim(arguments, 0));
539 * Sets the CSS display property. Uses originalDisplay if the specified value is a boolean true.
540 * @param {Boolean} value Boolean value to display the element using its default display, or a string to set the display directly
541 * @return {Roo.Element} this
543 setDisplayed : function(value) {
544 if(typeof value == "boolean"){
545 value = value ? this.originalDisplay : "none";
547 this.setStyle("display", value);
552 * Tries to focus the element. Any exceptions are caught and ignored.
553 * @return {Roo.Element} this
563 * Tries to blur the element. Any exceptions are caught and ignored.
564 * @return {Roo.Element} this
574 * Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.
575 * @param {String/Array} className The CSS class to add, or an array of classes
576 * @return {Roo.Element} this
578 addClass : function(className){
579 if(className instanceof Array){
580 for(var i = 0, len = className.length; i < len; i++) {
581 this.addClass(className[i]);
584 if(className && !this.hasClass(className)){
585 this.dom.className = this.dom.className + " " + className;
592 * Adds one or more CSS classes to this element and removes the same class(es) from all siblings.
593 * @param {String/Array} className The CSS class to add, or an array of classes
594 * @return {Roo.Element} this
596 radioClass : function(className){
597 var siblings = this.dom.parentNode.childNodes;
598 for(var i = 0; i < siblings.length; i++) {
601 Roo.get(s).removeClass(className);
604 this.addClass(className);
609 * Removes one or more CSS classes from the element.
610 * @param {String/Array} className The CSS class to remove, or an array of classes
611 * @return {Roo.Element} this
613 removeClass : function(className){
614 if(!className || !this.dom.className){
617 if(className instanceof Array){
618 for(var i = 0, len = className.length; i < len; i++) {
619 this.removeClass(className[i]);
622 if(this.hasClass(className)){
623 var re = this.classReCache[className];
625 re = new RegExp('(?:^|\\s+)' + className + '(?:\\s+|$)', "g");
626 this.classReCache[className] = re;
629 this.dom.className.replace(re, " ");
639 * Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it).
640 * @param {String} className The CSS class to toggle
641 * @return {Roo.Element} this
643 toggleClass : function(className){
644 if(this.hasClass(className)){
645 this.removeClass(className);
647 this.addClass(className);
653 * Checks if the specified CSS class exists on this element's DOM node.
654 * @param {String} className The CSS class to check for
655 * @return {Boolean} True if the class exists, else false
657 hasClass : function(className){
658 return className && (' '+this.dom.className+' ').indexOf(' '+className+' ') != -1;
662 * Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added.
663 * @param {String} oldClassName The CSS class to replace
664 * @param {String} newClassName The replacement CSS class
665 * @return {Roo.Element} this
667 replaceClass : function(oldClassName, newClassName){
668 this.removeClass(oldClassName);
669 this.addClass(newClassName);
674 * Returns an object with properties matching the styles requested.
675 * For example, el.getStyles('color', 'font-size', 'width') might return
676 * {'color': '#FFFFFF', 'font-size': '13px', 'width': '100px'}.
677 * @param {String} style1 A style name
678 * @param {String} style2 A style name
679 * @param {String} etc.
680 * @return {Object} The style object
682 getStyles : function(){
683 var a = arguments, len = a.length, r = {};
684 for(var i = 0; i < len; i++){
685 r[a[i]] = this.getStyle(a[i]);
691 * Normalizes currentStyle and computedStyle. This is not YUI getStyle, it is an optimised version.
692 * @param {String} property The style property whose value is returned.
693 * @return {String} The current value of the style property for this element.
695 getStyle : function(){
696 return view && view.getComputedStyle ?
698 var el = this.dom, v, cs, camel;
702 if(el.style && (v = el.style[prop])){
705 if(cs = view.getComputedStyle(el, "")){
706 if(!(camel = propCache[prop])){
707 camel = propCache[prop] = prop.replace(camelRe, camelFn);
714 var el = this.dom, v, cs, camel;
715 if(prop == 'opacity'){
716 if(typeof el.style.filter == 'string'){
717 var m = el.style.filter.match(/alpha\(opacity=(.*)\)/i);
719 var fv = parseFloat(m[1]);
721 return fv ? fv / 100 : 0;
726 }else if(prop == 'float'){
729 if(!(camel = propCache[prop])){
730 camel = propCache[prop] = prop.replace(camelRe, camelFn);
732 if(v = el.style[camel]){
735 if(cs = el.currentStyle){
743 * Wrapper for setting style properties, also takes single object parameter of multiple styles.
744 * @param {String/Object} property The style property to be set, or an object of multiple styles.
745 * @param {String} value (optional) The value to apply to the given property, or null if an object was passed.
746 * @return {Roo.Element} this
748 setStyle : function(prop, value){
749 if(typeof prop == "string"){
751 if (prop == 'float') {
752 this.setStyle(Roo.isIE ? 'styleFloat' : 'cssFloat', value);
757 if(!(camel = propCache[prop])){
758 camel = propCache[prop] = prop.replace(camelRe, camelFn);
761 if(camel == 'opacity') {
762 this.setOpacity(value);
764 this.dom.style[camel] = value;
767 for(var style in prop){
768 if(typeof prop[style] != "function"){
769 this.setStyle(style, prop[style]);
777 * More flexible version of {@link #setStyle} for setting style properties.
778 * @param {String/Object/Function} styles A style specification string, e.g. "width:100px", or object in the form {width:"100px"}, or
779 * a function which returns such a specification.
780 * @return {Roo.Element} this
782 applyStyles : function(style){
783 Roo.DomHelper.applyStyles(this.dom, style);
788 * Gets the current X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
789 * @return {Number} The X position of the element
792 return D.getX(this.dom);
796 * Gets the current Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
797 * @return {Number} The Y position of the element
800 return D.getY(this.dom);
804 * Gets the current position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
805 * @return {Array} The XY position of the element
808 return D.getXY(this.dom);
812 * Sets the X position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
813 * @param {Number} The X position of the element
814 * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object
815 * @return {Roo.Element} this
817 setX : function(x, animate){
821 this.setXY([x, this.getY()], this.preanim(arguments, 1));
827 * Sets the Y position of the element based on page coordinates. Element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
828 * @param {Number} The Y position of the element
829 * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object
830 * @return {Roo.Element} this
832 setY : function(y, animate){
836 this.setXY([this.getX(), y], this.preanim(arguments, 1));
842 * Sets the element's left position directly using CSS style (instead of {@link #setX}).
843 * @param {String} left The left CSS property value
844 * @return {Roo.Element} this
846 setLeft : function(left){
847 this.setStyle("left", this.addUnits(left));
852 * Sets the element's top position directly using CSS style (instead of {@link #setY}).
853 * @param {String} top The top CSS property value
854 * @return {Roo.Element} this
856 setTop : function(top){
857 this.setStyle("top", this.addUnits(top));
862 * Sets the element's CSS right style.
863 * @param {String} right The right CSS property value
864 * @return {Roo.Element} this
866 setRight : function(right){
867 this.setStyle("right", this.addUnits(right));
872 * Sets the element's CSS bottom style.
873 * @param {String} bottom The bottom CSS property value
874 * @return {Roo.Element} this
876 setBottom : function(bottom){
877 this.setStyle("bottom", this.addUnits(bottom));
882 * Sets the position of the element in page coordinates, regardless of how the element is positioned.
883 * The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
884 * @param {Array} pos Contains X & Y [x, y] values for new position (coordinates are page-based)
885 * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object
886 * @return {Roo.Element} this
888 setXY : function(pos, animate){
890 D.setXY(this.dom, pos);
892 this.anim({points: {to: pos}}, this.preanim(arguments, 1), 'motion');
898 * Sets the position of the element in page coordinates, regardless of how the element is positioned.
899 * The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
900 * @param {Number} x X value for new position (coordinates are page-based)
901 * @param {Number} y Y value for new position (coordinates are page-based)
902 * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object
903 * @return {Roo.Element} this
905 setLocation : function(x, y, animate){
906 this.setXY([x, y], this.preanim(arguments, 2));
911 * Sets the position of the element in page coordinates, regardless of how the element is positioned.
912 * The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
913 * @param {Number} x X value for new position (coordinates are page-based)
914 * @param {Number} y Y value for new position (coordinates are page-based)
915 * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object
916 * @return {Roo.Element} this
918 moveTo : function(x, y, animate){
919 this.setXY([x, y], this.preanim(arguments, 2));
924 * Returns the region of the given element.
925 * The element must be part of the DOM tree to have a region (display:none or elements not appended return false).
926 * @return {Region} A Roo.lib.Region containing "top, left, bottom, right" member data.
928 getRegion : function(){
929 return D.getRegion(this.dom);
933 * Returns the offset height of the element
934 * @param {Boolean} contentHeight (optional) true to get the height minus borders and padding
935 * @return {Number} The element's height
937 getHeight : function(contentHeight){
938 var h = this.dom.offsetHeight || 0;
939 return contentHeight !== true ? h : h-this.getBorderWidth("tb")-this.getPadding("tb");
943 * Returns the offset width of the element
944 * @param {Boolean} contentWidth (optional) true to get the width minus borders and padding
945 * @return {Number} The element's width
947 getWidth : function(contentWidth){
948 var w = this.dom.offsetWidth || 0;
949 return contentWidth !== true ? w : w-this.getBorderWidth("lr")-this.getPadding("lr");
953 * Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders
954 * when needed to simulate offsetHeight when offsets aren't available. This may not work on display:none elements
955 * if a height has not been set using CSS.
958 getComputedHeight : function(){
959 var h = Math.max(this.dom.offsetHeight, this.dom.clientHeight);
961 h = parseInt(this.getStyle('height'), 10) || 0;
962 if(!this.isBorderBox()){
963 h += this.getFrameWidth('tb');
970 * Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders
971 * when needed to simulate offsetWidth when offsets aren't available. This may not work on display:none elements
972 * if a width has not been set using CSS.
975 getComputedWidth : function(){
976 var w = Math.max(this.dom.offsetWidth, this.dom.clientWidth);
978 w = parseInt(this.getStyle('width'), 10) || 0;
979 if(!this.isBorderBox()){
980 w += this.getFrameWidth('lr');
987 * Returns the size of the element.
988 * @param {Boolean} contentSize (optional) true to get the width/size minus borders and padding
989 * @return {Object} An object containing the element's size {width: (element width), height: (element height)}
991 getSize : function(contentSize){
992 return {width: this.getWidth(contentSize), height: this.getHeight(contentSize)};
996 * Returns the width and height of the viewport.
997 * @return {Object} An object containing the viewport's size {width: (viewport width), height: (viewport height)}
999 getViewSize : function(){
1000 var d = this.dom, doc = document, aw = 0, ah = 0;
1001 if(d == doc || d == doc.body){
1002 return {width : D.getViewWidth(), height: D.getViewHeight()};
1005 width : d.clientWidth,
1006 height: d.clientHeight
1012 * Returns the value of the "value" attribute
1013 * @param {Boolean} asNumber true to parse the value as a number
1014 * @return {String/Number}
1016 getValue : function(asNumber){
1017 return asNumber ? parseInt(this.dom.value, 10) : this.dom.value;
1021 adjustWidth : function(width){
1022 if(typeof width == "number"){
1023 if(this.autoBoxAdjust && !this.isBorderBox()){
1024 width -= (this.getBorderWidth("lr") + this.getPadding("lr"));
1034 adjustHeight : function(height){
1035 if(typeof height == "number"){
1036 if(this.autoBoxAdjust && !this.isBorderBox()){
1037 height -= (this.getBorderWidth("tb") + this.getPadding("tb"));
1047 * Set the width of the element
1048 * @param {Number} width The new width
1049 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1050 * @return {Roo.Element} this
1052 setWidth : function(width, animate){
1053 width = this.adjustWidth(width);
1055 this.dom.style.width = this.addUnits(width);
1057 this.anim({width: {to: width}}, this.preanim(arguments, 1));
1063 * Set the height of the element
1064 * @param {Number} height The new height
1065 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1066 * @return {Roo.Element} this
1068 setHeight : function(height, animate){
1069 height = this.adjustHeight(height);
1071 this.dom.style.height = this.addUnits(height);
1073 this.anim({height: {to: height}}, this.preanim(arguments, 1));
1079 * Set the size of the element. If animation is true, both width an height will be animated concurrently.
1080 * @param {Number} width The new width
1081 * @param {Number} height The new height
1082 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1083 * @return {Roo.Element} this
1085 setSize : function(width, height, animate){
1086 if(typeof width == "object"){ // in case of object from getSize()
1087 height = width.height; width = width.width;
1089 width = this.adjustWidth(width); height = this.adjustHeight(height);
1091 this.dom.style.width = this.addUnits(width);
1092 this.dom.style.height = this.addUnits(height);
1094 this.anim({width: {to: width}, height: {to: height}}, this.preanim(arguments, 2));
1100 * Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated concurrently.
1101 * @param {Number} x X value for new position (coordinates are page-based)
1102 * @param {Number} y Y value for new position (coordinates are page-based)
1103 * @param {Number} width The new width
1104 * @param {Number} height The new height
1105 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1106 * @return {Roo.Element} this
1108 setBounds : function(x, y, width, height, animate){
1110 this.setSize(width, height);
1111 this.setLocation(x, y);
1113 width = this.adjustWidth(width); height = this.adjustHeight(height);
1114 this.anim({points: {to: [x, y]}, width: {to: width}, height: {to: height}},
1115 this.preanim(arguments, 4), 'motion');
1121 * Sets the element's position and size the the specified region. If animation is true then width, height, x and y will be animated concurrently.
1122 * @param {Roo.lib.Region} region The region to fill
1123 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1124 * @return {Roo.Element} this
1126 setRegion : function(region, animate){
1127 this.setBounds(region.left, region.top, region.right-region.left, region.bottom-region.top, this.preanim(arguments, 1));
1132 * Appends an event handler
1134 * @param {String} eventName The type of event to append
1135 * @param {Function} fn The method the event invokes
1136 * @param {Object} scope (optional) The scope (this object) of the fn
1137 * @param {Object} options (optional)An object with standard {@link Roo.EventManager#addListener} options
1139 addListener : function(eventName, fn, scope, options){
1141 Roo.EventManager.on(this.dom, eventName, fn, scope || this, options);
1146 * Removes an event handler from this element
1147 * @param {String} eventName the type of event to remove
1148 * @param {Function} fn the method the event invokes
1149 * @return {Roo.Element} this
1151 removeListener : function(eventName, fn){
1152 Roo.EventManager.removeListener(this.dom, eventName, fn);
1157 * Removes all previous added listeners from this element
1158 * @return {Roo.Element} this
1160 removeAllListeners : function(){
1161 E.purgeElement(this.dom);
1165 relayEvent : function(eventName, observable){
1166 this.on(eventName, function(e){
1167 observable.fireEvent(eventName, e);
1172 * Set the opacity of the element
1173 * @param {Float} opacity The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc
1174 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1175 * @return {Roo.Element} this
1177 setOpacity : function(opacity, animate){
1179 var s = this.dom.style;
1182 s.filter = (s.filter || '').replace(/alpha\([^\)]*\)/gi,"") +
1183 (opacity == 1 ? "" : "alpha(opacity=" + opacity * 100 + ")");
1185 s.opacity = opacity;
1188 this.anim({opacity: {to: opacity}}, this.preanim(arguments, 1), null, .35, 'easeIn');
1194 * Gets the left X coordinate
1195 * @param {Boolean} local True to get the local css position instead of page coordinate
1198 getLeft : function(local){
1203 return parseInt(this.getStyle("left"), 10) || 0;
1205 var x = this.getStyle("left");
1207 if(!x || x === 'AUTO'){
1211 if(this.pxReg.test(x)){
1212 return parseFloat(x);
1217 // var par = this.dom.offsetParent ? Roo.fly(this.dom.offsetParent) : false;
1219 // if (par !== false) {
1228 * Gets the right X coordinate of the element (element X position + element width)
1229 * @param {Boolean} local True to get the local css position instead of page coordinate
1232 getRight : function(local){
1234 return this.getX() + this.getWidth();
1236 return (this.getLeft(true) + this.getWidth()) || 0;
1241 * Gets the top Y coordinate
1242 * @param {Boolean} local True to get the local css position instead of page coordinate
1245 getTop : function(local) {
1249 return parseInt(this.getStyle("top"), 10) || 0;
1254 * Gets the bottom Y coordinate of the element (element Y position + element height)
1255 * @param {Boolean} local True to get the local css position instead of page coordinate
1258 getBottom : function(local){
1260 return this.getY() + this.getHeight();
1262 return (this.getTop(true) + this.getHeight()) || 0;
1267 * Initializes positioning on this element. If a desired position is not passed, it will make the
1268 * the element positioned relative IF it is not already positioned.
1269 * @param {String} pos (optional) Positioning to use "relative", "absolute" or "fixed"
1270 * @param {Number} zIndex (optional) The zIndex to apply
1271 * @param {Number} x (optional) Set the page X position
1272 * @param {Number} y (optional) Set the page Y position
1274 position : function(pos, zIndex, x, y){
1276 if(this.getStyle('position') == 'static'){
1277 this.setStyle('position', 'relative');
1280 this.setStyle("position", pos);
1283 this.setStyle("z-index", zIndex);
1285 if(x !== undefined && y !== undefined){
1287 }else if(x !== undefined){
1289 }else if(y !== undefined){
1295 * Clear positioning back to the default when the document was loaded
1296 * @param {String} value (optional) The value to use for the left,right,top,bottom, defaults to '' (empty string). You could use 'auto'.
1297 * @return {Roo.Element} this
1299 clearPositioning : function(value){
1307 "position" : "static"
1313 * Gets an object with all CSS positioning properties. Useful along with setPostioning to get
1314 * snapshot before performing an update and then restoring the element.
1317 getPositioning : function(){
1318 var l = this.getStyle("left");
1319 var t = this.getStyle("top");
1321 "position" : this.getStyle("position"),
1323 "right" : l ? "" : this.getStyle("right"),
1325 "bottom" : t ? "" : this.getStyle("bottom"),
1326 "z-index" : this.getStyle("z-index")
1331 * Gets the width of the border(s) for the specified side(s)
1332 * @param {String} side Can be t, l, r, b or any combination of those to add multiple values. For example,
1333 * passing lr would get the border (l)eft width + the border (r)ight width.
1334 * @return {Number} The width of the sides passed added together
1336 getBorderWidth : function(side){
1337 return this.addStyles(side, El.borders);
1341 * Gets the width of the padding(s) for the specified side(s)
1342 * @param {String} side Can be t, l, r, b or any combination of those to add multiple values. For example,
1343 * passing lr would get the padding (l)eft + the padding (r)ight.
1344 * @return {Number} The padding of the sides passed added together
1346 getPadding : function(side){
1347 return this.addStyles(side, El.paddings);
1351 * Set positioning with an object returned by getPositioning().
1352 * @param {Object} posCfg
1353 * @return {Roo.Element} this
1355 setPositioning : function(pc){
1356 this.applyStyles(pc);
1357 if(pc.right == "auto"){
1358 this.dom.style.right = "";
1360 if(pc.bottom == "auto"){
1361 this.dom.style.bottom = "";
1367 fixDisplay : function(){
1368 if(this.getStyle("display") == "none"){
1369 this.setStyle("visibility", "hidden");
1370 this.setStyle("display", this.originalDisplay); // first try reverting to default
1371 if(this.getStyle("display") == "none"){ // if that fails, default to block
1372 this.setStyle("display", "block");
1378 * Quick set left and top adding default units
1379 * @param {String} left The left CSS property value
1380 * @param {String} top The top CSS property value
1381 * @return {Roo.Element} this
1383 setLeftTop : function(left, top){
1384 this.dom.style.left = this.addUnits(left);
1385 this.dom.style.top = this.addUnits(top);
1390 * Move this element relative to its current position.
1391 * @param {String} direction Possible values are: "l","left" - "r","right" - "t","top","up" - "b","bottom","down".
1392 * @param {Number} distance How far to move the element in pixels
1393 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1394 * @return {Roo.Element} this
1396 move : function(direction, distance, animate){
1397 var xy = this.getXY();
1398 direction = direction.toLowerCase();
1402 this.moveTo(xy[0]-distance, xy[1], this.preanim(arguments, 2));
1406 this.moveTo(xy[0]+distance, xy[1], this.preanim(arguments, 2));
1411 this.moveTo(xy[0], xy[1]-distance, this.preanim(arguments, 2));
1416 this.moveTo(xy[0], xy[1]+distance, this.preanim(arguments, 2));
1423 * Store the current overflow setting and clip overflow on the element - use {@link #unclip} to remove
1424 * @return {Roo.Element} this
1427 if(!this.isClipped){
1428 this.isClipped = true;
1429 this.originalClip = {
1430 "o": this.getStyle("overflow"),
1431 "x": this.getStyle("overflow-x"),
1432 "y": this.getStyle("overflow-y")
1434 this.setStyle("overflow", "hidden");
1435 this.setStyle("overflow-x", "hidden");
1436 this.setStyle("overflow-y", "hidden");
1442 * Return clipping (overflow) to original clipping before clip() was called
1443 * @return {Roo.Element} this
1445 unclip : function(){
1447 this.isClipped = false;
1448 var o = this.originalClip;
1449 if(o.o){this.setStyle("overflow", o.o);}
1450 if(o.x){this.setStyle("overflow-x", o.x);}
1451 if(o.y){this.setStyle("overflow-y", o.y);}
1458 * Gets the x,y coordinates specified by the anchor position on the element.
1459 * @param {String} anchor (optional) The specified anchor position (defaults to "c"). See {@link #alignTo} for details on supported anchor positions.
1460 * @param {Object} size (optional) An object containing the size to use for calculating anchor position
1461 * {width: (target width), height: (target height)} (defaults to the element's current size)
1462 * @param {Boolean} local (optional) True to get the local (element top/left-relative) anchor position instead of page coordinates
1463 * @return {Array} [x, y] An array containing the element's x and y coordinates
1465 getAnchorXY : function(anchor, local, s){
1466 //Passing a different size is useful for pre-calculating anchors,
1467 //especially for anchored animations that change the el size.
1469 var w, h, vp = false;
1472 if(d == document.body || d == document){
1474 w = D.getViewWidth(); h = D.getViewHeight();
1476 w = this.getWidth(); h = this.getHeight();
1479 w = s.width; h = s.height;
1481 var x = 0, y = 0, r = Math.round;
1482 switch((anchor || "tl").toLowerCase()){
1524 var sc = this.getScroll();
1525 return [x + sc.left, y + sc.top];
1527 //Add the element's offset xy
1528 var o = this.getXY();
1529 return [x+o[0], y+o[1]];
1533 * Gets the x,y coordinates to align this element with another element. See {@link #alignTo} for more info on the
1534 * supported position values.
1535 * @param {String/HTMLElement/Roo.Element} element The element to align to.
1536 * @param {String} position The position to align to.
1537 * @param {Array} offsets (optional) Offset the positioning by [x, y]
1538 * @return {Array} [x, y]
1540 getAlignToXY : function(el, p, o){
1544 throw "Element.alignTo with an element that doesn't exist";
1546 var c = false; //constrain to viewport
1547 var p1 = "", p2 = "";
1554 }else if(p.indexOf("-") == -1){
1557 p = p.toLowerCase();
1558 var m = p.match(/^([a-z]+)-([a-z]+)(\?)?$/);
1560 throw "Element.alignTo with an invalid alignment " + p;
1562 p1 = m[1]; p2 = m[2]; c = !!m[3];
1564 //Subtract the aligned el's internal xy from the target's offset xy
1565 //plus custom offset to get the aligned el's new offset xy
1566 var a1 = this.getAnchorXY(p1, true);
1567 var a2 = el.getAnchorXY(p2, false);
1568 var x = a2[0] - a1[0] + o[0];
1569 var y = a2[1] - a1[1] + o[1];
1571 //constrain the aligned el to viewport if necessary
1572 var w = this.getWidth(), h = this.getHeight(), r = el.getRegion();
1573 // 5px of margin for ie
1574 var dw = D.getViewWidth()-5, dh = D.getViewHeight()-5;
1576 //If we are at a viewport boundary and the aligned el is anchored on a target border that is
1577 //perpendicular to the vp border, allow the aligned el to slide on that border,
1578 //otherwise swap the aligned el to the opposite border of the target.
1579 var p1y = p1.charAt(0), p1x = p1.charAt(p1.length-1);
1580 var p2y = p2.charAt(0), p2x = p2.charAt(p2.length-1);
1581 var swapY = ((p1y=="t" && p2y=="b") || (p1y=="b" && p2y=="t"));
1582 var swapX = ((p1x=="r" && p2x=="l") || (p1x=="l" && p2x=="r"));
1585 var scrollX = (doc.documentElement.scrollLeft || doc.body.scrollLeft || 0)+5;
1586 var scrollY = (doc.documentElement.scrollTop || doc.body.scrollTop || 0)+5;
1588 if((x+w) > dw + scrollX){
1589 x = swapX ? r.left-w : dw+scrollX-w;
1592 x = swapX ? r.right : scrollX;
1594 if((y+h) > dh + scrollY){
1595 y = swapY ? r.top-h : dh+scrollY-h;
1598 y = swapY ? r.bottom : scrollY;
1605 getConstrainToXY : function(){
1606 var os = {top:0, left:0, bottom:0, right: 0};
1608 return function(el, local, offsets, proposedXY){
1610 offsets = offsets ? Roo.applyIf(offsets, os) : os;
1612 var vw, vh, vx = 0, vy = 0;
1613 if(el.dom == document.body || el.dom == document){
1614 vw = Roo.lib.Dom.getViewWidth();
1615 vh = Roo.lib.Dom.getViewHeight();
1617 vw = el.dom.clientWidth;
1618 vh = el.dom.clientHeight;
1620 var vxy = el.getXY();
1626 var s = el.getScroll();
1628 vx += offsets.left + s.left;
1629 vy += offsets.top + s.top;
1631 vw -= offsets.right;
1632 vh -= offsets.bottom;
1637 var xy = proposedXY || (!local ? this.getXY() : [this.getLeft(true), this.getTop(true)]);
1638 var x = xy[0], y = xy[1];
1639 var w = this.dom.offsetWidth, h = this.dom.offsetHeight;
1641 // only move it if it needs it
1644 // first validate right/bottom
1653 // then make sure top/left isn't negative
1662 return moved ? [x, y] : false;
1667 adjustForConstraints : function(xy, parent, offsets){
1668 return this.getConstrainToXY(parent || document, false, offsets, xy) || xy;
1672 * Aligns this element with another element relative to the specified anchor points. If the other element is the
1673 * document it aligns it to the viewport.
1674 * The position parameter is optional, and can be specified in any one of the following formats:
1676 * <li><b>Blank</b>: Defaults to aligning the element's top-left corner to the target's bottom-left corner ("tl-bl").</li>
1677 * <li><b>One anchor (deprecated)</b>: The passed anchor position is used as the target element's anchor point.
1678 * The element being aligned will position its top-left corner (tl) to that point. <i>This method has been
1679 * deprecated in favor of the newer two anchor syntax below</i>.</li>
1680 * <li><b>Two anchors</b>: If two values from the table below are passed separated by a dash, the first value is used as the
1681 * element's anchor point, and the second value is used as the target's anchor point.</li>
1683 * In addition to the anchor points, the position parameter also supports the "?" character. If "?" is passed at the end of
1684 * the position string, the element will attempt to align as specified, but the position will be adjusted to constrain to
1685 * the viewport if necessary. Note that the element being aligned might be swapped to align to a different position than
1686 * that specified in order to enforce the viewport constraints.
1687 * Following are all of the supported anchor positions:
1690 ----- -----------------------------
1691 tl The top left corner (default)
1692 t The center of the top edge
1693 tr The top right corner
1694 l The center of the left edge
1695 c In the center of the element
1696 r The center of the right edge
1697 bl The bottom left corner
1698 b The center of the bottom edge
1699 br The bottom right corner
1703 // align el to other-el using the default positioning ("tl-bl", non-constrained)
1704 el.alignTo("other-el");
1706 // align the top left corner of el with the top right corner of other-el (constrained to viewport)
1707 el.alignTo("other-el", "tr?");
1709 // align the bottom right corner of el with the center left edge of other-el
1710 el.alignTo("other-el", "br-l?");
1712 // align the center of el with the bottom left corner of other-el and
1713 // adjust the x position by -6 pixels (and the y position by 0)
1714 el.alignTo("other-el", "c-bl", [-6, 0]);
1716 * @param {String/HTMLElement/Roo.Element} element The element to align to.
1717 * @param {String} position The position to align to.
1718 * @param {Array} offsets (optional) Offset the positioning by [x, y]
1719 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1720 * @return {Roo.Element} this
1722 alignTo : function(element, position, offsets, animate){
1723 var xy = this.getAlignToXY(element, position, offsets);
1724 this.setXY(xy, this.preanim(arguments, 3));
1729 * Anchors an element to another element and realigns it when the window is resized.
1730 * @param {String/HTMLElement/Roo.Element} element The element to align to.
1731 * @param {String} position The position to align to.
1732 * @param {Array} offsets (optional) Offset the positioning by [x, y]
1733 * @param {Boolean/Object} animate (optional) True for the default animation or a standard Element animation config object
1734 * @param {Boolean/Number} monitorScroll (optional) True to monitor body scroll and reposition. If this parameter
1735 * is a number, it is used as the buffer delay (defaults to 50ms).
1736 * @param {Function} callback The function to call after the animation finishes
1737 * @return {Roo.Element} this
1739 anchorTo : function(el, alignment, offsets, animate, monitorScroll, callback){
1740 var action = function(){
1741 this.alignTo(el, alignment, offsets, animate);
1742 Roo.callback(callback, this);
1744 Roo.EventManager.onWindowResize(action, this);
1745 var tm = typeof monitorScroll;
1746 if(tm != 'undefined'){
1747 Roo.EventManager.on(window, 'scroll', action, this,
1748 {buffer: tm == 'number' ? monitorScroll : 50});
1750 action.call(this); // align immediately
1754 * Clears any opacity settings from this element. Required in some cases for IE.
1755 * @return {Roo.Element} this
1757 clearOpacity : function(){
1758 if (window.ActiveXObject) {
1759 if(typeof this.dom.style.filter == 'string' && (/alpha/i).test(this.dom.style.filter)){
1760 this.dom.style.filter = "";
1763 this.dom.style.opacity = "";
1764 this.dom.style["-moz-opacity"] = "";
1765 this.dom.style["-khtml-opacity"] = "";
1771 * Hide this element - Uses display mode to determine whether to use "display" or "visibility". See {@link #setVisible}.
1772 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1773 * @return {Roo.Element} this
1775 hide : function(animate){
1776 this.setVisible(false, this.preanim(arguments, 0));
1781 * Show this element - Uses display mode to determine whether to use "display" or "visibility". See {@link #setVisible}.
1782 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1783 * @return {Roo.Element} this
1785 show : function(animate){
1786 this.setVisible(true, this.preanim(arguments, 0));
1791 * @private Test if size has a unit, otherwise appends the default
1793 addUnits : function(size){
1794 return Roo.Element.addUnits(size, this.defaultUnit);
1798 * Temporarily enables offsets (width,height,x,y) for an element with display:none, use endMeasure() when done.
1799 * @return {Roo.Element} this
1801 beginMeasure : function(){
1803 if(el.offsetWidth || el.offsetHeight){
1804 return this; // offsets work already
1807 var p = this.dom, b = document.body; // start with this element
1808 while((!el.offsetWidth && !el.offsetHeight) && p && p.tagName && p != b){
1809 var pe = Roo.get(p);
1810 if(pe.getStyle('display') == 'none'){
1811 changed.push({el: p, visibility: pe.getStyle("visibility")});
1812 p.style.visibility = "hidden";
1813 p.style.display = "block";
1817 this._measureChanged = changed;
1823 * Restores displays to before beginMeasure was called
1824 * @return {Roo.Element} this
1826 endMeasure : function(){
1827 var changed = this._measureChanged;
1829 for(var i = 0, len = changed.length; i < len; i++) {
1831 r.el.style.visibility = r.visibility;
1832 r.el.style.display = "none";
1834 this._measureChanged = null;
1840 * Update the innerHTML of this element, optionally searching for and processing scripts
1841 * @param {String} html The new HTML
1842 * @param {Boolean} loadScripts (optional) true to look for and process scripts
1843 * @param {Function} callback For async script loading you can be noticed when the update completes
1844 * @return {Roo.Element} this
1846 update : function(html, loadScripts, callback){
1847 if(typeof html == "undefined"){
1850 if(loadScripts !== true){
1851 this.dom.innerHTML = html;
1852 if(typeof callback == "function"){
1860 html += '<span id="' + id + '"></span>';
1862 E.onAvailable(id, function(){
1863 var hd = document.getElementsByTagName("head")[0];
1864 var re = /(?:<script([^>]*)?>)((\n|\r|.)*?)(?:<\/script>)/ig;
1865 var srcRe = /\ssrc=([\'\"])(.*?)\1/i;
1866 var typeRe = /\stype=([\'\"])(.*?)\1/i;
1869 while(match = re.exec(html)){
1870 var attrs = match[1];
1871 var srcMatch = attrs ? attrs.match(srcRe) : false;
1872 if(srcMatch && srcMatch[2]){
1873 var s = document.createElement("script");
1874 s.src = srcMatch[2];
1875 var typeMatch = attrs.match(typeRe);
1876 if(typeMatch && typeMatch[2]){
1877 s.type = typeMatch[2];
1880 }else if(match[2] && match[2].length > 0){
1881 if(window.execScript) {
1882 window.execScript(match[2]);
1890 window.eval(match[2]);
1894 var el = document.getElementById(id);
1895 if(el){el.parentNode.removeChild(el);}
1896 if(typeof callback == "function"){
1900 dom.innerHTML = html.replace(/(?:<script.*?>)((\n|\r|.)*?)(?:<\/script>)/ig, "");
1905 * Direct access to the UpdateManager update() method (takes the same parameters).
1906 * @param {String/Function} url The url for this request or a function to call to get the url
1907 * @param {String/Object} params (optional) The parameters to pass as either a url encoded string "param1=1&param2=2" or an object {param1: 1, param2: 2}
1908 * @param {Function} callback (optional) Callback when transaction is complete - called with signature (oElement, bSuccess)
1909 * @param {Boolean} discardUrl (optional) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url.
1910 * @return {Roo.Element} this
1913 var um = this.getUpdateManager();
1914 um.update.apply(um, arguments);
1919 * Gets this element's UpdateManager
1920 * @return {Roo.UpdateManager} The UpdateManager
1922 getUpdateManager : function(){
1923 if(!this.updateManager){
1924 this.updateManager = new Roo.UpdateManager(this);
1926 return this.updateManager;
1930 * Disables text selection for this element (normalized across browsers)
1931 * @return {Roo.Element} this
1933 unselectable : function(){
1934 this.dom.unselectable = "on";
1935 this.swallowEvent("selectstart", true);
1936 this.applyStyles("-moz-user-select:none;-khtml-user-select:none;");
1937 this.addClass("x-unselectable");
1942 * Calculates the x, y to center this element on the screen
1943 * @return {Array} The x, y values [x, y]
1945 getCenterXY : function(){
1946 return this.getAlignToXY(document, 'c-c');
1950 * Centers the Element in either the viewport, or another Element.
1951 * @param {String/HTMLElement/Roo.Element} centerIn (optional) The element in which to center the element.
1953 center : function(centerIn){
1954 this.alignTo(centerIn || document, 'c-c');
1959 * Tests various css rules/browsers to determine if this element uses a border box
1962 isBorderBox : function(){
1963 return noBoxAdjust[this.dom.tagName.toLowerCase()] || Roo.isBorderBox;
1967 * Return a box {x, y, width, height} that can be used to set another elements
1968 * size/location to match this element.
1969 * @param {Boolean} contentBox (optional) If true a box for the content of the element is returned.
1970 * @param {Boolean} local (optional) If true the element's left and top are returned instead of page x/y.
1971 * @return {Object} box An object in the format {x, y, width, height}
1973 getBox : function(contentBox, local){
1978 var left = parseInt(this.getStyle("left"), 10) || 0;
1979 var top = parseInt(this.getStyle("top"), 10) || 0;
1982 var el = this.dom, w = el.offsetWidth, h = el.offsetHeight, bx;
1984 bx = {x: xy[0], y: xy[1], 0: xy[0], 1: xy[1], width: w, height: h};
1986 var l = this.getBorderWidth("l")+this.getPadding("l");
1987 var r = this.getBorderWidth("r")+this.getPadding("r");
1988 var t = this.getBorderWidth("t")+this.getPadding("t");
1989 var b = this.getBorderWidth("b")+this.getPadding("b");
1990 bx = {x: xy[0]+l, y: xy[1]+t, 0: xy[0]+l, 1: xy[1]+t, width: w-(l+r), height: h-(t+b)};
1992 bx.right = bx.x + bx.width;
1993 bx.bottom = bx.y + bx.height;
1998 * Returns the sum width of the padding and borders for the passed "sides". See getBorderWidth()
1999 for more information about the sides.
2000 * @param {String} sides
2003 getFrameWidth : function(sides, onlyContentBox){
2004 return onlyContentBox && Roo.isBorderBox ? 0 : (this.getPadding(sides) + this.getBorderWidth(sides));
2008 * Sets the element's box. Use getBox() on another element to get a box obj. If animate is true then width, height, x and y will be animated concurrently.
2009 * @param {Object} box The box to fill {x, y, width, height}
2010 * @param {Boolean} adjust (optional) Whether to adjust for box-model issues automatically
2011 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
2012 * @return {Roo.Element} this
2014 setBox : function(box, adjust, animate){
2015 var w = box.width, h = box.height;
2016 if((adjust && !this.autoBoxAdjust) && !this.isBorderBox()){
2017 w -= (this.getBorderWidth("lr") + this.getPadding("lr"));
2018 h -= (this.getBorderWidth("tb") + this.getPadding("tb"));
2020 this.setBounds(box.x, box.y, w, h, this.preanim(arguments, 2));
2025 * Forces the browser to repaint this element
2026 * @return {Roo.Element} this
2028 repaint : function(){
2030 this.addClass("x-repaint");
2031 setTimeout(function(){
2032 Roo.get(dom).removeClass("x-repaint");
2038 * Returns an object with properties top, left, right and bottom representing the margins of this element unless sides is passed,
2039 * then it returns the calculated width of the sides (see getPadding)
2040 * @param {String} sides (optional) Any combination of l, r, t, b to get the sum of those sides
2041 * @return {Object/Number}
2043 getMargins : function(side){
2046 top: parseInt(this.getStyle("margin-top"), 10) || 0,
2047 left: parseInt(this.getStyle("margin-left"), 10) || 0,
2048 bottom: parseInt(this.getStyle("margin-bottom"), 10) || 0,
2049 right: parseInt(this.getStyle("margin-right"), 10) || 0
2052 return this.addStyles(side, El.margins);
2057 addStyles : function(sides, styles){
2059 for(var i = 0, len = sides.length; i < len; i++){
2060 v = this.getStyle(styles[sides.charAt(i)]);
2062 w = parseInt(v, 10);
2070 * Creates a proxy element of this element
2071 * @param {String/Object} config The class name of the proxy element or a DomHelper config object
2072 * @param {String/HTMLElement} renderTo (optional) The element or element id to render the proxy to (defaults to document.body)
2073 * @param {Boolean} matchBox (optional) True to align and size the proxy to this element now (defaults to false)
2074 * @return {Roo.Element} The new proxy element
2076 createProxy : function(config, renderTo, matchBox){
2078 renderTo = Roo.getDom(renderTo);
2080 renderTo = document.body;
2082 config = typeof config == "object" ?
2083 config : {tag : "div", cls: config};
2084 var proxy = Roo.DomHelper.append(renderTo, config, true);
2086 proxy.setBox(this.getBox());
2092 * Puts a mask over this element to disable user interaction. Requires core.css.
2093 * This method can only be applied to elements which accept child nodes.
2094 * @param {String} msg (optional) A message to display in the mask
2095 * @param {String} msgCls (optional) A css class to apply to the msg element
2096 * @return {Element} The mask element
2098 mask : function(msg, msgCls)
2100 if(this.getStyle("position") == "static" && this.dom.tagName !== 'BODY'){
2101 this.setStyle("position", "relative");
2104 this._mask = Roo.DomHelper.append(this.dom, {cls:"roo-el-mask"}, true);
2106 this.addClass("x-masked");
2107 this._mask.setDisplayed(true);
2112 while (dom && dom.style) {
2113 if (!isNaN(parseInt(dom.style.zIndex))) {
2114 z = Math.max(z, parseInt(dom.style.zIndex));
2116 dom = dom.parentNode;
2118 // if we are masking the body - then it hides everything..
2119 if (this.dom == document.body) {
2121 this._mask.setWidth(Roo.lib.Dom.getDocumentWidth());
2122 this._mask.setHeight(Roo.lib.Dom.getDocumentHeight());
2125 if(typeof msg == 'string'){
2127 this._maskMsg = Roo.DomHelper.append(this.dom, {cls:"roo-el-mask-msg", cn:{tag:'div'}}, true);
2129 var mm = this._maskMsg;
2130 mm.dom.className = msgCls ? "roo-el-mask-msg " + msgCls : "roo-el-mask-msg";
2131 if (mm.dom.firstChild) { // weird IE issue?
2132 mm.dom.firstChild.innerHTML = msg;
2134 mm.setDisplayed(true);
2136 mm.setStyle('z-index', z + 102);
2138 if(Roo.isIE && !(Roo.isIE7 && Roo.isStrict) && this.getStyle('height') == 'auto'){ // ie will not expand full height automatically
2139 this._mask.setHeight(this.getHeight());
2141 this._mask.setStyle('z-index', z + 100);
2147 * Removes a previously applied mask. If removeEl is true the mask overlay is destroyed, otherwise
2148 * it is cached for reuse.
2150 unmask : function(removeEl){
2152 if(removeEl === true){
2153 this._mask.remove();
2156 this._maskMsg.remove();
2157 delete this._maskMsg;
2160 this._mask.setDisplayed(false);
2162 this._maskMsg.setDisplayed(false);
2166 this.removeClass("x-masked");
2170 * Returns true if this element is masked
2173 isMasked : function(){
2174 return this._mask && this._mask.isVisible();
2178 * Creates an iframe shim for this element to keep selects and other windowed objects from
2180 * @return {Roo.Element} The new shim element
2182 createShim : function(){
2183 var el = document.createElement('iframe');
2184 el.frameBorder = 'no';
2185 el.className = 'roo-shim';
2186 if(Roo.isIE && Roo.isSecure){
2187 el.src = Roo.SSL_SECURE_URL;
2189 var shim = Roo.get(this.dom.parentNode.insertBefore(el, this.dom));
2190 shim.autoBoxAdjust = false;
2195 * Removes this element from the DOM and deletes it from the cache
2197 remove : function(){
2198 if(this.dom.parentNode){
2199 this.dom.parentNode.removeChild(this.dom);
2201 delete El.cache[this.dom.id];
2205 * Sets up event handlers to add and remove a css class when the mouse is over this element
2206 * @param {String} className
2207 * @param {Boolean} preventFlicker (optional) If set to true, it prevents flickering by filtering
2208 * mouseout events for children elements
2209 * @return {Roo.Element} this
2211 addClassOnOver : function(className, preventFlicker){
2212 this.on("mouseover", function(){
2213 Roo.fly(this, '_internal').addClass(className);
2215 var removeFn = function(e){
2216 if(preventFlicker !== true || !e.within(this, true)){
2217 Roo.fly(this, '_internal').removeClass(className);
2220 this.on("mouseout", removeFn, this.dom);
2225 * Sets up event handlers to add and remove a css class when this element has the focus
2226 * @param {String} className
2227 * @return {Roo.Element} this
2229 addClassOnFocus : function(className){
2230 this.on("focus", function(){
2231 Roo.fly(this, '_internal').addClass(className);
2233 this.on("blur", function(){
2234 Roo.fly(this, '_internal').removeClass(className);
2239 * Sets up event handlers to add and remove a css class when the mouse is down and then up on this element (a click effect)
2240 * @param {String} className
2241 * @return {Roo.Element} this
2243 addClassOnClick : function(className){
2245 this.on("mousedown", function(){
2246 Roo.fly(dom, '_internal').addClass(className);
2247 var d = Roo.get(document);
2248 var fn = function(){
2249 Roo.fly(dom, '_internal').removeClass(className);
2250 d.removeListener("mouseup", fn);
2252 d.on("mouseup", fn);
2258 * Stops the specified event from bubbling and optionally prevents the default action
2259 * @param {String} eventName
2260 * @param {Boolean} preventDefault (optional) true to prevent the default action too
2261 * @return {Roo.Element} this
2263 swallowEvent : function(eventName, preventDefault){
2264 var fn = function(e){
2265 e.stopPropagation();
2270 if(eventName instanceof Array){
2271 for(var i = 0, len = eventName.length; i < len; i++){
2272 this.on(eventName[i], fn);
2276 this.on(eventName, fn);
2283 fitToParentDelegate : Roo.emptyFn, // keep a reference to the fitToParent delegate
2286 * Sizes this element to its parent element's dimensions performing
2287 * neccessary box adjustments.
2288 * @param {Boolean} monitorResize (optional) If true maintains the fit when the browser window is resized.
2289 * @param {String/HTMLElment/Element} targetParent (optional) The target parent, default to the parentNode.
2290 * @return {Roo.Element} this
2292 fitToParent : function(monitorResize, targetParent) {
2293 Roo.EventManager.removeResizeListener(this.fitToParentDelegate); // always remove previous fitToParent delegate from onWindowResize
2294 this.fitToParentDelegate = Roo.emptyFn; // remove reference to previous delegate
2295 if (monitorResize === true && !this.dom.parentNode) { // check if this Element still exists
2298 var p = Roo.get(targetParent || this.dom.parentNode);
2299 this.setSize(p.getComputedWidth() - p.getFrameWidth('lr'), p.getComputedHeight() - p.getFrameWidth('tb'));
2300 if (monitorResize === true) {
2301 this.fitToParentDelegate = this.fitToParent.createDelegate(this, [true, targetParent]);
2302 Roo.EventManager.onWindowResize(this.fitToParentDelegate);
2308 * Gets the next sibling, skipping text nodes
2309 * @return {HTMLElement} The next sibling or null
2311 getNextSibling : function(){
2312 var n = this.dom.nextSibling;
2313 while(n && n.nodeType != 1){
2320 * Gets the previous sibling, skipping text nodes
2321 * @return {HTMLElement} The previous sibling or null
2323 getPrevSibling : function(){
2324 var n = this.dom.previousSibling;
2325 while(n && n.nodeType != 1){
2326 n = n.previousSibling;
2333 * Appends the passed element(s) to this element
2334 * @param {String/HTMLElement/Array/Element/CompositeElement} el
2335 * @return {Roo.Element} this
2337 appendChild: function(el){
2344 * Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element.
2345 * @param {Object} config DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be
2346 * automatically generated with the specified attributes.
2347 * @param {HTMLElement} insertBefore (optional) a child element of this element
2348 * @param {Boolean} returnDom (optional) true to return the dom node instead of creating an Element
2349 * @return {Roo.Element} The new child element
2351 createChild: function(config, insertBefore, returnDom){
2352 config = config || {tag:'div'};
2354 return Roo.DomHelper.insertBefore(insertBefore, config, returnDom !== true);
2356 return Roo.DomHelper[!this.dom.firstChild ? 'overwrite' : 'append'](this.dom, config, returnDom !== true);
2360 * Appends this element to the passed element
2361 * @param {String/HTMLElement/Element} el The new parent element
2362 * @return {Roo.Element} this
2364 appendTo: function(el){
2365 el = Roo.getDom(el);
2366 el.appendChild(this.dom);
2371 * Inserts this element before the passed element in the DOM
2372 * @param {String/HTMLElement/Element} el The element to insert before
2373 * @return {Roo.Element} this
2375 insertBefore: function(el){
2376 el = Roo.getDom(el);
2377 el.parentNode.insertBefore(this.dom, el);
2382 * Inserts this element after the passed element in the DOM
2383 * @param {String/HTMLElement/Element} el The element to insert after
2384 * @return {Roo.Element} this
2386 insertAfter: function(el){
2387 el = Roo.getDom(el);
2388 el.parentNode.insertBefore(this.dom, el.nextSibling);
2393 * Inserts (or creates) an element (or DomHelper config) as the first child of the this element
2394 * @param {String/HTMLElement/Element/Object} el The id or element to insert or a DomHelper config to create and insert
2395 * @return {Roo.Element} The new child
2397 insertFirst: function(el, returnDom){
2399 if(typeof el == 'object' && !el.nodeType){ // dh config
2400 return this.createChild(el, this.dom.firstChild, returnDom);
2402 el = Roo.getDom(el);
2403 this.dom.insertBefore(el, this.dom.firstChild);
2404 return !returnDom ? Roo.get(el) : el;
2409 * Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element
2410 * @param {String/HTMLElement/Element/Object} el The id or element to insert or a DomHelper config to create and insert
2411 * @param {String} where (optional) 'before' or 'after' defaults to before
2412 * @param {Boolean} returnDom (optional) True to return the raw DOM element instead of Roo.Element
2413 * @return {Roo.Element} the inserted Element
2415 insertSibling: function(el, where, returnDom){
2416 where = where ? where.toLowerCase() : 'before';
2418 var rt, refNode = where == 'before' ? this.dom : this.dom.nextSibling;
2420 if(typeof el == 'object' && !el.nodeType){ // dh config
2421 if(where == 'after' && !this.dom.nextSibling){
2422 rt = Roo.DomHelper.append(this.dom.parentNode, el, !returnDom);
2424 rt = Roo.DomHelper[where == 'after' ? 'insertAfter' : 'insertBefore'](this.dom, el, !returnDom);
2428 rt = this.dom.parentNode.insertBefore(Roo.getDom(el),
2429 where == 'before' ? this.dom : this.dom.nextSibling);
2438 * Creates and wraps this element with another element
2439 * @param {Object} config (optional) DomHelper element config object for the wrapper element or null for an empty div
2440 * @param {Boolean} returnDom (optional) True to return the raw DOM element instead of Roo.Element
2441 * @return {HTMLElement/Element} The newly created wrapper element
2443 wrap: function(config, returnDom){
2445 config = {tag: "div"};
2447 var newEl = Roo.DomHelper.insertBefore(this.dom, config, !returnDom);
2448 newEl.dom ? newEl.dom.appendChild(this.dom) : newEl.appendChild(this.dom);
2453 * Replaces the passed element with this element
2454 * @param {String/HTMLElement/Element} el The element to replace
2455 * @return {Roo.Element} this
2457 replace: function(el){
2459 this.insertBefore(el);
2465 * Inserts an html fragment into this element
2466 * @param {String} where Where to insert the html in relation to the this element - beforeBegin, afterBegin, beforeEnd, afterEnd.
2467 * @param {String} html The HTML fragment
2468 * @param {Boolean} returnEl True to return an Roo.Element
2469 * @return {HTMLElement/Roo.Element} The inserted node (or nearest related if more than 1 inserted)
2471 insertHtml : function(where, html, returnEl){
2472 var el = Roo.DomHelper.insertHtml(where, this.dom, html);
2473 return returnEl ? Roo.get(el) : el;
2477 * Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)
2478 * @param {Object} o The object with the attributes
2479 * @param {Boolean} useSet (optional) false to override the default setAttribute to use expandos.
2480 * @return {Roo.Element} this
2482 set : function(o, useSet){
2484 useSet = typeof useSet == 'undefined' ? (el.setAttribute ? true : false) : useSet;
2486 if(attr == "style" || typeof o[attr] == "function") continue;
2488 el.className = o["cls"];
2490 if(useSet) el.setAttribute(attr, o[attr]);
2491 else el[attr] = o[attr];
2495 Roo.DomHelper.applyStyles(el, o.style);
2501 * Convenience method for constructing a KeyMap
2502 * @param {Number/Array/Object/String} key Either a string with the keys to listen for, the numeric key code, array of key codes or an object with the following options:
2503 * {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}
2504 * @param {Function} fn The function to call
2505 * @param {Object} scope (optional) The scope of the function
2506 * @return {Roo.KeyMap} The KeyMap created
2508 addKeyListener : function(key, fn, scope){
2510 if(typeof key != "object" || key instanceof Array){
2526 return new Roo.KeyMap(this, config);
2530 * Creates a KeyMap for this element
2531 * @param {Object} config The KeyMap config. See {@link Roo.KeyMap} for more details
2532 * @return {Roo.KeyMap} The KeyMap created
2534 addKeyMap : function(config){
2535 return new Roo.KeyMap(this, config);
2539 * Returns true if this element is scrollable.
2542 isScrollable : function(){
2544 return dom.scrollHeight > dom.clientHeight || dom.scrollWidth > dom.clientWidth;
2548 * Scrolls this element the specified scroll point. It does NOT do bounds checking so if you scroll to a weird value it will try to do it. For auto bounds checking, use scroll().
2549 * @param {String} side Either "left" for scrollLeft values or "top" for scrollTop values.
2550 * @param {Number} value The new scroll value
2551 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
2552 * @return {Element} this
2555 scrollTo : function(side, value, animate){
2556 var prop = side.toLowerCase() == "left" ? "scrollLeft" : "scrollTop";
2558 this.dom[prop] = value;
2560 var to = prop == "scrollLeft" ? [value, this.dom.scrollTop] : [this.dom.scrollLeft, value];
2561 this.anim({scroll: {"to": to}}, this.preanim(arguments, 2), 'scroll');
2567 * Scrolls this element the specified direction. Does bounds checking to make sure the scroll is
2568 * within this element's scrollable range.
2569 * @param {String} direction Possible values are: "l","left" - "r","right" - "t","top","up" - "b","bottom","down".
2570 * @param {Number} distance How far to scroll the element in pixels
2571 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
2572 * @return {Boolean} Returns true if a scroll was triggered or false if the element
2573 * was scrolled as far as it could go.
2575 scroll : function(direction, distance, animate){
2576 if(!this.isScrollable()){
2580 var l = el.scrollLeft, t = el.scrollTop;
2581 var w = el.scrollWidth, h = el.scrollHeight;
2582 var cw = el.clientWidth, ch = el.clientHeight;
2583 direction = direction.toLowerCase();
2584 var scrolled = false;
2585 var a = this.preanim(arguments, 2);
2590 var v = Math.min(l + distance, w-cw);
2591 this.scrollTo("left", v, a);
2598 var v = Math.max(l - distance, 0);
2599 this.scrollTo("left", v, a);
2607 var v = Math.max(t - distance, 0);
2608 this.scrollTo("top", v, a);
2616 var v = Math.min(t + distance, h-ch);
2617 this.scrollTo("top", v, a);
2626 * Translates the passed page coordinates into left/top css values for this element
2627 * @param {Number/Array} x The page x or an array containing [x, y]
2628 * @param {Number} y The page y
2629 * @return {Object} An object with left and top properties. e.g. {left: (value), top: (value)}
2631 translatePoints : function(x, y){
2632 if(typeof x == 'object' || x instanceof Array){
2635 var p = this.getStyle('position');
2636 var o = this.getXY();
2638 var l = parseInt(this.getStyle('left'), 10);
2639 var t = parseInt(this.getStyle('top'), 10);
2642 l = (p == "relative") ? 0 : this.dom.offsetLeft;
2645 t = (p == "relative") ? 0 : this.dom.offsetTop;
2648 return {left: (x - o[0] + l), top: (y - o[1] + t)};
2652 * Returns the current scroll position of the element.
2653 * @return {Object} An object containing the scroll position in the format {left: (scrollLeft), top: (scrollTop)}
2655 getScroll : function(){
2656 var d = this.dom, doc = document;
2657 if(d == doc || d == doc.body){
2658 var l = window.pageXOffset || doc.documentElement.scrollLeft || doc.body.scrollLeft || 0;
2659 var t = window.pageYOffset || doc.documentElement.scrollTop || doc.body.scrollTop || 0;
2660 return {left: l, top: t};
2662 return {left: d.scrollLeft, top: d.scrollTop};
2667 * Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values
2668 * are convert to standard 6 digit hex color.
2669 * @param {String} attr The css attribute
2670 * @param {String} defaultValue The default value to use when a valid color isn't found
2671 * @param {String} prefix (optional) defaults to #. Use an empty string when working with
2674 getColor : function(attr, defaultValue, prefix){
2675 var v = this.getStyle(attr);
2676 if(!v || v == "transparent" || v == "inherit") {
2677 return defaultValue;
2679 var color = typeof prefix == "undefined" ? "#" : prefix;
2680 if(v.substr(0, 4) == "rgb("){
2681 var rvs = v.slice(4, v.length -1).split(",");
2682 for(var i = 0; i < 3; i++){
2683 var h = parseInt(rvs[i]).toString(16);
2690 if(v.substr(0, 1) == "#"){
2692 for(var i = 1; i < 4; i++){
2693 var c = v.charAt(i);
2696 }else if(v.length == 7){
2697 color += v.substr(1);
2701 return(color.length > 5 ? color.toLowerCase() : defaultValue);
2705 * Wraps the specified element with a special markup/CSS block that renders by default as a gray container with a
2706 * gradient background, rounded corners and a 4-way shadow.
2707 * @param {String} class (optional) A base CSS class to apply to the containing wrapper element (defaults to 'x-box').
2708 * Note that there are a number of CSS rules that are dependent on this name to make the overall effect work,
2709 * so if you supply an alternate base class, make sure you also supply all of the necessary rules.
2710 * @return {Roo.Element} this
2712 boxWrap : function(cls){
2713 cls = cls || 'x-box';
2714 var el = Roo.get(this.insertHtml('beforeBegin', String.format('<div class="{0}">'+El.boxMarkup+'</div>', cls)));
2715 el.child('.'+cls+'-mc').dom.appendChild(this.dom);
2720 * Returns the value of a namespaced attribute from the element's underlying DOM node.
2721 * @param {String} namespace The namespace in which to look for the attribute
2722 * @param {String} name The attribute name
2723 * @return {String} The attribute value
2725 getAttributeNS : Roo.isIE ? function(ns, name){
2727 var type = typeof d[ns+":"+name];
2728 if(type != 'undefined' && type != 'unknown'){
2729 return d[ns+":"+name];
2732 } : function(ns, name){
2734 return d.getAttributeNS(ns, name) || d.getAttribute(ns+":"+name) || d.getAttribute(name) || d[name];
2739 * Sets or Returns the value the dom attribute value
2740 * @param {String|Object} name The attribute name (or object to set multiple attributes)
2741 * @param {String} value (optional) The value to set the attribute to
2742 * @return {String} The attribute value
2744 attr : function(name){
2745 if (arguments.length > 1) {
2746 this.dom.setAttribute(name, arguments[1]);
2747 return arguments[1];
2749 if (typeof(name) == 'object') {
2750 for(var i in name) {
2751 this.attr(i, name[i]);
2757 if (!this.dom.hasAttribute(name)) {
2760 return this.dom.getAttribute(name);
2767 var ep = El.prototype;
2770 * Appends an event handler (Shorthand for addListener)
2771 * @param {String} eventName The type of event to append
2772 * @param {Function} fn The method the event invokes
2773 * @param {Object} scope (optional) The scope (this object) of the fn
2774 * @param {Object} options (optional)An object with standard {@link Roo.EventManager#addListener} options
2777 ep.on = ep.addListener;
2779 ep.mon = ep.addListener;
2782 * Removes an event handler from this element (shorthand for removeListener)
2783 * @param {String} eventName the type of event to remove
2784 * @param {Function} fn the method the event invokes
2785 * @return {Roo.Element} this
2788 ep.un = ep.removeListener;
2791 * true to automatically adjust width and height settings for box-model issues (default to true)
2793 ep.autoBoxAdjust = true;
2796 El.unitPattern = /\d+(px|em|%|en|ex|pt|in|cm|mm|pc)$/i;
2799 El.addUnits = function(v, defaultUnit){
2800 if(v === "" || v == "auto"){
2803 if(v === undefined){
2806 if(typeof v == "number" || !El.unitPattern.test(v)){
2807 return v + (defaultUnit || 'px');
2812 // special markup used throughout Roo when box wrapping elements
2813 El.boxMarkup = '<div class="{0}-tl"><div class="{0}-tr"><div class="{0}-tc"></div></div></div><div class="{0}-ml"><div class="{0}-mr"><div class="{0}-mc"></div></div></div><div class="{0}-bl"><div class="{0}-br"><div class="{0}-bc"></div></div></div>';
2815 * Visibility mode constant - Use visibility to hide element
2821 * Visibility mode constant - Use display to hide element
2827 El.borders = {l: "border-left-width", r: "border-right-width", t: "border-top-width", b: "border-bottom-width"};
2828 El.paddings = {l: "padding-left", r: "padding-right", t: "padding-top", b: "padding-bottom"};
2829 El.margins = {l: "margin-left", r: "margin-right", t: "margin-top", b: "margin-bottom"};
2841 * Static method to retrieve Element objects. Uses simple caching to consistently return the same object.
2842 * Automatically fixes if an object was recreated with the same id via AJAX or DOM.
2843 * @param {String/HTMLElement/Element} el The id of the node, a DOM Node or an existing Element.
2844 * @return {Element} The Element object
2847 El.get = function(el){
2849 if(!el){ return null; }
2850 if(typeof el == "string"){ // element id
2851 if(!(elm = document.getElementById(el))){
2854 if(ex = El.cache[el]){
2857 ex = El.cache[el] = new El(elm);
2860 }else if(el.tagName){ // dom element
2864 if(ex = El.cache[id]){
2867 ex = El.cache[id] = new El(el);
2870 }else if(el instanceof El){
2872 el.dom = document.getElementById(el.id) || el.dom; // refresh dom element in case no longer valid,
2873 // catch case where it hasn't been appended
2874 El.cache[el.id] = el; // in case it was created directly with Element(), let's cache it
2877 }else if(el.isComposite){
2879 }else if(el instanceof Array){
2880 return El.select(el);
2881 }else if(el == document){
2882 // create a bogus element object representing the document object
2884 var f = function(){};
2885 f.prototype = El.prototype;
2887 docEl.dom = document;
2895 El.uncache = function(el){
2896 for(var i = 0, a = arguments, len = a.length; i < len; i++) {
2898 delete El.cache[a[i].id || a[i]];
2904 // Garbage collection - uncache elements/purge listeners on orphaned elements
2905 // so we don't hold a reference and cause the browser to retain them
2906 El.garbageCollect = function(){
2907 if(!Roo.enableGarbageCollector){
2908 clearInterval(El.collectorThread);
2911 for(var eid in El.cache){
2912 var el = El.cache[eid], d = el.dom;
2913 // -------------------------------------------------------
2914 // Determining what is garbage:
2915 // -------------------------------------------------------
2917 // dom node is null, definitely garbage
2918 // -------------------------------------------------------
2920 // no parentNode == direct orphan, definitely garbage
2921 // -------------------------------------------------------
2922 // !d.offsetParent && !document.getElementById(eid)
2923 // display none elements have no offsetParent so we will
2924 // also try to look it up by it's id. However, check
2925 // offsetParent first so we don't do unneeded lookups.
2926 // This enables collection of elements that are not orphans
2927 // directly, but somewhere up the line they have an orphan
2929 // -------------------------------------------------------
2930 if(!d || !d.parentNode || (!d.offsetParent && !document.getElementById(eid))){
2931 delete El.cache[eid];
2932 if(d && Roo.enableListenerCollection){
2938 El.collectorThreadId = setInterval(El.garbageCollect, 30000);
2942 El.Flyweight = function(dom){
2945 El.Flyweight.prototype = El.prototype;
2947 El._flyweights = {};
2949 * Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -
2950 * the dom node can be overwritten by other code.
2951 * @param {String/HTMLElement} el The dom node or id
2952 * @param {String} named (optional) Allows for creation of named reusable flyweights to
2953 * prevent conflicts (e.g. internally Roo uses "_internal")
2955 * @return {Element} The shared Element object
2957 El.fly = function(el, named){
2958 named = named || '_global';
2959 el = Roo.getDom(el);
2963 if(!El._flyweights[named]){
2964 El._flyweights[named] = new El.Flyweight();
2966 El._flyweights[named].dom = el;
2967 return El._flyweights[named];
2971 * Static method to retrieve Element objects. Uses simple caching to consistently return the same object.
2972 * Automatically fixes if an object was recreated with the same id via AJAX or DOM.
2973 * Shorthand of {@link Roo.Element#get}
2974 * @param {String/HTMLElement/Element} el The id of the node, a DOM Node or an existing Element.
2975 * @return {Element} The Element object
2981 * Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -
2982 * the dom node can be overwritten by other code.
2983 * Shorthand of {@link Roo.Element#fly}
2984 * @param {String/HTMLElement} el The dom node or id
2985 * @param {String} named (optional) Allows for creation of named reusable flyweights to
2986 * prevent conflicts (e.g. internally Roo uses "_internal")
2988 * @return {Element} The shared Element object
2994 // speedy lookup for elements never to box adjust
2995 var noBoxAdjust = Roo.isStrict ? {
2998 input:1, select:1, textarea:1
3000 if(Roo.isIE || Roo.isGecko){
3001 noBoxAdjust['button'] = 1;
3005 Roo.EventManager.on(window, 'unload', function(){
3007 delete El._flyweights;
3015 Roo.Element.selectorFunction = Roo.DomQuery.select;
3018 Roo.Element.select = function(selector, unique, root){
3020 if(typeof selector == "string"){
3021 els = Roo.Element.selectorFunction(selector, root);
3022 }else if(selector.length !== undefined){
3025 throw "Invalid selector";
3027 if(unique === true){
3028 return new Roo.CompositeElement(els);
3030 return new Roo.CompositeElementLite(els);
3034 * Selects elements based on the passed CSS selector to enable working on them as 1.
3035 * @param {String/Array} selector The CSS selector or an array of elements
3036 * @param {Boolean} unique (optional) true to create a unique Roo.Element for each element (defaults to a shared flyweight object)
3037 * @param {HTMLElement/String} root (optional) The root element of the query or id of the root
3038 * @return {CompositeElementLite/CompositeElement}
3042 Roo.select = Roo.Element.select;