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).
129 * Sets the element's visibility mode. When setVisible() is called it
130 * will use this to determine whether to set the visibility or the display property.
131 * @param visMode Element.VISIBILITY or Element.DISPLAY
132 * @return {Roo.Element} this
134 setVisibilityMode : function(visMode){
135 this.visibilityMode = visMode;
139 * Convenience method for setVisibilityMode(Element.DISPLAY)
140 * @param {String} display (optional) What to set display to when visible
141 * @return {Roo.Element} this
143 enableDisplayMode : function(display){
144 this.setVisibilityMode(El.DISPLAY);
145 if(typeof display != "undefined") { this.originalDisplay = display; }
150 * 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)
151 * @param {String} selector The simple selector to test
152 * @param {Number/String/HTMLElement/Element} maxDepth (optional) The max depth to
153 search as a number or element (defaults to 10 || document.body)
154 * @param {Boolean} returnEl (optional) True to return a Roo.Element object instead of DOM node
155 * @return {HTMLElement} The matching DOM node (or null if no match was found)
157 findParent : function(simpleSelector, maxDepth, returnEl){
158 var p = this.dom, b = document.body, depth = 0, dq = Roo.DomQuery, stopEl;
159 maxDepth = maxDepth || 50;
160 if(typeof maxDepth != "number"){
161 stopEl = Roo.getDom(maxDepth);
164 while(p && p.nodeType == 1 && depth < maxDepth && p != b && p != stopEl){
165 if(dq.is(p, simpleSelector)){
166 return returnEl ? Roo.get(p) : p;
176 * Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)
177 * @param {String} selector The simple selector to test
178 * @param {Number/String/HTMLElement/Element} maxDepth (optional) The max depth to
179 search as a number or element (defaults to 10 || document.body)
180 * @param {Boolean} returnEl (optional) True to return a Roo.Element object instead of DOM node
181 * @return {HTMLElement} The matching DOM node (or null if no match was found)
183 findParentNode : function(simpleSelector, maxDepth, returnEl){
184 var p = Roo.fly(this.dom.parentNode, '_internal');
185 return p ? p.findParent(simpleSelector, maxDepth, returnEl) : null;
189 * Looks at the scrollable parent element
191 findScrollableParent : function(){
193 var el = Roo.get(this.dom.parentNode);
194 Roo.log('D: '+JSON.stringify(D, null, 4));
198 !el.isScrollable() ||
202 D.getViewHeight() - el.dom.clientHeight > 15 ||
203 D.getViewWidth() - el.dom.clientWidth > 15
207 el.dom.nodeName.toLowerCase() != 'body'
209 el = Roo.get(el.dom.parentNode);
210 Roo.log('findparent:'+ JSON.stringify(el, null, 4));
214 if(!el.isScrollable()){
222 * Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first-child).
223 * This is a shortcut for findParentNode() that always returns an Roo.Element.
224 * @param {String} selector The simple selector to test
225 * @param {Number/String/HTMLElement/Element} maxDepth (optional) The max depth to
226 search as a number or element (defaults to 10 || document.body)
227 * @return {Roo.Element} The matching DOM node (or null if no match was found)
229 up : function(simpleSelector, maxDepth){
230 return this.findParentNode(simpleSelector, maxDepth, true);
236 * Returns true if this element matches the passed simple selector (e.g. div.some-class or span:first-child)
237 * @param {String} selector The simple selector to test
238 * @return {Boolean} True if this element matches the selector, else false
240 is : function(simpleSelector){
241 return Roo.DomQuery.is(this.dom, simpleSelector);
245 * Perform animation on this element.
246 * @param {Object} args The YUI animation control args
247 * @param {Float} duration (optional) How long the animation lasts in seconds (defaults to .35)
248 * @param {Function} onComplete (optional) Function to call when animation completes
249 * @param {String} easing (optional) Easing method to use (defaults to 'easeOut')
250 * @param {String} animType (optional) 'run' is the default. Can also be 'color', 'motion', or 'scroll'
251 * @return {Roo.Element} this
253 animate : function(args, duration, onComplete, easing, animType){
254 this.anim(args, {duration: duration, callback: onComplete, easing: easing}, animType);
259 * @private Internal animation call
261 anim : function(args, opt, animType, defaultDur, defaultEase, cb){
262 animType = animType || 'run';
264 var anim = Roo.lib.Anim[animType](
266 (opt.duration || defaultDur) || .35,
267 (opt.easing || defaultEase) || 'easeOut',
269 Roo.callback(cb, this);
270 Roo.callback(opt.callback, opt.scope || this, [this, opt]);
278 // private legacy anim prep
279 preanim : function(a, i){
280 return !a[i] ? false : (typeof a[i] == "object" ? a[i]: {duration: a[i+1], callback: a[i+2], easing: a[i+3]});
284 * Removes worthless text nodes
285 * @param {Boolean} forceReclean (optional) By default the element
286 * keeps track if it has been cleaned already so
287 * you can call this over and over. However, if you update the element and
288 * need to force a reclean, you can pass true.
290 clean : function(forceReclean){
291 if(this.isCleaned && forceReclean !== true){
295 var d = this.dom, n = d.firstChild, ni = -1;
297 var nx = n.nextSibling;
298 if(n.nodeType == 3 && !ns.test(n.nodeValue)){
305 this.isCleaned = true;
310 calcOffsetsTo : function(el){
313 var restorePos = false;
314 if(el.getStyle('position') == 'static'){
315 el.position('relative');
320 while(op && op != d && op.tagName != 'HTML'){
323 op = op.offsetParent;
326 el.position('static');
332 * Scrolls this element into view within the passed container.
333 * @param {String/HTMLElement/Element} container (optional) The container element to scroll (defaults to document.body)
334 * @param {Boolean} hscroll (optional) False to disable horizontal scroll (defaults to true)
335 * @return {Roo.Element} this
337 scrollIntoView : function(container, hscroll){
338 var c = Roo.getDom(container) || document.body;
341 var o = this.calcOffsetsTo(c),
344 b = t+el.offsetHeight,
345 r = l+el.offsetWidth;
347 var ch = c.clientHeight;
348 var ct = parseInt(c.scrollTop, 10);
349 var cl = parseInt(c.scrollLeft, 10);
351 var cr = cl + c.clientWidth;
359 if(hscroll !== false){
363 c.scrollLeft = r-c.clientWidth;
370 scrollChildIntoView : function(child, hscroll){
371 Roo.fly(child, '_scrollChildIntoView').scrollIntoView(this, hscroll);
375 * Measures the element's content height and updates height to match. Note: this function uses setTimeout so
376 * the new height may not be available immediately.
377 * @param {Boolean} animate (optional) Animate the transition (defaults to false)
378 * @param {Float} duration (optional) Length of the animation in seconds (defaults to .35)
379 * @param {Function} onComplete (optional) Function to call when animation completes
380 * @param {String} easing (optional) Easing method to use (defaults to easeOut)
381 * @return {Roo.Element} this
383 autoHeight : function(animate, duration, onComplete, easing){
384 var oldHeight = this.getHeight();
386 this.setHeight(1); // force clipping
387 setTimeout(function(){
388 var height = parseInt(this.dom.scrollHeight, 10); // parseInt for Safari
390 this.setHeight(height);
392 if(typeof onComplete == "function"){
396 this.setHeight(oldHeight); // restore original height
397 this.setHeight(height, animate, duration, function(){
399 if(typeof onComplete == "function") { onComplete(); }
400 }.createDelegate(this), easing);
402 }.createDelegate(this), 0);
407 * Returns true if this element is an ancestor of the passed element
408 * @param {HTMLElement/String} el The element to check
409 * @return {Boolean} True if this element is an ancestor of el, else false
411 contains : function(el){
412 if(!el){return false;}
413 return D.isAncestor(this.dom, el.dom ? el.dom : el);
417 * Checks whether the element is currently visible using both visibility and display properties.
418 * @param {Boolean} deep (optional) True to walk the dom and see if parent elements are hidden (defaults to false)
419 * @return {Boolean} True if the element is currently visible, else false
421 isVisible : function(deep) {
422 var vis = !(this.getStyle("visibility") == "hidden" || this.getStyle("display") == "none");
423 if(deep !== true || !vis){
426 var p = this.dom.parentNode;
427 while(p && p.tagName.toLowerCase() != "body"){
428 if(!Roo.fly(p, '_isVisible').isVisible()){
437 * Creates a {@link Roo.CompositeElement} for child nodes based on the passed CSS selector (the selector should not contain an id).
438 * @param {String} selector The CSS selector
439 * @param {Boolean} unique (optional) True to create a unique Roo.Element for each child (defaults to false, which creates a single shared flyweight object)
440 * @return {CompositeElement/CompositeElementLite} The composite element
442 select : function(selector, unique){
443 return El.select(selector, unique, this.dom);
447 * Selects child nodes based on the passed CSS selector (the selector should not contain an id).
448 * @param {String} selector The CSS selector
449 * @return {Array} An array of the matched nodes
451 query : function(selector, unique){
452 return Roo.DomQuery.select(selector, this.dom);
456 * Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id).
457 * @param {String} selector The CSS selector
458 * @param {Boolean} returnDom (optional) True to return the DOM node instead of Roo.Element (defaults to false)
459 * @return {HTMLElement/Roo.Element} The child Roo.Element (or DOM node if returnDom = true)
461 child : function(selector, returnDom){
462 var n = Roo.DomQuery.selectNode(selector, this.dom);
463 return returnDom ? n : Roo.get(n);
467 * Selects a single *direct* child based on the passed CSS selector (the selector should not contain an id).
468 * @param {String} selector The CSS selector
469 * @param {Boolean} returnDom (optional) True to return the DOM node instead of Roo.Element (defaults to false)
470 * @return {HTMLElement/Roo.Element} The child Roo.Element (or DOM node if returnDom = true)
472 down : function(selector, returnDom){
473 var n = Roo.DomQuery.selectNode(" > " + selector, this.dom);
474 return returnDom ? n : Roo.get(n);
478 * Initializes a {@link Roo.dd.DD} drag drop object for this element.
479 * @param {String} group The group the DD object is member of
480 * @param {Object} config The DD config object
481 * @param {Object} overrides An object containing methods to override/implement on the DD object
482 * @return {Roo.dd.DD} The DD object
484 initDD : function(group, config, overrides){
485 var dd = new Roo.dd.DD(Roo.id(this.dom), group, config);
486 return Roo.apply(dd, overrides);
490 * Initializes a {@link Roo.dd.DDProxy} object for this element.
491 * @param {String} group The group the DDProxy object is member of
492 * @param {Object} config The DDProxy config object
493 * @param {Object} overrides An object containing methods to override/implement on the DDProxy object
494 * @return {Roo.dd.DDProxy} The DDProxy object
496 initDDProxy : function(group, config, overrides){
497 var dd = new Roo.dd.DDProxy(Roo.id(this.dom), group, config);
498 return Roo.apply(dd, overrides);
502 * Initializes a {@link Roo.dd.DDTarget} object for this element.
503 * @param {String} group The group the DDTarget object is member of
504 * @param {Object} config The DDTarget config object
505 * @param {Object} overrides An object containing methods to override/implement on the DDTarget object
506 * @return {Roo.dd.DDTarget} The DDTarget object
508 initDDTarget : function(group, config, overrides){
509 var dd = new Roo.dd.DDTarget(Roo.id(this.dom), group, config);
510 return Roo.apply(dd, overrides);
514 * Sets the visibility of the element (see details). If the visibilityMode is set to Element.DISPLAY, it will use
515 * the display property to hide the element, otherwise it uses visibility. The default is to hide and show using the visibility property.
516 * @param {Boolean} visible Whether the element is visible
517 * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object
518 * @return {Roo.Element} this
520 setVisible : function(visible, animate){
522 if(this.visibilityMode == El.DISPLAY){
523 this.setDisplayed(visible);
526 this.dom.style.visibility = visible ? "visible" : "hidden";
529 // closure for composites
531 var visMode = this.visibilityMode;
533 this.setOpacity(.01);
534 this.setVisible(true);
536 this.anim({opacity: { to: (visible?1:0) }},
537 this.preanim(arguments, 1),
538 null, .35, 'easeIn', function(){
540 if(visMode == El.DISPLAY){
541 dom.style.display = "none";
543 dom.style.visibility = "hidden";
545 Roo.get(dom).setOpacity(1);
553 * Returns true if display is not "none"
556 isDisplayed : function() {
557 return this.getStyle("display") != "none";
561 * Toggles the element's visibility or display, depending on visibility mode.
562 * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object
563 * @return {Roo.Element} this
565 toggle : function(animate){
566 this.setVisible(!this.isVisible(), this.preanim(arguments, 0));
571 * Sets the CSS display property. Uses originalDisplay if the specified value is a boolean true.
572 * @param {Boolean} value Boolean value to display the element using its default display, or a string to set the display directly
573 * @return {Roo.Element} this
575 setDisplayed : function(value) {
576 if(typeof value == "boolean"){
577 value = value ? this.originalDisplay : "none";
579 this.setStyle("display", value);
584 * Tries to focus the element. Any exceptions are caught and ignored.
585 * @return {Roo.Element} this
595 * Tries to blur the element. Any exceptions are caught and ignored.
596 * @return {Roo.Element} this
606 * Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.
607 * @param {String/Array} className The CSS class to add, or an array of classes
608 * @return {Roo.Element} this
610 addClass : function(className){
611 if(className instanceof Array){
612 for(var i = 0, len = className.length; i < len; i++) {
613 this.addClass(className[i]);
616 if(className && !this.hasClass(className)){
617 this.dom.className = this.dom.className + " " + className;
624 * Adds one or more CSS classes to this element and removes the same class(es) from all siblings.
625 * @param {String/Array} className The CSS class to add, or an array of classes
626 * @return {Roo.Element} this
628 radioClass : function(className){
629 var siblings = this.dom.parentNode.childNodes;
630 for(var i = 0; i < siblings.length; i++) {
633 Roo.get(s).removeClass(className);
636 this.addClass(className);
641 * Removes one or more CSS classes from the element.
642 * @param {String/Array} className The CSS class to remove, or an array of classes
643 * @return {Roo.Element} this
645 removeClass : function(className){
646 if(!className || !this.dom.className){
649 if(className instanceof Array){
650 for(var i = 0, len = className.length; i < len; i++) {
651 this.removeClass(className[i]);
654 if(this.hasClass(className)){
655 var re = this.classReCache[className];
657 re = new RegExp('(?:^|\\s+)' + className + '(?:\\s+|$)', "g");
658 this.classReCache[className] = re;
661 this.dom.className.replace(re, " ");
671 * Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it).
672 * @param {String} className The CSS class to toggle
673 * @return {Roo.Element} this
675 toggleClass : function(className){
676 if(this.hasClass(className)){
677 this.removeClass(className);
679 this.addClass(className);
685 * Checks if the specified CSS class exists on this element's DOM node.
686 * @param {String} className The CSS class to check for
687 * @return {Boolean} True if the class exists, else false
689 hasClass : function(className){
690 return className && (' '+this.dom.className+' ').indexOf(' '+className+' ') != -1;
694 * Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added.
695 * @param {String} oldClassName The CSS class to replace
696 * @param {String} newClassName The replacement CSS class
697 * @return {Roo.Element} this
699 replaceClass : function(oldClassName, newClassName){
700 this.removeClass(oldClassName);
701 this.addClass(newClassName);
706 * Returns an object with properties matching the styles requested.
707 * For example, el.getStyles('color', 'font-size', 'width') might return
708 * {'color': '#FFFFFF', 'font-size': '13px', 'width': '100px'}.
709 * @param {String} style1 A style name
710 * @param {String} style2 A style name
711 * @param {String} etc.
712 * @return {Object} The style object
714 getStyles : function(){
715 var a = arguments, len = a.length, r = {};
716 for(var i = 0; i < len; i++){
717 r[a[i]] = this.getStyle(a[i]);
723 * Normalizes currentStyle and computedStyle. This is not YUI getStyle, it is an optimised version.
724 * @param {String} property The style property whose value is returned.
725 * @return {String} The current value of the style property for this element.
727 getStyle : function(){
728 return view && view.getComputedStyle ?
730 var el = this.dom, v, cs, camel;
734 if(el.style && (v = el.style[prop])){
737 if(cs = view.getComputedStyle(el, "")){
738 if(!(camel = propCache[prop])){
739 camel = propCache[prop] = prop.replace(camelRe, camelFn);
746 var el = this.dom, v, cs, camel;
747 if(prop == 'opacity'){
748 if(typeof el.style.filter == 'string'){
749 var m = el.style.filter.match(/alpha\(opacity=(.*)\)/i);
751 var fv = parseFloat(m[1]);
753 return fv ? fv / 100 : 0;
758 }else if(prop == 'float'){
761 if(!(camel = propCache[prop])){
762 camel = propCache[prop] = prop.replace(camelRe, camelFn);
764 if(v = el.style[camel]){
767 if(cs = el.currentStyle){
775 * Wrapper for setting style properties, also takes single object parameter of multiple styles.
776 * @param {String/Object} property The style property to be set, or an object of multiple styles.
777 * @param {String} value (optional) The value to apply to the given property, or null if an object was passed.
778 * @return {Roo.Element} this
780 setStyle : function(prop, value){
781 if(typeof prop == "string"){
783 if (prop == 'float') {
784 this.setStyle(Roo.isIE ? 'styleFloat' : 'cssFloat', value);
789 if(!(camel = propCache[prop])){
790 camel = propCache[prop] = prop.replace(camelRe, camelFn);
793 if(camel == 'opacity') {
794 this.setOpacity(value);
796 this.dom.style[camel] = value;
799 for(var style in prop){
800 if(typeof prop[style] != "function"){
801 this.setStyle(style, prop[style]);
809 * More flexible version of {@link #setStyle} for setting style properties.
810 * @param {String/Object/Function} styles A style specification string, e.g. "width:100px", or object in the form {width:"100px"}, or
811 * a function which returns such a specification.
812 * @return {Roo.Element} this
814 applyStyles : function(style){
815 Roo.DomHelper.applyStyles(this.dom, style);
820 * 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).
821 * @return {Number} The X position of the element
824 return D.getX(this.dom);
828 * 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).
829 * @return {Number} The Y position of the element
832 return D.getY(this.dom);
836 * 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).
837 * @return {Array} The XY position of the element
840 return D.getXY(this.dom);
844 * 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).
845 * @param {Number} The X position of the element
846 * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object
847 * @return {Roo.Element} this
849 setX : function(x, animate){
853 this.setXY([x, this.getY()], this.preanim(arguments, 1));
859 * 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).
860 * @param {Number} The Y position of the element
861 * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object
862 * @return {Roo.Element} this
864 setY : function(y, animate){
868 this.setXY([this.getX(), y], this.preanim(arguments, 1));
874 * Sets the element's left position directly using CSS style (instead of {@link #setX}).
875 * @param {String} left The left CSS property value
876 * @return {Roo.Element} this
878 setLeft : function(left){
879 this.setStyle("left", this.addUnits(left));
884 * Sets the element's top position directly using CSS style (instead of {@link #setY}).
885 * @param {String} top The top CSS property value
886 * @return {Roo.Element} this
888 setTop : function(top){
889 this.setStyle("top", this.addUnits(top));
894 * Sets the element's CSS right style.
895 * @param {String} right The right CSS property value
896 * @return {Roo.Element} this
898 setRight : function(right){
899 this.setStyle("right", this.addUnits(right));
904 * Sets the element's CSS bottom style.
905 * @param {String} bottom The bottom CSS property value
906 * @return {Roo.Element} this
908 setBottom : function(bottom){
909 this.setStyle("bottom", this.addUnits(bottom));
914 * Sets the position of the element in page coordinates, regardless of how the element is positioned.
915 * The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
916 * @param {Array} pos Contains X & Y [x, y] values for new position (coordinates are page-based)
917 * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object
918 * @return {Roo.Element} this
920 setXY : function(pos, animate){
922 D.setXY(this.dom, pos);
924 this.anim({points: {to: pos}}, this.preanim(arguments, 1), 'motion');
930 * Sets the position of the element in page coordinates, regardless of how the element is positioned.
931 * The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
932 * @param {Number} x X value for new position (coordinates are page-based)
933 * @param {Number} y Y value for new position (coordinates are page-based)
934 * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object
935 * @return {Roo.Element} this
937 setLocation : function(x, y, animate){
938 this.setXY([x, y], this.preanim(arguments, 2));
943 * Sets the position of the element in page coordinates, regardless of how the element is positioned.
944 * The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
945 * @param {Number} x X value for new position (coordinates are page-based)
946 * @param {Number} y Y value for new position (coordinates are page-based)
947 * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object
948 * @return {Roo.Element} this
950 moveTo : function(x, y, animate){
951 this.setXY([x, y], this.preanim(arguments, 2));
956 * Returns the region of the given element.
957 * The element must be part of the DOM tree to have a region (display:none or elements not appended return false).
958 * @return {Region} A Roo.lib.Region containing "top, left, bottom, right" member data.
960 getRegion : function(){
961 return D.getRegion(this.dom);
965 * Returns the offset height of the element
966 * @param {Boolean} contentHeight (optional) true to get the height minus borders and padding
967 * @return {Number} The element's height
969 getHeight : function(contentHeight){
970 var h = this.dom.offsetHeight || 0;
971 return contentHeight !== true ? h : h-this.getBorderWidth("tb")-this.getPadding("tb");
975 * Returns the offset width of the element
976 * @param {Boolean} contentWidth (optional) true to get the width minus borders and padding
977 * @return {Number} The element's width
979 getWidth : function(contentWidth){
980 var w = this.dom.offsetWidth || 0;
981 return contentWidth !== true ? w : w-this.getBorderWidth("lr")-this.getPadding("lr");
985 * Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders
986 * when needed to simulate offsetHeight when offsets aren't available. This may not work on display:none elements
987 * if a height has not been set using CSS.
990 getComputedHeight : function(){
991 var h = Math.max(this.dom.offsetHeight, this.dom.clientHeight);
993 h = parseInt(this.getStyle('height'), 10) || 0;
994 if(!this.isBorderBox()){
995 h += this.getFrameWidth('tb');
1002 * Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders
1003 * when needed to simulate offsetWidth when offsets aren't available. This may not work on display:none elements
1004 * if a width has not been set using CSS.
1007 getComputedWidth : function(){
1008 var w = Math.max(this.dom.offsetWidth, this.dom.clientWidth);
1010 w = parseInt(this.getStyle('width'), 10) || 0;
1011 if(!this.isBorderBox()){
1012 w += this.getFrameWidth('lr');
1019 * Returns the size of the element.
1020 * @param {Boolean} contentSize (optional) true to get the width/size minus borders and padding
1021 * @return {Object} An object containing the element's size {width: (element width), height: (element height)}
1023 getSize : function(contentSize){
1024 return {width: this.getWidth(contentSize), height: this.getHeight(contentSize)};
1028 * Returns the width and height of the viewport.
1029 * @return {Object} An object containing the viewport's size {width: (viewport width), height: (viewport height)}
1031 getViewSize : function(){
1032 var d = this.dom, doc = document, aw = 0, ah = 0;
1033 if(d == doc || d == doc.body){
1034 return {width : D.getViewWidth(), height: D.getViewHeight()};
1037 width : d.clientWidth,
1038 height: d.clientHeight
1044 * Returns the value of the "value" attribute
1045 * @param {Boolean} asNumber true to parse the value as a number
1046 * @return {String/Number}
1048 getValue : function(asNumber){
1049 return asNumber ? parseInt(this.dom.value, 10) : this.dom.value;
1053 adjustWidth : function(width){
1054 if(typeof width == "number"){
1055 if(this.autoBoxAdjust && !this.isBorderBox()){
1056 width -= (this.getBorderWidth("lr") + this.getPadding("lr"));
1066 adjustHeight : function(height){
1067 if(typeof height == "number"){
1068 if(this.autoBoxAdjust && !this.isBorderBox()){
1069 height -= (this.getBorderWidth("tb") + this.getPadding("tb"));
1079 * Set the width of the element
1080 * @param {Number} width The new width
1081 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1082 * @return {Roo.Element} this
1084 setWidth : function(width, animate){
1085 width = this.adjustWidth(width);
1087 this.dom.style.width = this.addUnits(width);
1089 this.anim({width: {to: width}}, this.preanim(arguments, 1));
1095 * Set the height of the element
1096 * @param {Number} height The new height
1097 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1098 * @return {Roo.Element} this
1100 setHeight : function(height, animate){
1101 height = this.adjustHeight(height);
1103 this.dom.style.height = this.addUnits(height);
1105 this.anim({height: {to: height}}, this.preanim(arguments, 1));
1111 * Set the size of the element. If animation is true, both width an height will be animated concurrently.
1112 * @param {Number} width The new width
1113 * @param {Number} height The new height
1114 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1115 * @return {Roo.Element} this
1117 setSize : function(width, height, animate){
1118 if(typeof width == "object"){ // in case of object from getSize()
1119 height = width.height; width = width.width;
1121 width = this.adjustWidth(width); height = this.adjustHeight(height);
1123 this.dom.style.width = this.addUnits(width);
1124 this.dom.style.height = this.addUnits(height);
1126 this.anim({width: {to: width}, height: {to: height}}, this.preanim(arguments, 2));
1132 * Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated concurrently.
1133 * @param {Number} x X value for new position (coordinates are page-based)
1134 * @param {Number} y Y value for new position (coordinates are page-based)
1135 * @param {Number} width The new width
1136 * @param {Number} height The new height
1137 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1138 * @return {Roo.Element} this
1140 setBounds : function(x, y, width, height, animate){
1142 this.setSize(width, height);
1143 this.setLocation(x, y);
1145 width = this.adjustWidth(width); height = this.adjustHeight(height);
1146 this.anim({points: {to: [x, y]}, width: {to: width}, height: {to: height}},
1147 this.preanim(arguments, 4), 'motion');
1153 * 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.
1154 * @param {Roo.lib.Region} region The region to fill
1155 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1156 * @return {Roo.Element} this
1158 setRegion : function(region, animate){
1159 this.setBounds(region.left, region.top, region.right-region.left, region.bottom-region.top, this.preanim(arguments, 1));
1164 * Appends an event handler
1166 * @param {String} eventName The type of event to append
1167 * @param {Function} fn The method the event invokes
1168 * @param {Object} scope (optional) The scope (this object) of the fn
1169 * @param {Object} options (optional)An object with standard {@link Roo.EventManager#addListener} options
1171 addListener : function(eventName, fn, scope, options){
1173 Roo.EventManager.on(this.dom, eventName, fn, scope || this, options);
1178 * Removes an event handler from this element
1179 * @param {String} eventName the type of event to remove
1180 * @param {Function} fn the method the event invokes
1181 * @return {Roo.Element} this
1183 removeListener : function(eventName, fn){
1184 Roo.EventManager.removeListener(this.dom, eventName, fn);
1189 * Removes all previous added listeners from this element
1190 * @return {Roo.Element} this
1192 removeAllListeners : function(){
1193 E.purgeElement(this.dom);
1197 relayEvent : function(eventName, observable){
1198 this.on(eventName, function(e){
1199 observable.fireEvent(eventName, e);
1204 * Set the opacity of the element
1205 * @param {Float} opacity The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc
1206 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1207 * @return {Roo.Element} this
1209 setOpacity : function(opacity, animate){
1211 var s = this.dom.style;
1214 s.filter = (s.filter || '').replace(/alpha\([^\)]*\)/gi,"") +
1215 (opacity == 1 ? "" : "alpha(opacity=" + opacity * 100 + ")");
1217 s.opacity = opacity;
1220 this.anim({opacity: {to: opacity}}, this.preanim(arguments, 1), null, .35, 'easeIn');
1226 * Gets the left X coordinate
1227 * @param {Boolean} local True to get the local css position instead of page coordinate
1230 getLeft : function(local){
1234 return parseInt(this.getStyle("left"), 10) || 0;
1239 * Gets the right X coordinate of the element (element X position + element width)
1240 * @param {Boolean} local True to get the local css position instead of page coordinate
1243 getRight : function(local){
1245 return this.getX() + this.getWidth();
1247 return (this.getLeft(true) + this.getWidth()) || 0;
1252 * Gets the top Y coordinate
1253 * @param {Boolean} local True to get the local css position instead of page coordinate
1256 getTop : function(local) {
1260 return parseInt(this.getStyle("top"), 10) || 0;
1265 * Gets the bottom Y coordinate of the element (element Y position + element height)
1266 * @param {Boolean} local True to get the local css position instead of page coordinate
1269 getBottom : function(local){
1271 return this.getY() + this.getHeight();
1273 return (this.getTop(true) + this.getHeight()) || 0;
1278 * Initializes positioning on this element. If a desired position is not passed, it will make the
1279 * the element positioned relative IF it is not already positioned.
1280 * @param {String} pos (optional) Positioning to use "relative", "absolute" or "fixed"
1281 * @param {Number} zIndex (optional) The zIndex to apply
1282 * @param {Number} x (optional) Set the page X position
1283 * @param {Number} y (optional) Set the page Y position
1285 position : function(pos, zIndex, x, y){
1287 if(this.getStyle('position') == 'static'){
1288 this.setStyle('position', 'relative');
1291 this.setStyle("position", pos);
1294 this.setStyle("z-index", zIndex);
1296 if(x !== undefined && y !== undefined){
1298 }else if(x !== undefined){
1300 }else if(y !== undefined){
1306 * Clear positioning back to the default when the document was loaded
1307 * @param {String} value (optional) The value to use for the left,right,top,bottom, defaults to '' (empty string). You could use 'auto'.
1308 * @return {Roo.Element} this
1310 clearPositioning : function(value){
1318 "position" : "static"
1324 * Gets an object with all CSS positioning properties. Useful along with setPostioning to get
1325 * snapshot before performing an update and then restoring the element.
1328 getPositioning : function(){
1329 var l = this.getStyle("left");
1330 var t = this.getStyle("top");
1332 "position" : this.getStyle("position"),
1334 "right" : l ? "" : this.getStyle("right"),
1336 "bottom" : t ? "" : this.getStyle("bottom"),
1337 "z-index" : this.getStyle("z-index")
1342 * Gets the width of the border(s) for the specified side(s)
1343 * @param {String} side Can be t, l, r, b or any combination of those to add multiple values. For example,
1344 * passing lr would get the border (l)eft width + the border (r)ight width.
1345 * @return {Number} The width of the sides passed added together
1347 getBorderWidth : function(side){
1348 return this.addStyles(side, El.borders);
1352 * Gets the width of the padding(s) for the specified side(s)
1353 * @param {String} side Can be t, l, r, b or any combination of those to add multiple values. For example,
1354 * passing lr would get the padding (l)eft + the padding (r)ight.
1355 * @return {Number} The padding of the sides passed added together
1357 getPadding : function(side){
1358 return this.addStyles(side, El.paddings);
1362 * Set positioning with an object returned by getPositioning().
1363 * @param {Object} posCfg
1364 * @return {Roo.Element} this
1366 setPositioning : function(pc){
1367 this.applyStyles(pc);
1368 if(pc.right == "auto"){
1369 this.dom.style.right = "";
1371 if(pc.bottom == "auto"){
1372 this.dom.style.bottom = "";
1378 fixDisplay : function(){
1379 if(this.getStyle("display") == "none"){
1380 this.setStyle("visibility", "hidden");
1381 this.setStyle("display", this.originalDisplay); // first try reverting to default
1382 if(this.getStyle("display") == "none"){ // if that fails, default to block
1383 this.setStyle("display", "block");
1389 * Quick set left and top adding default units
1390 * @param {String} left The left CSS property value
1391 * @param {String} top The top CSS property value
1392 * @return {Roo.Element} this
1394 setLeftTop : function(left, top){
1395 this.dom.style.left = this.addUnits(left);
1396 this.dom.style.top = this.addUnits(top);
1401 * Move this element relative to its current position.
1402 * @param {String} direction Possible values are: "l","left" - "r","right" - "t","top","up" - "b","bottom","down".
1403 * @param {Number} distance How far to move the element in pixels
1404 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1405 * @return {Roo.Element} this
1407 move : function(direction, distance, animate){
1408 var xy = this.getXY();
1409 direction = direction.toLowerCase();
1413 this.moveTo(xy[0]-distance, xy[1], this.preanim(arguments, 2));
1417 this.moveTo(xy[0]+distance, xy[1], this.preanim(arguments, 2));
1422 this.moveTo(xy[0], xy[1]-distance, this.preanim(arguments, 2));
1427 this.moveTo(xy[0], xy[1]+distance, this.preanim(arguments, 2));
1434 * Store the current overflow setting and clip overflow on the element - use {@link #unclip} to remove
1435 * @return {Roo.Element} this
1438 if(!this.isClipped){
1439 this.isClipped = true;
1440 this.originalClip = {
1441 "o": this.getStyle("overflow"),
1442 "x": this.getStyle("overflow-x"),
1443 "y": this.getStyle("overflow-y")
1445 this.setStyle("overflow", "hidden");
1446 this.setStyle("overflow-x", "hidden");
1447 this.setStyle("overflow-y", "hidden");
1453 * Return clipping (overflow) to original clipping before clip() was called
1454 * @return {Roo.Element} this
1456 unclip : function(){
1458 this.isClipped = false;
1459 var o = this.originalClip;
1460 if(o.o){this.setStyle("overflow", o.o);}
1461 if(o.x){this.setStyle("overflow-x", o.x);}
1462 if(o.y){this.setStyle("overflow-y", o.y);}
1469 * Gets the x,y coordinates specified by the anchor position on the element.
1470 * @param {String} anchor (optional) The specified anchor position (defaults to "c"). See {@link #alignTo} for details on supported anchor positions.
1471 * @param {Object} size (optional) An object containing the size to use for calculating anchor position
1472 * {width: (target width), height: (target height)} (defaults to the element's current size)
1473 * @param {Boolean} local (optional) True to get the local (element top/left-relative) anchor position instead of page coordinates
1474 * @return {Array} [x, y] An array containing the element's x and y coordinates
1476 getAnchorXY : function(anchor, local, s){
1477 //Passing a different size is useful for pre-calculating anchors,
1478 //especially for anchored animations that change the el size.
1480 var w, h, vp = false;
1483 if(d == document.body || d == document){
1485 w = D.getViewWidth(); h = D.getViewHeight();
1487 w = this.getWidth(); h = this.getHeight();
1490 w = s.width; h = s.height;
1492 var x = 0, y = 0, r = Math.round;
1493 switch((anchor || "tl").toLowerCase()){
1535 var sc = this.getScroll();
1536 return [x + sc.left, y + sc.top];
1538 //Add the element's offset xy
1539 var o = this.getXY();
1540 return [x+o[0], y+o[1]];
1544 * Gets the x,y coordinates to align this element with another element. See {@link #alignTo} for more info on the
1545 * supported position values.
1546 * @param {String/HTMLElement/Roo.Element} element The element to align to.
1547 * @param {String} position The position to align to.
1548 * @param {Array} offsets (optional) Offset the positioning by [x, y]
1549 * @return {Array} [x, y]
1551 getAlignToXY : function(el, p, o){
1555 throw "Element.alignTo with an element that doesn't exist";
1557 var c = false; //constrain to viewport
1558 var p1 = "", p2 = "";
1565 }else if(p.indexOf("-") == -1){
1568 p = p.toLowerCase();
1569 var m = p.match(/^([a-z]+)-([a-z]+)(\?)?$/);
1571 throw "Element.alignTo with an invalid alignment " + p;
1573 p1 = m[1]; p2 = m[2]; c = !!m[3];
1575 //Subtract the aligned el's internal xy from the target's offset xy
1576 //plus custom offset to get the aligned el's new offset xy
1577 var a1 = this.getAnchorXY(p1, true);
1578 var a2 = el.getAnchorXY(p2, false);
1579 var x = a2[0] - a1[0] + o[0];
1580 var y = a2[1] - a1[1] + o[1];
1582 //constrain the aligned el to viewport if necessary
1583 var w = this.getWidth(), h = this.getHeight(), r = el.getRegion();
1584 // 5px of margin for ie
1585 var dw = D.getViewWidth()-5, dh = D.getViewHeight()-5;
1587 //If we are at a viewport boundary and the aligned el is anchored on a target border that is
1588 //perpendicular to the vp border, allow the aligned el to slide on that border,
1589 //otherwise swap the aligned el to the opposite border of the target.
1590 var p1y = p1.charAt(0), p1x = p1.charAt(p1.length-1);
1591 var p2y = p2.charAt(0), p2x = p2.charAt(p2.length-1);
1592 var swapY = ((p1y=="t" && p2y=="b") || (p1y=="b" && p2y=="t"));
1593 var swapX = ((p1x=="r" && p2x=="l") || (p1x=="l" && p2x=="r"));
1596 var scrollX = (doc.documentElement.scrollLeft || doc.body.scrollLeft || 0)+5;
1597 var scrollY = (doc.documentElement.scrollTop || doc.body.scrollTop || 0)+5;
1599 if((x+w) > dw + scrollX){
1600 x = swapX ? r.left-w : dw+scrollX-w;
1603 x = swapX ? r.right : scrollX;
1605 if((y+h) > dh + scrollY){
1606 y = swapY ? r.top-h : dh+scrollY-h;
1609 y = swapY ? r.bottom : scrollY;
1616 getConstrainToXY : function(){
1617 var os = {top:0, left:0, bottom:0, right: 0};
1619 return function(el, local, offsets, proposedXY){
1621 offsets = offsets ? Roo.applyIf(offsets, os) : os;
1623 var vw, vh, vx = 0, vy = 0;
1624 if(el.dom == document.body || el.dom == document){
1625 vw = Roo.lib.Dom.getViewWidth();
1626 vh = Roo.lib.Dom.getViewHeight();
1628 vw = el.dom.clientWidth;
1629 vh = el.dom.clientHeight;
1631 var vxy = el.getXY();
1637 var s = el.getScroll();
1639 vx += offsets.left + s.left;
1640 vy += offsets.top + s.top;
1642 vw -= offsets.right;
1643 vh -= offsets.bottom;
1648 var xy = proposedXY || (!local ? this.getXY() : [this.getLeft(true), this.getTop(true)]);
1649 var x = xy[0], y = xy[1];
1650 var w = this.dom.offsetWidth, h = this.dom.offsetHeight;
1652 // only move it if it needs it
1655 // first validate right/bottom
1664 // then make sure top/left isn't negative
1673 return moved ? [x, y] : false;
1678 adjustForConstraints : function(xy, parent, offsets){
1679 return this.getConstrainToXY(parent || document, false, offsets, xy) || xy;
1683 * Aligns this element with another element relative to the specified anchor points. If the other element is the
1684 * document it aligns it to the viewport.
1685 * The position parameter is optional, and can be specified in any one of the following formats:
1687 * <li><b>Blank</b>: Defaults to aligning the element's top-left corner to the target's bottom-left corner ("tl-bl").</li>
1688 * <li><b>One anchor (deprecated)</b>: The passed anchor position is used as the target element's anchor point.
1689 * The element being aligned will position its top-left corner (tl) to that point. <i>This method has been
1690 * deprecated in favor of the newer two anchor syntax below</i>.</li>
1691 * <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
1692 * element's anchor point, and the second value is used as the target's anchor point.</li>
1694 * In addition to the anchor points, the position parameter also supports the "?" character. If "?" is passed at the end of
1695 * the position string, the element will attempt to align as specified, but the position will be adjusted to constrain to
1696 * the viewport if necessary. Note that the element being aligned might be swapped to align to a different position than
1697 * that specified in order to enforce the viewport constraints.
1698 * Following are all of the supported anchor positions:
1701 ----- -----------------------------
1702 tl The top left corner (default)
1703 t The center of the top edge
1704 tr The top right corner
1705 l The center of the left edge
1706 c In the center of the element
1707 r The center of the right edge
1708 bl The bottom left corner
1709 b The center of the bottom edge
1710 br The bottom right corner
1714 // align el to other-el using the default positioning ("tl-bl", non-constrained)
1715 el.alignTo("other-el");
1717 // align the top left corner of el with the top right corner of other-el (constrained to viewport)
1718 el.alignTo("other-el", "tr?");
1720 // align the bottom right corner of el with the center left edge of other-el
1721 el.alignTo("other-el", "br-l?");
1723 // align the center of el with the bottom left corner of other-el and
1724 // adjust the x position by -6 pixels (and the y position by 0)
1725 el.alignTo("other-el", "c-bl", [-6, 0]);
1727 * @param {String/HTMLElement/Roo.Element} element The element to align to.
1728 * @param {String} position The position to align to.
1729 * @param {Array} offsets (optional) Offset the positioning by [x, y]
1730 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1731 * @return {Roo.Element} this
1733 alignTo : function(element, position, offsets, animate){
1734 var xy = this.getAlignToXY(element, position, offsets);
1735 this.setXY(xy, this.preanim(arguments, 3));
1740 * Anchors an element to another element and realigns it when the window is resized.
1741 * @param {String/HTMLElement/Roo.Element} element The element to align to.
1742 * @param {String} position The position to align to.
1743 * @param {Array} offsets (optional) Offset the positioning by [x, y]
1744 * @param {Boolean/Object} animate (optional) True for the default animation or a standard Element animation config object
1745 * @param {Boolean/Number} monitorScroll (optional) True to monitor body scroll and reposition. If this parameter
1746 * is a number, it is used as the buffer delay (defaults to 50ms).
1747 * @param {Function} callback The function to call after the animation finishes
1748 * @return {Roo.Element} this
1750 anchorTo : function(el, alignment, offsets, animate, monitorScroll, callback){
1751 var action = function(){
1752 this.alignTo(el, alignment, offsets, animate);
1753 Roo.callback(callback, this);
1755 Roo.EventManager.onWindowResize(action, this);
1756 var tm = typeof monitorScroll;
1757 if(tm != 'undefined'){
1758 Roo.EventManager.on(window, 'scroll', action, this,
1759 {buffer: tm == 'number' ? monitorScroll : 50});
1761 action.call(this); // align immediately
1765 * Clears any opacity settings from this element. Required in some cases for IE.
1766 * @return {Roo.Element} this
1768 clearOpacity : function(){
1769 if (window.ActiveXObject) {
1770 if(typeof this.dom.style.filter == 'string' && (/alpha/i).test(this.dom.style.filter)){
1771 this.dom.style.filter = "";
1774 this.dom.style.opacity = "";
1775 this.dom.style["-moz-opacity"] = "";
1776 this.dom.style["-khtml-opacity"] = "";
1782 * Hide this element - Uses display mode to determine whether to use "display" or "visibility". See {@link #setVisible}.
1783 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1784 * @return {Roo.Element} this
1786 hide : function(animate){
1787 this.setVisible(false, this.preanim(arguments, 0));
1792 * Show this element - Uses display mode to determine whether to use "display" or "visibility". See {@link #setVisible}.
1793 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1794 * @return {Roo.Element} this
1796 show : function(animate){
1797 this.setVisible(true, this.preanim(arguments, 0));
1802 * @private Test if size has a unit, otherwise appends the default
1804 addUnits : function(size){
1805 return Roo.Element.addUnits(size, this.defaultUnit);
1809 * Temporarily enables offsets (width,height,x,y) for an element with display:none, use endMeasure() when done.
1810 * @return {Roo.Element} this
1812 beginMeasure : function(){
1814 if(el.offsetWidth || el.offsetHeight){
1815 return this; // offsets work already
1818 var p = this.dom, b = document.body; // start with this element
1819 while((!el.offsetWidth && !el.offsetHeight) && p && p.tagName && p != b){
1820 var pe = Roo.get(p);
1821 if(pe.getStyle('display') == 'none'){
1822 changed.push({el: p, visibility: pe.getStyle("visibility")});
1823 p.style.visibility = "hidden";
1824 p.style.display = "block";
1828 this._measureChanged = changed;
1834 * Restores displays to before beginMeasure was called
1835 * @return {Roo.Element} this
1837 endMeasure : function(){
1838 var changed = this._measureChanged;
1840 for(var i = 0, len = changed.length; i < len; i++) {
1842 r.el.style.visibility = r.visibility;
1843 r.el.style.display = "none";
1845 this._measureChanged = null;
1851 * Update the innerHTML of this element, optionally searching for and processing scripts
1852 * @param {String} html The new HTML
1853 * @param {Boolean} loadScripts (optional) true to look for and process scripts
1854 * @param {Function} callback For async script loading you can be noticed when the update completes
1855 * @return {Roo.Element} this
1857 update : function(html, loadScripts, callback){
1858 if(typeof html == "undefined"){
1861 if(loadScripts !== true){
1862 this.dom.innerHTML = html;
1863 if(typeof callback == "function"){
1871 html += '<span id="' + id + '"></span>';
1873 E.onAvailable(id, function(){
1874 var hd = document.getElementsByTagName("head")[0];
1875 var re = /(?:<script([^>]*)?>)((\n|\r|.)*?)(?:<\/script>)/ig;
1876 var srcRe = /\ssrc=([\'\"])(.*?)\1/i;
1877 var typeRe = /\stype=([\'\"])(.*?)\1/i;
1880 while(match = re.exec(html)){
1881 var attrs = match[1];
1882 var srcMatch = attrs ? attrs.match(srcRe) : false;
1883 if(srcMatch && srcMatch[2]){
1884 var s = document.createElement("script");
1885 s.src = srcMatch[2];
1886 var typeMatch = attrs.match(typeRe);
1887 if(typeMatch && typeMatch[2]){
1888 s.type = typeMatch[2];
1891 }else if(match[2] && match[2].length > 0){
1892 if(window.execScript) {
1893 window.execScript(match[2]);
1901 window.eval(match[2]);
1905 var el = document.getElementById(id);
1906 if(el){el.parentNode.removeChild(el);}
1907 if(typeof callback == "function"){
1911 dom.innerHTML = html.replace(/(?:<script.*?>)((\n|\r|.)*?)(?:<\/script>)/ig, "");
1916 * Direct access to the UpdateManager update() method (takes the same parameters).
1917 * @param {String/Function} url The url for this request or a function to call to get the url
1918 * @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}
1919 * @param {Function} callback (optional) Callback when transaction is complete - called with signature (oElement, bSuccess)
1920 * @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.
1921 * @return {Roo.Element} this
1924 var um = this.getUpdateManager();
1925 um.update.apply(um, arguments);
1930 * Gets this element's UpdateManager
1931 * @return {Roo.UpdateManager} The UpdateManager
1933 getUpdateManager : function(){
1934 if(!this.updateManager){
1935 this.updateManager = new Roo.UpdateManager(this);
1937 return this.updateManager;
1941 * Disables text selection for this element (normalized across browsers)
1942 * @return {Roo.Element} this
1944 unselectable : function(){
1945 this.dom.unselectable = "on";
1946 this.swallowEvent("selectstart", true);
1947 this.applyStyles("-moz-user-select:none;-khtml-user-select:none;");
1948 this.addClass("x-unselectable");
1953 * Calculates the x, y to center this element on the screen
1954 * @return {Array} The x, y values [x, y]
1956 getCenterXY : function(){
1957 return this.getAlignToXY(document, 'c-c');
1961 * Centers the Element in either the viewport, or another Element.
1962 * @param {String/HTMLElement/Roo.Element} centerIn (optional) The element in which to center the element.
1964 center : function(centerIn){
1965 this.alignTo(centerIn || document, 'c-c');
1970 * Tests various css rules/browsers to determine if this element uses a border box
1973 isBorderBox : function(){
1974 return noBoxAdjust[this.dom.tagName.toLowerCase()] || Roo.isBorderBox;
1978 * Return a box {x, y, width, height} that can be used to set another elements
1979 * size/location to match this element.
1980 * @param {Boolean} contentBox (optional) If true a box for the content of the element is returned.
1981 * @param {Boolean} local (optional) If true the element's left and top are returned instead of page x/y.
1982 * @return {Object} box An object in the format {x, y, width, height}
1984 getBox : function(contentBox, local){
1989 var left = parseInt(this.getStyle("left"), 10) || 0;
1990 var top = parseInt(this.getStyle("top"), 10) || 0;
1993 var el = this.dom, w = el.offsetWidth, h = el.offsetHeight, bx;
1995 bx = {x: xy[0], y: xy[1], 0: xy[0], 1: xy[1], width: w, height: h};
1997 var l = this.getBorderWidth("l")+this.getPadding("l");
1998 var r = this.getBorderWidth("r")+this.getPadding("r");
1999 var t = this.getBorderWidth("t")+this.getPadding("t");
2000 var b = this.getBorderWidth("b")+this.getPadding("b");
2001 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)};
2003 bx.right = bx.x + bx.width;
2004 bx.bottom = bx.y + bx.height;
2009 * Returns the sum width of the padding and borders for the passed "sides". See getBorderWidth()
2010 for more information about the sides.
2011 * @param {String} sides
2014 getFrameWidth : function(sides, onlyContentBox){
2015 return onlyContentBox && Roo.isBorderBox ? 0 : (this.getPadding(sides) + this.getBorderWidth(sides));
2019 * 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.
2020 * @param {Object} box The box to fill {x, y, width, height}
2021 * @param {Boolean} adjust (optional) Whether to adjust for box-model issues automatically
2022 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
2023 * @return {Roo.Element} this
2025 setBox : function(box, adjust, animate){
2026 var w = box.width, h = box.height;
2027 if((adjust && !this.autoBoxAdjust) && !this.isBorderBox()){
2028 w -= (this.getBorderWidth("lr") + this.getPadding("lr"));
2029 h -= (this.getBorderWidth("tb") + this.getPadding("tb"));
2031 this.setBounds(box.x, box.y, w, h, this.preanim(arguments, 2));
2036 * Forces the browser to repaint this element
2037 * @return {Roo.Element} this
2039 repaint : function(){
2041 this.addClass("x-repaint");
2042 setTimeout(function(){
2043 Roo.get(dom).removeClass("x-repaint");
2049 * Returns an object with properties top, left, right and bottom representing the margins of this element unless sides is passed,
2050 * then it returns the calculated width of the sides (see getPadding)
2051 * @param {String} sides (optional) Any combination of l, r, t, b to get the sum of those sides
2052 * @return {Object/Number}
2054 getMargins : function(side){
2057 top: parseInt(this.getStyle("margin-top"), 10) || 0,
2058 left: parseInt(this.getStyle("margin-left"), 10) || 0,
2059 bottom: parseInt(this.getStyle("margin-bottom"), 10) || 0,
2060 right: parseInt(this.getStyle("margin-right"), 10) || 0
2063 return this.addStyles(side, El.margins);
2068 addStyles : function(sides, styles){
2070 for(var i = 0, len = sides.length; i < len; i++){
2071 v = this.getStyle(styles[sides.charAt(i)]);
2073 w = parseInt(v, 10);
2081 * Creates a proxy element of this element
2082 * @param {String/Object} config The class name of the proxy element or a DomHelper config object
2083 * @param {String/HTMLElement} renderTo (optional) The element or element id to render the proxy to (defaults to document.body)
2084 * @param {Boolean} matchBox (optional) True to align and size the proxy to this element now (defaults to false)
2085 * @return {Roo.Element} The new proxy element
2087 createProxy : function(config, renderTo, matchBox){
2089 renderTo = Roo.getDom(renderTo);
2091 renderTo = document.body;
2093 config = typeof config == "object" ?
2094 config : {tag : "div", cls: config};
2095 var proxy = Roo.DomHelper.append(renderTo, config, true);
2097 proxy.setBox(this.getBox());
2103 * Puts a mask over this element to disable user interaction. Requires core.css.
2104 * This method can only be applied to elements which accept child nodes.
2105 * @param {String} msg (optional) A message to display in the mask
2106 * @param {String} msgCls (optional) A css class to apply to the msg element
2107 * @return {Element} The mask element
2109 mask : function(msg, msgCls)
2111 if(this.getStyle("position") == "static" && this.dom.tagName !== 'BODY'){
2112 this.setStyle("position", "relative");
2115 this._mask = Roo.DomHelper.append(this.dom, {cls:"roo-el-mask"}, true);
2117 this.addClass("x-masked");
2118 this._mask.setDisplayed(true);
2123 while (dom && dom.style) {
2124 if (!isNaN(parseInt(dom.style.zIndex))) {
2125 z = Math.max(z, parseInt(dom.style.zIndex));
2127 dom = dom.parentNode;
2129 // if we are masking the body - then it hides everything..
2130 if (this.dom == document.body) {
2132 this._mask.setWidth(Roo.lib.Dom.getDocumentWidth());
2133 this._mask.setHeight(Roo.lib.Dom.getDocumentHeight());
2136 if(typeof msg == 'string'){
2138 this._maskMsg = Roo.DomHelper.append(this.dom, {cls:"roo-el-mask-msg", cn:{tag:'div'}}, true);
2140 var mm = this._maskMsg;
2141 mm.dom.className = msgCls ? "roo-el-mask-msg " + msgCls : "roo-el-mask-msg";
2142 if (mm.dom.firstChild) { // weird IE issue?
2143 mm.dom.firstChild.innerHTML = msg;
2145 mm.setDisplayed(true);
2147 mm.setStyle('z-index', z + 102);
2149 if(Roo.isIE && !(Roo.isIE7 && Roo.isStrict) && this.getStyle('height') == 'auto'){ // ie will not expand full height automatically
2150 this._mask.setHeight(this.getHeight());
2152 this._mask.setStyle('z-index', z + 100);
2158 * Removes a previously applied mask. If removeEl is true the mask overlay is destroyed, otherwise
2159 * it is cached for reuse.
2161 unmask : function(removeEl){
2163 if(removeEl === true){
2164 this._mask.remove();
2167 this._maskMsg.remove();
2168 delete this._maskMsg;
2171 this._mask.setDisplayed(false);
2173 this._maskMsg.setDisplayed(false);
2177 this.removeClass("x-masked");
2181 * Returns true if this element is masked
2184 isMasked : function(){
2185 return this._mask && this._mask.isVisible();
2189 * Creates an iframe shim for this element to keep selects and other windowed objects from
2191 * @return {Roo.Element} The new shim element
2193 createShim : function(){
2194 var el = document.createElement('iframe');
2195 el.frameBorder = 'no';
2196 el.className = 'roo-shim';
2197 if(Roo.isIE && Roo.isSecure){
2198 el.src = Roo.SSL_SECURE_URL;
2200 var shim = Roo.get(this.dom.parentNode.insertBefore(el, this.dom));
2201 shim.autoBoxAdjust = false;
2206 * Removes this element from the DOM and deletes it from the cache
2208 remove : function(){
2209 if(this.dom.parentNode){
2210 this.dom.parentNode.removeChild(this.dom);
2212 delete El.cache[this.dom.id];
2216 * Sets up event handlers to add and remove a css class when the mouse is over this element
2217 * @param {String} className
2218 * @param {Boolean} preventFlicker (optional) If set to true, it prevents flickering by filtering
2219 * mouseout events for children elements
2220 * @return {Roo.Element} this
2222 addClassOnOver : function(className, preventFlicker){
2223 this.on("mouseover", function(){
2224 Roo.fly(this, '_internal').addClass(className);
2226 var removeFn = function(e){
2227 if(preventFlicker !== true || !e.within(this, true)){
2228 Roo.fly(this, '_internal').removeClass(className);
2231 this.on("mouseout", removeFn, this.dom);
2236 * Sets up event handlers to add and remove a css class when this element has the focus
2237 * @param {String} className
2238 * @return {Roo.Element} this
2240 addClassOnFocus : function(className){
2241 this.on("focus", function(){
2242 Roo.fly(this, '_internal').addClass(className);
2244 this.on("blur", function(){
2245 Roo.fly(this, '_internal').removeClass(className);
2250 * 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)
2251 * @param {String} className
2252 * @return {Roo.Element} this
2254 addClassOnClick : function(className){
2256 this.on("mousedown", function(){
2257 Roo.fly(dom, '_internal').addClass(className);
2258 var d = Roo.get(document);
2259 var fn = function(){
2260 Roo.fly(dom, '_internal').removeClass(className);
2261 d.removeListener("mouseup", fn);
2263 d.on("mouseup", fn);
2269 * Stops the specified event from bubbling and optionally prevents the default action
2270 * @param {String} eventName
2271 * @param {Boolean} preventDefault (optional) true to prevent the default action too
2272 * @return {Roo.Element} this
2274 swallowEvent : function(eventName, preventDefault){
2275 var fn = function(e){
2276 e.stopPropagation();
2281 if(eventName instanceof Array){
2282 for(var i = 0, len = eventName.length; i < len; i++){
2283 this.on(eventName[i], fn);
2287 this.on(eventName, fn);
2294 fitToParentDelegate : Roo.emptyFn, // keep a reference to the fitToParent delegate
2297 * Sizes this element to its parent element's dimensions performing
2298 * neccessary box adjustments.
2299 * @param {Boolean} monitorResize (optional) If true maintains the fit when the browser window is resized.
2300 * @param {String/HTMLElment/Element} targetParent (optional) The target parent, default to the parentNode.
2301 * @return {Roo.Element} this
2303 fitToParent : function(monitorResize, targetParent) {
2304 Roo.EventManager.removeResizeListener(this.fitToParentDelegate); // always remove previous fitToParent delegate from onWindowResize
2305 this.fitToParentDelegate = Roo.emptyFn; // remove reference to previous delegate
2306 if (monitorResize === true && !this.dom.parentNode) { // check if this Element still exists
2309 var p = Roo.get(targetParent || this.dom.parentNode);
2310 this.setSize(p.getComputedWidth() - p.getFrameWidth('lr'), p.getComputedHeight() - p.getFrameWidth('tb'));
2311 if (monitorResize === true) {
2312 this.fitToParentDelegate = this.fitToParent.createDelegate(this, [true, targetParent]);
2313 Roo.EventManager.onWindowResize(this.fitToParentDelegate);
2319 * Gets the next sibling, skipping text nodes
2320 * @return {HTMLElement} The next sibling or null
2322 getNextSibling : function(){
2323 var n = this.dom.nextSibling;
2324 while(n && n.nodeType != 1){
2331 * Gets the previous sibling, skipping text nodes
2332 * @return {HTMLElement} The previous sibling or null
2334 getPrevSibling : function(){
2335 var n = this.dom.previousSibling;
2336 while(n && n.nodeType != 1){
2337 n = n.previousSibling;
2344 * Appends the passed element(s) to this element
2345 * @param {String/HTMLElement/Array/Element/CompositeElement} el
2346 * @return {Roo.Element} this
2348 appendChild: function(el){
2355 * Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element.
2356 * @param {Object} config DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be
2357 * automatically generated with the specified attributes.
2358 * @param {HTMLElement} insertBefore (optional) a child element of this element
2359 * @param {Boolean} returnDom (optional) true to return the dom node instead of creating an Element
2360 * @return {Roo.Element} The new child element
2362 createChild: function(config, insertBefore, returnDom){
2363 config = config || {tag:'div'};
2365 return Roo.DomHelper.insertBefore(insertBefore, config, returnDom !== true);
2367 return Roo.DomHelper[!this.dom.firstChild ? 'overwrite' : 'append'](this.dom, config, returnDom !== true);
2371 * Appends this element to the passed element
2372 * @param {String/HTMLElement/Element} el The new parent element
2373 * @return {Roo.Element} this
2375 appendTo: function(el){
2376 el = Roo.getDom(el);
2377 el.appendChild(this.dom);
2382 * Inserts this element before the passed element in the DOM
2383 * @param {String/HTMLElement/Element} el The element to insert before
2384 * @return {Roo.Element} this
2386 insertBefore: function(el){
2387 el = Roo.getDom(el);
2388 el.parentNode.insertBefore(this.dom, el);
2393 * Inserts this element after the passed element in the DOM
2394 * @param {String/HTMLElement/Element} el The element to insert after
2395 * @return {Roo.Element} this
2397 insertAfter: function(el){
2398 el = Roo.getDom(el);
2399 el.parentNode.insertBefore(this.dom, el.nextSibling);
2404 * Inserts (or creates) an element (or DomHelper config) as the first child of the this element
2405 * @param {String/HTMLElement/Element/Object} el The id or element to insert or a DomHelper config to create and insert
2406 * @return {Roo.Element} The new child
2408 insertFirst: function(el, returnDom){
2410 if(typeof el == 'object' && !el.nodeType){ // dh config
2411 return this.createChild(el, this.dom.firstChild, returnDom);
2413 el = Roo.getDom(el);
2414 this.dom.insertBefore(el, this.dom.firstChild);
2415 return !returnDom ? Roo.get(el) : el;
2420 * Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element
2421 * @param {String/HTMLElement/Element/Object} el The id or element to insert or a DomHelper config to create and insert
2422 * @param {String} where (optional) 'before' or 'after' defaults to before
2423 * @param {Boolean} returnDom (optional) True to return the raw DOM element instead of Roo.Element
2424 * @return {Roo.Element} the inserted Element
2426 insertSibling: function(el, where, returnDom){
2427 where = where ? where.toLowerCase() : 'before';
2429 var rt, refNode = where == 'before' ? this.dom : this.dom.nextSibling;
2431 if(typeof el == 'object' && !el.nodeType){ // dh config
2432 if(where == 'after' && !this.dom.nextSibling){
2433 rt = Roo.DomHelper.append(this.dom.parentNode, el, !returnDom);
2435 rt = Roo.DomHelper[where == 'after' ? 'insertAfter' : 'insertBefore'](this.dom, el, !returnDom);
2439 rt = this.dom.parentNode.insertBefore(Roo.getDom(el),
2440 where == 'before' ? this.dom : this.dom.nextSibling);
2449 * Creates and wraps this element with another element
2450 * @param {Object} config (optional) DomHelper element config object for the wrapper element or null for an empty div
2451 * @param {Boolean} returnDom (optional) True to return the raw DOM element instead of Roo.Element
2452 * @return {HTMLElement/Element} The newly created wrapper element
2454 wrap: function(config, returnDom){
2456 config = {tag: "div"};
2458 var newEl = Roo.DomHelper.insertBefore(this.dom, config, !returnDom);
2459 newEl.dom ? newEl.dom.appendChild(this.dom) : newEl.appendChild(this.dom);
2464 * Replaces the passed element with this element
2465 * @param {String/HTMLElement/Element} el The element to replace
2466 * @return {Roo.Element} this
2468 replace: function(el){
2470 this.insertBefore(el);
2476 * Inserts an html fragment into this element
2477 * @param {String} where Where to insert the html in relation to the this element - beforeBegin, afterBegin, beforeEnd, afterEnd.
2478 * @param {String} html The HTML fragment
2479 * @param {Boolean} returnEl True to return an Roo.Element
2480 * @return {HTMLElement/Roo.Element} The inserted node (or nearest related if more than 1 inserted)
2482 insertHtml : function(where, html, returnEl){
2483 var el = Roo.DomHelper.insertHtml(where, this.dom, html);
2484 return returnEl ? Roo.get(el) : el;
2488 * Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)
2489 * @param {Object} o The object with the attributes
2490 * @param {Boolean} useSet (optional) false to override the default setAttribute to use expandos.
2491 * @return {Roo.Element} this
2493 set : function(o, useSet){
2495 useSet = typeof useSet == 'undefined' ? (el.setAttribute ? true : false) : useSet;
2497 if(attr == "style" || typeof o[attr] == "function") { continue; }
2499 el.className = o["cls"];
2502 el.setAttribute(attr, o[attr]);
2509 Roo.DomHelper.applyStyles(el, o.style);
2515 * Convenience method for constructing a KeyMap
2516 * @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:
2517 * {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}
2518 * @param {Function} fn The function to call
2519 * @param {Object} scope (optional) The scope of the function
2520 * @return {Roo.KeyMap} The KeyMap created
2522 addKeyListener : function(key, fn, scope){
2524 if(typeof key != "object" || key instanceof Array){
2540 return new Roo.KeyMap(this, config);
2544 * Creates a KeyMap for this element
2545 * @param {Object} config The KeyMap config. See {@link Roo.KeyMap} for more details
2546 * @return {Roo.KeyMap} The KeyMap created
2548 addKeyMap : function(config){
2549 return new Roo.KeyMap(this, config);
2553 * Returns true if this element is scrollable.
2556 isScrollable : function(){
2558 return dom.scrollHeight > dom.clientHeight || dom.scrollWidth > dom.clientWidth;
2562 * 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().
2563 * @param {String} side Either "left" for scrollLeft values or "top" for scrollTop values.
2564 * @param {Number} value The new scroll value
2565 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
2566 * @return {Element} this
2569 scrollTo : function(side, value, animate){
2570 var prop = side.toLowerCase() == "left" ? "scrollLeft" : "scrollTop";
2572 this.dom[prop] = value;
2574 var to = prop == "scrollLeft" ? [value, this.dom.scrollTop] : [this.dom.scrollLeft, value];
2575 this.anim({scroll: {"to": to}}, this.preanim(arguments, 2), 'scroll');
2581 * Scrolls this element the specified direction. Does bounds checking to make sure the scroll is
2582 * within this element's scrollable range.
2583 * @param {String} direction Possible values are: "l","left" - "r","right" - "t","top","up" - "b","bottom","down".
2584 * @param {Number} distance How far to scroll the element in pixels
2585 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
2586 * @return {Boolean} Returns true if a scroll was triggered or false if the element
2587 * was scrolled as far as it could go.
2589 scroll : function(direction, distance, animate){
2590 if(!this.isScrollable()){
2594 var l = el.scrollLeft, t = el.scrollTop;
2595 var w = el.scrollWidth, h = el.scrollHeight;
2596 var cw = el.clientWidth, ch = el.clientHeight;
2597 direction = direction.toLowerCase();
2598 var scrolled = false;
2599 var a = this.preanim(arguments, 2);
2604 var v = Math.min(l + distance, w-cw);
2605 this.scrollTo("left", v, a);
2612 var v = Math.max(l - distance, 0);
2613 this.scrollTo("left", v, a);
2621 var v = Math.max(t - distance, 0);
2622 this.scrollTo("top", v, a);
2630 var v = Math.min(t + distance, h-ch);
2631 this.scrollTo("top", v, a);
2640 * Translates the passed page coordinates into left/top css values for this element
2641 * @param {Number/Array} x The page x or an array containing [x, y]
2642 * @param {Number} y The page y
2643 * @return {Object} An object with left and top properties. e.g. {left: (value), top: (value)}
2645 translatePoints : function(x, y){
2646 if(typeof x == 'object' || x instanceof Array){
2649 var p = this.getStyle('position');
2650 var o = this.getXY();
2652 var l = parseInt(this.getStyle('left'), 10);
2653 var t = parseInt(this.getStyle('top'), 10);
2656 l = (p == "relative") ? 0 : this.dom.offsetLeft;
2659 t = (p == "relative") ? 0 : this.dom.offsetTop;
2662 return {left: (x - o[0] + l), top: (y - o[1] + t)};
2666 * Returns the current scroll position of the element.
2667 * @return {Object} An object containing the scroll position in the format {left: (scrollLeft), top: (scrollTop)}
2669 getScroll : function(){
2670 var d = this.dom, doc = document;
2671 if(d == doc || d == doc.body){
2672 var l = window.pageXOffset || doc.documentElement.scrollLeft || doc.body.scrollLeft || 0;
2673 var t = window.pageYOffset || doc.documentElement.scrollTop || doc.body.scrollTop || 0;
2674 return {left: l, top: t};
2676 return {left: d.scrollLeft, top: d.scrollTop};
2681 * Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values
2682 * are convert to standard 6 digit hex color.
2683 * @param {String} attr The css attribute
2684 * @param {String} defaultValue The default value to use when a valid color isn't found
2685 * @param {String} prefix (optional) defaults to #. Use an empty string when working with
2688 getColor : function(attr, defaultValue, prefix){
2689 var v = this.getStyle(attr);
2690 if(!v || v == "transparent" || v == "inherit") {
2691 return defaultValue;
2693 var color = typeof prefix == "undefined" ? "#" : prefix;
2694 if(v.substr(0, 4) == "rgb("){
2695 var rvs = v.slice(4, v.length -1).split(",");
2696 for(var i = 0; i < 3; i++){
2697 var h = parseInt(rvs[i]).toString(16);
2704 if(v.substr(0, 1) == "#"){
2706 for(var i = 1; i < 4; i++){
2707 var c = v.charAt(i);
2710 }else if(v.length == 7){
2711 color += v.substr(1);
2715 return(color.length > 5 ? color.toLowerCase() : defaultValue);
2719 * Wraps the specified element with a special markup/CSS block that renders by default as a gray container with a
2720 * gradient background, rounded corners and a 4-way shadow.
2721 * @param {String} class (optional) A base CSS class to apply to the containing wrapper element (defaults to 'x-box').
2722 * Note that there are a number of CSS rules that are dependent on this name to make the overall effect work,
2723 * so if you supply an alternate base class, make sure you also supply all of the necessary rules.
2724 * @return {Roo.Element} this
2726 boxWrap : function(cls){
2727 cls = cls || 'x-box';
2728 var el = Roo.get(this.insertHtml('beforeBegin', String.format('<div class="{0}">'+El.boxMarkup+'</div>', cls)));
2729 el.child('.'+cls+'-mc').dom.appendChild(this.dom);
2734 * Returns the value of a namespaced attribute from the element's underlying DOM node.
2735 * @param {String} namespace The namespace in which to look for the attribute
2736 * @param {String} name The attribute name
2737 * @return {String} The attribute value
2739 getAttributeNS : Roo.isIE ? function(ns, name){
2741 var type = typeof d[ns+":"+name];
2742 if(type != 'undefined' && type != 'unknown'){
2743 return d[ns+":"+name];
2746 } : function(ns, name){
2748 return d.getAttributeNS(ns, name) || d.getAttribute(ns+":"+name) || d.getAttribute(name) || d[name];
2753 * Sets or Returns the value the dom attribute value
2754 * @param {String|Object} name The attribute name (or object to set multiple attributes)
2755 * @param {String} value (optional) The value to set the attribute to
2756 * @return {String} The attribute value
2758 attr : function(name){
2759 if (arguments.length > 1) {
2760 this.dom.setAttribute(name, arguments[1]);
2761 return arguments[1];
2763 if (typeof(name) == 'object') {
2764 for(var i in name) {
2765 this.attr(i, name[i]);
2771 if (!this.dom.hasAttribute(name)) {
2774 return this.dom.getAttribute(name);
2781 var ep = El.prototype;
2784 * Appends an event handler (Shorthand for addListener)
2785 * @param {String} eventName The type of event to append
2786 * @param {Function} fn The method the event invokes
2787 * @param {Object} scope (optional) The scope (this object) of the fn
2788 * @param {Object} options (optional)An object with standard {@link Roo.EventManager#addListener} options
2791 ep.on = ep.addListener;
2793 ep.mon = ep.addListener;
2796 * Removes an event handler from this element (shorthand for removeListener)
2797 * @param {String} eventName the type of event to remove
2798 * @param {Function} fn the method the event invokes
2799 * @return {Roo.Element} this
2802 ep.un = ep.removeListener;
2805 * true to automatically adjust width and height settings for box-model issues (default to true)
2807 ep.autoBoxAdjust = true;
2810 El.unitPattern = /\d+(px|em|%|en|ex|pt|in|cm|mm|pc)$/i;
2813 El.addUnits = function(v, defaultUnit){
2814 if(v === "" || v == "auto"){
2817 if(v === undefined){
2820 if(typeof v == "number" || !El.unitPattern.test(v)){
2821 return v + (defaultUnit || 'px');
2826 // special markup used throughout Roo when box wrapping elements
2827 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>';
2829 * Visibility mode constant - Use visibility to hide element
2835 * Visibility mode constant - Use display to hide element
2841 El.borders = {l: "border-left-width", r: "border-right-width", t: "border-top-width", b: "border-bottom-width"};
2842 El.paddings = {l: "padding-left", r: "padding-right", t: "padding-top", b: "padding-bottom"};
2843 El.margins = {l: "margin-left", r: "margin-right", t: "margin-top", b: "margin-bottom"};
2855 * Static method to retrieve Element objects. Uses simple caching to consistently return the same object.
2856 * Automatically fixes if an object was recreated with the same id via AJAX or DOM.
2857 * @param {String/HTMLElement/Element} el The id of the node, a DOM Node or an existing Element.
2858 * @return {Element} The Element object
2861 El.get = function(el){
2863 if(!el){ return null; }
2864 if(typeof el == "string"){ // element id
2865 if(!(elm = document.getElementById(el))){
2868 if(ex = El.cache[el]){
2871 ex = El.cache[el] = new El(elm);
2874 }else if(el.tagName){ // dom element
2878 if(ex = El.cache[id]){
2881 ex = El.cache[id] = new El(el);
2884 }else if(el instanceof El){
2886 el.dom = document.getElementById(el.id) || el.dom; // refresh dom element in case no longer valid,
2887 // catch case where it hasn't been appended
2888 El.cache[el.id] = el; // in case it was created directly with Element(), let's cache it
2891 }else if(el.isComposite){
2893 }else if(el instanceof Array){
2894 return El.select(el);
2895 }else if(el == document){
2896 // create a bogus element object representing the document object
2898 var f = function(){};
2899 f.prototype = El.prototype;
2901 docEl.dom = document;
2909 El.uncache = function(el){
2910 for(var i = 0, a = arguments, len = a.length; i < len; i++) {
2912 delete El.cache[a[i].id || a[i]];
2918 // Garbage collection - uncache elements/purge listeners on orphaned elements
2919 // so we don't hold a reference and cause the browser to retain them
2920 El.garbageCollect = function(){
2921 if(!Roo.enableGarbageCollector){
2922 clearInterval(El.collectorThread);
2925 for(var eid in El.cache){
2926 var el = El.cache[eid], d = el.dom;
2927 // -------------------------------------------------------
2928 // Determining what is garbage:
2929 // -------------------------------------------------------
2931 // dom node is null, definitely garbage
2932 // -------------------------------------------------------
2934 // no parentNode == direct orphan, definitely garbage
2935 // -------------------------------------------------------
2936 // !d.offsetParent && !document.getElementById(eid)
2937 // display none elements have no offsetParent so we will
2938 // also try to look it up by it's id. However, check
2939 // offsetParent first so we don't do unneeded lookups.
2940 // This enables collection of elements that are not orphans
2941 // directly, but somewhere up the line they have an orphan
2943 // -------------------------------------------------------
2944 if(!d || !d.parentNode || (!d.offsetParent && !document.getElementById(eid))){
2945 delete El.cache[eid];
2946 if(d && Roo.enableListenerCollection){
2952 El.collectorThreadId = setInterval(El.garbageCollect, 30000);
2956 El.Flyweight = function(dom){
2959 El.Flyweight.prototype = El.prototype;
2961 El._flyweights = {};
2963 * Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -
2964 * the dom node can be overwritten by other code.
2965 * @param {String/HTMLElement} el The dom node or id
2966 * @param {String} named (optional) Allows for creation of named reusable flyweights to
2967 * prevent conflicts (e.g. internally Roo uses "_internal")
2969 * @return {Element} The shared Element object
2971 El.fly = function(el, named){
2972 named = named || '_global';
2973 el = Roo.getDom(el);
2977 if(!El._flyweights[named]){
2978 El._flyweights[named] = new El.Flyweight();
2980 El._flyweights[named].dom = el;
2981 return El._flyweights[named];
2985 * Static method to retrieve Element objects. Uses simple caching to consistently return the same object.
2986 * Automatically fixes if an object was recreated with the same id via AJAX or DOM.
2987 * Shorthand of {@link Roo.Element#get}
2988 * @param {String/HTMLElement/Element} el The id of the node, a DOM Node or an existing Element.
2989 * @return {Element} The Element object
2995 * Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -
2996 * the dom node can be overwritten by other code.
2997 * Shorthand of {@link Roo.Element#fly}
2998 * @param {String/HTMLElement} el The dom node or id
2999 * @param {String} named (optional) Allows for creation of named reusable flyweights to
3000 * prevent conflicts (e.g. internally Roo uses "_internal")
3002 * @return {Element} The shared Element object
3008 // speedy lookup for elements never to box adjust
3009 var noBoxAdjust = Roo.isStrict ? {
3012 input:1, select:1, textarea:1
3014 if(Roo.isIE || Roo.isGecko){
3015 noBoxAdjust['button'] = 1;
3019 Roo.EventManager.on(window, 'unload', function(){
3021 delete El._flyweights;
3029 Roo.Element.selectorFunction = Roo.DomQuery.select;
3032 Roo.Element.select = function(selector, unique, root){
3034 if(typeof selector == "string"){
3035 els = Roo.Element.selectorFunction(selector, root);
3036 }else if(selector.length !== undefined){
3039 throw "Invalid selector";
3041 if(unique === true){
3042 return new Roo.CompositeElement(els);
3044 return new Roo.CompositeElementLite(els);
3048 * Selects elements based on the passed CSS selector to enable working on them as 1.
3049 * @param {String/Array} selector The CSS selector or an array of elements
3050 * @param {Boolean} unique (optional) true to create a unique Roo.Element for each element (defaults to a shared flyweight object)
3051 * @param {HTMLElement/String} root (optional) The root element of the query or id of the root
3052 * @return {CompositeElementLite/CompositeElement}
3056 Roo.select = Roo.Element.select;