git.roojs.org Git - roojs1/blob - docs/symbols/Roo.UpdateManager.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.UpdateManager</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.UpdateManager-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.UpdateManager-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.UpdateManager-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.UpdateManager-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.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.UpdateManager
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.UpdateManager
  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_UpdateManager.js.html">Roo/UpdateManager.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">UpdateManager</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         Provides AJAX-style update for Element object.<br><br><br/>Usage:<br><br/><pre><code><br/>// Get it from a Roo.Element object<br/>var el = Roo.get("foo");<br/>var mgr = el.getUpdateManager();<br/>mgr.update("http://myserver.com/index.php", "param1=1&amp;param2=2");<br/>...<br/>mgr.formUpdate("myFormId", "http://myserver.com/index.php");<br/><br><br/>// or directly (returns the same UpdateManager instance)<br/>var mgr = new Roo.UpdateManager("myElementId");<br/>mgr.startAutoRefresh(60, "http://myserver.com/index.php");<br/>mgr.on("update", myFcnNeedsToKnow);<br/><br><br/>   // short handed call directly from the element object<br/>   Roo.get("foo").load({<br/>        url: "bar.php",<br/>        scripts:true,<br/>        params: "for=bar",<br/>        text: "Loading Foo..."<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.UpdateManager';">[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.UpdateManager.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.UpdateManager-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.UpdateManager-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.UpdateManager-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-UpdateManager"   name=".UpdateManager"></a>
 181                 <div class="fixedFont">
 182                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">UpdateManager</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:Boolean">Boolean</a> <B><i>forceNew</i></B>)
 185
 186
 187
 188                 </div>
 189                 <div class="mdesc">
 190
 191
 192                         <div class="short">Create a new Roo.UpdateManager</div>
 193
 194
 195                     <div class="long">
 196
 197
 198
 199                                 Create a new Roo.UpdateManager
 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 element to update</dd>
 210
 211                                         <dt>
 212                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>forceNew</b>
 213
 214                                         </dt>
 215                                         <dd>(optional) By default the constructor checks to see if the passed element already has an UpdateManager and if it does it returns the same instance. This will skip that check (useful for extending this class).</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.UpdateManager-method-updateElement"   name=".updateElement"></a>
 245                 <div class="fixedFont">
 246                         <span class="attributes">Roo.UpdateManager.</span><b class="itemname">updateElement</b>
 247
 248                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>el</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>url</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object <B><i>params</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
 249
 250
 251
 252                 </div>
 253                 <div class="mdesc">
 254
 255                    <div class="short">Static convenience method.</div>
 256
 257
 258
 259                     <div class="long">
 260
 261                                 Static convenience method. This method is deprecated in favor of el.load({url:'foo.php', ...}).<br/>Usage:<br/><pre><code>Roo.UpdateManager.updateElement("my-div", "stuff.php");</code></pre>
 262
 263
 264
 265
 266
 267
 268                                 <dl class="detailList">
 269                                 <dt class="heading">Parameters:</dt>
 270
 271                                         <dt>
 272                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 273
 274                                         </dt>
 275                                         <dd>The element to update</dd>
 276
 277                                         <dt>
 278                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>url</b>
 279
 280                                         </dt>
 281                                         <dd>The url</dd>
 282
 283                                         <dt>
 284                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object</span>  <b>params</b>
 285
 286                                         </dt>
 287                                         <dd>(optional) Url encoded param string or an object of name/value pairs</dd>
 288
 289                                         <dt>
 290                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>options</b>
 291
 292                                         </dt>
 293                                         <dd>(optional) A config object with any of the UpdateManager properties you want to set - for example: {disableCaching:true, indicatorText: "Loading data..."}</dd>
 294
 295                                 </dl>
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307                     </div>
 308                 </div>
 309
 310             </td>
 311             <td class="msource">
 312
 313                         Roo.UpdateManager
 314                 &nbsp;
 315             </td>
 316         </tr>
 317
 318
 319           <tr class="method-row config-row-alt0 expandable notInherited">
 320             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 321
 322
 323             <td class="sig">
 324                 <a id="Roo.UpdateManager-method-abort"   name=".abort"></a>
 325                 <div class="fixedFont">
 326                         <span class="attributes"></span><b class="itemname">abort</b>
 327
 328                                  ()
 329
 330
 331
 332                 </div>
 333                 <div class="mdesc">
 334
 335                    <div class="short">Aborts the executing transaction</div>
 336
 337
 338
 339                     <div class="long">
 340
 341                                 Aborts the executing transaction
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358                     </div>
 359                 </div>
 360
 361             </td>
 362             <td class="msource">
 363
 364                         Roo.UpdateManager
 365                 &nbsp;
 366             </td>
 367         </tr>
 368
 369
 370           <tr class="method-row config-row-alt1 expandable notInherited">
 371             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 372
 373
 374             <td class="sig">
 375                 <a id="Roo.UpdateManager-method-formUpdate"   name=".formUpdate"></a>
 376                 <div class="fixedFont">
 377                         <span class="attributes"></span><b class="itemname">formUpdate</b>
 378
 379                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement <B><i>form</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>url</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>reset</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>callback</i></B>)
 380
 381
 382
 383                 </div>
 384                 <div class="mdesc">
 385
 386                    <div class="short">Performs an async form post, updating this element with the response.</div>
 387
 388
 389
 390                     <div class="long">
 391
 392                                 Performs an async form post, updating this element with the response. If the form has the attribute enctype="multipart/form-data", it assumes it's a file upload.<br/>Uses this.sslBlankUrl for SSL file uploads to prevent IE security warning.
 393
 394
 395
 396
 397
 398
 399                                 <dl class="detailList">
 400                                 <dt class="heading">Parameters:</dt>
 401
 402                                         <dt>
 403                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement</span>  <b>form</b>
 404
 405                                         </dt>
 406                                         <dd>The form Id or form element</dd>
 407
 408                                         <dt>
 409                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>url</b>
 410
 411                                         </dt>
 412                                         <dd>(optional) The url to pass the form to. If omitted the action attribute on the form will be used.</dd>
 413
 414                                         <dt>
 415                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>reset</b>
 416
 417                                         </dt>
 418                                         <dd>(optional) Whether to try to reset the form after the update</dd>
 419
 420                                         <dt>
 421                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>callback</b>
 422
 423                                         </dt>
 424                                         <dd>(optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse)</dd>
 425
 426                                 </dl>
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438                     </div>
 439                 </div>
 440
 441             </td>
 442             <td class="msource">
 443
 444                         Roo.UpdateManager
 445                 &nbsp;
 446             </td>
 447         </tr>
 448
 449
 450           <tr class="method-row config-row-alt0 expandable notInherited">
 451             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 452
 453
 454             <td class="sig">
 455                 <a id="Roo.UpdateManager-method-getEl"   name=".getEl"></a>
 456                 <div class="fixedFont">
 457                         <span class="attributes"></span><b class="itemname">getEl</b>
 458
 459                                  ()
 460
 461
 462                                          :
 463
 464
 465                                                 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
 466
 467
 468
 469
 470
 471                 </div>
 472                 <div class="mdesc">
 473
 474                    <div class="short">Get the Element this UpdateManager is bound to</div>
 475
 476
 477
 478                     <div class="long">
 479
 480                                 Get the Element this UpdateManager is bound to
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491                                 <dl class="detailList">
 492                                 <dt class="heading">Returns:</dt>
 493
 494                                         <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span>  The element</dd>
 495
 496                                 </dl>
 497
 498
 499
 500
 501
 502
 503
 504                     </div>
 505                 </div>
 506
 507             </td>
 508             <td class="msource">
 509
 510                         Roo.UpdateManager
 511                 &nbsp;
 512             </td>
 513         </tr>
 514
 515
 516           <tr class="method-row config-row-alt1 expandable notInherited">
 517             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 518
 519
 520             <td class="sig">
 521                 <a id="Roo.UpdateManager-method-isUpdating"   name=".isUpdating"></a>
 522                 <div class="fixedFont">
 523                         <span class="attributes"></span><b class="itemname">isUpdating</b>
 524
 525                                  ()
 526
 527
 528                                          :
 529
 530
 531                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 532
 533
 534
 535
 536
 537                 </div>
 538                 <div class="mdesc">
 539
 540                    <div class="short">Returns true if an update is in progress</div>
 541
 542
 543
 544                     <div class="long">
 545
 546                                 Returns true if an update is in progress
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557                                 <dl class="detailList">
 558                                 <dt class="heading">Returns:</dt>
 559
 560                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
 561
 562                                 </dl>
 563
 564
 565
 566
 567
 568
 569
 570                     </div>
 571                 </div>
 572
 573             </td>
 574             <td class="msource">
 575
 576                         Roo.UpdateManager
 577                 &nbsp;
 578             </td>
 579         </tr>
 580
 581
 582           <tr class="method-row config-row-alt0 expandable notInherited">
 583             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 584
 585
 586             <td class="sig">
 587                 <a id="Roo.UpdateManager-method-refresh"   name=".refresh"></a>
 588                 <div class="fixedFont">
 589                         <span class="attributes"></span><b class="itemname">refresh</b>
 590
 591                                  (<a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>callback</i></B>)
 592
 593
 594
 595                 </div>
 596                 <div class="mdesc">
 597
 598                    <div class="short">Refresh the element with the last used url or defaultUrl.</div>
 599
 600
 601
 602                     <div class="long">
 603
 604                                 Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately
 605
 606
 607
 608
 609
 610
 611                                 <dl class="detailList">
 612                                 <dt class="heading">Parameters:</dt>
 613
 614                                         <dt>
 615                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>callback</b>
 616
 617                                         </dt>
 618                                         <dd>(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)</dd>
 619
 620                                 </dl>
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632                     </div>
 633                 </div>
 634
 635             </td>
 636             <td class="msource">
 637
 638                         Roo.UpdateManager
 639                 &nbsp;
 640             </td>
 641         </tr>
 642
 643
 644           <tr class="method-row config-row-alt1 expandable notInherited">
 645             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 646
 647
 648             <td class="sig">
 649                 <a id="Roo.UpdateManager-method-setDefaultUrl"   name=".setDefaultUrl"></a>
 650                 <div class="fixedFont">
 651                         <span class="attributes"></span><b class="itemname">setDefaultUrl</b>
 652
 653                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Function <B><i>defaultUrl</i></B>)
 654
 655
 656
 657                 </div>
 658                 <div class="mdesc">
 659
 660                    <div class="short">Set the defaultUrl used for updates</div>
 661
 662
 663
 664                     <div class="long">
 665
 666                                 Set the defaultUrl used for updates
 667
 668
 669
 670
 671
 672
 673                                 <dl class="detailList">
 674                                 <dt class="heading">Parameters:</dt>
 675
 676                                         <dt>
 677                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Function</span>  <b>defaultUrl</b>
 678
 679                                         </dt>
 680                                         <dd>The url or a function to call to get the url</dd>
 681
 682                                 </dl>
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694                     </div>
 695                 </div>
 696
 697             </td>
 698             <td class="msource">
 699
 700                         Roo.UpdateManager
 701                 &nbsp;
 702             </td>
 703         </tr>
 704
 705
 706           <tr class="method-row config-row-alt0 expandable notInherited">
 707             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 708
 709
 710             <td class="sig">
 711                 <a id="Roo.UpdateManager-method-setRenderer"   name=".setRenderer"></a>
 712                 <div class="fixedFont">
 713                         <span class="attributes"></span><b class="itemname">setRenderer</b>
 714
 715                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>renderer</i></B>)
 716
 717
 718
 719                 </div>
 720                 <div class="mdesc">
 721
 722                    <div class="short">Set the content renderer for this UpdateManager.</div>
 723
 724
 725
 726                     <div class="long">
 727
 728                                 Set the content renderer for this UpdateManager. See {<b>link</b> Roo.UpdateManager.BasicRenderer<b>render</b>} for more details.
 729
 730
 731
 732
 733
 734
 735                                 <dl class="detailList">
 736                                 <dt class="heading">Parameters:</dt>
 737
 738                                         <dt>
 739                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>renderer</b>
 740
 741                                         </dt>
 742                                         <dd>The object implementing the render() method</dd>
 743
 744                                 </dl>
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756                     </div>
 757                 </div>
 758
 759             </td>
 760             <td class="msource">
 761
 762                         Roo.UpdateManager
 763                 &nbsp;
 764             </td>
 765         </tr>
 766
 767
 768           <tr class="method-row config-row-alt1 expandable notInherited">
 769             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 770
 771
 772             <td class="sig">
 773                 <a id="Roo.UpdateManager-method-showLoading"   name=".showLoading"></a>
 774                 <div class="fixedFont">
 775                         <span class="attributes"></span><b class="itemname">showLoading</b>
 776
 777                                  ()
 778
 779
 780
 781                 </div>
 782                 <div class="mdesc">
 783
 784                    <div class="short">Called to update the element to "Loading" state.</div>
 785
 786
 787
 788                     <div class="long">
 789
 790                                 Called to update the element to "Loading" state. Override to perform custom action.
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807                     </div>
 808                 </div>
 809
 810             </td>
 811             <td class="msource">
 812
 813                         Roo.UpdateManager
 814                 &nbsp;
 815             </td>
 816         </tr>
 817
 818
 819           <tr class="method-row config-row-alt0 expandable notInherited">
 820             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 821
 822
 823             <td class="sig">
 824                 <a id="Roo.UpdateManager-method-startAutoRefresh"   name=".startAutoRefresh"></a>
 825                 <div class="fixedFont">
 826                         <span class="attributes"></span><b class="itemname">startAutoRefresh</b>
 827
 828                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>interval</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Function <B><i>url</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object <B><i>params</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>callback</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>refreshNow</i></B>)
 829
 830
 831
 832                 </div>
 833                 <div class="mdesc">
 834
 835                    <div class="short">Set this element to auto refresh.</div>
 836
 837
 838
 839                     <div class="long">
 840
 841                                 Set this element to auto refresh.
 842
 843
 844
 845
 846
 847
 848                                 <dl class="detailList">
 849                                 <dt class="heading">Parameters:</dt>
 850
 851                                         <dt>
 852                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>interval</b>
 853
 854                                         </dt>
 855                                         <dd>How often to update (in seconds).</dd>
 856
 857                                         <dt>
 858                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Function</span>  <b>url</b>
 859
 860                                         </dt>
 861                                         <dd>(optional) The url for this request or a function to call to get the url (Defaults to the last used url)</dd>
 862
 863                                         <dt>
 864                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object</span>  <b>params</b>
 865
 866                                         </dt>
 867                                         <dd>(optional) The parameters to pass as either a url encoded string "&param1=1&param2=2" or as an object {param1: 1, param2: 2}</dd>
 868
 869                                         <dt>
 870                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>callback</b>
 871
 872                                         </dt>
 873                                         <dd>(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)</dd>
 874
 875                                         <dt>
 876                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>refreshNow</b>
 877
 878                                         </dt>
 879                                         <dd>(optional) Whether to execute the refresh now, or wait the interval</dd>
 880
 881                                 </dl>
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893                     </div>
 894                 </div>
 895
 896             </td>
 897             <td class="msource">
 898
 899                         Roo.UpdateManager
 900                 &nbsp;
 901             </td>
 902         </tr>
 903
 904
 905           <tr class="method-row config-row-alt1 expandable notInherited">
 906             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 907
 908
 909             <td class="sig">
 910                 <a id="Roo.UpdateManager-method-stopAutoRefresh"   name=".stopAutoRefresh"></a>
 911                 <div class="fixedFont">
 912                         <span class="attributes"></span><b class="itemname">stopAutoRefresh</b>
 913
 914                                  ()
 915
 916
 917
 918                 </div>
 919                 <div class="mdesc">
 920
 921                    <div class="short">Stop auto refresh on this element.</div>
 922
 923
 924
 925                     <div class="long">
 926
 927                                 Stop auto refresh on this element.
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944                     </div>
 945                 </div>
 946
 947             </td>
 948             <td class="msource">
 949
 950                         Roo.UpdateManager
 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.UpdateManager-method-update"   name=".update"></a>
 962                 <div class="fixedFont">
 963                         <span class="attributes"></span><b class="itemname">update</b>
 964
 965                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>/String/Function <B><i>url</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object <B><i>params</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>callback</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>discardUrl</i></B>)
 966
 967
 968
 969                 </div>
 970                 <div class="mdesc">
 971
 972                    <div class="short">Performs an async request, updating this element with the response.</div>
 973
 974
 975
 976                     <div class="long">
 977
 978                                 Performs an async request, updating this element with the response. If params are specified it uses POST, otherwise it uses GET.
 979
 980
 981
 982
 983
 984
 985                                 <dl class="detailList">
 986                                 <dt class="heading">Parameters:</dt>
 987
 988                                         <dt>
 989                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>/String/Function</span>  <b>url</b>
 990
 991                                         </dt>
 992                                         <dd>The url for this request or a function to call to get the url or a config object containing any of the following options:<br/><pre><code><br/>um.update({<br/><br/>    url: "your-url.php",<br/><br/>    params: {param1: "foo", param2: "bar"}, // or a URL encoded string<br/><br/>    callback: yourFunction,<br/><br/>    scope: yourObject, //(optional scope)  <br/><br/>    discardUrl: false, <br/><br/>    nocache: false,<br/><br/>    text: "Loading...",<br/><br/>    timeout: 30,<br/><br/>    scripts: false<br/><br/>});<br/></code></pre><br/>The only required property is url. The optional properties nocache, text and scripts<br/>are shorthand for disableCaching, indicatorText and loadScripts and are used to set their associated property on this UpdateManager instance.</dd>
 993
 994                                         <dt>
 995                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object</span>  <b>params</b>
 996
 997                                         </dt>
 998                                         <dd>(optional) The parameters to pass as either a url encoded string "param1=1&amp;param2=2" or an object {param1: 1, param2: 2}</dd>
 999
1000                                         <dt>
1001                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>callback</b>
1002
1003                                         </dt>
1004                                         <dd>(optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse)</dd>
1005
1006                                         <dt>
1007                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>discardUrl</b>
1008
1009                                         </dt>
1010                                         <dd>(optional) By default when you execute an update the defaultUrl is changed to the last used url. If true, it will not store the url.</dd>
1011
1012                                 </dl>
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024                     </div>
1025                 </div>
1026
1027             </td>
1028             <td class="msource">
1029
1030                         Roo.UpdateManager
1031                 &nbsp;
1032             </td>
1033         </tr>
1034
1035
1036     </table>
1037
1038
1039   <!-- ============================== events summary / details ======================== -->
1040
1041
1042   <a id="Roo.UpdateManager-events"></a>
1043
1044
1045
1046
1047
1048
1049
1050
1051       <table cellspacing="0" class="member-table">
1052                 <caption>Events</caption>
1053               <thead>
1054                 <tr>
1055                     <th class="sig-header" colspan="2">Event</th>
1056                     <th class="msource-header">Defined By</th>
1057
1058                 </tr>
1059               </thead>
1060
1061
1062
1063
1064
1065           <tr class="method-row expandable config-row-alt0 notInherited">
1066             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1067
1068             <td class="sig">
1069                 <a id="Roo.UpdateManager-event-*beforeupdate"></a>
1070
1071                <div class="fixedFont">
1072                 <b class="itemname">beforeupdate</b> (<a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a> <B><i>el</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object/Function <B><i>url</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object <B><i>params</i></B>)
1073
1074                 </div>
1075
1076                 <div class="mdesc">
1077
1078                    <div class="short">Fired before an update is made, return false from your handler and the update is cancelled.
1079
1080                 </div>
1081
1082                     <div class="long">
1083
1084                         Fired before an update is made, return false from your handler and the update is cancelled.
1085
1086
1087
1088
1089
1090                                 <dl class="detailList">
1091                                 <dt class="heading">Parameters:</dt>
1092
1093                                         <dt>
1094                                                 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> <b>el</b>
1095
1096                                         </dt>
1097                                         <dd></dd>
1098
1099                                         <dt>
1100                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object/Function</span> <b>url</b>
1101
1102                                         </dt>
1103                                         <dd></dd>
1104
1105                                         <dt>
1106                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object</span> <b>params</b>
1107
1108                                         </dt>
1109                                         <dd></dd>
1110
1111                                 </dl>
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123                     </div>
1124                 </div>
1125
1126             </td>
1127             <td class="msource">
1128                 Roo.UpdateManager
1129             </td>
1130         </tr>
1131
1132           <tr class="method-row expandable config-row-alt1 notInherited">
1133             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1134
1135             <td class="sig">
1136                 <a id="Roo.UpdateManager-event-*failure"></a>
1137
1138                <div class="fixedFont">
1139                 <b class="itemname">failure</b> (<a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a> <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>oResponseObject</i></B>)
1140
1141                 </div>
1142
1143                 <div class="mdesc">
1144
1145                    <div class="short">Fired on update failure.
1146
1147                 </div>
1148
1149                     <div class="long">
1150
1151                         Fired on update failure.
1152
1153
1154
1155
1156
1157                                 <dl class="detailList">
1158                                 <dt class="heading">Parameters:</dt>
1159
1160                                         <dt>
1161                                                 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> <b>el</b>
1162
1163                                         </dt>
1164                                         <dd></dd>
1165
1166                                         <dt>
1167                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>oResponseObject</b>
1168
1169                                         </dt>
1170                                         <dd>The response Object</dd>
1171
1172                                 </dl>
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184                     </div>
1185                 </div>
1186
1187             </td>
1188             <td class="msource">
1189                 Roo.UpdateManager
1190             </td>
1191         </tr>
1192
1193           <tr class="method-row expandable config-row-alt0 notInherited">
1194             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1195
1196             <td class="sig">
1197                 <a id="Roo.UpdateManager-event-*update"></a>
1198
1199                <div class="fixedFont">
1200                 <b class="itemname">update</b> (<a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a> <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>oResponseObject</i></B>)
1201
1202                 </div>
1203
1204                 <div class="mdesc">
1205
1206                    <div class="short">Fired after successful update is made.
1207
1208                 </div>
1209
1210                     <div class="long">
1211
1212                         Fired after successful update is made.
1213
1214
1215
1216
1217
1218                                 <dl class="detailList">
1219                                 <dt class="heading">Parameters:</dt>
1220
1221                                         <dt>
1222                                                 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> <b>el</b>
1223
1224                                         </dt>
1225                                         <dd></dd>
1226
1227                                         <dt>
1228                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>oResponseObject</b>
1229
1230                                         </dt>
1231                                         <dd>The response Object</dd>
1232
1233                                 </dl>
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245                     </div>
1246                 </div>
1247
1248             </td>
1249             <td class="msource">
1250                 Roo.UpdateManager
1251             </td>
1252         </tr>
1253
1254
1255     </table>
1256
1257
1258
1259
1260
1261 <!-- ============================== footer ================================= -->
1262                 <div class="fineprint" style="clear:both">
1263
1264                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 15:55:24 GMT+0800 (HKT)
1265                         Based on
1266                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1267                 </div>
1268         </body>
1269 </html>