git.roojs.org Git - roojs1/blob - docs/symbols/Roo.Layer.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2
   3
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5
   6         <head>
   7                 <meta http-equiv="content-type" content="text/html; charset=undefined" />
   8                 <meta name="generator" content="JsDoc Toolkit" />
   9
  10
  11                 <title>JsDoc Reference - Roo.Layer</title>
  12
  13
  14         <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
  15         <link rel="stylesheet" type="text/css" href="../default.css" />
  16
  17
  18         <script type="text/javascript" src="../page.js">
  19
  20         </script>
  21
  22
  23         </head>
  24
  25         <body onload="RooDocsPage.onload();">
  26
  27
  28 <div class="body-wrap">
  29
  30     <!-- ============================== links to methods. ================================= -->
  31
  32     <div class="top-tools">
  33     <!--
  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>
  39         -->
  40     </div>
  41
  42
  43 <!-- ============================== inheritance Block. ================================= -->
  44
  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
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.Layer
  58                         </h1>
  59
  60     <table cellspacing="0" class="class-summary-table">
  61
  62                 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
  63
  64         <tr><td class="label">Defined In:</td><td class="hd-info">
  65
  66                                         <a href="./src/Roo_Layer.js.html">Roo/Layer.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">Layer</td></tr>
  70
  71
  72
  73
  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>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  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.
  86     </div>
  87
  88
  89 <!-- ============================== Class comment block... ========================== -->
  90
  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>
  94         <br/>
  95         <iframe frameborder="0"  id="comments-Roo" style="border: none;width:100%;"
  96                 src="/blog.php/GtkDjsComments/Roo.Layer.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.Layer-configs"></a>
 108
 109
 110
 111
 112
 113       <table cellspacing="0" class="member-table">
 114       <caption>Config Options (Usually are also Properties)</caption>
 115
 116
 117         <tr>
 118             <th class="sig-header" colspan="2">Options</th>
 119
 120             <th class="msource-header">Defined By</th>
 121         </tr>
 122
 123
 124
 125
 126
 127                 <tr class="config-row expandable config-row-alt0 notInherited">
 128                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 129                     <td class="sig">
 130
 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>
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <div class="short">CSS class to add to the element</div>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <div class="long">CSS class to add to the element</div>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         Roo.Layer
 152
 153                     </td>
 154                 </tr>
 155
 156
 157                 <tr class="config-row expandable config-row-alt1 notInherited">
 158                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 159                     <td class="sig">
 160
 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>
 164
 165
 166                         </div>
 167
 168                         <div class="mdesc">
 169                             <div class="short">False to disable constrain to viewport (defaults to true)</div>
 170                         </div>
 171
 172                         <div class="mdesc">
 173                             <div class="long">False to disable constrain to viewport (defaults to true)</div>
 174                         </div>
 175
 176
 177
 178                     </td>
 179                     <td class="msource">
 180
 181                         Roo.Layer
 182
 183                     </td>
 184                 </tr>
 185
 186
 187                 <tr class="config-row expandable config-row-alt0 notInherited">
 188                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 189                     <td class="sig">
 190
 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>
 194
 195
 196                         </div>
 197
 198                         <div class="mdesc">
 199                             <div class="short">DomHelper object config to create element with (defaults to {tag: "div", cls: "x-layer"}).</div>
 200                         </div>
 201
 202                         <div class="mdesc">
 203                             <div class="long">DomHelper object config to create element with (defaults to {tag: "div", cls: "x-layer"}).</div>
 204                         </div>
 205
 206
 207
 208                     </td>
 209                     <td class="msource">
 210
 211                         Roo.Layer
 212
 213                     </td>
 214                 </tr>
 215
 216
 217                 <tr class="config-row expandable config-row-alt1 notInherited">
 218                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 219                     <td class="sig">
 220
 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
 224
 225
 226                         </div>
 227
 228                         <div class="mdesc">
 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>
 230                         </div>
 231
 232                         <div class="mdesc">
 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>
 234                         </div>
 235
 236
 237
 238                     </td>
 239                     <td class="msource">
 240
 241                         Roo.Layer
 242
 243                     </td>
 244                 </tr>
 245
 246
 247                 <tr class="config-row expandable config-row-alt0 notInherited">
 248                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 249                     <td class="sig">
 250
 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>
 254
 255
 256                         </div>
 257
 258                         <div class="mdesc">
 259                             <div class="short">Number of pixels to offset the shadow (defaults to 3)</div>
 260                         </div>
 261
 262                         <div class="mdesc">
 263                             <div class="long">Number of pixels to offset the shadow (defaults to 3)</div>
 264                         </div>
 265
 266
 267
 268                     </td>
 269                     <td class="msource">
 270
 271                         Roo.Layer
 272
 273                     </td>
 274                 </tr>
 275
 276
 277                 <tr class="config-row expandable config-row-alt1 notInherited">
 278                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 279                     <td class="sig">
 280
 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>
 284
 285
 286                         </div>
 287
 288                         <div class="mdesc">
 289                             <div class="short">False to disable the iframe shim in browsers which need one (defaults to true)</div>
 290                         </div>
 291
 292                         <div class="mdesc">
 293                             <div class="long">False to disable the iframe shim in browsers which need one (defaults to true)</div>
 294                         </div>
 295
 296
 297
 298                     </td>
 299                     <td class="msource">
 300
 301                         Roo.Layer
 302
 303                     </td>
 304                 </tr>
 305
 306
 307                 <tr class="config-row expandable config-row-alt0 notInherited">
 308                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 309                     <td class="sig">
 310
 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>
 314
 315
 316                         </div>
 317
 318                         <div class="mdesc">
 319                             <div class="short">Starting z-index (defaults to 11000)</div>
 320                         </div>
 321
 322                         <div class="mdesc">
 323                             <div class="long">Starting z-index (defaults to 11000)</div>
 324                         </div>
 325
 326
 327
 328                     </td>
 329                     <td class="msource">
 330
 331                         Roo.Layer
 332
 333                     </td>
 334                 </tr>
 335
 336
 337     </table>
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347   <!-- ============================== public properties ==================== -->
 348
 349
 350
 351     <a id="Roo.Layer-props"></a>
 352
 353
 354
 355
 356
 357      <table cellspacing="0" class="member-table">
 358       <caption class="Empty">Public Properties - Has None</caption>
 359      </table>
 360
 361
 362
 363
 364   <!-- ============================== methods summary / details ======================== -->
 365
 366
 367   <a id="Roo.Layer-methods"></a>
 368         <!-- constructor?? -->
 369
 370         <!-- static's first
 371
 372
 373         -->
 374
 375         <!-- then dynamics first -->
 376
 377
 378
 379
 380
 381
 382       <table cellspacing="0" class="member-table">
 383       <caption>Public Methods</caption>
 384         <tr>
 385             <th class="sig-header" colspan="2">Method</th>
 386             <th class="msource-header">Defined By</th>
 387
 388         </tr>
 389
 390
 391
 392
 393
 394
 395
 396           <tr class="method-row config-row-alt0 expandable notInherited">
 397             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 398
 399
 400             <td class="sig">
 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>
 404
 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>)
 406
 407
 408
 409                 </div>
 410                 <div class="mdesc">
 411
 412
 413                         <div class="short">Create a new Roo.Layer</div>
 414
 415
 416                     <div class="long">
 417
 418
 419
 420                                 Create a new Roo.Layer
 421
 422
 423                                 <dl class="detailList">
 424                                 <dt class="heading">Parameters:</dt>
 425
 426                                         <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>
 428
 429                                         </dt>
 430                                         <dd>An object with config options.</dd>
 431
 432                                         <dt>
 433                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement</span>  <b>existingEl</b>
 434
 435                                         </dt>
 436                                         <dd>(optional) Uses an existing DOM element. If the element is not found it creates it.</dd>
 437
 438                                 </dl>
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450                     </div>
 451                 </div>
 452
 453             </td>
 454             <td class="msource">
 455                 &nbsp;
 456             </td>
 457         </tr>
 458
 459
 460           <tr class="method-row config-row-alt1 expandable notInherited">
 461             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 462
 463
 464             <td class="sig">
 465                 <a id="Roo.Layer-method-setZIndex"   name=".setZIndex"></a>
 466                 <div class="fixedFont">
 467                         <span class="attributes"></span><b class="itemname">setZIndex</b>
 468
 469                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>zindex</i></B>)
 470
 471
 472                                          :
 473
 474
 475                                                 <a href="./this.html#constructor" roo:cls="this.html#constructor">this</a>
 476
 477
 478
 479
 480
 481                 </div>
 482                 <div class="mdesc">
 483
 484                    <div class="short">Sets the z-index of this layer and adjusts any shadow and shim z-indexes.</div>
 485
 486
 487
 488                     <div class="long">
 489
 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).
 491
 492
 493
 494
 495
 496
 497                                 <dl class="detailList">
 498                                 <dt class="heading">Parameters:</dt>
 499
 500                                         <dt>
 501                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>zindex</b>
 502
 503                                         </dt>
 504                                         <dd>The new z-index to set</dd>
 505
 506                                 </dl>
 507
 508
 509
 510
 511
 512                                 <dl class="detailList">
 513                                 <dt class="heading">Returns:</dt>
 514
 515                                         <dd><span class="fixedFont"><a href="./this.html#constructor" roo:cls="this.html#constructor">this</a></span>  The Layer</dd>
 516
 517                                 </dl>
 518
 519
 520
 521
 522
 523
 524
 525                     </div>
 526                 </div>
 527
 528             </td>
 529             <td class="msource">
 530
 531                         Roo.Layer
 532                 &nbsp;
 533             </td>
 534         </tr>
 535
 536
 537     </table>
 538
 539
 540   <!-- ============================== events summary / details ======================== -->
 541
 542
 543   <a id="Roo.Layer-events"></a>
 544
 545
 546
 547
 548
 549      <table cellspacing="0" class="member-table">
 550       <caption class="Empty">Events - Has None</caption>
 551      </table>
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561 <!-- ============================== footer ================================= -->
 562                 <div class="fineprint" style="clear:both">
 563
 564                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 16:05:44 GMT+0800 (HKT)
 565                         Based on
 566                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 567                 </div>
 568         </body>
 569 </html>