git.roojs.org Git - roojs1/blob - docs/symbols/Roo.MessageBox.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.MessageBox</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.MessageBox-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.MessageBox-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.MessageBox-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.MessageBox-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.MessageBox
  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_MessageBox.js.html">Roo/MessageBox.js</a>.
  60
  61         </td></tr>
  62         <tr><td class="label">Class:</td><td class="hd-info">MessageBox</td></tr>
  63
  64
  65
  66
  67     </table>
  68
  69
  70 <!-- ============================== class summary ========================== -->
  71     <div class="description">
  72         Utility class for generating different styles of message boxes.  The alias Roo.Msg can also be used.<br/>Example usage:<br/><pre><code><br/>// Basic alert:<br/>Roo.Msg.alert('Status', 'Changes saved successfully.');<br/><br/>// Prompt for user data:<br/>Roo.Msg.prompt('Name', 'Please enter your name:', function(btn, text){<br/>    if (btn == 'ok'){<br/>        // process text value...<br/>    }<br/>});<br/><br/>// Show a dialog using config options:<br/>Roo.Msg.show({<br/>   title:'Save Changes?',<br/>   msg: 'Your are closing a tab that has unsaved changes. Would you like to save your changes?',<br/>   buttons: Roo.Msg.YESNOCANCEL,<br/>   fn: processResult,<br/>   animEl: 'elId'<br/>});<br/></code></pre>
  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.MessageBox';">[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.MessageBox.html"></iframe>
  84 </div>
  85
  86
  87
  88 <!-- ============================== config options ========================== -->
  89
  90
  91
  92
  93     <div class="hr"></div>
  94     <a id="Roo.MessageBox-configs"></a>
  95
  96
  97
  98      <table cellspacing="0" class="member-table">
  99       <caption class="Empty">Config Options - Has None</caption>
 100      </table>
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113   <!-- ============================== public properties ==================== -->
 114
 115
 116
 117     <a id="Roo.MessageBox-props"></a>
 118
 119
 120
 121
 122
 123      <table cellspacing="0" class="member-table">
 124       <caption class="Empty">Public Properties - Has None</caption>
 125      </table>
 126
 127
 128
 129
 130   <!-- ============================== methods summary / details ======================== -->
 131
 132
 133   <a id="Roo.MessageBox-methods"></a>
 134         <!-- constructor?? -->
 135
 136         <!-- static's first
 137
 138
 139         -->
 140
 141         <!-- then dynamics first -->
 142
 143
 144
 145
 146
 147
 148       <table cellspacing="0" class="member-table">
 149       <caption>Public Methods</caption>
 150         <tr>
 151             <th class="sig-header" colspan="2">Method</th>
 152             <th class="msource-header">Defined By</th>
 153
 154         </tr>
 155
 156
 157
 158
 159
 160
 161
 162           <tr class="method-row config-row-alt0 expandable notInherited">
 163             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 164
 165
 166             <td class="sig">
 167                 <a id="Roo.MessageBox-method-alert"   name=".alert"></a>
 168                 <div class="fixedFont">
 169                         <span class="attributes">Roo.MessageBox.</span><b class="itemname">alert</b>
 170
 171                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>title</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>msg</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
 172
 173
 174                                          :
 175
 176
 177                                                 <a href="./Roo.MessageBox.html#constructor" roo:cls="Roo.MessageBox.html#constructor">Roo.MessageBox</a>
 178
 179
 180
 181
 182
 183                 </div>
 184                 <div class="mdesc">
 185
 186                    <div class="short">Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert).</div>
 187
 188
 189
 190                     <div class="long">
 191
 192                                 Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert).<br/>If a callback function is passed it will be called after the user clicks the button, and the<br/>id of the button that was clicked will be passed as the only parameter to the callback<br/>(could also be the top-right close button).
 193
 194
 195
 196
 197
 198
 199                                 <dl class="detailList">
 200                                 <dt class="heading">Parameters:</dt>
 201
 202                                         <dt>
 203                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>title</b>
 204
 205                                         </dt>
 206                                         <dd>The title bar text</dd>
 207
 208                                         <dt>
 209                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>msg</b>
 210
 211                                         </dt>
 212                                         <dd>The message box body text</dd>
 213
 214                                         <dt>
 215                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>fn</b>
 216
 217                                         </dt>
 218                                         <dd>(optional) The callback function invoked after the message box is closed</dd>
 219
 220                                         <dt>
 221                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
 222
 223                                         </dt>
 224                                         <dd>(optional) The scope of the callback function</dd>
 225
 226                                 </dl>
 227
 228
 229
 230
 231
 232                                 <dl class="detailList">
 233                                 <dt class="heading">Returns:</dt>
 234
 235                                         <dd><span class="fixedFont"><a href="./Roo.MessageBox.html#constructor" roo:cls="Roo.MessageBox.html#constructor">Roo.MessageBox</a></span>  This message box</dd>
 236
 237                                 </dl>
 238
 239
 240
 241
 242
 243
 244
 245                     </div>
 246                 </div>
 247
 248             </td>
 249             <td class="msource">
 250
 251                         Roo.MessageBox
 252                 &nbsp;
 253             </td>
 254         </tr>
 255
 256
 257           <tr class="method-row config-row-alt1 expandable notInherited">
 258             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 259
 260
 261             <td class="sig">
 262                 <a id="Roo.MessageBox-method-confirm"   name=".confirm"></a>
 263                 <div class="fixedFont">
 264                         <span class="attributes">Roo.MessageBox.</span><b class="itemname">confirm</b>
 265
 266                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>title</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>msg</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
 267
 268
 269                                          :
 270
 271
 272                                                 <a href="./Roo.MessageBox.html#constructor" roo:cls="Roo.MessageBox.html#constructor">Roo.MessageBox</a>
 273
 274
 275
 276
 277
 278                 </div>
 279                 <div class="mdesc">
 280
 281                    <div class="short">Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm).</div>
 282
 283
 284
 285                     <div class="long">
 286
 287                                 Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm).<br/>If a callback function is passed it will be called after the user clicks either button, and the id of the<br/>button that was clicked will be passed as the only parameter to the callback (could also be the top-right close button).
 288
 289
 290
 291
 292
 293
 294                                 <dl class="detailList">
 295                                 <dt class="heading">Parameters:</dt>
 296
 297                                         <dt>
 298                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>title</b>
 299
 300                                         </dt>
 301                                         <dd>The title bar text</dd>
 302
 303                                         <dt>
 304                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>msg</b>
 305
 306                                         </dt>
 307                                         <dd>The message box body text</dd>
 308
 309                                         <dt>
 310                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>fn</b>
 311
 312                                         </dt>
 313                                         <dd>(optional) The callback function invoked after the message box is closed</dd>
 314
 315                                         <dt>
 316                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
 317
 318                                         </dt>
 319                                         <dd>(optional) The scope of the callback function</dd>
 320
 321                                 </dl>
 322
 323
 324
 325
 326
 327                                 <dl class="detailList">
 328                                 <dt class="heading">Returns:</dt>
 329
 330                                         <dd><span class="fixedFont"><a href="./Roo.MessageBox.html#constructor" roo:cls="Roo.MessageBox.html#constructor">Roo.MessageBox</a></span>  This message box</dd>
 331
 332                                 </dl>
 333
 334
 335
 336
 337
 338
 339
 340                     </div>
 341                 </div>
 342
 343             </td>
 344             <td class="msource">
 345
 346                         Roo.MessageBox
 347                 &nbsp;
 348             </td>
 349         </tr>
 350
 351
 352           <tr class="method-row config-row-alt0 expandable notInherited">
 353             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 354
 355
 356             <td class="sig">
 357                 <a id="Roo.MessageBox-method-getDialog"   name=".getDialog"></a>
 358                 <div class="fixedFont">
 359                         <span class="attributes">Roo.MessageBox.</span><b class="itemname">getDialog</b>
 360
 361                                  ()
 362
 363
 364                                          :
 365
 366
 367                                                 <a href="./Roo.BasicDialog.html#constructor" roo:cls="Roo.BasicDialog.html#constructor">Roo.BasicDialog</a>
 368
 369
 370
 371
 372
 373                 </div>
 374                 <div class="mdesc">
 375
 376                    <div class="short">Returns a reference to the underlying {<b>link</b> Roo.BasicDialog} element</div>
 377
 378
 379
 380                     <div class="long">
 381
 382                                 Returns a reference to the underlying {<b>link</b> Roo.BasicDialog} element
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393                                 <dl class="detailList">
 394                                 <dt class="heading">Returns:</dt>
 395
 396                                         <dd><span class="fixedFont"><a href="./Roo.BasicDialog.html#constructor" roo:cls="Roo.BasicDialog.html#constructor">Roo.BasicDialog</a></span>  The BasicDialog element</dd>
 397
 398                                 </dl>
 399
 400
 401
 402
 403
 404
 405
 406                     </div>
 407                 </div>
 408
 409             </td>
 410             <td class="msource">
 411
 412                         Roo.MessageBox
 413                 &nbsp;
 414             </td>
 415         </tr>
 416
 417
 418           <tr class="method-row config-row-alt1 expandable notInherited">
 419             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 420
 421
 422             <td class="sig">
 423                 <a id="Roo.MessageBox-method-hide"   name=".hide"></a>
 424                 <div class="fixedFont">
 425                         <span class="attributes">Roo.MessageBox.</span><b class="itemname">hide</b>
 426
 427                                  ()
 428
 429
 430
 431                 </div>
 432                 <div class="mdesc">
 433
 434                    <div class="short">Hides the message box if it is displayed</div>
 435
 436
 437
 438                     <div class="long">
 439
 440                                 Hides the message box if it is displayed
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457                     </div>
 458                 </div>
 459
 460             </td>
 461             <td class="msource">
 462
 463                         Roo.MessageBox
 464                 &nbsp;
 465             </td>
 466         </tr>
 467
 468
 469           <tr class="method-row config-row-alt0 expandable notInherited">
 470             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 471
 472
 473             <td class="sig">
 474                 <a id="Roo.MessageBox-method-isVisible"   name=".isVisible"></a>
 475                 <div class="fixedFont">
 476                         <span class="attributes">Roo.MessageBox.</span><b class="itemname">isVisible</b>
 477
 478                                  ()
 479
 480
 481                                          :
 482
 483
 484                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 485
 486
 487
 488
 489
 490                 </div>
 491                 <div class="mdesc">
 492
 493                    <div class="short">Returns true if the message box is currently displayed</div>
 494
 495
 496
 497                     <div class="long">
 498
 499                                 Returns true if the message box is currently displayed
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510                                 <dl class="detailList">
 511                                 <dt class="heading">Returns:</dt>
 512
 513                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  True if the message box is visible, else false</dd>
 514
 515                                 </dl>
 516
 517
 518
 519
 520
 521
 522
 523                     </div>
 524                 </div>
 525
 526             </td>
 527             <td class="msource">
 528
 529                         Roo.MessageBox
 530                 &nbsp;
 531             </td>
 532         </tr>
 533
 534
 535           <tr class="method-row config-row-alt1 expandable notInherited">
 536             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 537
 538
 539             <td class="sig">
 540                 <a id="Roo.MessageBox-method-progress"   name=".progress"></a>
 541                 <div class="fixedFont">
 542                         <span class="attributes">Roo.MessageBox.</span><b class="itemname">progress</b>
 543
 544                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>title</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>msg</i></B>)
 545
 546
 547                                          :
 548
 549
 550                                                 <a href="./Roo.MessageBox.html#constructor" roo:cls="Roo.MessageBox.html#constructor">Roo.MessageBox</a>
 551
 552
 553
 554
 555
 556                 </div>
 557                 <div class="mdesc">
 558
 559                    <div class="short">Displays a message box with a progress bar.</div>
 560
 561
 562
 563                     <div class="long">
 564
 565                                 Displays a message box with a progress bar.  This message box has no buttons and is not closeable by<br/>the user.  You are responsible for updating the progress bar as needed via {<b>link</b> Roo.MessageBox<b>updateProgress</b>}<br/>and closing the message box when the process is complete.
 566
 567
 568
 569
 570
 571
 572                                 <dl class="detailList">
 573                                 <dt class="heading">Parameters:</dt>
 574
 575                                         <dt>
 576                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>title</b>
 577
 578                                         </dt>
 579                                         <dd>The title bar text</dd>
 580
 581                                         <dt>
 582                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>msg</b>
 583
 584                                         </dt>
 585                                         <dd>The message box body text</dd>
 586
 587                                 </dl>
 588
 589
 590
 591
 592
 593                                 <dl class="detailList">
 594                                 <dt class="heading">Returns:</dt>
 595
 596                                         <dd><span class="fixedFont"><a href="./Roo.MessageBox.html#constructor" roo:cls="Roo.MessageBox.html#constructor">Roo.MessageBox</a></span>  This message box</dd>
 597
 598                                 </dl>
 599
 600
 601
 602
 603
 604
 605
 606                     </div>
 607                 </div>
 608
 609             </td>
 610             <td class="msource">
 611
 612                         Roo.MessageBox
 613                 &nbsp;
 614             </td>
 615         </tr>
 616
 617
 618           <tr class="method-row config-row-alt0 expandable notInherited">
 619             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 620
 621
 622             <td class="sig">
 623                 <a id="Roo.MessageBox-method-prompt"   name=".prompt"></a>
 624                 <div class="fixedFont">
 625                         <span class="attributes">Roo.MessageBox.</span><b class="itemname">prompt</b>
 626
 627                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>title</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>msg</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>/Number <B><i>multiline</i></B>)
 628
 629
 630                                          :
 631
 632
 633                                                 <a href="./Roo.MessageBox.html#constructor" roo:cls="Roo.MessageBox.html#constructor">Roo.MessageBox</a>
 634
 635
 636
 637
 638
 639                 </div>
 640                 <div class="mdesc">
 641
 642                    <div class="short">Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to<br/>JavaScript's Window.prompt).</div>
 643
 644
 645
 646                     <div class="long">
 647
 648                                 Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to<br/>JavaScript's Window.prompt).  The prompt can be a single-line or multi-line textbox.  If a callback function<br/>is passed it will be called after the user clicks either button, and the id of the button that was clicked<br/>(could also be the top-right close button) and the text that was entered will be passed as the two<br/>parameters to the callback.
 649
 650
 651
 652
 653
 654
 655                                 <dl class="detailList">
 656                                 <dt class="heading">Parameters:</dt>
 657
 658                                         <dt>
 659                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>title</b>
 660
 661                                         </dt>
 662                                         <dd>The title bar text</dd>
 663
 664                                         <dt>
 665                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>msg</b>
 666
 667                                         </dt>
 668                                         <dd>The message box body text</dd>
 669
 670                                         <dt>
 671                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>fn</b>
 672
 673                                         </dt>
 674                                         <dd>(optional) The callback function invoked after the message box is closed</dd>
 675
 676                                         <dt>
 677                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
 678
 679                                         </dt>
 680                                         <dd>(optional) The scope of the callback function</dd>
 681
 682                                         <dt>
 683                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>/Number</span>  <b>multiline</b>
 684
 685                                         </dt>
 686                                         <dd>(optional) True to create a multiline textbox using the defaultTextHeight<br/>property, or the height in pixels to create the textbox (defaults to false / single-line)</dd>
 687
 688                                 </dl>
 689
 690
 691
 692
 693
 694                                 <dl class="detailList">
 695                                 <dt class="heading">Returns:</dt>
 696
 697                                         <dd><span class="fixedFont"><a href="./Roo.MessageBox.html#constructor" roo:cls="Roo.MessageBox.html#constructor">Roo.MessageBox</a></span>  This message box</dd>
 698
 699                                 </dl>
 700
 701
 702
 703
 704
 705
 706
 707                     </div>
 708                 </div>
 709
 710             </td>
 711             <td class="msource">
 712
 713                         Roo.MessageBox
 714                 &nbsp;
 715             </td>
 716         </tr>
 717
 718
 719           <tr class="method-row config-row-alt1 expandable notInherited">
 720             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 721
 722
 723             <td class="sig">
 724                 <a id="Roo.MessageBox-method-show"   name=".show"></a>
 725                 <div class="fixedFont">
 726                         <span class="attributes">Roo.MessageBox.</span><b class="itemname">show</b>
 727
 728                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 729
 730
 731                                          :
 732
 733
 734                                                 <a href="./Roo.MessageBox.html#constructor" roo:cls="Roo.MessageBox.html#constructor">Roo.MessageBox</a>
 735
 736
 737
 738
 739
 740                 </div>
 741                 <div class="mdesc">
 742
 743                    <div class="short">Displays a new message box, or reinitializes an existing message box, based on the config options<br/>passed in.</div>
 744
 745
 746
 747                     <div class="long">
 748
 749                                 Displays a new message box, or reinitializes an existing message box, based on the config options<br/>passed in. All functions (e.g. prompt, alert, etc) on MessageBox call this function internally.<br/>The following config object properties are supported:<br/><pre><br/>Property    Type             Description<br/>----------  ---------------  ------------------------------------------------------------------------------------<br/>animEl            String/Element   An id or Element from which the message box should animate as it opens and<br/>                                   closes (defaults to undefined)<br/>buttons           Object/Boolean   A button config object (e.g., Roo.MessageBox.OKCANCEL or {ok:'Foo',<br/>                                   cancel:'Bar'}), or false to not show any buttons (defaults to false)<br/>closable          Boolean          False to hide the top-right close button (defaults to true).  Note that<br/>                                   progress and wait dialogs will ignore this property and always hide the<br/>                                   close button as they can only be closed programmatically.<br/>cls               String           A custom CSS class to apply to the message box element<br/>defaultTextHeight Number           The default height in pixels of the message box's multiline textarea if<br/>                                   displayed (defaults to 75)<br/>fn                Function         A callback function to execute after closing the dialog.  The arguments to the<br/>                                   function will be btn (the name of the button that was clicked, if applicable,<br/>                                   e.g. "ok"), and text (the value of the active text field, if applicable).<br/>                                   Progress and wait dialogs will ignore this option since they do not respond to<br/>                                   user actions and can only be closed programmatically, so any required function<br/>                                   should be called by the same code after it closes the dialog.<br/>icon              String           A CSS class that provides a background image to be used as an icon for<br/>                                   the dialog (e.g., Roo.MessageBox.WARNING or 'custom-class', defaults to '')<br/>maxWidth          Number           The maximum width in pixels of the message box (defaults to 600)<br/>minWidth          Number           The minimum width in pixels of the message box (defaults to 100)<br/>modal             Boolean          False to allow user interaction with the page while the message box is<br/>                                   displayed (defaults to true)<br/>msg               String           A string that will replace the existing message box body text (defaults<br/>                                   to the XHTML-compliant non-breaking space character '&#160;')<br/>multiline         Boolean          True to prompt the user to enter multi-line text (defaults to false)<br/>progress          Boolean          True to display a progress bar (defaults to false)<br/>progressText      String           The text to display inside the progress bar if progress = true (defaults to '')<br/>prompt            Boolean          True to prompt the user to enter single-line text (defaults to false)<br/>proxyDrag         Boolean          True to display a lightweight proxy while dragging (defaults to false)<br/>title             String           The title text<br/>value             String           The string value to set into the active textbox element if displayed<br/>wait              Boolean          True to display a progress bar (defaults to false)<br/>width             Number           The width of the dialog in pixels<br/></pre><br/><br/>Example usage:<br/><pre><code><br/>Roo.Msg.show({<br/>   title: 'Address',<br/>   msg: 'Please enter your address:',<br/>   width: 300,<br/>   buttons: Roo.MessageBox.OKCANCEL,<br/>   multiline: true,<br/>   fn: saveAddress,<br/>   animEl: 'addAddressBtn'<br/>});<br/></code></pre>
 750
 751
 752
 753
 754
 755
 756                                 <dl class="detailList">
 757                                 <dt class="heading">Parameters:</dt>
 758
 759                                         <dt>
 760                                                 <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>
 761
 762                                         </dt>
 763                                         <dd>Configuration options</dd>
 764
 765                                 </dl>
 766
 767
 768
 769
 770
 771                                 <dl class="detailList">
 772                                 <dt class="heading">Returns:</dt>
 773
 774                                         <dd><span class="fixedFont"><a href="./Roo.MessageBox.html#constructor" roo:cls="Roo.MessageBox.html#constructor">Roo.MessageBox</a></span>  This message box</dd>
 775
 776                                 </dl>
 777
 778
 779
 780
 781
 782
 783
 784                     </div>
 785                 </div>
 786
 787             </td>
 788             <td class="msource">
 789
 790                         Roo.MessageBox
 791                 &nbsp;
 792             </td>
 793         </tr>
 794
 795
 796           <tr class="method-row config-row-alt0 expandable notInherited">
 797             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 798
 799
 800             <td class="sig">
 801                 <a id="Roo.MessageBox-method-updateProgress"   name=".updateProgress"></a>
 802                 <div class="fixedFont">
 803                         <span class="attributes">Roo.MessageBox.</span><b class="itemname">updateProgress</b>
 804
 805                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>value</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>text</i></B>)
 806
 807
 808                                          :
 809
 810
 811                                                 <a href="./Roo.MessageBox.html#constructor" roo:cls="Roo.MessageBox.html#constructor">Roo.MessageBox</a>
 812
 813
 814
 815
 816
 817                 </div>
 818                 <div class="mdesc">
 819
 820                    <div class="short">Updates a progress-style message box's text and progress bar.</div>
 821
 822
 823
 824                     <div class="long">
 825
 826                                 Updates a progress-style message box's text and progress bar.  Only relevant on message boxes<br/>initiated via {<b>link</b> Roo.MessageBox<b>progress</b>} or by calling {<b>link</b> Roo.MessageBox<b>show</b>} with progress: true.
 827
 828
 829
 830
 831
 832
 833                                 <dl class="detailList">
 834                                 <dt class="heading">Parameters:</dt>
 835
 836                                         <dt>
 837                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>value</b>
 838
 839                                         </dt>
 840                                         <dd>Any number between 0 and 1 (e.g., .5)</dd>
 841
 842                                         <dt>
 843                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>text</b>
 844
 845                                         </dt>
 846                                         <dd>(optional) If defined, the message box's body text is replaced with the specified string (defaults to undefined)</dd>
 847
 848                                 </dl>
 849
 850
 851
 852
 853
 854                                 <dl class="detailList">
 855                                 <dt class="heading">Returns:</dt>
 856
 857                                         <dd><span class="fixedFont"><a href="./Roo.MessageBox.html#constructor" roo:cls="Roo.MessageBox.html#constructor">Roo.MessageBox</a></span>  This message box</dd>
 858
 859                                 </dl>
 860
 861
 862
 863
 864
 865
 866
 867                     </div>
 868                 </div>
 869
 870             </td>
 871             <td class="msource">
 872
 873                         Roo.MessageBox
 874                 &nbsp;
 875             </td>
 876         </tr>
 877
 878
 879           <tr class="method-row config-row-alt1 expandable notInherited">
 880             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 881
 882
 883             <td class="sig">
 884                 <a id="Roo.MessageBox-method-updateText"   name=".updateText"></a>
 885                 <div class="fixedFont">
 886                         <span class="attributes">Roo.MessageBox.</span><b class="itemname">updateText</b>
 887
 888                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>text</i></B>)
 889
 890
 891                                          :
 892
 893
 894                                                 <a href="./Roo.MessageBox.html#constructor" roo:cls="Roo.MessageBox.html#constructor">Roo.MessageBox</a>
 895
 896
 897
 898
 899
 900                 </div>
 901                 <div class="mdesc">
 902
 903                    <div class="short">Updates the message box body text</div>
 904
 905
 906
 907                     <div class="long">
 908
 909                                 Updates the message box body text
 910
 911
 912
 913
 914
 915
 916                                 <dl class="detailList">
 917                                 <dt class="heading">Parameters:</dt>
 918
 919                                         <dt>
 920                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>text</b>
 921
 922                                         </dt>
 923                                         <dd>(optional) Replaces the message box element's innerHTML with the specified string (defaults to<br/>the XHTML-compliant non-breaking space character '&amp;#160;')</dd>
 924
 925                                 </dl>
 926
 927
 928
 929
 930
 931                                 <dl class="detailList">
 932                                 <dt class="heading">Returns:</dt>
 933
 934                                         <dd><span class="fixedFont"><a href="./Roo.MessageBox.html#constructor" roo:cls="Roo.MessageBox.html#constructor">Roo.MessageBox</a></span>  This message box</dd>
 935
 936                                 </dl>
 937
 938
 939
 940
 941
 942
 943
 944                     </div>
 945                 </div>
 946
 947             </td>
 948             <td class="msource">
 949
 950                         Roo.MessageBox
 951                 &nbsp;
 952             </td>
 953         </tr>
 954
 955
 956           <tr class="method-row config-row-alt0 expandable notInherited">
 957             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 958
 959
 960             <td class="sig">
 961                 <a id="Roo.MessageBox-method-wait"   name=".wait"></a>
 962                 <div class="fixedFont">
 963                         <span class="attributes">Roo.MessageBox.</span><b class="itemname">wait</b>
 964
 965                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>msg</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>title</i></B>)
 966
 967
 968                                          :
 969
 970
 971                                                 <a href="./Roo.MessageBox.html#constructor" roo:cls="Roo.MessageBox.html#constructor">Roo.MessageBox</a>
 972
 973
 974
 975
 976
 977                 </div>
 978                 <div class="mdesc">
 979
 980                    <div class="short">Displays a message box with an infinitely auto-updating progress bar.</div>
 981
 982
 983
 984                     <div class="long">
 985
 986                                 Displays a message box with an infinitely auto-updating progress bar.  This can be used to block user<br/>interaction while waiting for a long-running process to complete that does not have defined intervals.<br/>You are responsible for closing the message box when the process is complete.
 987
 988
 989
 990
 991
 992
 993                                 <dl class="detailList">
 994                                 <dt class="heading">Parameters:</dt>
 995
 996                                         <dt>
 997                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>msg</b>
 998
 999                                         </dt>
