1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.Layer</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.Layer-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.Layer-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.Layer-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.Layer-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.Layer
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_Layer.js.html">Roo/Layer.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">Layer</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
75 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
85 An extended {<b>link</b> Roo.Element} object that supports a shadow and shim, constrain to viewport and<br/>automatic maintaining of shadow/shim positions.
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.Layer';">[Add Your comment/notes about this class]</u>
95 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.Layer.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.Layer-configs"></a>
113 <table cellspacing="0" class="member-table">
114 <caption>Config Options (Usually are also Properties)</caption>
118 <th class="sig-header" colspan="2">Options</th>
120 <th class="msource-header">Defined By</th>
127 <tr class="config-row expandable config-row-alt0 notInherited">
128 <td class="micon"><a class="exi" href="#expand"> </a></td>
131 <a id="Roo.Layer-cfg-cls" name=".cls"></a>
132 <div class="fixedFont">
133 <b class="itemname">cls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
139 <div class="short">CSS class to add to the element</div>
143 <div class="long">CSS class to add to the element</div>
157 <tr class="config-row expandable config-row-alt1 notInherited">
158 <td class="micon"><a class="exi" href="#expand"> </a></td>
161 <a id="Roo.Layer-cfg-constrain" name=".constrain"></a>
162 <div class="fixedFont">
163 <b class="itemname">constrain</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
169 <div class="short">False to disable constrain to viewport (defaults to true)</div>
173 <div class="long">False to disable constrain to viewport (defaults to true)</div>
187 <tr class="config-row expandable config-row-alt0 notInherited">
188 <td class="micon"><a class="exi" href="#expand"> </a></td>
191 <a id="Roo.Layer-cfg-dh" name=".dh"></a>
192 <div class="fixedFont">
193 <b class="itemname">dh</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
199 <div class="short">DomHelper object config to create element with (defaults to {tag: "div", cls: "x-layer"}).</div>
203 <div class="long">DomHelper object config to create element with (defaults to {tag: "div", cls: "x-layer"}).</div>
217 <tr class="config-row expandable config-row-alt1 notInherited">
218 <td class="micon"><a class="exi" href="#expand"> </a></td>
221 <a id="Roo.Layer-cfg-shadow" name=".shadow"></a>
222 <div class="fixedFont">
223 <b class="itemname">shadow</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Boolean
229 <div class="short">True to create a shadow element with default class "x-layer-shadow", or<br/>you can pass a string with a CSS class name.</div>
233 <div class="long">True to create a shadow element with default class "x-layer-shadow", or<br/>you can pass a string with a CSS class name. False turns off the shadow.</div>
247 <tr class="config-row expandable config-row-alt0 notInherited">
248 <td class="micon"><a class="exi" href="#expand"> </a></td>
251 <a id="Roo.Layer-cfg-shadowOffset" name=".shadowOffset"></a>
252 <div class="fixedFont">
253 <b class="itemname">shadowOffset</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
259 <div class="short">Number of pixels to offset the shadow (defaults to 3)</div>
263 <div class="long">Number of pixels to offset the shadow (defaults to 3)</div>
277 <tr class="config-row expandable config-row-alt1 notInherited">
278 <td class="micon"><a class="exi" href="#expand"> </a></td>
281 <a id="Roo.Layer-cfg-shim" name=".shim"></a>
282 <div class="fixedFont">
283 <b class="itemname">shim</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
289 <div class="short">False to disable the iframe shim in browsers which need one (defaults to true)</div>
293 <div class="long">False to disable the iframe shim in browsers which need one (defaults to true)</div>
307 <tr class="config-row expandable config-row-alt0 notInherited">
308 <td class="micon"><a class="exi" href="#expand"> </a></td>
311 <a id="Roo.Layer-cfg-zindex" name=".zindex"></a>
312 <div class="fixedFont">
313 <b class="itemname">zindex</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
319 <div class="short">Starting z-index (defaults to 11000)</div>
323 <div class="long">Starting z-index (defaults to 11000)</div>
347 <!-- ============================== public properties ==================== -->
351 <a id="Roo.Layer-props"></a>
357 <table cellspacing="0" class="member-table">
358 <caption class="Empty">Public Properties - Has None</caption>
364 <!-- ============================== methods summary / details ======================== -->
367 <a id="Roo.Layer-methods"></a>
368 <!-- constructor?? -->
375 <!-- then dynamics first -->
382 <table cellspacing="0" class="member-table">
383 <caption>Public Methods</caption>
385 <th class="sig-header" colspan="2">Method</th>
386 <th class="msource-header">Defined By</th>
396 <tr class="method-row config-row-alt0 expandable notInherited">
397 <td class="micon"><a class="exi" href="#expand"> </a></td>
401 <a id="Roo-method-Layer" name=".Layer"></a>
402 <div class="fixedFont">
403 <span class="attributes">new <B>Roo.</B></span><b class="itemname">Layer</b>
405 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement <B><i>existingEl</i></B>)
413 <div class="short">Create a new Roo.Layer</div>
420 Create a new Roo.Layer
423 <dl class="detailList">
424 <dt class="heading">Parameters:</dt>
427 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
430 <dd>An object with config options.</dd>
433 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement</span> <b>existingEl</b>
436 <dd>(optional) Uses an existing DOM element. If the element is not found it creates it.</dd>
460 <tr class="method-row config-row-alt1 expandable notInherited">
461 <td class="micon"><a class="exi" href="#expand"> </a></td>
465 <a id="Roo.Layer-method-setZIndex" name=".setZIndex"></a>
466 <div class="fixedFont">
467 <span class="attributes"></span><b class="itemname">setZIndex</b>
469 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>zindex</i></B>)
475 <a href="./this.html#constructor" roo:cls="this.html#constructor">this</a>
484 <div class="short">Sets the z-index of this layer and adjusts any shadow and shim z-indexes.</div>
490 Sets the z-index of this layer and adjusts any shadow and shim z-indexes. The layer z-index is automatically<br/>incremented by two more than the value passed in so that it always shows above any shadow or shim (the shadow<br/>element, if any, will be assigned z-index + 1, and the shim element, if any, will be assigned the unmodified z-index).
497 <dl class="detailList">
498 <dt class="heading">Parameters:</dt>
501 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>zindex</b>
504 <dd>The new z-index to set</dd>
512 <dl class="detailList">
513 <dt class="heading">Returns:</dt>
515 <dd><span class="fixedFont"><a href="./this.html#constructor" roo:cls="this.html#constructor">this</a></span> The Layer</dd>
540 <!-- ============================== events summary / details ======================== -->
543 <a id="Roo.Layer-events"></a>
549 <table cellspacing="0" class="member-table">
550 <caption class="Empty">Events - Has None</caption>
561 <!-- ============================== footer ================================= -->
562 <div class="fineprint" style="clear:both">
564 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Mon Jul 19 2010 11:50:45 GMT+0800 (HKT)
566 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>