3 * Copyright(c) 2006-2009 Ext JS, LLC
5 * http://www.extjs.com/license
10 * An extended {@link Ext.Element} object that supports a shadow and shim, constrain to viewport and
11 * automatic maintaining of shadow/shim positions.
12 * @cfg {Boolean} shim False to disable the iframe shim in browsers which need one (defaults to true)
13 * @cfg {String/Boolean} shadow True to automatically create an {@link Ext.Shadow}, or a string indicating the
14 * shadow's display {@link Ext.Shadow#mode}. False to disable the shadow. (defaults to false)
15 * @cfg {Object} dh DomHelper object config to create element with (defaults to {tag: 'div', cls: 'x-layer'}).
16 * @cfg {Boolean} constrain False to disable constrain to viewport (defaults to true)
17 * @cfg {String} cls CSS class to add to the element
18 * @cfg {Number} zindex Starting z-index (defaults to 11000)
19 * @cfg {Number} shadowOffset Number of pixels to offset the shadow (defaults to 4)
20 * @cfg {Boolean} useDisplay
21 * Defaults to use css offsets to hide the Layer. Specify <tt>true</tt>
22 * to use css style <tt>'display:none;'</tt> to hide the Layer.
24 * @param {Object} config An object with config options.
25 * @param {String/HTMLElement} existingEl (optional) Uses an existing DOM element. If the element is not found it creates it.
28 Ext.Layer = function(config, existingEl){
29 config = config || {};
30 var dh = Ext.DomHelper;
31 var cp = config.parentEl, pel = cp ? Ext.getDom(cp) : document.body;
33 this.dom = Ext.getDom(existingEl);
36 var o = config.dh || {tag: 'div', cls: 'x-layer'};
37 this.dom = dh.append(pel, o);
40 this.addClass(config.cls);
42 this.constrain = config.constrain !== false;
43 this.setVisibilityMode(Ext.Element.VISIBILITY);
45 this.id = this.dom.id = config.id;
47 this.id = Ext.id(this.dom);
49 this.zindex = config.zindex || this.getZIndex();
50 this.position('absolute', this.zindex);
52 this.shadowOffset = config.shadowOffset || 4;
53 this.shadow = new Ext.Shadow({
54 offset : this.shadowOffset,
58 this.shadowOffset = 0;
60 this.useShim = config.shim !== false && Ext.useShims;
61 this.useDisplay = config.useDisplay;
65 var supr = Ext.Element.prototype;
67 // shims are shared among layer to keep from having 100 iframes
70 Ext.extend(Ext.Layer, Ext.Element, {
72 getZIndex : function(){
73 return this.zindex || parseInt((this.getShim() || this).getStyle('z-index'), 10) || 11000;
83 var shim = shims.shift();
85 shim = this.createShim();
86 shim.enableDisplayMode('block');
87 shim.dom.style.display = 'none';
88 shim.dom.style.visibility = 'visible';
90 var pn = this.dom.parentNode;
91 if(shim.dom.parentNode != pn){
92 pn.insertBefore(shim.dom, this.dom);
94 shim.setStyle('z-index', this.getZIndex()-2);
99 hideShim : function(){
101 this.shim.setDisplayed(false);
102 shims.push(this.shim);
107 disableShadow : function(){
109 this.shadowDisabled = true;
111 this.lastShadowOffset = this.shadowOffset;
112 this.shadowOffset = 0;
116 enableShadow : function(show){
118 this.shadowDisabled = false;
119 this.shadowOffset = this.lastShadowOffset;
120 delete this.lastShadowOffset;
128 // this code can execute repeatedly in milliseconds (i.e. during a drag) so
129 // code size was sacrificed for effeciency (e.g. no getBox/setBox, no XY calls)
130 sync : function(doShow){
131 var sw = this.shadow;
132 if(!this.updating && this.isVisible() && (sw || this.useShim)){
133 var sh = this.getShim();
135 var w = this.getWidth(),
136 h = this.getHeight();
138 var l = this.getLeft(true),
139 t = this.getTop(true);
141 if(sw && !this.shadowDisabled){
142 if(doShow && !sw.isVisible()){
145 sw.realign(l, t, w, h);
151 // fit the shim behind the shadow, so it is shimmed too
152 var a = sw.adjusts, s = sh.dom.style;
153 s.left = (Math.min(l, l+a.l))+'px';
154 s.top = (Math.min(t, t+a.t))+'px';
155 s.width = (w+a.w)+'px';
156 s.height = (h+a.h)+'px';
170 destroy : function(){
175 this.removeAllListeners();
176 Ext.removeNode(this.dom);
177 Ext.Element.uncache(this.id);
185 beginUpdate : function(){
186 this.updating = true;
190 endUpdate : function(){
191 this.updating = false;
196 hideUnders : function(negOffset){
204 constrainXY : function(){
206 var vw = Ext.lib.Dom.getViewWidth(),
207 vh = Ext.lib.Dom.getViewHeight();
208 var s = Ext.getDoc().getScroll();
210 var xy = this.getXY();
211 var x = xy[0], y = xy[1];
212 var so = this.shadowOffset;
213 var w = this.dom.offsetWidth+so, h = this.dom.offsetHeight+so;
214 // only move it if it needs it
216 // first validate right/bottom
217 if((x + w) > vw+s.left){
221 if((y + h) > vh+s.top){
225 // then make sure top/left isn't negative
236 var ay = this.avoidY;
237 if(y <= ay && (y+h) >= ay){
243 supr.setXY.call(this, xy);
250 isVisible : function(){
255 showAction : function(){
256 this.visible = true; // track visibility to prevent getStyle calls
257 if(this.useDisplay === true){
258 this.setDisplayed('');
259 }else if(this.lastXY){
260 supr.setXY.call(this, this.lastXY);
261 }else if(this.lastLT){
262 supr.setLeftTop.call(this, this.lastLT[0], this.lastLT[1]);
267 hideAction : function(){
268 this.visible = false;
269 if(this.useDisplay === true){
270 this.setDisplayed(false);
272 this.setLeftTop(-10000,-10000);
276 // overridden Element method
277 setVisible : function(v, a, d, c, e){
287 }.createDelegate(this);
288 supr.setVisible.call(this, true, true, d, cb, e);
291 this.hideUnders(true);
300 }.createDelegate(this);
302 supr.setVisible.call(this, v, a, d, cb, e);
312 storeXY : function(xy){
317 storeLeftTop : function(left, top){
319 this.lastLT = [left, top];
323 beforeFx : function(){
325 return Ext.Layer.superclass.beforeFx.apply(this, arguments);
329 afterFx : function(){
330 Ext.Layer.superclass.afterFx.apply(this, arguments);
331 this.sync(this.isVisible());
335 beforeAction : function(){
336 if(!this.updating && this.shadow){
341 // overridden Element method
342 setLeft : function(left){
343 this.storeLeftTop(left, this.getTop(true));
344 supr.setLeft.apply(this, arguments);
349 setTop : function(top){
350 this.storeLeftTop(this.getLeft(true), top);
351 supr.setTop.apply(this, arguments);
356 setLeftTop : function(left, top){
357 this.storeLeftTop(left, top);
358 supr.setLeftTop.apply(this, arguments);
363 setXY : function(xy, a, d, c, e){
367 var cb = this.createCB(c);
368 supr.setXY.call(this, xy, a, d, cb, e);
376 createCB : function(c){
387 // overridden Element method
388 setX : function(x, a, d, c, e){
389 this.setXY([x, this.getY()], a, d, c, e);
393 // overridden Element method
394 setY : function(y, a, d, c, e){
395 this.setXY([this.getX(), y], a, d, c, e);
399 // overridden Element method
400 setSize : function(w, h, a, d, c, e){
402 var cb = this.createCB(c);
403 supr.setSize.call(this, w, h, a, d, cb, e);
410 // overridden Element method
411 setWidth : function(w, a, d, c, e){
413 var cb = this.createCB(c);
414 supr.setWidth.call(this, w, a, d, cb, e);
421 // overridden Element method
422 setHeight : function(h, a, d, c, e){
424 var cb = this.createCB(c);
425 supr.setHeight.call(this, h, a, d, cb, e);
432 // overridden Element method
433 setBounds : function(x, y, w, h, a, d, c, e){
435 var cb = this.createCB(c);
437 this.storeXY([x, y]);
438 supr.setXY.call(this, [x, y]);
439 supr.setSize.call(this, w, h, a, d, cb, e);
442 supr.setBounds.call(this, x, y, w, h, a, d, cb, e);
448 * Sets the z-index of this layer and adjusts any shadow and shim z-indexes. The layer z-index is automatically
449 * incremented by two more than the value passed in so that it always shows above any shadow or shim (the shadow
450 * element, if any, will be assigned z-index + 1, and the shim element, if any, will be assigned the unmodified z-index).
451 * @param {Number} zindex The new z-index to set
452 * @return {this} The Layer
454 setZIndex : function(zindex){
455 this.zindex = zindex;
456 this.setStyle('z-index', zindex + 2);
458 this.shadow.setZIndex(zindex + 1);
461 this.shim.setStyle('z-index', zindex);