1000                                         <dd>The message box body text</dd>
1001
1002                                         <dt>
1003                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>title</b>
1004
1005                                         </dt>
1006                                         <dd>(optional) The title bar text</dd>
1007
1008                                 </dl>
1009
1010
1011
1012
1013
1014                                 <dl class="detailList">
1015                                 <dt class="heading">Returns:</dt>
1016
1017                                         <dd><span class="fixedFont"><a href="./Roo.MessageBox.html#constructor" roo:cls="Roo.MessageBox.html#constructor">Roo.MessageBox</a></span>  This message box</dd>
1018
1019                                 </dl>
1020
1021
1022
1023
1024
1025
1026
1027                     </div>
1028                 </div>
1029
1030             </td>
1031             <td class="msource">
1032
1033                         Roo.MessageBox
1034                 &nbsp;
1035             </td>
1036         </tr>
1037
1038
1039     </table>
1040
1041
1042   <!-- ============================== events summary / details ======================== -->
1043
1044
1045   <a id="Roo.MessageBox-events"></a>
1046
1047
1048
1049
1050
1051      <table cellspacing="0" class="member-table">
1052       <caption class="Empty">Events - Has None</caption>
1053      </table>
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063 <!-- ============================== footer ================================= -->
1064                 <div class="fineprint" style="clear:both">
1065
1066                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Tue Jul 27 2010 11:05:06 GMT+0800 (HKT)
1067                         Based on
1068                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1069                 </div>
1070         </body>
1071 </html>