git.roojs.org Git - roojs1/blob - docs/symbols/Roo.BoxComponent.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.BoxComponent</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.BoxComponent-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.BoxComponent-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.BoxComponent-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.BoxComponent-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.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.BoxComponent
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.BoxComponent
  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_BoxComponent.js.html">Roo/BoxComponent.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">BoxComponent</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         Base class for any visual {<b>link</b> Roo.Component} that uses a box container.  BoxComponent provides automatic box<br/>model adjustments for sizing and positioning and will work correctly withnin the Component rendering model.  All<br/>container classes should subclass BoxComponent so that they will work consistently when nested within other Ext<br/>layout containers.
  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.BoxComponent';">[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.BoxComponent.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.BoxComponent-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.BoxComponent-cfg-height" name=".height"></a>
 132                         <div class="fixedFont">
 133                                 <b  class="itemname">height</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <div class="short">height (optional) size of component</div>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <div class="long">height (optional) size of component</div>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         Roo.BoxComponent
 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.BoxComponent-cfg-width" name=".width"></a>
 162                         <div class="fixedFont">
 163                                 <b  class="itemname">width</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 164
 165
 166                         </div>
 167
 168                         <div class="mdesc">
 169                             <div class="short">width (optional) size of component</div>
 170                         </div>
 171
 172                         <div class="mdesc">
 173                             <div class="long">width (optional) size of component</div>
 174                         </div>
 175
 176
 177
 178                     </td>
 179                     <td class="msource">
 180
 181                         Roo.BoxComponent
 182
 183                     </td>
 184                 </tr>
 185
 186
 187     </table>
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197   <!-- ============================== public properties ==================== -->
 198
 199
 200
 201     <a id="Roo.BoxComponent-props"></a>
 202
 203
 204
 205
 206
 207      <table cellspacing="0" class="member-table">
 208       <caption class="Empty">Public Properties - Has None</caption>
 209      </table>
 210
 211
 212
 213
 214   <!-- ============================== methods summary / details ======================== -->
 215
 216
 217   <a id="Roo.BoxComponent-methods"></a>
 218         <!-- constructor?? -->
 219
 220         <!-- static's first
 221
 222
 223         -->
 224
 225         <!-- then dynamics first -->
 226
 227
 228
 229
 230
 231
 232       <table cellspacing="0" class="member-table">
 233       <caption>Public Methods</caption>
 234         <tr>
 235             <th class="sig-header" colspan="2">Method</th>
 236             <th class="msource-header">Defined By</th>
 237
 238         </tr>
 239
 240
 241
 242
 243
 244
 245
 246           <tr class="method-row config-row-alt0 expandable notInherited">
 247             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 248
 249
 250             <td class="sig">
 251                 <a id="Roo-method-BoxComponent"   name=".BoxComponent"></a>
 252                 <div class="fixedFont">
 253                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">BoxComponent</b>
 254
 255                                  (<a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>/String/Object <B><i>config</i></B>)
 256
 257
 258
 259                 </div>
 260                 <div class="mdesc">
 261
 262
 263                         <div class="short">Create a new Roo.BoxComponent</div>
 264
 265
 266                     <div class="long">
 267
 268
 269
 270                                 Create a new Roo.BoxComponent
 271
 272
 273                                 <dl class="detailList">
 274                                 <dt class="heading">Parameters:</dt>
 275
 276                                         <dt>
 277                                                 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>/String/Object</span>  <b>config</b>
 278
 279                                         </dt>
 280                                         <dd>The configuration options.</dd>
 281
 282                                 </dl>
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294                     </div>
 295                 </div>
 296
 297             </td>
 298             <td class="msource">
 299                 &nbsp;
 300             </td>
 301         </tr>
 302
 303
 304           <tr class="method-row config-row-alt1 expandable notInherited">
 305             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 306
 307
 308             <td class="sig">
 309                 <a id="Roo.BoxComponent-method-getBox"   name=".getBox"></a>
 310                 <div class="fixedFont">
 311                         <span class="attributes"></span><b class="itemname">getBox</b>
 312
 313                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>local</i></B>)
 314
 315
 316
 317                 </div>
 318                 <div class="mdesc">
 319
 320                    <div class="short">Gets the current box measurements of the component's underlying element.</div>
 321
 322
 323
 324                     <div class="long">
 325
 326                                 Gets the current box measurements of the component's underlying element.
 327
 328
 329
 330
 331
 332
 333                                 <dl class="detailList">
 334                                 <dt class="heading">Parameters:</dt>
 335
 336                                         <dt>
 337                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>local</b>
 338
 339                                         </dt>
 340                                         <dd>(optional) If true the element's left and top are returned instead of page XY (defaults to false)</dd>
 341
 342                                 </dl>
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354                     </div>
 355                 </div>
 356
 357             </td>
 358             <td class="msource">
 359
 360                         Roo.BoxComponent
 361                 &nbsp;
 362             </td>
 363         </tr>
 364
 365
 366           <tr class="method-row config-row-alt0 expandable notInherited">
 367             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 368
 369
 370             <td class="sig">
 371                 <a id="Roo.BoxComponent-method-getPosition"   name=".getPosition"></a>
 372                 <div class="fixedFont">
 373                         <span class="attributes"></span><b class="itemname">getPosition</b>
 374
 375                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>local</i></B>)
 376
 377
 378                                          :
 379
 380
 381                                                 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
 382
 383
 384
 385
 386
 387                 </div>
 388                 <div class="mdesc">
 389
 390                    <div class="short">Gets the current XY position of the component's underlying element.</div>
 391
 392
 393
 394                     <div class="long">
 395
 396                                 Gets the current XY position of the component's underlying element.
 397
 398
 399
 400
 401
 402
 403                                 <dl class="detailList">
 404                                 <dt class="heading">Parameters:</dt>
 405
 406                                         <dt>
 407                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>local</b>
 408
 409                                         </dt>
 410                                         <dd>(optional) If true the element's left and top are returned instead of page XY (defaults to false)</dd>
 411
 412                                 </dl>
 413
 414
 415
 416
 417
 418                                 <dl class="detailList">
 419                                 <dt class="heading">Returns:</dt>
 420
 421                                         <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  The XY position of the element (e.g., [100, 200])</dd>
 422
 423                                 </dl>
 424
 425
 426
 427
 428
 429
 430
 431                     </div>
 432                 </div>
 433
 434             </td>
 435             <td class="msource">
 436
 437                         Roo.BoxComponent
 438                 &nbsp;
 439             </td>
 440         </tr>
 441
 442
 443           <tr class="method-row config-row-alt1 expandable notInherited">
 444             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 445
 446
 447             <td class="sig">
 448                 <a id="Roo.BoxComponent-method-getSize"   name=".getSize"></a>
 449                 <div class="fixedFont">
 450                         <span class="attributes"></span><b class="itemname">getSize</b>
 451
 452                                  ()
 453
 454
 455                                          :
 456
 457
 458                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 459
 460
 461
 462
 463
 464                 </div>
 465                 <div class="mdesc">
 466
 467                    <div class="short">Gets the current size of the component's underlying element.</div>
 468
 469
 470
 471                     <div class="long">
 472
 473                                 Gets the current size of the component's underlying element.
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484                                 <dl class="detailList">
 485                                 <dt class="heading">Returns:</dt>
 486
 487                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  An object containing the element's size {width: (element width), height: (element height)}</dd>
 488
 489                                 </dl>
 490
 491
 492
 493
 494
 495
 496
 497                     </div>
 498                 </div>
 499
 500             </td>
 501             <td class="msource">
 502
 503                         Roo.BoxComponent
 504                 &nbsp;
 505             </td>
 506         </tr>
 507
 508
 509           <tr class="method-row config-row-alt0 expandable notInherited">
 510             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 511
 512
 513             <td class="sig">
 514                 <a id="Roo.BoxComponent-method-onPosition"   name=".onPosition"></a>
 515                 <div class="fixedFont">
 516                         <span class="attributes"></span><b class="itemname">onPosition</b>
 517
 518                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>x</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>y</i></B>)
 519
 520
 521
 522                 </div>
 523                 <div class="mdesc">
 524
 525                    <div class="short">Called after the component is moved, this method is empty by default but can be implemented by any<br/>subclass that needs to perform custom logic after a move occurs.</div>
 526
 527
 528
 529                     <div class="long">
 530
 531                                 Called after the component is moved, this method is empty by default but can be implemented by any<br/>subclass that needs to perform custom logic after a move occurs.
 532
 533
 534
 535
 536
 537
 538                                 <dl class="detailList">
 539                                 <dt class="heading">Parameters:</dt>
 540
 541                                         <dt>
 542                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>x</b>
 543
 544                                         </dt>
 545                                         <dd>The new x position</dd>
 546
 547                                         <dt>
 548                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>y</b>
 549
 550                                         </dt>
 551                                         <dd>The new y position</dd>
 552
 553                                 </dl>
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565                     </div>
 566                 </div>
 567
 568             </td>
 569             <td class="msource">
 570
 571                         Roo.BoxComponent
 572                 &nbsp;
 573             </td>
 574         </tr>
 575
 576
 577           <tr class="method-row config-row-alt1 expandable notInherited">
 578             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 579
 580
 581             <td class="sig">
 582                 <a id="Roo.BoxComponent-method-onResize"   name=".onResize"></a>
 583                 <div class="fixedFont">
 584                         <span class="attributes"></span><b class="itemname">onResize</b>
 585
 586                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>adjWidth</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>adjHeight</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rawWidth</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rawHeight</i></B>)
 587
 588
 589
 590                 </div>
 591                 <div class="mdesc">
 592
 593                    <div class="short">Called after the component is resized, this method is empty by default but can be implemented by any<br/>subclass that needs to perform custom logic after a resize occurs.</div>
 594
 595
 596
 597                     <div class="long">
 598
 599                                 Called after the component is resized, this method is empty by default but can be implemented by any<br/>subclass that needs to perform custom logic after a resize occurs.
 600
 601
 602
 603
 604
 605
 606                                 <dl class="detailList">
 607                                 <dt class="heading">Parameters:</dt>
 608
 609                                         <dt>
 610                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>adjWidth</b>
 611
 612                                         </dt>
 613                                         <dd>The box-adjusted width that was set</dd>
 614
 615                                         <dt>
 616                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>adjHeight</b>
 617
 618                                         </dt>
 619                                         <dd>The box-adjusted height that was set</dd>
 620
 621                                         <dt>
 622                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>rawWidth</b>
 623
 624                                         </dt>
 625                                         <dd>The width that was originally specified</dd>
 626
 627                                         <dt>
 628                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>rawHeight</b>
 629
 630                                         </dt>
 631                                         <dd>The height that was originally specified</dd>
 632
 633                                 </dl>
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645                     </div>
 646                 </div>
 647
 648             </td>
 649             <td class="msource">
 650
 651                         Roo.BoxComponent
 652                 &nbsp;
 653             </td>
 654         </tr>
 655
 656
 657           <tr class="method-row config-row-alt0 expandable notInherited">
 658             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 659
 660
 661             <td class="sig">
 662                 <a id="Roo.BoxComponent-method-setPagePosition"   name=".setPagePosition"></a>
 663                 <div class="fixedFont">
 664                         <span class="attributes"></span><b class="itemname">setPagePosition</b>
 665
 666                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>x</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>y</i></B>)
 667
 668
 669
 670                 </div>
 671                 <div class="mdesc">
 672
 673                    <div class="short">Sets the page XY position of the component.</div>
 674
 675
 676
 677                     <div class="long">
 678
 679                                 Sets the page XY position of the component.  To set the left and top instead, use {<b>link</b> <b>setPosition</b>}.<br/>This method fires the move event.
 680
 681
 682
 683
 684
 685
 686                                 <dl class="detailList">
 687                                 <dt class="heading">Parameters:</dt>
 688
 689                                         <dt>
 690                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>x</b>
 691
 692                                         </dt>
 693                                         <dd>The new x position</dd>
 694
 695                                         <dt>
 696                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>y</b>
 697
 698                                         </dt>
 699                                         <dd>The new y position</dd>
 700
 701                                 </dl>
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713                     </div>
 714                 </div>
 715
 716             </td>
 717             <td class="msource">
 718
 719                         Roo.BoxComponent
 720                 &nbsp;
 721             </td>
 722         </tr>
 723
 724
 725           <tr class="method-row config-row-alt1 expandable notInherited">
 726             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 727
 728
 729             <td class="sig">
 730                 <a id="Roo.BoxComponent-method-setPosition"   name=".setPosition"></a>
 731                 <div class="fixedFont">
 732                         <span class="attributes"></span><b class="itemname">setPosition</b>
 733
 734                                  (<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>)
 735
 736
 737
 738                 </div>
 739                 <div class="mdesc">
 740
 741                    <div class="short">Sets the left and top of the component.</div>
 742
 743
 744
 745                     <div class="long">
 746
 747                                 Sets the left and top of the component.  To set the page XY position instead, use {<b>link</b> <b>setPagePosition</b>}.<br/>This method fires the move event.
 748
 749
 750
 751
 752
 753
 754                                 <dl class="detailList">
 755                                 <dt class="heading">Parameters:</dt>
 756
 757                                         <dt>
 758                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>left</b>
 759
 760                                         </dt>
 761                                         <dd>The new left</dd>
 762
 763                                         <dt>
 764                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>top</b>
 765
 766                                         </dt>
 767                                         <dd>The new top</dd>
 768
 769                                 </dl>
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781                     </div>
 782                 </div>
 783
 784             </td>
 785             <td class="msource">
 786
 787                         Roo.BoxComponent
 788                 &nbsp;
 789             </td>
 790         </tr>
 791
 792
 793           <tr class="method-row config-row-alt0 expandable notInherited">
 794             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 795
 796
 797             <td class="sig">
 798                 <a id="Roo.BoxComponent-method-setSize"   name=".setSize"></a>
 799                 <div class="fixedFont">
 800                         <span class="attributes"></span><b class="itemname">setSize</b>
 801
 802                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/Object <B><i>width</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>height</i></B>)
 803
 804
 805                                          :
 806
 807
 808                                                 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
 809
 810
 811
 812
 813
 814                 </div>
 815                 <div class="mdesc">
 816
 817                    <div class="short">Sets the width and height of the component.</div>
 818
 819
 820
 821                     <div class="long">
 822
 823                                 Sets the width and height of the component.  This method fires the resize event.  This method can accept<br/>either width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.
 824
 825
 826
 827
 828
 829
 830                                 <dl class="detailList">
 831                                 <dt class="heading">Parameters:</dt>
 832
 833                                         <dt>
 834                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/Object</span>  <b>width</b>
 835
 836                                         </dt>
 837                                         <dd>The new width to set, or a size object in the format {width, height}</dd>
 838
 839                                         <dt>
 840                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>height</b>
 841
 842                                         </dt>
 843                                         <dd>The new height to set (not required if a size object is passed as the first arg)</dd>
 844
 845                                 </dl>
 846
 847
 848
 849
 850
 851                                 <dl class="detailList">
 852                                 <dt class="heading">Returns:</dt>
 853
 854                                         <dd><span class="fixedFont"><a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a></span>  this</dd>
 855
 856                                 </dl>
 857
 858
 859
 860
 861
 862
 863
 864                     </div>
 865                 </div>
 866
 867             </td>
 868             <td class="msource">
 869
 870                         Roo.BoxComponent
 871                 &nbsp;
 872             </td>
 873         </tr>
 874
 875
 876           <tr class="method-row config-row-alt1 expandable notInherited">
 877             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 878
 879
 880             <td class="sig">
 881                 <a id="Roo.BoxComponent-method-syncSize"   name=".syncSize"></a>
 882                 <div class="fixedFont">
 883                         <span class="attributes"></span><b class="itemname">syncSize</b>
 884
 885                                  ()
 886
 887
 888
 889                 </div>
 890                 <div class="mdesc">
 891
 892                    <div class="short">Force the component's size to recalculate based on the underlying element's current height and width.</div>
 893
 894
 895
 896                     <div class="long">
 897
 898                                 Force the component's size to recalculate based on the underlying element's current height and width.
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915                     </div>
 916                 </div>
 917
 918             </td>
 919             <td class="msource">
 920
 921                         Roo.BoxComponent
 922                 &nbsp;
 923             </td>
 924         </tr>
 925
 926
 927           <tr class="method-row config-row-alt0 expandable notInherited">
 928             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 929
 930
 931             <td class="sig">
 932                 <a id="Roo.BoxComponent-method-updateBox"   name=".updateBox"></a>
 933                 <div class="fixedFont">
 934                         <span class="attributes"></span><b class="itemname">updateBox</b>
 935
 936                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>box</i></B>)
 937
 938
 939
 940                 </div>
 941                 <div class="mdesc">
 942
 943                    <div class="short">Sets the current box measurements of the component's underlying element.</div>
 944
 945
 946
 947                     <div class="long">
 948
 949                                 Sets the current box measurements of the component's underlying element.
 950
 951
 952
 953
 954
 955
 956                                 <dl class="detailList">
 957                                 <dt class="heading">Parameters:</dt>
 958
 959                                         <dt>
 960                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>box</b>
 961
 962                                         </dt>
 963                                         <dd>An object in the format {x, y, width, height}</dd>
 964
 965                                 </dl>
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977                     </div>
 978                 </div>
 979
 980             </td>
 981             <td class="msource">
 982
 983                         Roo.BoxComponent
 984                 &nbsp;
 985             </td>
 986         </tr>
 987
 988
 989     </table>
 990
 991
 992   <!-- ============================== events summary / details ======================== -->
 993
 994
 995   <a id="Roo.BoxComponent-events"></a>
 996
 997
 998
 999
