git.roojs.org Git - roojs1/blob - docs/symbols/Roo.LayoutDialog.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.LayoutDialog</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.LayoutDialog-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.LayoutDialog-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.LayoutDialog-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.LayoutDialog-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.BasicDialog.html#constructor" roo:cls="Roo.BasicDialog.html#constructor">Roo.BasicDialog</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.LayoutDialog
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.LayoutDialog
  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_BasicDialog.js.html">Roo/BasicDialog.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">LayoutDialog</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.BasicDialog.html#constructor" roo:cls="Roo.BasicDialog.html#constructor">Roo.BasicDialog</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         Dialog which provides adjustments for working with a layout in a Dialog.<br/>Add your necessary layout config options to the dialog's config.<br><br/>Example usage (including a nested layout):<br/><pre><code><br/>if(!dialog){<br/>    dialog = new Roo.LayoutDialog("download-dlg", {<br/>        modal: true,<br/>        width:600,<br/>        height:450,<br/>        shadow:true,<br/>        minWidth:500,<br/>        minHeight:350,<br/>        autoTabs:true,<br/>        proxyDrag:true,<br/>        // layout config merges with the dialog config<br/>        center:{<br/>            tabPosition: "top",<br/>            alwaysShowTabs: true<br/>        }<br/>    });<br/>    dialog.addKeyListener(27, dialog.hide, dialog);<br/>    dialog.setDefaultButton(dialog.addButton("Close", dialog.hide, dialog));<br/>    dialog.addButton("Build It!", this.getDownload, this);<br/><br/>    // we can even add nested layouts<br/>    var innerLayout = new Roo.BorderLayout("dl-inner", {<br/>        east: {<br/>            initialSize: 200,<br/>            autoScroll:true,<br/>            split:true<br/>        },<br/>        center: {<br/>            autoScroll:true<br/>        }<br/>    });<br/>    innerLayout.beginUpdate();<br/>    innerLayout.add("east", new Roo.ContentPanel("dl-details"));<br/>    innerLayout.add("center", new Roo.ContentPanel("selection-panel"));<br/>    innerLayout.endUpdate(true);<br/><br/>    var layout = dialog.getLayout();<br/>    layout.beginUpdate();<br/>    layout.add("center", new Roo.ContentPanel("standard-panel",<br/>                        {title: "Download the Source", fitToFrame:true}));<br/>    layout.add("center", new Roo.NestedLayoutPanel(innerLayout,<br/>               {title: "Build your own roo.js"}));<br/>    layout.getRegion("center").showPanel(sp);<br/>    layout.endUpdate();<br/>}<br/></code></pre>
  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.LayoutDialog';">[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.LayoutDialog.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.LayoutDialog-configs"></a>
 108
 109
 110
 111      <table cellspacing="0" class="member-table">
 112       <caption class="Empty">Config Options - Has None</caption>
 113      </table>
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126   <!-- ============================== public properties ==================== -->
 127
 128
 129
 130     <a id="Roo.LayoutDialog-props"></a>
 131
 132
 133
 134
 135
 136      <table cellspacing="0" class="member-table">
 137       <caption class="Empty">Public Properties - Has None</caption>
 138      </table>
 139
 140
 141
 142
 143   <!-- ============================== methods summary / details ======================== -->
 144
 145
 146   <a id="Roo.LayoutDialog-methods"></a>
 147         <!-- constructor?? -->
 148
 149         <!-- static's first
 150
 151
 152         -->
 153
 154         <!-- then dynamics first -->
 155
 156
 157
 158
 159
 160
 161       <table cellspacing="0" class="member-table">
 162       <caption>Public Methods</caption>
 163         <tr>
 164             <th class="sig-header" colspan="2">Method</th>
 165             <th class="msource-header">Defined By</th>
 166
 167         </tr>
 168
 169
 170
 171
 172
 173
 174
 175           <tr class="method-row config-row-alt0 expandable notInherited">
 176             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 177
 178
 179             <td class="sig">
 180                 <a id="Roo-method-LayoutDialog"   name=".LayoutDialog"></a>
 181                 <div class="fixedFont">
 182                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">LayoutDialog</b>
 183
 184                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>el</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 185
 186
 187
 188                 </div>
 189                 <div class="mdesc">
 190
 191
 192                         <div class="short">Create a new Roo.LayoutDialog</div>
 193
 194
 195                     <div class="long">
 196
 197
 198
 199                                 Create a new Roo.LayoutDialog
 200
 201
 202                                 <dl class="detailList">
 203                                 <dt class="heading">Parameters:</dt>
 204
 205                                         <dt>
 206                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 207
 208                                         </dt>
 209                                         <dd>The id of or container element, or config</dd>
 210
 211                                         <dt>
 212                                                 <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>
 213
 214                                         </dt>
 215                                         <dd>configuration options</dd>
 216
 217                                 </dl>
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229                     </div>
 230                 </div>
 231
 232             </td>
 233             <td class="msource">
 234                 &nbsp;
 235             </td>
 236         </tr>
 237
 238
 239           <tr class="method-row config-row-alt1 expandable notInherited">
 240             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 241
 242
 243             <td class="sig">
 244                 <a id="Roo.LayoutDialog-method-addxtype"   name=".addxtype"></a>
 245                 <div class="fixedFont">
 246                         <span class="attributes"></span><b class="itemname">addxtype</b>
 247
 248                                  ()
 249
 250
 251                                          :
 252
 253
 254                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 255
 256
 257
 258
 259
 260                 </div>
 261                 <div class="mdesc">
 262
 263                    <div class="short">Add an xtype element (actually adds to the layout.</div>
 264
 265
 266
 267                     <div class="long">
 268
 269                                 Add an xtype element (actually adds to the layout.)
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280                                 <dl class="detailList">
 281                                 <dt class="heading">Returns:</dt>
 282
 283                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  xdata xtype object data.</dd>
 284
 285                                 </dl>
 286
 287
 288
 289
 290
 291
 292
 293                     </div>
 294                 </div>
 295
 296             </td>
 297             <td class="msource">
 298
 299                         Roo.LayoutDialog
 300                 &nbsp;
 301             </td>
 302         </tr>
 303
 304
 305           <tr class="method-row config-row-alt0 expandable notInherited">
 306             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 307
 308
 309             <td class="sig">
 310                 <a id="Roo.LayoutDialog-method-beginUpdate"   name=".beginUpdate"></a>
 311                 <div class="fixedFont">
 312                         <span class="attributes"></span><b class="itemname">beginUpdate</b>
 313
 314                                  ()
 315
 316
 317
 318                 </div>
 319                 <div class="mdesc">
 320
 321                    <div class="short">Begins an update of the layout <strike>and sets display to block and visibility to hidden</strike>.</div>
 322
 323
 324
 325                     <div class="long">
 326
 327                                 Begins an update of the layout <strike>and sets display to block and visibility to hidden</strike>. Use standard beginUpdate/endUpdate on the layout.
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344                     </div>
 345                 </div>
 346
 347             </td>
 348             <td class="msource">
 349
 350                         Roo.LayoutDialog
 351                 &nbsp;
 352             </td>
 353         </tr>
 354
 355
 356           <tr class="method-row config-row-alt1 expandable notInherited">
 357             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 358
 359
 360             <td class="sig">
 361                 <a id="Roo.LayoutDialog-method-endUpdate"   name=".endUpdate"></a>
 362                 <div class="fixedFont">
 363                         <span class="attributes"></span><b class="itemname">endUpdate</b>
 364
 365                                  ()
 366
 367
 368
 369                 </div>
 370                 <div class="mdesc">
 371
 372                    <div class="short">Ends update of the layout <strike>and resets display to none</strike>.</div>
 373
 374
 375
 376                     <div class="long">
 377
 378                                 Ends update of the layout <strike>and resets display to none</strike>. Use standard beginUpdate/endUpdate on the layout.
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395                     </div>
 396                 </div>
 397
 398             </td>
 399             <td class="msource">
 400
 401                         Roo.LayoutDialog
 402                 &nbsp;
 403             </td>
 404         </tr>
 405
 406
 407           <tr class="method-row config-row-alt0 expandable notInherited">
 408             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 409
 410
 411             <td class="sig">
 412                 <a id="Roo.LayoutDialog-method-getLayout"   name=".getLayout"></a>
 413                 <div class="fixedFont">
 414                         <span class="attributes"></span><b class="itemname">getLayout</b>
 415
 416                                  ()
 417
 418
 419                                          :
 420
 421
 422                                                 <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>
 423
 424
 425
 426
 427
 428                 </div>
 429                 <div class="mdesc">
 430
 431                    <div class="short">Get the BorderLayout for this dialog</div>
 432
 433
 434
 435                     <div class="long">
 436
 437                                 Get the BorderLayout for this dialog
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448                                 <dl class="detailList">
 449                                 <dt class="heading">Returns:</dt>
 450
 451                                         <dd><span class="fixedFont"><a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a></span>  </dd>
 452
 453                                 </dl>
 454
 455
 456
 457
 458
 459
 460
 461                     </div>
 462                 </div>
 463
 464             </td>
 465             <td class="msource">
 466
 467                         Roo.LayoutDialog
 468                 &nbsp;
 469             </td>
 470         </tr>
 471
 472
 473     </table>
 474
 475
 476   <!-- ============================== events summary / details ======================== -->
 477
 478
 479   <a id="Roo.LayoutDialog-events"></a>
 480
 481
 482
 483
 484
 485      <table cellspacing="0" class="member-table">
 486       <caption class="Empty">Events - Has None</caption>
 487      </table>
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497 <!-- ============================== footer ================================= -->
 498                 <div class="fineprint" style="clear:both">
 499
 500                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 16:37:02 GMT+0800 (HKT)
 501                         Based on
 502                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 503                 </div>
 504         </body>
 505 </html>