git.roojs.org Git - roojs1/blob - docs/symbols/Roo.Shadow.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.Shadow</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.Shadow-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.Shadow-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.Shadow-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.Shadow-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 <!-- ============================== class title / details ============================ -->
  46
  47
  48     <h1 class="classTitle">
  49
  50                                 Class Roo.Shadow
  51                         </h1>
  52
  53     <table cellspacing="0" class="class-summary-table">
  54
  55                 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
  56
  57         <tr><td class="label">Defined In:</td><td class="hd-info">
  58
  59                                         <a href="./src/Roo_Shadow.js.html">Roo/Shadow.js</a>.
  60
  61         </td></tr>
  62         <tr><td class="label">Class:</td><td class="hd-info">Shadow</td></tr>
  63
  64
  65
  66
  67     </table>
  68
  69
  70 <!-- ============================== class summary ========================== -->
  71     <div class="description">
  72         Simple class that can provide a shadow effect for any element.  Note that the element MUST be absolutely positioned,<br/>and the shadow does not provide any shimming.  This should be used only in simple cases -- for more advanced<br/>functionality that can also provide the same shadow effect, see the {<b>link</b> Roo.Layer} class.
  73     </div>
  74
  75
  76 <!-- ============================== Class comment block... ========================== -->
  77
  78 <div class="comments">
  79         <b>Class Comments / Notes</B> =>
  80         <u onclick="parent.CommentDialog.showCommentId = 'Roo.Shadow';">[Add Your comment/notes about this class]</u>
  81         <br/>
  82         <iframe frameborder="0"  id="comments-Roo" style="border: none;width:100%;"
  83                 src="/blog.php/GtkDjsComments/Roo.Shadow.html"></iframe>
  84 </div>
  85
  86
  87
  88 <!-- ============================== config options ========================== -->
  89
  90
  91
  92
  93     <div class="hr"></div>
  94     <a id="Roo.Shadow-configs"></a>
  95
  96
  97
  98
  99
 100       <table cellspacing="0" class="member-table">
 101       <caption>Config Options (Usually are also Properties)</caption>
 102
 103
 104         <tr>
 105             <th class="sig-header" colspan="2">Options</th>
 106
 107             <th class="msource-header">Defined By</th>
 108         </tr>
 109
 110
 111
 112
 113
 114                 <tr class="config-row expandable config-row-alt0">
 115                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 116                     <td class="sig">
 117
 118                         <a id="Roo-cfg-mode" name=".mode"></a>
 119                         <div class="fixedFont">
 120                                 <b  class="itemname">mode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 121
 122
 123                         </div>
 124
 125                         <div class="mdesc">
 126                             <div class="short">The shadow display mode.</div>
 127                         </div>
 128
 129                         <div class="mdesc">
 130                             <div class="long">
 131                     The shadow display mode.  Supports the following options:<br /><br/>sides: Shadow displays on both sides and bottom only<br /><br/>frame: Shadow displays equally on all four sides<br /><br/>drop: Traditional bottom-right drop shadow (default)
 132
 133                 </div>
 134                         </div>
 135
 136
 137
 138                     </td>
 139                     <td class="msource">
 140
 141                         <a href="./Roo.html#constructor" roo:cls="Roo.html#constructor">Roo</a>
 142
 143                     </td>
 144                 </tr>
 145
 146
 147                 <tr class="config-row expandable config-row-alt1 notInherited">
 148                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 149                     <td class="sig">
 150
 151                         <a id="Roo.Shadow-cfg-offset" name=".offset"></a>
 152                         <div class="fixedFont">
 153                                 <b  class="itemname">offset</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 154
 155
 156                         </div>
 157
 158                         <div class="mdesc">
 159                             <div class="short">The number of pixels to offset the shadow from the element (defaults to 4)</div>
 160                         </div>
 161
 162                         <div class="mdesc">
 163                             <div class="long">
 164                     The number of pixels to offset the shadow from the element (defaults to 4)
 165
 166                 </div>
 167                         </div>
 168
 169
 170
 171                     </td>
 172                     <td class="msource">
 173
 174                         Roo.Shadow
 175
 176                     </td>
 177                 </tr>
 178
 179
 180     </table>
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190   <!-- ============================== public properties ==================== -->
 191
 192
 193
 194     <a id="Roo.Shadow-props"></a>
 195
 196
 197
 198
 199
 200      <table cellspacing="0" class="member-table">
 201       <caption class="Empty">Public Properties - Has None</caption>
 202      </table>
 203
 204
 205
 206
 207   <!-- ============================== methods summary / details ======================== -->
 208
 209
 210   <a id="Roo.Shadow-methods"></a>
 211         <!-- constructor?? -->
 212
 213         <!-- static's first
 214
 215
 216         -->
 217
 218         <!-- then dynamics first -->
 219
 220
 221
 222
 223
 224
 225       <table cellspacing="0" class="member-table">
 226       <caption>Public Methods</caption>
 227         <tr>
 228             <th class="sig-header" colspan="2">Method</th>
 229             <th class="msource-header">Defined By</th>
 230
 231         </tr>
 232
 233
 234
 235
 236
 237
 238
 239           <tr class="method-row config-row-alt0 expandable notInherited">
 240             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 241
 242
 243             <td class="sig">
 244                 <a id="Roo-method-Shadow"   name=".Shadow"></a>
 245                 <div class="fixedFont">
 246                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">Shadow</b>
 247
 248                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 249
 250
 251
 252                 </div>
 253                 <div class="mdesc">
 254
 255
 256                         <div class="short">Create a new Roo.Shadow</div>
 257
 258
 259                     <div class="long">
 260
 261
 262
 263                                 Create a new Roo.Shadow
 264
 265
 266                                 <dl class="detailList">
 267                                 <dt class="heading">Parameters:</dt>
 268
 269                                         <dt>
 270                                                 <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>
 271
 272                                         </dt>
 273                                         <dd>The config object</dd>
 274
 275                                 </dl>
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287                     </div>
 288                 </div>
 289
 290             </td>
 291             <td class="msource">
 292                 &nbsp;
 293             </td>
 294         </tr>
 295
 296
 297           <tr class="method-row config-row-alt1 expandable notInherited">
 298             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 299
 300
 301             <td class="sig">
 302                 <a id="Roo.Shadow-method-hide"   name=".hide"></a>
 303                 <div class="fixedFont">
 304                         <span class="attributes"></span><b class="itemname">hide</b>
 305
 306                                  ()
 307
 308
 309
 310                 </div>
 311                 <div class="mdesc">
 312
 313                    <div class="short">Hides this shadow</div>
 314
 315
 316
 317                     <div class="long">
 318
 319                                 Hides this shadow
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336                     </div>
 337                 </div>
 338
 339             </td>
 340             <td class="msource">
 341
 342                         Roo.Shadow
 343                 &nbsp;
 344             </td>
 345         </tr>
 346
 347
 348           <tr class="method-row config-row-alt0 expandable notInherited">
 349             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 350
 351
 352             <td class="sig">
 353                 <a id="Roo.Shadow-method-isVisible"   name=".isVisible"></a>
 354                 <div class="fixedFont">
 355                         <span class="attributes"></span><b class="itemname">isVisible</b>
 356
 357                                  ()
 358
 359
 360
 361                 </div>
 362                 <div class="mdesc">
 363
 364                    <div class="short">Returns true if the shadow is visible, else false</div>
 365
 366
 367
 368                     <div class="long">
 369
 370                                 Returns true if the shadow is visible, else false
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387                     </div>
 388                 </div>
 389
 390             </td>
 391             <td class="msource">
 392
 393                         Roo.Shadow
 394                 &nbsp;
 395             </td>
 396         </tr>
 397
 398
 399           <tr class="method-row config-row-alt1 expandable notInherited">
 400             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 401
 402
 403             <td class="sig">
 404                 <a id="Roo.Shadow-method-realign"   name=".realign"></a>
 405                 <div class="fixedFont">
 406                         <span class="attributes"></span><b class="itemname">realign</b>
 407
 408                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>left</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>top</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>width</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>height</i></B>)
 409
 410
 411
 412                 </div>
 413                 <div class="mdesc">
 414
 415                    <div class="short">Direct alignment when values are already available.</div>
 416
 417
 418
 419                     <div class="long">
 420
 421                                 Direct alignment when values are already available. Show must be called at least once before<br/>calling this method to ensure it is initialized.
 422
 423
 424
 425
 426
 427
 428                                 <dl class="detailList">
 429                                 <dt class="heading">Parameters:</dt>
 430
 431                                         <dt>
 432                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>left</b>
 433
 434                                         </dt>
 435                                         <dd>The target element left position</dd>
 436
 437                                         <dt>
 438                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>top</b>
 439
 440                                         </dt>
 441                                         <dd>The target element top position</dd>
 442
 443                                         <dt>
 444                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>width</b>
 445
 446                                         </dt>
 447                                         <dd>The target element width</dd>
 448
 449                                         <dt>
 450                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>height</b>
 451
 452                                         </dt>
 453                                         <dd>The target element height</dd>
 454
 455                                 </dl>
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467                     </div>
 468                 </div>
 469
 470             </td>
 471             <td class="msource">
 472
 473                         Roo.Shadow
 474                 &nbsp;
 475             </td>
 476         </tr>
 477
 478
 479           <tr class="method-row config-row-alt0 expandable notInherited">
 480             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 481
 482
 483             <td class="sig">
 484                 <a id="Roo.Shadow-method-setZIndex"   name=".setZIndex"></a>
 485                 <div class="fixedFont">
 486                         <span class="attributes"></span><b class="itemname">setZIndex</b>
 487
 488                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>zindex</i></B>)
 489
 490
 491
 492                 </div>
 493                 <div class="mdesc">
 494
 495                    <div class="short">Adjust the z-index of this shadow</div>
 496
 497
 498
 499                     <div class="long">
 500
 501                                 Adjust the z-index of this shadow
 502
 503
 504
 505
 506
 507
 508                                 <dl class="detailList">
 509                                 <dt class="heading">Parameters:</dt>
 510
 511                                         <dt>
 512                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>zindex</b>
 513
 514                                         </dt>
 515                                         <dd>The new z-index</dd>
 516
 517                                 </dl>
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529                     </div>
 530                 </div>
 531
 532             </td>
 533             <td class="msource">
 534
 535                         Roo.Shadow
 536                 &nbsp;
 537             </td>
 538         </tr>
 539
 540
 541           <tr class="method-row config-row-alt1 expandable notInherited">
 542             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 543
 544
 545             <td class="sig">
 546                 <a id="Roo.Shadow-method-show"   name=".show"></a>
 547                 <div class="fixedFont">
 548                         <span class="attributes"></span><b class="itemname">show</b>
 549
 550                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>targetEl</i></B>)
 551
 552
 553
 554                 </div>
 555                 <div class="mdesc">
 556
 557                    <div class="short">Displays the shadow under the target element</div>
 558
 559
 560
 561                     <div class="long">
 562
 563                                 Displays the shadow under the target element
 564
 565
 566
 567
 568
 569
 570                                 <dl class="detailList">
 571                                 <dt class="heading">Parameters:</dt>
 572
 573                                         <dt>
 574                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>targetEl</b>
 575
 576                                         </dt>
 577                                         <dd>The id or element under which the shadow should display</dd>
 578
 579                                 </dl>
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591                     </div>
 592                 </div>
 593
 594             </td>
 595             <td class="msource">
 596
 597                         Roo.Shadow
 598                 &nbsp;
 599             </td>
 600         </tr>
 601
 602
 603     </table>
 604
 605
 606   <!-- ============================== events summary / details ======================== -->
 607
 608
 609   <a id="Roo.Shadow-events"></a>
 610
 611
 612
 613
 614
 615      <table cellspacing="0" class="member-table">
 616       <caption class="Empty">Events - Has None</caption>
 617      </table>
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627 <!-- ============================== footer ================================= -->
 628                 <div class="fineprint" style="clear:both">
 629
 630                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 13 2018 14:10:53 GMT+0800 (HKT)
 631                         Based on
 632                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 633                 </div>
 634         </body>
 635 </html>