1000
1001
1002
1003
1004       <table cellspacing="0" class="member-table">
1005                 <caption>Events</caption>
1006               <thead>
1007                 <tr>
1008                     <th class="sig-header" colspan="2">Event</th>
1009                     <th class="msource-header">Defined By</th>
1010
1011                 </tr>
1012               </thead>
1013
1014
1015
1016
1017
1018           <tr class="method-row expandable config-row-alt0 notInherited">
1019             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1020
1021             <td class="sig">
1022                 <a id="Roo.BoxComponent-event-*move"></a>
1023
1024                <div class="fixedFont">
1025                 <b class="itemname">move</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>x</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>y</i></B>)
1026
1027                 </div>
1028
1029                 <div class="mdesc">
1030
1031                    <div class="short">Fires after the component is moved.
1032
1033                 </div>
1034
1035                     <div class="long">
1036
1037                         Fires after the component is moved.
1038
1039
1040
1041
1042
1043                                 <dl class="detailList">
1044                                 <dt class="heading">Parameters:</dt>
1045
1046                                         <dt>
1047                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1048
1049                                         </dt>
1050                                         <dd></dd>
1051
1052                                         <dt>
1053                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
1054
1055                                         </dt>
1056                                         <dd>The new x position</dd>
1057
1058                                         <dt>
1059                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
1060
1061                                         </dt>
1062                                         <dd>The new y position</dd>
1063
1064                                 </dl>
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076                     </div>
1077                 </div>
1078
1079             </td>
1080             <td class="msource">
1081                 Roo.BoxComponent
1082             </td>
1083         </tr>
1084
1085           <tr class="method-row expandable config-row-alt1 notInherited">
1086             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1087
1088             <td class="sig">
1089                 <a id="Roo.BoxComponent-event-*resize"></a>
1090
1091                <div class="fixedFont">
1092                 <b class="itemname">resize</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>adjWidth</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>adjHeight</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rawWidth</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rawHeight</i></B>)
1093
1094                 </div>
1095
1096                 <div class="mdesc">
1097
1098                    <div class="short">Fires after the component is resized.
1099
1100                 </div>
1101
1102                     <div class="long">
1103
1104                         Fires after the component is resized.
1105
1106
1107
1108
1109
1110                                 <dl class="detailList">
1111                                 <dt class="heading">Parameters:</dt>
1112
1113                                         <dt>
1114                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1115
1116                                         </dt>
1117                                         <dd></dd>
1118
1119                                         <dt>
1120                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjWidth</b>
1121
1122                                         </dt>
1123                                         <dd>The box-adjusted width that was set</dd>
1124
1125                                         <dt>
1126                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjHeight</b>
1127
1128                                         </dt>
1129                                         <dd>The box-adjusted height that was set</dd>
1130
1131                                         <dt>
1132                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawWidth</b>
1133
1134                                         </dt>
1135                                         <dd>The width that was originally specified</dd>
1136
1137                                         <dt>
1138                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawHeight</b>
1139
1140                                         </dt>
1141                                         <dd>The height that was originally specified</dd>
1142
1143                                 </dl>
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155                     </div>
1156                 </div>
1157
1158             </td>
1159             <td class="msource">
1160                 Roo.BoxComponent
1161             </td>
1162         </tr>
1163
1164
1165     </table>
1166
1167
1168
1169
1170
1171 <!-- ============================== footer ================================= -->
1172                 <div class="fineprint" style="clear:both">
1173
1174                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 19:32:43 GMT+0800 (HKT)
1175                         Based on
1176                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1177                 </div>
1178         </body>
1179 </html>