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 : "",
122 // note this is overridden in BS version..
125 * The default unit to append to CSS values where a unit isn't provided (defaults to px).
131 * Sets the element's visibility mode. When setVisible() is called it
132 * will use this to determine whether to set the visibility or the display property.
133 * @param visMode Element.VISIBILITY or Element.DISPLAY
134 * @return {Roo.Element} this
136 setVisibilityMode : function(visMode){
137 this.visibilityMode = visMode;
141 * Convenience method for setVisibilityMode(Element.DISPLAY)
142 * @param {String} display (optional) What to set display to when visible
143 * @return {Roo.Element} this
145 enableDisplayMode : function(display){
146 this.setVisibilityMode(El.DISPLAY);
147 if(typeof display != "undefined") { this.originalDisplay = display; }
152 * 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)
153 * @param {String} selector The simple selector to test
154 * @param {Number/String/HTMLElement/Element} maxDepth (optional) The max depth to
155 search as a number or element (defaults to 10 || document.body)
156 * @param {Boolean} returnEl (optional) True to return a Roo.Element object instead of DOM node
157 * @return {HTMLElement} The matching DOM node (or null if no match was found)
159 findParent : function(simpleSelector, maxDepth, returnEl){
160 var p = this.dom, b = document.body, depth = 0, dq = Roo.DomQuery, stopEl;
161 maxDepth = maxDepth || 50;
162 if(typeof maxDepth != "number"){
163 stopEl = Roo.getDom(maxDepth);
166 while(p && p.nodeType == 1 && depth < maxDepth && p != b && p != stopEl){
167 if(dq.is(p, simpleSelector)){
168 return returnEl ? Roo.get(p) : p;
178 * Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child)
179 * @param {String} selector The simple selector to test
180 * @param {Number/String/HTMLElement/Element} maxDepth (optional) The max depth to
181 search as a number or element (defaults to 10 || document.body)
182 * @param {Boolean} returnEl (optional) True to return a Roo.Element object instead of DOM node
183 * @return {HTMLElement} The matching DOM node (or null if no match was found)
185 findParentNode : function(simpleSelector, maxDepth, returnEl){
186 var p = Roo.fly(this.dom.parentNode, '_internal');
187 return p ? p.findParent(simpleSelector, maxDepth, returnEl) : null;
191 * Looks at the scrollable parent element
193 findScrollableParent : function()
195 var overflowRegex = /(auto|scroll)/;
197 if(this.getStyle('position') === 'fixed'){
198 return Roo.isAndroid ? Roo.get(document.documentElement) : Roo.get(document.body);
201 var excludeStaticParent = this.getStyle('position') === "absolute";
203 for (var parent = this; (parent = Roo.get(parent.dom.parentNode));){
205 if (excludeStaticParent && parent.getStyle('position') === "static") {
209 if (overflowRegex.test(parent.getStyle('overflow') + parent.getStyle('overflow-x') + parent.getStyle('overflow-y'))){
213 if(parent.dom.nodeName.toLowerCase() == 'body'){
214 return Roo.isAndroid ? Roo.get(document.documentElement) : Roo.get(document.body);
218 return Roo.isAndroid ? Roo.get(document.documentElement) : Roo.get(document.body);
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 if (this.dom instanceof SVGElement) {
618 this.dom.className.baseVal =this.dom.className.baseVal + " " + className;
620 this.dom.className = this.dom.className + " " + className;
628 * Adds one or more CSS classes to this element and removes the same class(es) from all siblings.
629 * @param {String/Array} className The CSS class to add, or an array of classes
630 * @return {Roo.Element} this
632 radioClass : function(className){
633 var siblings = this.dom.parentNode.childNodes;
634 for(var i = 0; i < siblings.length; i++) {
637 Roo.get(s).removeClass(className);
640 this.addClass(className);
645 * Removes one or more CSS classes from the element.
646 * @param {String/Array} className The CSS class to remove, or an array of classes
647 * @return {Roo.Element} this
649 removeClass : function(className){
651 var cn = this.dom instanceof SVGElement ? this.dom.className.baseVal : this.dom.className;
652 if(!className || !cn){
655 if(className instanceof Array){
656 for(var i = 0, len = className.length; i < len; i++) {
657 this.removeClass(className[i]);
660 if(this.hasClass(className)){
661 var re = this.classReCache[className];
663 re = new RegExp('(?:^|\\s+)' + className + '(?:\\s+|$)', "g");
664 this.classReCache[className] = re;
666 if (this.dom instanceof SVGElement) {
667 this.dom.className.baseVal = cn.replace(re, " ");
669 this.dom.className = cn.replace(re, " ");
680 * Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it).
681 * @param {String} className The CSS class to toggle
682 * @return {Roo.Element} this
684 toggleClass : function(className){
685 if(this.hasClass(className)){
686 this.removeClass(className);
688 this.addClass(className);
694 * Checks if the specified CSS class exists on this element's DOM node.
695 * @param {String} className The CSS class to check for
696 * @return {Boolean} True if the class exists, else false
698 hasClass : function(className){
699 if (this.dom instanceof SVGElement) {
700 return className && (' '+this.dom.className.baseVal +' ').indexOf(' '+className+' ') != -1;
702 return className && (' '+this.dom.className+' ').indexOf(' '+className+' ') != -1;
706 * Replaces a CSS class on the element with another. If the old name does not exist, the new name will simply be added.
707 * @param {String} oldClassName The CSS class to replace
708 * @param {String} newClassName The replacement CSS class
709 * @return {Roo.Element} this
711 replaceClass : function(oldClassName, newClassName){
712 this.removeClass(oldClassName);
713 this.addClass(newClassName);
718 * Returns an object with properties matching the styles requested.
719 * For example, el.getStyles('color', 'font-size', 'width') might return
720 * {'color': '#FFFFFF', 'font-size': '13px', 'width': '100px'}.
721 * @param {String} style1 A style name
722 * @param {String} style2 A style name
723 * @param {String} etc.
724 * @return {Object} The style object
726 getStyles : function(){
727 var a = arguments, len = a.length, r = {};
728 for(var i = 0; i < len; i++){
729 r[a[i]] = this.getStyle(a[i]);
735 * Normalizes currentStyle and computedStyle. This is not YUI getStyle, it is an optimised version.
736 * @param {String} property The style property whose value is returned.
737 * @return {String} The current value of the style property for this element.
739 getStyle : function(){
740 return view && view.getComputedStyle ?
742 var el = this.dom, v, cs, camel;
746 if(el.style && (v = el.style[prop])){
749 if(cs = view.getComputedStyle(el, "")){
750 if(!(camel = propCache[prop])){
751 camel = propCache[prop] = prop.replace(camelRe, camelFn);
758 var el = this.dom, v, cs, camel;
759 if(prop == 'opacity'){
760 if(typeof el.style.filter == 'string'){
761 var m = el.style.filter.match(/alpha\(opacity=(.*)\)/i);
763 var fv = parseFloat(m[1]);
765 return fv ? fv / 100 : 0;
770 }else if(prop == 'float'){
773 if(!(camel = propCache[prop])){
774 camel = propCache[prop] = prop.replace(camelRe, camelFn);
776 if(v = el.style[camel]){
779 if(cs = el.currentStyle){
787 * Wrapper for setting style properties, also takes single object parameter of multiple styles.
788 * @param {String/Object} property The style property to be set, or an object of multiple styles.
789 * @param {String} value (optional) The value to apply to the given property, or null if an object was passed.
790 * @return {Roo.Element} this
792 setStyle : function(prop, value){
793 if(typeof prop == "string"){
795 if (prop == 'float') {
796 this.setStyle(Roo.isIE ? 'styleFloat' : 'cssFloat', value);
801 if(!(camel = propCache[prop])){
802 camel = propCache[prop] = prop.replace(camelRe, camelFn);
805 if(camel == 'opacity') {
806 this.setOpacity(value);
808 this.dom.style[camel] = value;
811 for(var style in prop){
812 if(typeof prop[style] != "function"){
813 this.setStyle(style, prop[style]);
821 * More flexible version of {@link #setStyle} for setting style properties.
822 * @param {String/Object/Function} styles A style specification string, e.g. "width:100px", or object in the form {width:"100px"}, or
823 * a function which returns such a specification.
824 * @return {Roo.Element} this
826 applyStyles : function(style){
827 Roo.DomHelper.applyStyles(this.dom, style);
832 * 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).
833 * @return {Number} The X position of the element
836 return D.getX(this.dom);
840 * 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).
841 * @return {Number} The Y position of the element
844 return D.getY(this.dom);
848 * 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).
849 * @return {Array} The XY position of the element
852 return D.getXY(this.dom);
856 * 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).
857 * @param {Number} The X position of the element
858 * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object
859 * @return {Roo.Element} this
861 setX : function(x, animate){
865 this.setXY([x, this.getY()], this.preanim(arguments, 1));
871 * 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).
872 * @param {Number} The Y position of the element
873 * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object
874 * @return {Roo.Element} this
876 setY : function(y, animate){
880 this.setXY([this.getX(), y], this.preanim(arguments, 1));
886 * Sets the element's left position directly using CSS style (instead of {@link #setX}).
887 * @param {String} left The left CSS property value
888 * @return {Roo.Element} this
890 setLeft : function(left){
891 this.setStyle("left", this.addUnits(left));
896 * Sets the element's top position directly using CSS style (instead of {@link #setY}).
897 * @param {String} top The top CSS property value
898 * @return {Roo.Element} this
900 setTop : function(top){
901 this.setStyle("top", this.addUnits(top));
906 * Sets the element's CSS right style.
907 * @param {String} right The right CSS property value
908 * @return {Roo.Element} this
910 setRight : function(right){
911 this.setStyle("right", this.addUnits(right));
916 * Sets the element's CSS bottom style.
917 * @param {String} bottom The bottom CSS property value
918 * @return {Roo.Element} this
920 setBottom : function(bottom){
921 this.setStyle("bottom", this.addUnits(bottom));
926 * Sets the position of the element in page coordinates, regardless of how the element is positioned.
927 * The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
928 * @param {Array} pos Contains X & Y [x, y] values for new position (coordinates are page-based)
929 * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object
930 * @return {Roo.Element} this
932 setXY : function(pos, animate){
934 D.setXY(this.dom, pos);
936 this.anim({points: {to: pos}}, this.preanim(arguments, 1), 'motion');
942 * Sets the position of the element in page coordinates, regardless of how the element is positioned.
943 * The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
944 * @param {Number} x X value for new position (coordinates are page-based)
945 * @param {Number} y Y value for new position (coordinates are page-based)
946 * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object
947 * @return {Roo.Element} this
949 setLocation : function(x, y, animate){
950 this.setXY([x, y], this.preanim(arguments, 2));
955 * Sets the position of the element in page coordinates, regardless of how the element is positioned.
956 * The element must be part of the DOM tree to have page coordinates (display:none or elements not appended return false).
957 * @param {Number} x X value for new position (coordinates are page-based)
958 * @param {Number} y Y value for new position (coordinates are page-based)
959 * @param {Boolean/Object} animate (optional) True for the default animation, or a standard Element animation config object
960 * @return {Roo.Element} this
962 moveTo : function(x, y, animate){
963 this.setXY([x, y], this.preanim(arguments, 2));
968 * Returns the region of the given element.
969 * The element must be part of the DOM tree to have a region (display:none or elements not appended return false).
970 * @return {Region} A Roo.lib.Region containing "top, left, bottom, right" member data.
972 getRegion : function(){
973 return D.getRegion(this.dom);
977 * Returns the offset height of the element
978 * @param {Boolean} contentHeight (optional) true to get the height minus borders and padding
979 * @return {Number} The element's height
981 getHeight : function(contentHeight){
982 var h = this.dom.offsetHeight || 0;
983 return contentHeight !== true ? h : h-this.getBorderWidth("tb")-this.getPadding("tb");
987 * Returns the offset width of the element
988 * @param {Boolean} contentWidth (optional) true to get the width minus borders and padding
989 * @return {Number} The element's width
991 getWidth : function(contentWidth){
992 var w = this.dom.offsetWidth || 0;
993 return contentWidth !== true ? w : w-this.getBorderWidth("lr")-this.getPadding("lr");
997 * Returns either the offsetHeight or the height of this element based on CSS height adjusted by padding or borders
998 * when needed to simulate offsetHeight when offsets aren't available. This may not work on display:none elements
999 * if a height has not been set using CSS.
1002 getComputedHeight : function(){
1003 var h = Math.max(this.dom.offsetHeight, this.dom.clientHeight);
1005 h = parseInt(this.getStyle('height'), 10) || 0;
1006 if(!this.isBorderBox()){
1007 h += this.getFrameWidth('tb');
1014 * Returns either the offsetWidth or the width of this element based on CSS width adjusted by padding or borders
1015 * when needed to simulate offsetWidth when offsets aren't available. This may not work on display:none elements
1016 * if a width has not been set using CSS.
1019 getComputedWidth : function(){
1020 var w = Math.max(this.dom.offsetWidth, this.dom.clientWidth);
1022 w = parseInt(this.getStyle('width'), 10) || 0;
1023 if(!this.isBorderBox()){
1024 w += this.getFrameWidth('lr');
1031 * Returns the size of the element.
1032 * @param {Boolean} contentSize (optional) true to get the width/size minus borders and padding
1033 * @return {Object} An object containing the element's size {width: (element width), height: (element height)}
1035 getSize : function(contentSize){
1036 return {width: this.getWidth(contentSize), height: this.getHeight(contentSize)};
1040 * Returns the width and height of the viewport.
1041 * @return {Object} An object containing the viewport's size {width: (viewport width), height: (viewport height)}
1043 getViewSize : function(){
1044 var d = this.dom, doc = document, aw = 0, ah = 0;
1045 if(d == doc || d == doc.body){
1046 return {width : D.getViewWidth(), height: D.getViewHeight()};
1049 width : d.clientWidth,
1050 height: d.clientHeight
1056 * Returns the value of the "value" attribute
1057 * @param {Boolean} asNumber true to parse the value as a number
1058 * @return {String/Number}
1060 getValue : function(asNumber){
1061 return asNumber ? parseInt(this.dom.value, 10) : this.dom.value;
1065 adjustWidth : function(width){
1066 if(typeof width == "number"){
1067 if(this.autoBoxAdjust && !this.isBorderBox()){
1068 width -= (this.getBorderWidth("lr") + this.getPadding("lr"));
1078 adjustHeight : function(height){
1079 if(typeof height == "number"){
1080 if(this.autoBoxAdjust && !this.isBorderBox()){
1081 height -= (this.getBorderWidth("tb") + this.getPadding("tb"));
1091 * Set the width of the element
1092 * @param {Number} width The new width
1093 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1094 * @return {Roo.Element} this
1096 setWidth : function(width, animate){
1097 width = this.adjustWidth(width);
1099 this.dom.style.width = this.addUnits(width);
1101 this.anim({width: {to: width}}, this.preanim(arguments, 1));
1107 * Set the height of the element
1108 * @param {Number} height The new height
1109 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1110 * @return {Roo.Element} this
1112 setHeight : function(height, animate){
1113 height = this.adjustHeight(height);
1115 this.dom.style.height = this.addUnits(height);
1117 this.anim({height: {to: height}}, this.preanim(arguments, 1));
1123 * Set the size of the element. If animation is true, both width an height will be animated concurrently.
1124 * @param {Number} width The new width
1125 * @param {Number} height The new height
1126 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1127 * @return {Roo.Element} this
1129 setSize : function(width, height, animate){
1130 if(typeof width == "object"){ // in case of object from getSize()
1131 height = width.height; width = width.width;
1133 width = this.adjustWidth(width); height = this.adjustHeight(height);
1135 this.dom.style.width = this.addUnits(width);
1136 this.dom.style.height = this.addUnits(height);
1138 this.anim({width: {to: width}, height: {to: height}}, this.preanim(arguments, 2));
1144 * Sets the element's position and size in one shot. If animation is true then width, height, x and y will be animated concurrently.
1145 * @param {Number} x X value for new position (coordinates are page-based)
1146 * @param {Number} y Y value for new position (coordinates are page-based)
1147 * @param {Number} width The new width
1148 * @param {Number} height The new height
1149 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1150 * @return {Roo.Element} this
1152 setBounds : function(x, y, width, height, animate){
1154 this.setSize(width, height);
1155 this.setLocation(x, y);
1157 width = this.adjustWidth(width); height = this.adjustHeight(height);
1158 this.anim({points: {to: [x, y]}, width: {to: width}, height: {to: height}},
1159 this.preanim(arguments, 4), 'motion');
1165 * 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.
1166 * @param {Roo.lib.Region} region The region to fill
1167 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1168 * @return {Roo.Element} this
1170 setRegion : function(region, animate){
1171 this.setBounds(region.left, region.top, region.right-region.left, region.bottom-region.top, this.preanim(arguments, 1));
1176 * Appends an event handler
1178 * @param {String} eventName The type of event to append
1179 * @param {Function} fn The method the event invokes
1180 * @param {Object} scope (optional) The scope (this object) of the fn
1181 * @param {Object} options (optional)An object with standard {@link Roo.EventManager#addListener} options
1183 addListener : function(eventName, fn, scope, options){
1185 Roo.EventManager.on(this.dom, eventName, fn, scope || this, options);
1187 if (eventName == 'dblclick') {
1188 this.addListener('touchstart', this.onTapHandler, this);
1192 onTapHandler : function(event)
1194 if(!this.tapedTwice) {
1195 this.tapedTwice = true;
1197 setTimeout( function() {
1198 s.tapedTwice = false;
1202 event.preventDefault();
1203 var revent = new MouseEvent('dblclick', {
1209 this.dom.dispatchEvent(revent);
1210 //action on double tap goes below
1215 * Removes an event handler from this element
1216 * @param {String} eventName the type of event to remove
1217 * @param {Function} fn the method the event invokes
1218 * @return {Roo.Element} this
1220 removeListener : function(eventName, fn){
1221 Roo.EventManager.removeListener(this.dom, eventName, fn);
1226 * Removes all previous added listeners from this element
1227 * @return {Roo.Element} this
1229 removeAllListeners : function(){
1230 E.purgeElement(this.dom);
1234 relayEvent : function(eventName, observable){
1235 this.on(eventName, function(e){
1236 observable.fireEvent(eventName, e);
1241 * Set the opacity of the element
1242 * @param {Float} opacity The new opacity. 0 = transparent, .5 = 50% visibile, 1 = fully visible, etc
1243 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1244 * @return {Roo.Element} this
1246 setOpacity : function(opacity, animate){
1248 var s = this.dom.style;
1251 s.filter = (s.filter || '').replace(/alpha\([^\)]*\)/gi,"") +
1252 (opacity == 1 ? "" : "alpha(opacity=" + opacity * 100 + ")");
1254 s.opacity = opacity;
1257 this.anim({opacity: {to: opacity}}, this.preanim(arguments, 1), null, .35, 'easeIn');
1263 * Gets the left X coordinate
1264 * @param {Boolean} local True to get the local css position instead of page coordinate
1267 getLeft : function(local){
1271 return parseInt(this.getStyle("left"), 10) || 0;
1276 * Gets the right X coordinate of the element (element X position + element width)
1277 * @param {Boolean} local True to get the local css position instead of page coordinate
1280 getRight : function(local){
1282 return this.getX() + this.getWidth();
1284 return (this.getLeft(true) + this.getWidth()) || 0;
1289 * Gets the top Y coordinate
1290 * @param {Boolean} local True to get the local css position instead of page coordinate
1293 getTop : function(local) {
1297 return parseInt(this.getStyle("top"), 10) || 0;
1302 * Gets the bottom Y coordinate of the element (element Y position + element height)
1303 * @param {Boolean} local True to get the local css position instead of page coordinate
1306 getBottom : function(local){
1308 return this.getY() + this.getHeight();
1310 return (this.getTop(true) + this.getHeight()) || 0;
1315 * Initializes positioning on this element. If a desired position is not passed, it will make the
1316 * the element positioned relative IF it is not already positioned.
1317 * @param {String} pos (optional) Positioning to use "relative", "absolute" or "fixed"
1318 * @param {Number} zIndex (optional) The zIndex to apply
1319 * @param {Number} x (optional) Set the page X position
1320 * @param {Number} y (optional) Set the page Y position
1322 position : function(pos, zIndex, x, y){
1324 if(this.getStyle('position') == 'static'){
1325 this.setStyle('position', 'relative');
1328 this.setStyle("position", pos);
1331 this.setStyle("z-index", zIndex);
1333 if(x !== undefined && y !== undefined){
1335 }else if(x !== undefined){
1337 }else if(y !== undefined){
1343 * Clear positioning back to the default when the document was loaded
1344 * @param {String} value (optional) The value to use for the left,right,top,bottom, defaults to '' (empty string). You could use 'auto'.
1345 * @return {Roo.Element} this
1347 clearPositioning : function(value){
1355 "position" : "static"
1361 * Gets an object with all CSS positioning properties. Useful along with setPostioning to get
1362 * snapshot before performing an update and then restoring the element.
1365 getPositioning : function(){
1366 var l = this.getStyle("left");
1367 var t = this.getStyle("top");
1369 "position" : this.getStyle("position"),
1371 "right" : l ? "" : this.getStyle("right"),
1373 "bottom" : t ? "" : this.getStyle("bottom"),
1374 "z-index" : this.getStyle("z-index")
1379 * Gets the width of the border(s) for the specified side(s)
1380 * @param {String} side Can be t, l, r, b or any combination of those to add multiple values. For example,
1381 * passing lr would get the border (l)eft width + the border (r)ight width.
1382 * @return {Number} The width of the sides passed added together
1384 getBorderWidth : function(side){
1385 return this.addStyles(side, El.borders);
1389 * Gets the width of the padding(s) for the specified side(s)
1390 * @param {String} side Can be t, l, r, b or any combination of those to add multiple values. For example,
1391 * passing lr would get the padding (l)eft + the padding (r)ight.
1392 * @return {Number} The padding of the sides passed added together
1394 getPadding : function(side){
1395 return this.addStyles(side, El.paddings);
1399 * Set positioning with an object returned by getPositioning().
1400 * @param {Object} posCfg
1401 * @return {Roo.Element} this
1403 setPositioning : function(pc){
1404 this.applyStyles(pc);
1405 if(pc.right == "auto"){
1406 this.dom.style.right = "";
1408 if(pc.bottom == "auto"){
1409 this.dom.style.bottom = "";
1415 fixDisplay : function(){
1416 if(this.getStyle("display") == "none"){
1417 this.setStyle("visibility", "hidden");
1418 this.setStyle("display", this.originalDisplay); // first try reverting to default
1419 if(this.getStyle("display") == "none"){ // if that fails, default to block
1420 this.setStyle("display", "block");
1426 * Quick set left and top adding default units
1427 * @param {String} left The left CSS property value
1428 * @param {String} top The top CSS property value
1429 * @return {Roo.Element} this
1431 setLeftTop : function(left, top){
1432 this.dom.style.left = this.addUnits(left);
1433 this.dom.style.top = this.addUnits(top);
1438 * Move this element relative to its current position.
1439 * @param {String} direction Possible values are: "l","left" - "r","right" - "t","top","up" - "b","bottom","down".
1440 * @param {Number} distance How far to move the element in pixels
1441 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1442 * @return {Roo.Element} this
1444 move : function(direction, distance, animate){
1445 var xy = this.getXY();
1446 direction = direction.toLowerCase();
1450 this.moveTo(xy[0]-distance, xy[1], this.preanim(arguments, 2));
1454 this.moveTo(xy[0]+distance, xy[1], this.preanim(arguments, 2));
1459 this.moveTo(xy[0], xy[1]-distance, this.preanim(arguments, 2));
1464 this.moveTo(xy[0], xy[1]+distance, this.preanim(arguments, 2));
1471 * Store the current overflow setting and clip overflow on the element - use {@link #unclip} to remove
1472 * @return {Roo.Element} this
1475 if(!this.isClipped){
1476 this.isClipped = true;
1477 this.originalClip = {
1478 "o": this.getStyle("overflow"),
1479 "x": this.getStyle("overflow-x"),
1480 "y": this.getStyle("overflow-y")
1482 this.setStyle("overflow", "hidden");
1483 this.setStyle("overflow-x", "hidden");
1484 this.setStyle("overflow-y", "hidden");
1490 * Return clipping (overflow) to original clipping before clip() was called
1491 * @return {Roo.Element} this
1493 unclip : function(){
1495 this.isClipped = false;
1496 var o = this.originalClip;
1497 if(o.o){this.setStyle("overflow", o.o);}
1498 if(o.x){this.setStyle("overflow-x", o.x);}
1499 if(o.y){this.setStyle("overflow-y", o.y);}
1506 * Gets the x,y coordinates specified by the anchor position on the element.
1507 * @param {String} anchor (optional) The specified anchor position (defaults to "c"). See {@link #alignTo} for details on supported anchor positions.
1508 * @param {Object} size (optional) An object containing the size to use for calculating anchor position
1509 * {width: (target width), height: (target height)} (defaults to the element's current size)
1510 * @param {Boolean} local (optional) True to get the local (element top/left-relative) anchor position instead of page coordinates
1511 * @return {Array} [x, y] An array containing the element's x and y coordinates
1513 getAnchorXY : function(anchor, local, s){
1514 //Passing a different size is useful for pre-calculating anchors,
1515 //especially for anchored animations that change the el size.
1517 var w, h, vp = false;
1520 if(d == document.body || d == document){
1522 w = D.getViewWidth(); h = D.getViewHeight();
1524 w = this.getWidth(); h = this.getHeight();
1527 w = s.width; h = s.height;
1529 var x = 0, y = 0, r = Math.round;
1530 switch((anchor || "tl").toLowerCase()){
1572 var sc = this.getScroll();
1573 return [x + sc.left, y + sc.top];
1575 //Add the element's offset xy
1576 var o = this.getXY();
1577 return [x+o[0], y+o[1]];
1581 * Gets the x,y coordinates to align this element with another element. See {@link #alignTo} for more info on the
1582 * supported position values.
1583 * @param {String/HTMLElement/Roo.Element} element The element to align to.
1584 * @param {String} position The position to align to.
1585 * @param {Array} offsets (optional) Offset the positioning by [x, y]
1586 * @return {Array} [x, y]
1588 getAlignToXY : function(el, p, o)
1593 throw "Element.alignTo with an element that doesn't exist";
1595 var c = false; //constrain to viewport
1596 var p1 = "", p2 = "";
1603 }else if(p.indexOf("-") == -1){
1606 p = p.toLowerCase();
1607 var m = p.match(/^([a-z]+)-([a-z]+)(\?)?$/);
1609 throw "Element.alignTo with an invalid alignment " + p;
1611 p1 = m[1]; p2 = m[2]; c = !!m[3];
1613 //Subtract the aligned el's internal xy from the target's offset xy
1614 //plus custom offset to get the aligned el's new offset xy
1615 var a1 = this.getAnchorXY(p1, true);
1616 var a2 = el.getAnchorXY(p2, false);
1617 var x = a2[0] - a1[0] + o[0];
1618 var y = a2[1] - a1[1] + o[1];
1620 //constrain the aligned el to viewport if necessary
1621 var w = this.getWidth(), h = this.getHeight(), r = el.getRegion();
1622 // 5px of margin for ie
1623 var dw = D.getViewWidth()-5, dh = D.getViewHeight()-5;
1625 //If we are at a viewport boundary and the aligned el is anchored on a target border that is
1626 //perpendicular to the vp border, allow the aligned el to slide on that border,
1627 //otherwise swap the aligned el to the opposite border of the target.
1628 var p1y = p1.charAt(0), p1x = p1.charAt(p1.length-1);
1629 var p2y = p2.charAt(0), p2x = p2.charAt(p2.length-1);
1630 var swapY = ((p1y=="t" && p2y=="b") || (p1y=="b" && p2y=="t") );
1631 var swapX = ((p1x=="r" && p2x=="l") || (p1x=="l" && p2x=="r"));
1634 var scrollX = (doc.documentElement.scrollLeft || doc.body.scrollLeft || 0)+5;
1635 var scrollY = (doc.documentElement.scrollTop || doc.body.scrollTop || 0)+5;
1637 if((x+w) > dw + scrollX){
1638 x = swapX ? r.left-w : dw+scrollX-w;
1641 x = swapX ? r.right : scrollX;
1643 if((y+h) > dh + scrollY){
1644 y = swapY ? r.top-h : dh+scrollY-h;
1647 y = swapY ? r.bottom : scrollY;
1654 getConstrainToXY : function(){
1655 var os = {top:0, left:0, bottom:0, right: 0};
1657 return function(el, local, offsets, proposedXY){
1659 offsets = offsets ? Roo.applyIf(offsets, os) : os;
1661 var vw, vh, vx = 0, vy = 0;
1662 if(el.dom == document.body || el.dom == document){
1663 vw = Roo.lib.Dom.getViewWidth();
1664 vh = Roo.lib.Dom.getViewHeight();
1666 vw = el.dom.clientWidth;
1667 vh = el.dom.clientHeight;
1669 var vxy = el.getXY();
1675 var s = el.getScroll();
1677 vx += offsets.left + s.left;
1678 vy += offsets.top + s.top;
1680 vw -= offsets.right;
1681 vh -= offsets.bottom;
1686 var xy = proposedXY || (!local ? this.getXY() : [this.getLeft(true), this.getTop(true)]);
1687 var x = xy[0], y = xy[1];
1688 var w = this.dom.offsetWidth, h = this.dom.offsetHeight;
1690 // only move it if it needs it
1693 // first validate right/bottom
1702 // then make sure top/left isn't negative
1711 return moved ? [x, y] : false;
1716 adjustForConstraints : function(xy, parent, offsets){
1717 return this.getConstrainToXY(parent || document, false, offsets, xy) || xy;
1721 * Aligns this element with another element relative to the specified anchor points. If the other element is the
1722 * document it aligns it to the viewport.
1723 * The position parameter is optional, and can be specified in any one of the following formats:
1725 * <li><b>Blank</b>: Defaults to aligning the element's top-left corner to the target's bottom-left corner ("tl-bl").</li>
1726 * <li><b>One anchor (deprecated)</b>: The passed anchor position is used as the target element's anchor point.
1727 * The element being aligned will position its top-left corner (tl) to that point. <i>This method has been
1728 * deprecated in favor of the newer two anchor syntax below</i>.</li>
1729 * <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
1730 * element's anchor point, and the second value is used as the target's anchor point.</li>
1732 * In addition to the anchor points, the position parameter also supports the "?" character. If "?" is passed at the end of
1733 * the position string, the element will attempt to align as specified, but the position will be adjusted to constrain to
1734 * the viewport if necessary. Note that the element being aligned might be swapped to align to a different position than
1735 * that specified in order to enforce the viewport constraints.
1736 * Following are all of the supported anchor positions:
1739 ----- -----------------------------
1740 tl The top left corner (default)
1741 t The center of the top edge
1742 tr The top right corner
1743 l The center of the left edge
1744 c In the center of the element
1745 r The center of the right edge
1746 bl The bottom left corner
1747 b The center of the bottom edge
1748 br The bottom right corner
1752 // align el to other-el using the default positioning ("tl-bl", non-constrained)
1753 el.alignTo("other-el");
1755 // align the top left corner of el with the top right corner of other-el (constrained to viewport)
1756 el.alignTo("other-el", "tr?");
1758 // align the bottom right corner of el with the center left edge of other-el
1759 el.alignTo("other-el", "br-l?");
1761 // align the center of el with the bottom left corner of other-el and
1762 // adjust the x position by -6 pixels (and the y position by 0)
1763 el.alignTo("other-el", "c-bl", [-6, 0]);
1765 * @param {String/HTMLElement/Roo.Element} element The element to align to.
1766 * @param {String} position The position to align to.
1767 * @param {Array} offsets (optional) Offset the positioning by [x, y]
1768 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1769 * @return {Roo.Element} this
1771 alignTo : function(element, position, offsets, animate){
1772 var xy = this.getAlignToXY(element, position, offsets);
1773 this.setXY(xy, this.preanim(arguments, 3));
1778 * Anchors an element to another element and realigns it when the window is resized.
1779 * @param {String/HTMLElement/Roo.Element} element The element to align to.
1780 * @param {String} position The position to align to.
1781 * @param {Array} offsets (optional) Offset the positioning by [x, y]
1782 * @param {Boolean/Object} animate (optional) True for the default animation or a standard Element animation config object
1783 * @param {Boolean/Number} monitorScroll (optional) True to monitor body scroll and reposition. If this parameter
1784 * is a number, it is used as the buffer delay (defaults to 50ms).
1785 * @param {Function} callback The function to call after the animation finishes
1786 * @return {Roo.Element} this
1788 anchorTo : function(el, alignment, offsets, animate, monitorScroll, callback){
1789 var action = function(){
1790 this.alignTo(el, alignment, offsets, animate);
1791 Roo.callback(callback, this);
1793 Roo.EventManager.onWindowResize(action, this);
1794 var tm = typeof monitorScroll;
1795 if(tm != 'undefined'){
1796 Roo.EventManager.on(window, 'scroll', action, this,
1797 {buffer: tm == 'number' ? monitorScroll : 50});
1799 action.call(this); // align immediately
1803 * Clears any opacity settings from this element. Required in some cases for IE.
1804 * @return {Roo.Element} this
1806 clearOpacity : function(){
1807 if (window.ActiveXObject) {
1808 if(typeof this.dom.style.filter == 'string' && (/alpha/i).test(this.dom.style.filter)){
1809 this.dom.style.filter = "";
1812 this.dom.style.opacity = "";
1813 this.dom.style["-moz-opacity"] = "";
1814 this.dom.style["-khtml-opacity"] = "";
1820 * Hide this element - Uses display mode to determine whether to use "display" or "visibility". See {@link #setVisible}.
1821 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1822 * @return {Roo.Element} this
1824 hide : function(animate){
1825 this.setVisible(false, this.preanim(arguments, 0));
1830 * Show this element - Uses display mode to determine whether to use "display" or "visibility". See {@link #setVisible}.
1831 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
1832 * @return {Roo.Element} this
1834 show : function(animate){
1835 this.setVisible(true, this.preanim(arguments, 0));
1840 * @private Test if size has a unit, otherwise appends the default
1842 addUnits : function(size){
1843 return Roo.Element.addUnits(size, this.defaultUnit);
1847 * Temporarily enables offsets (width,height,x,y) for an element with display:none, use endMeasure() when done.
1848 * @return {Roo.Element} this
1850 beginMeasure : function(){
1852 if(el.offsetWidth || el.offsetHeight){
1853 return this; // offsets work already
1856 var p = this.dom, b = document.body; // start with this element
1857 while((!el.offsetWidth && !el.offsetHeight) && p && p.tagName && p != b){
1858 var pe = Roo.get(p);
1859 if(pe.getStyle('display') == 'none'){
1860 changed.push({el: p, visibility: pe.getStyle("visibility")});
1861 p.style.visibility = "hidden";
1862 p.style.display = "block";
1866 this._measureChanged = changed;
1872 * Restores displays to before beginMeasure was called
1873 * @return {Roo.Element} this
1875 endMeasure : function(){
1876 var changed = this._measureChanged;
1878 for(var i = 0, len = changed.length; i < len; i++) {
1880 r.el.style.visibility = r.visibility;
1881 r.el.style.display = "none";
1883 this._measureChanged = null;
1889 * Update the innerHTML of this element, optionally searching for and processing scripts
1890 * @param {String} html The new HTML
1891 * @param {Boolean} loadScripts (optional) true to look for and process scripts
1892 * @param {Function} callback For async script loading you can be noticed when the update completes
1893 * @return {Roo.Element} this
1895 update : function(html, loadScripts, callback){
1896 if(typeof html == "undefined"){
1899 if(loadScripts !== true){
1900 this.dom.innerHTML = html;
1901 if(typeof callback == "function"){
1909 html += '<span id="' + id + '"></span>';
1911 E.onAvailable(id, function(){
1912 var hd = document.getElementsByTagName("head")[0];
1913 var re = /(?:<script([^>]*)?>)((\n|\r|.)*?)(?:<\/script>)/ig;
1914 var srcRe = /\ssrc=([\'\"])(.*?)\1/i;
1915 var typeRe = /\stype=([\'\"])(.*?)\1/i;
1918 while(match = re.exec(html)){
1919 var attrs = match[1];
1920 var srcMatch = attrs ? attrs.match(srcRe) : false;
1921 if(srcMatch && srcMatch[2]){
1922 var s = document.createElement("script");
1923 s.src = srcMatch[2];
1924 var typeMatch = attrs.match(typeRe);
1925 if(typeMatch && typeMatch[2]){
1926 s.type = typeMatch[2];
1929 }else if(match[2] && match[2].length > 0){
1930 if(window.execScript) {
1931 window.execScript(match[2]);
1939 window.eval(match[2]);
1943 var el = document.getElementById(id);
1944 if(el){el.parentNode.removeChild(el);}
1945 if(typeof callback == "function"){
1949 dom.innerHTML = html.replace(/(?:<script.*?>)((\n|\r|.)*?)(?:<\/script>)/ig, "");
1954 * Direct access to the UpdateManager update() method (takes the same parameters).
1955 * @param {String/Function} url The url for this request or a function to call to get the url
1956 * @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}
1957 * @param {Function} callback (optional) Callback when transaction is complete - called with signature (oElement, bSuccess)
1958 * @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.
1959 * @return {Roo.Element} this
1962 var um = this.getUpdateManager();
1963 um.update.apply(um, arguments);
1968 * Gets this element's UpdateManager
1969 * @return {Roo.UpdateManager} The UpdateManager
1971 getUpdateManager : function(){
1972 if(!this.updateManager){
1973 this.updateManager = new Roo.UpdateManager(this);
1975 return this.updateManager;
1979 * Disables text selection for this element (normalized across browsers)
1980 * @return {Roo.Element} this
1982 unselectable : function(){
1983 this.dom.unselectable = "on";
1984 this.swallowEvent("selectstart", true);
1985 this.applyStyles("-moz-user-select:none;-khtml-user-select:none;");
1986 this.addClass("x-unselectable");
1991 * Calculates the x, y to center this element on the screen
1992 * @return {Array} The x, y values [x, y]
1994 getCenterXY : function(){
1995 return this.getAlignToXY(document, 'c-c');
1999 * Centers the Element in either the viewport, or another Element.
2000 * @param {String/HTMLElement/Roo.Element} centerIn (optional) The element in which to center the element.
2002 center : function(centerIn){
2003 this.alignTo(centerIn || document, 'c-c');
2008 * Tests various css rules/browsers to determine if this element uses a border box
2011 isBorderBox : function(){
2012 return noBoxAdjust[this.dom.tagName.toLowerCase()] || Roo.isBorderBox;
2016 * Return a box {x, y, width, height} that can be used to set another elements
2017 * size/location to match this element.
2018 * @param {Boolean} contentBox (optional) If true a box for the content of the element is returned.
2019 * @param {Boolean} local (optional) If true the element's left and top are returned instead of page x/y.
2020 * @return {Object} box An object in the format {x, y, width, height}
2022 getBox : function(contentBox, local){
2027 var left = parseInt(this.getStyle("left"), 10) || 0;
2028 var top = parseInt(this.getStyle("top"), 10) || 0;
2031 var el = this.dom, w = el.offsetWidth, h = el.offsetHeight, bx;
2033 bx = {x: xy[0], y: xy[1], 0: xy[0], 1: xy[1], width: w, height: h};
2035 var l = this.getBorderWidth("l")+this.getPadding("l");
2036 var r = this.getBorderWidth("r")+this.getPadding("r");
2037 var t = this.getBorderWidth("t")+this.getPadding("t");
2038 var b = this.getBorderWidth("b")+this.getPadding("b");
2039 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)};
2041 bx.right = bx.x + bx.width;
2042 bx.bottom = bx.y + bx.height;
2047 * Returns the sum width of the padding and borders for the passed "sides". See getBorderWidth()
2048 for more information about the sides.
2049 * @param {String} sides
2052 getFrameWidth : function(sides, onlyContentBox){
2053 return onlyContentBox && Roo.isBorderBox ? 0 : (this.getPadding(sides) + this.getBorderWidth(sides));
2057 * 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.
2058 * @param {Object} box The box to fill {x, y, width, height}
2059 * @param {Boolean} adjust (optional) Whether to adjust for box-model issues automatically
2060 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
2061 * @return {Roo.Element} this
2063 setBox : function(box, adjust, animate){
2064 var w = box.width, h = box.height;
2065 if((adjust && !this.autoBoxAdjust) && !this.isBorderBox()){
2066 w -= (this.getBorderWidth("lr") + this.getPadding("lr"));
2067 h -= (this.getBorderWidth("tb") + this.getPadding("tb"));
2069 this.setBounds(box.x, box.y, w, h, this.preanim(arguments, 2));
2074 * Forces the browser to repaint this element
2075 * @return {Roo.Element} this
2077 repaint : function(){
2079 this.addClass("x-repaint");
2080 setTimeout(function(){
2081 Roo.get(dom).removeClass("x-repaint");
2087 * Returns an object with properties top, left, right and bottom representing the margins of this element unless sides is passed,
2088 * then it returns the calculated width of the sides (see getPadding)
2089 * @param {String} sides (optional) Any combination of l, r, t, b to get the sum of those sides
2090 * @return {Object/Number}
2092 getMargins : function(side){
2095 top: parseInt(this.getStyle("margin-top"), 10) || 0,
2096 left: parseInt(this.getStyle("margin-left"), 10) || 0,
2097 bottom: parseInt(this.getStyle("margin-bottom"), 10) || 0,
2098 right: parseInt(this.getStyle("margin-right"), 10) || 0
2101 return this.addStyles(side, El.margins);
2106 addStyles : function(sides, styles){
2108 for(var i = 0, len = sides.length; i < len; i++){
2109 v = this.getStyle(styles[sides.charAt(i)]);
2111 w = parseInt(v, 10);
2119 * Creates a proxy element of this element
2120 * @param {String/Object} config The class name of the proxy element or a DomHelper config object
2121 * @param {String/HTMLElement} renderTo (optional) The element or element id to render the proxy to (defaults to document.body)
2122 * @param {Boolean} matchBox (optional) True to align and size the proxy to this element now (defaults to false)
2123 * @return {Roo.Element} The new proxy element
2125 createProxy : function(config, renderTo, matchBox){
2127 renderTo = Roo.getDom(renderTo);
2129 renderTo = document.body;
2131 config = typeof config == "object" ?
2132 config : {tag : "div", cls: config};
2133 var proxy = Roo.DomHelper.append(renderTo, config, true);
2135 proxy.setBox(this.getBox());
2141 * Puts a mask over this element to disable user interaction. Requires core.css.
2142 * This method can only be applied to elements which accept child nodes.
2143 * @param {String} msg (optional) A message to display in the mask
2144 * @param {String} msgCls (optional) A css class to apply to the msg element
2145 * @return {Element} The mask element
2147 mask : function(msg, msgCls)
2149 if(this.getStyle("position") == "static" && this.dom.tagName !== 'BODY'){
2150 this.setStyle("position", "relative");
2153 this._mask = Roo.DomHelper.append(this.dom, {cls:"roo-el-mask"}, true);
2156 this.addClass("x-masked");
2157 this._mask.setDisplayed(true);
2162 while (dom && dom.style) {
2163 if (!isNaN(parseInt(dom.style.zIndex))) {
2164 z = Math.max(z, parseInt(dom.style.zIndex));
2166 dom = dom.parentNode;
2168 // if we are masking the body - then it hides everything..
2169 if (this.dom == document.body) {
2171 this._mask.setWidth(Roo.lib.Dom.getDocumentWidth());
2172 this._mask.setHeight(Roo.lib.Dom.getDocumentHeight());
2175 if(typeof msg == 'string'){
2177 this._maskMsg = Roo.DomHelper.append(this.dom, {
2178 cls: "roo-el-mask-msg",
2182 cls: 'fa fa-spinner fa-spin'
2190 var mm = this._maskMsg;
2191 mm.dom.className = msgCls ? "roo-el-mask-msg " + msgCls : "roo-el-mask-msg";
2192 if (mm.dom.lastChild) { // weird IE issue?
2193 mm.dom.lastChild.innerHTML = msg;
2195 mm.setDisplayed(true);
2197 mm.setStyle('z-index', z + 102);
2199 if(Roo.isIE && !(Roo.isIE7 && Roo.isStrict) && this.getStyle('height') == 'auto'){ // ie will not expand full height automatically
2200 this._mask.setHeight(this.getHeight());
2202 this._mask.setStyle('z-index', z + 100);
2208 * Removes a previously applied mask. If removeEl is true the mask overlay is destroyed, otherwise
2209 * it is cached for reuse.
2211 unmask : function(removeEl){
2213 if(removeEl === true){
2214 this._mask.remove();
2217 this._maskMsg.remove();
2218 delete this._maskMsg;
2221 this._mask.setDisplayed(false);
2223 this._maskMsg.setDisplayed(false);
2227 this.removeClass("x-masked");
2231 * Returns true if this element is masked
2234 isMasked : function(){
2235 return this._mask && this._mask.isVisible();
2239 * Creates an iframe shim for this element to keep selects and other windowed objects from
2241 * @return {Roo.Element} The new shim element
2243 createShim : function(){
2244 var el = document.createElement('iframe');
2245 el.frameBorder = 'no';
2246 el.className = 'roo-shim';
2247 if(Roo.isIE && Roo.isSecure){
2248 el.src = Roo.SSL_SECURE_URL;
2250 var shim = Roo.get(this.dom.parentNode.insertBefore(el, this.dom));
2251 shim.autoBoxAdjust = false;
2256 * Removes this element from the DOM and deletes it from the cache
2258 remove : function(){
2259 if(this.dom.parentNode){
2260 this.dom.parentNode.removeChild(this.dom);
2262 delete El.cache[this.dom.id];
2266 * Sets up event handlers to add and remove a css class when the mouse is over this element
2267 * @param {String} className
2268 * @param {Boolean} preventFlicker (optional) If set to true, it prevents flickering by filtering
2269 * mouseout events for children elements
2270 * @return {Roo.Element} this
2272 addClassOnOver : function(className, preventFlicker){
2273 this.on("mouseover", function(){
2274 Roo.fly(this, '_internal').addClass(className);
2276 var removeFn = function(e){
2277 if(preventFlicker !== true || !e.within(this, true)){
2278 Roo.fly(this, '_internal').removeClass(className);
2281 this.on("mouseout", removeFn, this.dom);
2286 * Sets up event handlers to add and remove a css class when this element has the focus
2287 * @param {String} className
2288 * @return {Roo.Element} this
2290 addClassOnFocus : function(className){
2291 this.on("focus", function(){
2292 Roo.fly(this, '_internal').addClass(className);
2294 this.on("blur", function(){
2295 Roo.fly(this, '_internal').removeClass(className);
2300 * 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)
2301 * @param {String} className
2302 * @return {Roo.Element} this
2304 addClassOnClick : function(className){
2306 this.on("mousedown", function(){
2307 Roo.fly(dom, '_internal').addClass(className);
2308 var d = Roo.get(document);
2309 var fn = function(){
2310 Roo.fly(dom, '_internal').removeClass(className);
2311 d.removeListener("mouseup", fn);
2313 d.on("mouseup", fn);
2319 * Stops the specified event from bubbling and optionally prevents the default action
2320 * @param {String} eventName
2321 * @param {Boolean} preventDefault (optional) true to prevent the default action too
2322 * @return {Roo.Element} this
2324 swallowEvent : function(eventName, preventDefault){
2325 var fn = function(e){
2326 e.stopPropagation();
2331 if(eventName instanceof Array){
2332 for(var i = 0, len = eventName.length; i < len; i++){
2333 this.on(eventName[i], fn);
2337 this.on(eventName, fn);
2344 fitToParentDelegate : Roo.emptyFn, // keep a reference to the fitToParent delegate
2347 * Sizes this element to its parent element's dimensions performing
2348 * neccessary box adjustments.
2349 * @param {Boolean} monitorResize (optional) If true maintains the fit when the browser window is resized.
2350 * @param {String/HTMLElment/Element} targetParent (optional) The target parent, default to the parentNode.
2351 * @return {Roo.Element} this
2353 fitToParent : function(monitorResize, targetParent) {
2354 Roo.EventManager.removeResizeListener(this.fitToParentDelegate); // always remove previous fitToParent delegate from onWindowResize
2355 this.fitToParentDelegate = Roo.emptyFn; // remove reference to previous delegate
2356 if (monitorResize === true && !this.dom.parentNode) { // check if this Element still exists
2359 var p = Roo.get(targetParent || this.dom.parentNode);
2360 this.setSize(p.getComputedWidth() - p.getFrameWidth('lr'), p.getComputedHeight() - p.getFrameWidth('tb'));
2361 if (monitorResize === true) {
2362 this.fitToParentDelegate = this.fitToParent.createDelegate(this, [true, targetParent]);
2363 Roo.EventManager.onWindowResize(this.fitToParentDelegate);
2369 * Gets the next sibling, skipping text nodes
2370 * @return {HTMLElement} The next sibling or null
2372 getNextSibling : function(){
2373 var n = this.dom.nextSibling;
2374 while(n && n.nodeType != 1){
2381 * Gets the previous sibling, skipping text nodes
2382 * @return {HTMLElement} The previous sibling or null
2384 getPrevSibling : function(){
2385 var n = this.dom.previousSibling;
2386 while(n && n.nodeType != 1){
2387 n = n.previousSibling;
2394 * Appends the passed element(s) to this element
2395 * @param {String/HTMLElement/Array/Element/CompositeElement} el
2396 * @return {Roo.Element} this
2398 appendChild: function(el){
2405 * Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child element.
2406 * @param {Object} config DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be
2407 * automatically generated with the specified attributes.
2408 * @param {HTMLElement} insertBefore (optional) a child element of this element
2409 * @param {Boolean} returnDom (optional) true to return the dom node instead of creating an Element
2410 * @return {Roo.Element} The new child element
2412 createChild: function(config, insertBefore, returnDom){
2413 config = config || {tag:'div'};
2415 return Roo.DomHelper.insertBefore(insertBefore, config, returnDom !== true);
2417 return Roo.DomHelper[!this.dom.firstChild ? 'overwrite' : 'append'](this.dom, config, returnDom !== true);
2421 * Appends this element to the passed element
2422 * @param {String/HTMLElement/Element} el The new parent element
2423 * @return {Roo.Element} this
2425 appendTo: function(el){
2426 el = Roo.getDom(el);
2427 el.appendChild(this.dom);
2432 * Inserts this element before the passed element in the DOM
2433 * @param {String/HTMLElement/Element} el The element to insert before
2434 * @return {Roo.Element} this
2436 insertBefore: function(el){
2437 el = Roo.getDom(el);
2438 el.parentNode.insertBefore(this.dom, el);
2443 * Inserts this element after the passed element in the DOM
2444 * @param {String/HTMLElement/Element} el The element to insert after
2445 * @return {Roo.Element} this
2447 insertAfter: function(el){
2448 el = Roo.getDom(el);
2449 el.parentNode.insertBefore(this.dom, el.nextSibling);
2454 * Inserts (or creates) an element (or DomHelper config) as the first child of the this element
2455 * @param {String/HTMLElement/Element/Object} el The id or element to insert or a DomHelper config to create and insert
2456 * @return {Roo.Element} The new child
2458 insertFirst: function(el, returnDom){
2460 if(typeof el == 'object' && !el.nodeType){ // dh config
2461 return this.createChild(el, this.dom.firstChild, returnDom);
2463 el = Roo.getDom(el);
2464 this.dom.insertBefore(el, this.dom.firstChild);
2465 return !returnDom ? Roo.get(el) : el;
2470 * Inserts (or creates) the passed element (or DomHelper config) as a sibling of this element
2471 * @param {String/HTMLElement/Element/Object} el The id or element to insert or a DomHelper config to create and insert
2472 * @param {String} where (optional) 'before' or 'after' defaults to before
2473 * @param {Boolean} returnDom (optional) True to return the raw DOM element instead of Roo.Element
2474 * @return {Roo.Element} the inserted Element
2476 insertSibling: function(el, where, returnDom){
2477 where = where ? where.toLowerCase() : 'before';
2479 var rt, refNode = where == 'before' ? this.dom : this.dom.nextSibling;
2481 if(typeof el == 'object' && !el.nodeType){ // dh config
2482 if(where == 'after' && !this.dom.nextSibling){
2483 rt = Roo.DomHelper.append(this.dom.parentNode, el, !returnDom);
2485 rt = Roo.DomHelper[where == 'after' ? 'insertAfter' : 'insertBefore'](this.dom, el, !returnDom);
2489 rt = this.dom.parentNode.insertBefore(Roo.getDom(el),
2490 where == 'before' ? this.dom : this.dom.nextSibling);
2499 * Creates and wraps this element with another element
2500 * @param {Object} config (optional) DomHelper element config object for the wrapper element or null for an empty div
2501 * @param {Boolean} returnDom (optional) True to return the raw DOM element instead of Roo.Element
2502 * @return {HTMLElement/Element} The newly created wrapper element
2504 wrap: function(config, returnDom){
2506 config = {tag: "div"};
2508 var newEl = Roo.DomHelper.insertBefore(this.dom, config, !returnDom);
2509 newEl.dom ? newEl.dom.appendChild(this.dom) : newEl.appendChild(this.dom);
2514 * Replaces the passed element with this element
2515 * @param {String/HTMLElement/Element} el The element to replace
2516 * @return {Roo.Element} this
2518 replace: function(el){
2520 this.insertBefore(el);
2526 * Inserts an html fragment into this element
2527 * @param {String} where Where to insert the html in relation to the this element - beforeBegin, afterBegin, beforeEnd, afterEnd.
2528 * @param {String} html The HTML fragment
2529 * @param {Boolean} returnEl True to return an Roo.Element
2530 * @return {HTMLElement/Roo.Element} The inserted node (or nearest related if more than 1 inserted)
2532 insertHtml : function(where, html, returnEl){
2533 var el = Roo.DomHelper.insertHtml(where, this.dom, html);
2534 return returnEl ? Roo.get(el) : el;
2538 * Sets the passed attributes as attributes of this element (a style attribute can be a string, object or function)
2539 * @param {Object} o The object with the attributes
2540 * @param {Boolean} useSet (optional) false to override the default setAttribute to use expandos.
2541 * @return {Roo.Element} this
2543 set : function(o, useSet){
2545 useSet = typeof useSet == 'undefined' ? (el.setAttribute ? true : false) : useSet;
2547 if(attr == "style" || typeof o[attr] == "function") { continue; }
2549 el.className = o["cls"];
2552 el.setAttribute(attr, o[attr]);
2559 Roo.DomHelper.applyStyles(el, o.style);
2565 * Convenience method for constructing a KeyMap
2566 * @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:
2567 * {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}
2568 * @param {Function} fn The function to call
2569 * @param {Object} scope (optional) The scope of the function
2570 * @return {Roo.KeyMap} The KeyMap created
2572 addKeyListener : function(key, fn, scope){
2574 if(typeof key != "object" || key instanceof Array){
2590 return new Roo.KeyMap(this, config);
2594 * Creates a KeyMap for this element
2595 * @param {Object} config The KeyMap config. See {@link Roo.KeyMap} for more details
2596 * @return {Roo.KeyMap} The KeyMap created
2598 addKeyMap : function(config){
2599 return new Roo.KeyMap(this, config);
2603 * Returns true if this element is scrollable.
2606 isScrollable : function(){
2608 return dom.scrollHeight > dom.clientHeight || dom.scrollWidth > dom.clientWidth;
2612 * 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().
2613 * @param {String} side Either "left" for scrollLeft values or "top" for scrollTop values.
2614 * @param {Number} value The new scroll value
2615 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
2616 * @return {Element} this
2619 scrollTo : function(side, value, animate){
2620 var prop = side.toLowerCase() == "left" ? "scrollLeft" : "scrollTop";
2622 this.dom[prop] = value;
2624 var to = prop == "scrollLeft" ? [value, this.dom.scrollTop] : [this.dom.scrollLeft, value];
2625 this.anim({scroll: {"to": to}}, this.preanim(arguments, 2), 'scroll');
2631 * Scrolls this element the specified direction. Does bounds checking to make sure the scroll is
2632 * within this element's scrollable range.
2633 * @param {String} direction Possible values are: "l","left" - "r","right" - "t","top","up" - "b","bottom","down".
2634 * @param {Number} distance How far to scroll the element in pixels
2635 * @param {Boolean/Object} animate (optional) true for the default animation or a standard Element animation config object
2636 * @return {Boolean} Returns true if a scroll was triggered or false if the element
2637 * was scrolled as far as it could go.
2639 scroll : function(direction, distance, animate){
2640 if(!this.isScrollable()){
2644 var l = el.scrollLeft, t = el.scrollTop;
2645 var w = el.scrollWidth, h = el.scrollHeight;
2646 var cw = el.clientWidth, ch = el.clientHeight;
2647 direction = direction.toLowerCase();
2648 var scrolled = false;
2649 var a = this.preanim(arguments, 2);
2654 var v = Math.min(l + distance, w-cw);
2655 this.scrollTo("left", v, a);
2662 var v = Math.max(l - distance, 0);
2663 this.scrollTo("left", v, a);
2671 var v = Math.max(t - distance, 0);
2672 this.scrollTo("top", v, a);
2680 var v = Math.min(t + distance, h-ch);
2681 this.scrollTo("top", v, a);
2690 * Translates the passed page coordinates into left/top css values for this element
2691 * @param {Number/Array} x The page x or an array containing [x, y]
2692 * @param {Number} y The page y
2693 * @return {Object} An object with left and top properties. e.g. {left: (value), top: (value)}
2695 translatePoints : function(x, y){
2696 if(typeof x == 'object' || x instanceof Array){
2699 var p = this.getStyle('position');
2700 var o = this.getXY();
2702 var l = parseInt(this.getStyle('left'), 10);
2703 var t = parseInt(this.getStyle('top'), 10);
2706 l = (p == "relative") ? 0 : this.dom.offsetLeft;
2709 t = (p == "relative") ? 0 : this.dom.offsetTop;
2712 return {left: (x - o[0] + l), top: (y - o[1] + t)};
2716 * Returns the current scroll position of the element.
2717 * @return {Object} An object containing the scroll position in the format {left: (scrollLeft), top: (scrollTop)}
2719 getScroll : function(){
2720 var d = this.dom, doc = document;
2721 if(d == doc || d == doc.body){
2722 var l = window.pageXOffset || doc.documentElement.scrollLeft || doc.body.scrollLeft || 0;
2723 var t = window.pageYOffset || doc.documentElement.scrollTop || doc.body.scrollTop || 0;
2724 return {left: l, top: t};
2726 return {left: d.scrollLeft, top: d.scrollTop};
2731 * Return the CSS color for the specified CSS attribute. rgb, 3 digit (like #fff) and valid values
2732 * are convert to standard 6 digit hex color.
2733 * @param {String} attr The css attribute
2734 * @param {String} defaultValue The default value to use when a valid color isn't found
2735 * @param {String} prefix (optional) defaults to #. Use an empty string when working with
2738 getColor : function(attr, defaultValue, prefix){
2739 var v = this.getStyle(attr);
2740 if(!v || v == "transparent" || v == "inherit") {
2741 return defaultValue;
2743 var color = typeof prefix == "undefined" ? "#" : prefix;
2744 if(v.substr(0, 4) == "rgb("){
2745 var rvs = v.slice(4, v.length -1).split(",");
2746 for(var i = 0; i < 3; i++){
2747 var h = parseInt(rvs[i]).toString(16);
2754 if(v.substr(0, 1) == "#"){
2756 for(var i = 1; i < 4; i++){
2757 var c = v.charAt(i);
2760 }else if(v.length == 7){
2761 color += v.substr(1);
2765 return(color.length > 5 ? color.toLowerCase() : defaultValue);
2769 * Wraps the specified element with a special markup/CSS block that renders by default as a gray container with a
2770 * gradient background, rounded corners and a 4-way shadow.
2771 * @param {String} class (optional) A base CSS class to apply to the containing wrapper element (defaults to 'x-box').
2772 * Note that there are a number of CSS rules that are dependent on this name to make the overall effect work,
2773 * so if you supply an alternate base class, make sure you also supply all of the necessary rules.
2774 * @return {Roo.Element} this
2776 boxWrap : function(cls){
2777 cls = cls || 'x-box';
2778 var el = Roo.get(this.insertHtml('beforeBegin', String.format('<div class="{0}">'+El.boxMarkup+'</div>', cls)));
2779 el.child('.'+cls+'-mc').dom.appendChild(this.dom);
2784 * Returns the value of a namespaced attribute from the element's underlying DOM node.
2785 * @param {String} namespace The namespace in which to look for the attribute
2786 * @param {String} name The attribute name
2787 * @return {String} The attribute value
2789 getAttributeNS : Roo.isIE ? function(ns, name){
2791 var type = typeof d[ns+":"+name];
2792 if(type != 'undefined' && type != 'unknown'){
2793 return d[ns+":"+name];
2796 } : function(ns, name){
2798 return d.getAttributeNS(ns, name) || d.getAttribute(ns+":"+name) || d.getAttribute(name) || d[name];
2803 * Sets or Returns the value the dom attribute value
2804 * @param {String|Object} name The attribute name (or object to set multiple attributes)
2805 * @param {String} value (optional) The value to set the attribute to
2806 * @return {String} The attribute value
2808 attr : function(name){
2809 if (arguments.length > 1) {
2810 this.dom.setAttribute(name, arguments[1]);
2811 return arguments[1];
2813 if (typeof(name) == 'object') {
2814 for(var i in name) {
2815 this.attr(i, name[i]);
2821 if (!this.dom.hasAttribute(name)) {
2824 return this.dom.getAttribute(name);
2831 var ep = El.prototype;
2834 * Appends an event handler (Shorthand for addListener)
2835 * @param {String} eventName The type of event to append
2836 * @param {Function} fn The method the event invokes
2837 * @param {Object} scope (optional) The scope (this object) of the fn
2838 * @param {Object} options (optional)An object with standard {@link Roo.EventManager#addListener} options
2841 ep.on = ep.addListener;
2843 ep.mon = ep.addListener;
2846 * Removes an event handler from this element (shorthand for removeListener)
2847 * @param {String} eventName the type of event to remove
2848 * @param {Function} fn the method the event invokes
2849 * @return {Roo.Element} this
2852 ep.un = ep.removeListener;
2855 * true to automatically adjust width and height settings for box-model issues (default to true)
2857 ep.autoBoxAdjust = true;
2860 El.unitPattern = /\d+(px|em|%|en|ex|pt|in|cm|mm|pc)$/i;
2863 El.addUnits = function(v, defaultUnit){
2864 if(v === "" || v == "auto"){
2867 if(v === undefined){
2870 if(typeof v == "number" || !El.unitPattern.test(v)){
2871 return v + (defaultUnit || 'px');
2876 // special markup used throughout Roo when box wrapping elements
2877 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>';
2879 * Visibility mode constant - Use visibility to hide element
2885 * Visibility mode constant - Use display to hide element
2891 El.borders = {l: "border-left-width", r: "border-right-width", t: "border-top-width", b: "border-bottom-width"};
2892 El.paddings = {l: "padding-left", r: "padding-right", t: "padding-top", b: "padding-bottom"};
2893 El.margins = {l: "margin-left", r: "margin-right", t: "margin-top", b: "margin-bottom"};
2905 * Static method to retrieve Element objects. Uses simple caching to consistently return the same object.
2906 * Automatically fixes if an object was recreated with the same id via AJAX or DOM.
2907 * @param {String/HTMLElement/Element} el The id of the node, a DOM Node or an existing Element.
2908 * @return {Element} The Element object
2911 El.get = function(el){
2913 if(!el){ return null; }
2914 if(typeof el == "string"){ // element id
2915 if(!(elm = document.getElementById(el))){
2918 if(ex = El.cache[el]){
2921 ex = El.cache[el] = new El(elm);
2924 }else if(el.tagName){ // dom element
2928 if(ex = El.cache[id]){
2931 ex = El.cache[id] = new El(el);
2934 }else if(el instanceof El){
2936 el.dom = document.getElementById(el.id) || el.dom; // refresh dom element in case no longer valid,
2937 // catch case where it hasn't been appended
2938 El.cache[el.id] = el; // in case it was created directly with Element(), let's cache it
2941 }else if(el.isComposite){
2943 }else if(el instanceof Array){
2944 return El.select(el);
2945 }else if(el == document){
2946 // create a bogus element object representing the document object
2948 var f = function(){};
2949 f.prototype = El.prototype;
2951 docEl.dom = document;
2959 El.uncache = function(el){
2960 for(var i = 0, a = arguments, len = a.length; i < len; i++) {
2962 delete El.cache[a[i].id || a[i]];
2968 // Garbage collection - uncache elements/purge listeners on orphaned elements
2969 // so we don't hold a reference and cause the browser to retain them
2970 El.garbageCollect = function(){
2971 if(!Roo.enableGarbageCollector){
2972 clearInterval(El.collectorThread);
2975 for(var eid in El.cache){
2976 var el = El.cache[eid], d = el.dom;
2977 // -------------------------------------------------------
2978 // Determining what is garbage:
2979 // -------------------------------------------------------
2981 // dom node is null, definitely garbage
2982 // -------------------------------------------------------
2984 // no parentNode == direct orphan, definitely garbage
2985 // -------------------------------------------------------
2986 // !d.offsetParent && !document.getElementById(eid)
2987 // display none elements have no offsetParent so we will
2988 // also try to look it up by it's id. However, check
2989 // offsetParent first so we don't do unneeded lookups.
2990 // This enables collection of elements that are not orphans
2991 // directly, but somewhere up the line they have an orphan
2993 // -------------------------------------------------------
2994 if(!d || !d.parentNode || (!d.offsetParent && !document.getElementById(eid))){
2995 delete El.cache[eid];
2996 if(d && Roo.enableListenerCollection){
3002 El.collectorThreadId = setInterval(El.garbageCollect, 30000);
3006 El.Flyweight = function(dom){
3009 El.Flyweight.prototype = El.prototype;
3011 El._flyweights = {};
3013 * Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -
3014 * the dom node can be overwritten by other code.
3015 * @param {String/HTMLElement} el The dom node or id
3016 * @param {String} named (optional) Allows for creation of named reusable flyweights to
3017 * prevent conflicts (e.g. internally Roo uses "_internal")
3019 * @return {Element} The shared Element object
3021 El.fly = function(el, named){
3022 named = named || '_global';
3023 el = Roo.getDom(el);
3027 if(!El._flyweights[named]){
3028 El._flyweights[named] = new El.Flyweight();
3030 El._flyweights[named].dom = el;
3031 return El._flyweights[named];
3035 * Static method to retrieve Element objects. Uses simple caching to consistently return the same object.
3036 * Automatically fixes if an object was recreated with the same id via AJAX or DOM.
3037 * Shorthand of {@link Roo.Element#get}
3038 * @param {String/HTMLElement/Element} el The id of the node, a DOM Node or an existing Element.
3039 * @return {Element} The Element object
3045 * Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element -
3046 * the dom node can be overwritten by other code.
3047 * Shorthand of {@link Roo.Element#fly}
3048 * @param {String/HTMLElement} el The dom node or id
3049 * @param {String} named (optional) Allows for creation of named reusable flyweights to
3050 * prevent conflicts (e.g. internally Roo uses "_internal")
3052 * @return {Element} The shared Element object
3058 // speedy lookup for elements never to box adjust
3059 var noBoxAdjust = Roo.isStrict ? {
3062 input:1, select:1, textarea:1
3064 if(Roo.isIE || Roo.isGecko){
3065 noBoxAdjust['button'] = 1;
3069 Roo.EventManager.on(window, 'unload', function(){
3071 delete El._flyweights;
3079 Roo.Element.selectorFunction = Roo.DomQuery.select;
3082 Roo.Element.select = function(selector, unique, root){
3084 if(typeof selector == "string"){
3085 els = Roo.Element.selectorFunction(selector, root);
3086 }else if(selector.length !== undefined){
3089 throw "Invalid selector";
3091 if(unique === true){
3092 return new Roo.CompositeElement(els);
3094 return new Roo.CompositeElementLite(els);
3098 * Selects elements based on the passed CSS selector to enable working on them as 1.
3099 * @param {String/Array} selector The CSS selector or an array of elements
3100 * @param {Boolean} unique (optional) true to create a unique Roo.Element for each element (defaults to a shared flyweight object)
3101 * @param {HTMLElement/String} root (optional) The root element of the query or id of the root
3102 * @return {CompositeElementLite/CompositeElement}
3106 Roo.select = Roo.Element.select;