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
 112
 113       <table cellspacing="0" class="member-table">
 114       <caption>Config Options (Usually are also Properties)</caption>
 115
 116
 117         <tr>
 118             <th class="sig-header" colspan="2">Options</th>
 119
 120             <th class="msource-header">Defined By</th>
 121         </tr>
 122
 123
 124
 125
 126
 127                 <tr class="config-row expandable config-row-alt0">
 128                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 129                     <td class="sig">
 130
 131                         <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
 132                         <div class="fixedFont">
 133                                 <b  class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/>    listeners :  { <br/>       'click' : function(e) {<br/>           .</div>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <div class="long">
 144                     list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/>    listeners :  { <br/>       'click' : function(e) {<br/>           ..... <br/>        } ,<br/>        .... <br/>    } <br/>  </code></pre>
 145
 146                 </div>
 147                         </div>
 148
 149
 150
 151                     </td>
 152                     <td class="msource">
 153
 154                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 155
 156                     </td>
 157                 </tr>
 158
 159
 160     </table>
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170   <!-- ============================== public properties ==================== -->
 171
 172
 173
 174     <a id="Roo.UpdateManager-props"></a>
 175
 176
 177
 178
 179
 180      <table cellspacing="0" class="member-table">
 181       <caption class="Empty">Public Properties - Has None</caption>
 182      </table>
 183
 184
 185
 186
 187   <!-- ============================== methods summary / details ======================== -->
 188
 189
 190   <a id="Roo.UpdateManager-methods"></a>
 191         <!-- constructor?? -->
 192
 193         <!-- static's first
 194
 195
 196         -->
 197
 198         <!-- then dynamics first -->
 199
 200
 201
 202
 203
 204
 205       <table cellspacing="0" class="member-table">
 206       <caption>Public Methods</caption>
 207         <tr>
 208             <th class="sig-header" colspan="2">Method</th>
 209             <th class="msource-header">Defined By</th>
 210
 211         </tr>
 212
 213
 214
 215
 216
 217
 218
 219           <tr class="method-row config-row-alt0 expandable notInherited">
 220             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 221
 222
 223             <td class="sig">
 224                 <a id="Roo-method-UpdateManager"   name=".UpdateManager"></a>
 225                 <div class="fixedFont">
 226                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">UpdateManager</b>
 227
 228                                  (<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>)
 229
 230
 231
 232                 </div>
 233                 <div class="mdesc">
 234
 235
 236                         <div class="short">Create a new Roo.UpdateManager</div>
 237
 238
 239                     <div class="long">
 240
 241
 242
 243                                 Create a new Roo.UpdateManager
 244
 245
 246                                 <dl class="detailList">
 247                                 <dt class="heading">Parameters:</dt>
 248
 249                                         <dt>
 250                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 251
 252                                         </dt>
 253                                         <dd>The element to update</dd>
 254
 255                                         <dt>
 256                                                 <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>
 257
 258                                         </dt>
 259                                         <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>
 260
 261                                 </dl>
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273                     </div>
 274                 </div>
 275
 276             </td>
 277             <td class="msource">
 278                 &nbsp;
 279             </td>
 280         </tr>
 281
 282
 283           <tr class="method-row config-row-alt1 expandable notInherited">
 284             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 285
 286
 287             <td class="sig">
 288                 <a id="Roo.UpdateManager-method-updateElement"   name=".updateElement"></a>
 289                 <div class="fixedFont">
 290                         <span class="attributes">Roo.UpdateManager.</span><b class="itemname">updateElement</b>
 291
 292                                  (<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>)
 293
 294
 295
 296                 </div>
 297                 <div class="mdesc">
 298
 299                    <div class="short">Static convenience method.</div>
 300
 301
 302
 303                     <div class="long">
 304
 305                                 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>
 306
 307
 308
 309
 310
 311
 312                                 <dl class="detailList">
 313                                 <dt class="heading">Parameters:</dt>
 314
 315                                         <dt>
 316                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>el</b>
 317
 318                                         </dt>
 319                                         <dd>The element to update</dd>
 320
 321                                         <dt>
 322                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>url</b>
 323
 324                                         </dt>
 325                                         <dd>The url</dd>
 326
 327                                         <dt>
 328                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object</span>  <b>params</b>
 329
 330                                         </dt>
 331                                         <dd>(optional) Url encoded param string or an object of name/value pairs</dd>
 332
 333                                         <dt>
 334                                                 <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>
 335
 336                                         </dt>
 337                                         <dd>(optional) A config object with any of the UpdateManager properties you want to set - for example: {disableCaching:true, indicatorText: "Loading data..."}</dd>
 338
 339                                 </dl>
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351                     </div>
 352                 </div>
 353
 354             </td>
 355             <td class="msource">
 356
 357                         Roo.UpdateManager
 358                 &nbsp;
 359             </td>
 360         </tr>
 361
 362
 363           <tr class="method-row config-row-alt0 expandable notInherited">
 364             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 365
 366
 367             <td class="sig">
 368                 <a id="Roo.UpdateManager-method-abort"   name=".abort"></a>
 369                 <div class="fixedFont">
 370                         <span class="attributes"></span><b class="itemname">abort</b>
 371
 372                                  ()
 373
 374
 375
 376                 </div>
 377                 <div class="mdesc">
 378
 379                    <div class="short">Aborts the executing transaction</div>
 380
 381
 382
 383                     <div class="long">
 384
 385                                 Aborts the executing transaction
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402                     </div>
 403                 </div>
 404
 405             </td>
 406             <td class="msource">
 407
 408                         Roo.UpdateManager
 409                 &nbsp;
 410             </td>
 411         </tr>
 412
 413
 414           <tr class="method-row config-row-alt1 expandable">
 415             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 416
 417
 418             <td class="sig">
 419                 <a id="Roo.util.Observable-method-addEvents"   name=".addEvents"></a>
 420                 <div class="fixedFont">
 421                         <span class="attributes"></span><b class="itemname">addEvents</b>
 422
 423                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
 424
 425
 426
 427                 </div>
 428                 <div class="mdesc">
 429
 430                    <div class="short">Used to define events on this Observable</div>
 431
 432
 433
 434                     <div class="long">
 435
 436                                 Used to define events on this Observable
 437
 438
 439
 440
 441
 442
 443                                 <dl class="detailList">
 444                                 <dt class="heading">Parameters:</dt>
 445
 446                                         <dt>
 447                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>object</b>
 448
 449                                         </dt>
 450                                         <dd>The object with the events defined</dd>
 451
 452                                 </dl>
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464                     </div>
 465                 </div>
 466
 467             </td>
 468             <td class="msource">
 469
 470                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 471                 &nbsp;
 472             </td>
 473         </tr>
 474
 475
 476           <tr class="method-row config-row-alt0 expandable">
 477             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 478
 479
 480             <td class="sig">
 481                 <a id="Roo.util.Observable-method-addListener"   name=".addListener"></a>
 482                 <div class="fixedFont">
 483                         <span class="attributes"></span><b class="itemname">addListener</b>
 484
 485                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</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:Object">Object</a> <B><i>options</i></B>)
 486
 487
 488
 489                 </div>
 490                 <div class="mdesc">
 491
 492                    <div class="short">Appends an event handler to this component</div>
 493
 494
 495
 496                     <div class="long">
 497
 498                                 Appends an event handler to this component
 499
 500
 501
 502
 503
 504
 505                                 <dl class="detailList">
 506                                 <dt class="heading">Parameters:</dt>
 507
 508                                         <dt>
 509                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 510
 511                                         </dt>
 512                                         <dd>The type of event to listen for</dd>
 513
 514                                         <dt>
 515                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 516
 517                                         </dt>
 518                                         <dd>The method the event invokes</dd>
 519
 520                                         <dt>
 521                                                 <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>
 522
 523                                         </dt>
 524                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 525
 526                                         <dt>
 527                                                 <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>
 528
 529                                         </dt>
 530                                         <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/>             <pre><code><br/>                el.on('click', this.onClick, this, {<br/>                       single: true,<br/>              delay: 100,<br/>                forumId: 4<br/>         });<br/>                </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/>               el.on({<br/>                    'click': {<br/>                 fn: this.onClick,<br/>                  scope: this,<br/>                       delay: 100<br/>                 }, <br/>                'mouseover': {<br/>                     fn: this.onMouseOver,<br/>                      scope: this<br/>                },<br/>                 'mouseout': {<br/>                      fn: this.onMouseOut,<br/>                       scope: this<br/>                }<br/>          });<br/>                </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/>        <pre><code><br/>                el.on({<br/>                    'click': this.onClick,<br/>             'mouseover': this.onMouseOver,<br/>             'mouseout': this.onMouseOut,<br/>               scope: this<br/>                });<br/>                </code></pre></dd>
 531
 532                                 </dl>
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544                     </div>
 545                 </div>
 546
 547             </td>
 548             <td class="msource">
 549
 550                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 551                 &nbsp;
 552             </td>
 553         </tr>
 554
 555
 556           <tr class="method-row config-row-alt1 expandable">
 557             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 558
 559
 560             <td class="sig">
 561                 <a id="Roo.util.Observable-method-fireEvent"   name=".fireEvent"></a>
 562                 <div class="fixedFont">
 563                         <span class="attributes"></span><b class="itemname">fireEvent</b>
 564
 565                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
 566
 567
 568                                          :
 569
 570
 571                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 572
 573
 574
 575
 576
 577                 </div>
 578                 <div class="mdesc">
 579
 580                    <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
 581
 582
 583
 584                     <div class="long">
 585
 586                                 Fires the specified event with the passed parameters (minus the event name).
 587
 588
 589
 590
 591
 592
 593                                 <dl class="detailList">
 594                                 <dt class="heading">Parameters:</dt>
 595
 596                                         <dt>
 597                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 598
 599                                         </dt>
 600                                         <dd></dd>
 601
 602                                         <dt>
 603                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span>  <b>args</b>
 604
 605                                         </dt>
 606                                         <dd>Variable number of parameters are passed to handlers</dd>
 607
 608                                 </dl>
 609
 610
 611
 612
 613
 614                                 <dl class="detailList">
 615                                 <dt class="heading">Returns:</dt>
 616
 617                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  returns false if any of the handlers return false otherwise it returns true</dd>
 618
 619                                 </dl>
 620
 621
 622
 623
 624
 625
 626
 627                     </div>
 628                 </div>
 629
 630             </td>
 631             <td class="msource">
 632
 633                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 634                 &nbsp;
 635             </td>
 636         </tr>
 637
 638
 639           <tr class="method-row config-row-alt0 expandable notInherited">
 640             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 641
 642
 643             <td class="sig">
 644                 <a id="Roo.UpdateManager-method-formUpdate"   name=".formUpdate"></a>
 645                 <div class="fixedFont">
 646                         <span class="attributes"></span><b class="itemname">formUpdate</b>
 647
 648                                  (<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>)
 649
 650
 651
 652                 </div>
 653                 <div class="mdesc">
 654
 655                    <div class="short">Performs an async form post, updating this element with the response.</div>
 656
 657
 658
 659                     <div class="long">
 660
 661                                 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.
 662
 663
 664
 665
 666
 667
 668                                 <dl class="detailList">
 669                                 <dt class="heading">Parameters:</dt>
 670
 671                                         <dt>
 672                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement</span>  <b>form</b>
 673
 674                                         </dt>
 675                                         <dd>The form Id or form element</dd>
 676
 677                                         <dt>
 678                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>url</b>
 679
 680                                         </dt>
 681                                         <dd>(optional) The url to pass the form to. If omitted the action attribute on the form will be used.</dd>
 682
 683                                         <dt>
 684                                                 <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>
 685
 686                                         </dt>
 687                                         <dd>(optional) Whether to try to reset the form after the update</dd>
 688
 689                                         <dt>
 690                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>callback</b>
 691
 692                                         </dt>
 693                                         <dd>(optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse)</dd>
 694
 695                                 </dl>
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707                     </div>
 708                 </div>
 709
 710             </td>
 711             <td class="msource">
 712
 713                         Roo.UpdateManager
 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.UpdateManager-method-getEl"   name=".getEl"></a>
 725                 <div class="fixedFont">
 726                         <span class="attributes"></span><b class="itemname">getEl</b>
 727
 728                                  ()
 729
 730
 731                                          :
 732
 733
 734                                                 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
 735
 736
 737
 738
 739
 740                 </div>
 741                 <div class="mdesc">
 742
 743                    <div class="short">Get the Element this UpdateManager is bound to</div>
 744
 745
 746
 747                     <div class="long">
 748
 749                                 Get the Element this UpdateManager is bound to
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760                                 <dl class="detailList">
 761                                 <dt class="heading">Returns:</dt>
 762
 763                                         <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span>  The element</dd>
 764
 765                                 </dl>
 766
 767
 768
 769
 770
 771
 772
 773                     </div>
 774                 </div>
 775
 776             </td>
 777             <td class="msource">
 778
 779                         Roo.UpdateManager
 780                 &nbsp;
 781             </td>
 782         </tr>
 783
 784
 785           <tr class="method-row config-row-alt0 expandable">
 786             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 787
 788
 789             <td class="sig">
 790                 <a id="Roo.util.Observable-method-hasListener"   name=".hasListener"></a>
 791                 <div class="fixedFont">
 792                         <span class="attributes"></span><b class="itemname">hasListener</b>
 793
 794                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
 795
 796
 797                                          :
 798
 799
 800                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 801
 802
 803
 804
 805
 806                 </div>
 807                 <div class="mdesc">
 808
 809                    <div class="short">Checks to see if this object has any listeners for a specified event</div>
 810
 811
 812
 813                     <div class="long">
 814
 815                                 Checks to see if this object has any listeners for a specified event
 816
 817
 818
 819
 820
 821
 822                                 <dl class="detailList">
 823                                 <dt class="heading">Parameters:</dt>
 824
 825                                         <dt>
 826                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 827
 828                                         </dt>
 829                                         <dd>The name of the event to check for</dd>
 830
 831                                 </dl>
 832
 833
 834
 835
 836
 837                                 <dl class="detailList">
 838                                 <dt class="heading">Returns:</dt>
 839
 840                                         <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 event is being listened for, else false</dd>
 841
 842                                 </dl>
 843
 844
 845
 846
 847
 848
 849
 850                     </div>
 851                 </div>
 852
 853             </td>
 854             <td class="msource">
 855
 856                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 857                 &nbsp;
 858             </td>
 859         </tr>
 860
 861
 862           <tr class="method-row config-row-alt1 expandable notInherited">
 863             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 864
 865
 866             <td class="sig">
 867                 <a id="Roo.UpdateManager-method-isUpdating"   name=".isUpdating"></a>
 868                 <div class="fixedFont">
 869                         <span class="attributes"></span><b class="itemname">isUpdating</b>
 870
 871                                  ()
 872
 873
 874                                          :
 875
 876
 877                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 878
 879
 880
 881
 882
 883                 </div>
 884                 <div class="mdesc">
 885
 886                    <div class="short">Returns true if an update is in progress</div>
 887
 888
 889
 890                     <div class="long">
 891
 892                                 Returns true if an update is in progress
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903                                 <dl class="detailList">
 904                                 <dt class="heading">Returns:</dt>
 905
 906                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
 907
 908                                 </dl>
 909
 910
 911
 912
 913
 914
 915
 916                     </div>
 917                 </div>
 918
 919             </td>
 920             <td class="msource">
 921
 922                         Roo.UpdateManager
 923                 &nbsp;
 924             </td>
 925         </tr>
 926
 927
 928           <tr class="method-row config-row-alt0 expandable">
 929             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 930
 931
 932             <td class="sig">
 933                 <a id="Roo.util.Observable-method-on"   name=".on"></a>
 934                 <div class="fixedFont">
 935                         <span class="attributes"></span><b class="itemname">on</b>
 936
 937                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</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:Object">Object</a> <B><i>options</i></B>)
 938
 939
 940
 941                 </div>
 942                 <div class="mdesc">
 943
 944                    <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
 945
 946
 947
 948                     <div class="long">
 949
 950                                 Appends an event handler to this element (shorthand for addListener)
 951
 952
 953
 954
 955
 956
 957                                 <dl class="detailList">
 958                                 <dt class="heading">Parameters:</dt>
 959
 960                                         <dt>
 961                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 962
 963                                         </dt>
 964                                         <dd>The type of event to listen for</dd>
 965
 966                                         <dt>
 967                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 968
 969                                         </dt>
 970                                         <dd>The method the event invokes</dd>
 971
 972                                         <dt>
 973                                                 <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>
 974
 975                                         </dt>
 976                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 977
 978                                         <dt>
 979                                                 <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>
 980
 981                                         </dt>
 982                                         <dd>(optional)</dd>
 983
 984                                 </dl>
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996                     </div>
 997                 </div>
 998
 999             </td>
1000             <td class="msource">
1001
1002                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1003                 &nbsp;
1004             </td>
1005         </tr>
1006
1007
1008           <tr class="method-row config-row-alt1 expandable">
1009             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1010
1011
1012             <td class="sig">
1013                 <a id="Roo.util.Observable-method-purgeListeners"   name=".purgeListeners"></a>
1014                 <div class="fixedFont">
1015                         <span class="attributes"></span><b class="itemname">purgeListeners</b>
1016
1017                                  ()
1018
1019
1020
1021                 </div>
1022                 <div class="mdesc">
1023
1024                    <div class="short">Removes all listeners for this object</div>
1025
1026
1027
1028                     <div class="long">
1029
1030                                 Removes all listeners for this object
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047                     </div>
1048                 </div>
1049
1050             </td>
1051             <td class="msource">
1052
1053                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1054                 &nbsp;
1055             </td>
1056         </tr>
1057
1058
1059           <tr class="method-row config-row-alt0 expandable notInherited">
1060             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1061
1062
1063             <td class="sig">
1064                 <a id="Roo.UpdateManager-method-refresh"   name=".refresh"></a>
1065                 <div class="fixedFont">
1066                         <span class="attributes"></span><b class="itemname">refresh</b>
1067
1068                                  (<a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>callback</i></B>)
1069
1070
1071
1072                 </div>
1073                 <div class="mdesc">
1074
1075                    <div class="short">Refresh the element with the last used url or defaultUrl.</div>
1076
1077
1078
1079                     <div class="long">
1080
1081                                 Refresh the element with the last used url or defaultUrl. If there is no url, it returns immediately
1082
1083
1084
1085
1086
1087
1088                                 <dl class="detailList">
1089                                 <dt class="heading">Parameters:</dt>
1090
1091                                         <dt>
1092                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>callback</b>
1093
1094                                         </dt>
1095                                         <dd>(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)</dd>
1096
1097                                 </dl>
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109                     </div>
1110                 </div>
1111
1112             </td>
1113             <td class="msource">
1114
1115                         Roo.UpdateManager
1116                 &nbsp;
1117             </td>
1118         </tr>
1119
1120
1121           <tr class="method-row config-row-alt1 expandable">
1122             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1123
1124
1125             <td class="sig">
1126                 <a id="Roo.util.Observable-method-removeListener"   name=".removeListener"></a>
1127                 <div class="fixedFont">
1128                         <span class="attributes"></span><b class="itemname">removeListener</b>
1129
1130                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</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>)
1131
1132
1133
1134                 </div>
1135                 <div class="mdesc">
1136
1137                    <div class="short">Removes a listener</div>
1138
1139
1140
1141                     <div class="long">
1142
1143                                 Removes a listener
1144
1145
1146
1147
1148
1149
1150                                 <dl class="detailList">
1151                                 <dt class="heading">Parameters:</dt>
1152
1153                                         <dt>
1154                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1155
1156                                         </dt>
1157                                         <dd>The type of event to listen for</dd>
1158
1159                                         <dt>
1160                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1161
1162                                         </dt>
1163                                         <dd>The handler to remove</dd>
1164
1165                                         <dt>
1166                                                 <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>
1167
1168                                         </dt>
1169                                         <dd>(optional) The scope (this object) for the handler</dd>
1170
1171                                 </dl>
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183                     </div>
1184                 </div>
1185
1186             </td>
1187             <td class="msource">
1188
1189                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1190                 &nbsp;
1191             </td>
1192         </tr>
1193
1194
1195           <tr class="method-row config-row-alt0 expandable notInherited">
1196             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1197
1198
1199             <td class="sig">
1200                 <a id="Roo.UpdateManager-method-setDefaultUrl"   name=".setDefaultUrl"></a>
1201                 <div class="fixedFont">
1202                         <span class="attributes"></span><b class="itemname">setDefaultUrl</b>
1203
1204                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Function <B><i>defaultUrl</i></B>)
1205
1206
1207
1208                 </div>
1209                 <div class="mdesc">
1210
1211                    <div class="short">Set the defaultUrl used for updates</div>
1212
1213
1214
1215                     <div class="long">
1216
1217                                 Set the defaultUrl used for updates
1218
1219
1220
1221
1222
1223
1224                                 <dl class="detailList">
1225                                 <dt class="heading">Parameters:</dt>
1226
1227                                         <dt>
1228                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Function</span>  <b>defaultUrl</b>
1229
1230                                         </dt>
1231                                         <dd>The url or a function to call to get the url</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
1251                         Roo.UpdateManager
1252                 &nbsp;
1253             </td>
1254         </tr>
1255
1256
1257           <tr class="method-row config-row-alt1 expandable notInherited">
1258             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1259
1260
1261             <td class="sig">
1262                 <a id="Roo.UpdateManager-method-setRenderer"   name=".setRenderer"></a>
1263                 <div class="fixedFont">
1264                         <span class="attributes"></span><b class="itemname">setRenderer</b>
1265
1266                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>renderer</i></B>)
1267
1268
1269
1270                 </div>
1271                 <div class="mdesc">
1272
1273                    <div class="short">Set the content renderer for this UpdateManager.</div>
1274
1275
1276
1277                     <div class="long">
1278
1279                                 Set the content renderer for this UpdateManager. See {<b>link</b> Roo.UpdateManager.BasicRenderer<b>render</b>} for more details.
1280
1281
1282
1283
1284
1285
1286                                 <dl class="detailList">
1287                                 <dt class="heading">Parameters:</dt>
1288
1289                                         <dt>
1290                                                 <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>
1291
1292                                         </dt>
1293                                         <dd>The object implementing the render() method</dd>
1294
1295                                 </dl>
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307                     </div>
1308                 </div>
1309
1310             </td>
1311             <td class="msource">
1312
1313                         Roo.UpdateManager
1314                 &nbsp;
1315             </td>
1316         </tr>
1317
1318
1319           <tr class="method-row config-row-alt0 expandable notInherited">
1320             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1321
1322
1323             <td class="sig">
1324                 <a id="Roo.UpdateManager-method-showLoading"   name=".showLoading"></a>
1325                 <div class="fixedFont">
1326                         <span class="attributes"></span><b class="itemname">showLoading</b>
1327
1328                                  ()
1329
1330
1331
1332                 </div>
1333                 <div class="mdesc">
1334
1335                    <div class="short">Called to update the element to "Loading" state.</div>
1336
1337
1338
1339                     <div class="long">
1340
1341                                 Called to update the element to "Loading" state. Override to perform custom action.
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358                     </div>
1359                 </div>
1360
1361             </td>
1362             <td class="msource">
1363
1364                         Roo.UpdateManager
1365                 &nbsp;
1366             </td>
1367         </tr>
1368
1369
1370           <tr class="method-row config-row-alt1 expandable notInherited">
1371             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1372
1373
1374             <td class="sig">
1375                 <a id="Roo.UpdateManager-method-startAutoRefresh"   name=".startAutoRefresh"></a>
1376                 <div class="fixedFont">
1377                         <span class="attributes"></span><b class="itemname">startAutoRefresh</b>
1378
1379                                  (<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>)
1380
1381
1382
1383                 </div>
1384                 <div class="mdesc">
1385
1386                    <div class="short">Set this element to auto refresh.</div>
1387
1388
1389
1390                     <div class="long">
1391
1392                                 Set this element to auto refresh.
1393
1394
1395
1396
1397
1398
1399                                 <dl class="detailList">
1400                                 <dt class="heading">Parameters:</dt>
1401
1402                                         <dt>
1403                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>interval</b>
1404
1405                                         </dt>
1406                                         <dd>How often to update (in seconds).</dd>
1407
1408                                         <dt>
1409                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Function</span>  <b>url</b>
1410
1411                                         </dt>
1412                                         <dd>(optional) The url for this request or a function to call to get the url (Defaults to the last used url)</dd>
1413
1414                                         <dt>
1415                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object</span>  <b>params</b>
1416
1417                                         </dt>
1418                                         <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>
1419
1420                                         <dt>
1421                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>callback</b>
1422
1423                                         </dt>
1424                                         <dd>(optional) Callback when transaction is complete - called with signature (oElement, bSuccess)</dd>
1425
1426                                         <dt>
1427                                                 <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>
1428
1429                                         </dt>
1430                                         <dd>(optional) Whether to execute the refresh now, or wait the interval</dd>
1431
1432                                 </dl>
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444                     </div>
1445                 </div>
1446
1447             </td>
1448             <td class="msource">
1449
1450                         Roo.UpdateManager
1451                 &nbsp;
1452             </td>
1453         </tr>
1454
1455
1456           <tr class="method-row config-row-alt0 expandable notInherited">
1457             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1458
1459
1460             <td class="sig">
1461                 <a id="Roo.UpdateManager-method-stopAutoRefresh"   name=".stopAutoRefresh"></a>
1462                 <div class="fixedFont">
1463                         <span class="attributes"></span><b class="itemname">stopAutoRefresh</b>
1464
1465                                  ()
1466
1467
1468
1469                 </div>
1470                 <div class="mdesc">
1471
1472                    <div class="short">Stop auto refresh on this element.</div>
1473
1474
1475
1476                     <div class="long">
1477
1478                                 Stop auto refresh on this element.
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495                     </div>
1496                 </div>
1497
1498             </td>
1499             <td class="msource">
1500
1501                         Roo.UpdateManager
1502                 &nbsp;
1503             </td>
1504         </tr>
1505
1506
1507           <tr class="method-row config-row-alt1 expandable">
1508             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1509
1510
1511             <td class="sig">
1512                 <a id="Roo.util.Observable-method-un"   name=".un"></a>
1513                 <div class="fixedFont">
1514                         <span class="attributes"></span><b class="itemname">un</b>
1515
1516                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</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>)
1517
1518
1519
1520                 </div>
1521                 <div class="mdesc">
1522
1523                    <div class="short">Removes a listener (shorthand for removeListener)</div>
1524
1525
1526
1527                     <div class="long">
1528
1529                                 Removes a listener (shorthand for removeListener)
1530
1531
1532
1533
1534
1535
1536                                 <dl class="detailList">
1537                                 <dt class="heading">Parameters:</dt>
1538
1539                                         <dt>
1540                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1541
1542                                         </dt>
1543                                         <dd>The type of event to listen for</dd>
1544
1545                                         <dt>
1546                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1547
1548                                         </dt>
1549                                         <dd>The handler to remove</dd>
1550
1551                                         <dt>
1552                                                 <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>
1553
1554                                         </dt>
1555                                         <dd>(optional) The scope (this object) for the handler</dd>
1556
1557                                 </dl>
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569                     </div>
1570                 </div>
1571
1572             </td>
1573             <td class="msource">
1574
1575                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1576                 &nbsp;
1577             </td>
1578         </tr>
1579
1580
1581           <tr class="method-row config-row-alt0 expandable notInherited">
1582             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1583
1584
1585             <td class="sig">
1586                 <a id="Roo.UpdateManager-method-update"   name=".update"></a>
1587                 <div class="fixedFont">
1588                         <span class="attributes"></span><b class="itemname">update</b>
1589
1590                                  (<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>)
1591
1592
1593
1594                 </div>
1595                 <div class="mdesc">
1596
1597                    <div class="short">Performs an async request, updating this element with the response.</div>
1598
1599
1600
1601                     <div class="long">
1602
1603                                 Performs an async request, updating this element with the response. If params are specified it uses POST, otherwise it uses GET.
1604
1605
1606
1607
1608
1609
1610                                 <dl class="detailList">
1611                                 <dt class="heading">Parameters:</dt>
1612
1613                                         <dt>
1614                                                 <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>
1615
1616                                         </dt>
1617                                         <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>
1618
1619                                         <dt>
1620                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object</span>  <b>params</b>
1621
1622                                         </dt>
1623                                         <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>
1624
1625                                         <dt>
1626                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>callback</b>
1627
1628                                         </dt>
1629                                         <dd>(optional) Callback when transaction is complete - called with signature (oElement, bSuccess, oResponse)</dd>
1630
1631                                         <dt>
1632                                                 <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>
1633
1634                                         </dt>
1635                                         <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>
1636
1637                                 </dl>
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649                     </div>
1650                 </div>
1651
1652             </td>
1653             <td class="msource">
1654
1655                         Roo.UpdateManager
1656                 &nbsp;
1657             </td>
1658         </tr>
1659
1660
1661     </table>
1662
1663
1664   <!-- ============================== events summary / details ======================== -->
1665
1666
1667   <a id="Roo.UpdateManager-events"></a>
1668
1669
1670
1671
1672
1673
1674
1675
1676       <table cellspacing="0" class="member-table">
1677                 <caption>Events</caption>
1678               <thead>
1679                 <tr>
1680                     <th class="sig-header" colspan="2">Event</th>
1681                     <th class="msource-header">Defined By</th>
1682
1683                 </tr>
1684               </thead>
1685
1686
1687
1688
1689
1690           <tr class="method-row expandable config-row-alt0 notInherited">
1691             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1692
1693             <td class="sig">
1694                 <a id="Roo.UpdateManager-event-*beforeupdate"></a>
1695
1696                <div class="fixedFont">
1697                 <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>)
1698
1699                 </div>
1700
1701                 <div class="mdesc">
1702
1703                    <div class="short">Fired before an update is made, return false from your handler and the update is cancelled.
1704
1705                 </div>
1706
1707                     <div class="long">
1708
1709                         Fired before an update is made, return false from your handler and the update is cancelled.
1710
1711
1712
1713
1714
1715                                 <dl class="detailList">
1716                                 <dt class="heading">Parameters:</dt>
1717
1718                                         <dt>
1719                                                 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> <b>el</b>
1720
1721                                         </dt>
1722                                         <dd></dd>
1723
1724                                         <dt>
1725                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object/Function</span> <b>url</b>
1726
1727                                         </dt>
1728                                         <dd></dd>
1729
1730                                         <dt>
1731                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object</span> <b>params</b>
1732
1733                                         </dt>
1734                                         <dd></dd>
1735
1736                                 </dl>
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748                     </div>
1749                 </div>
1750
1751             </td>
1752             <td class="msource">
1753                 Roo.UpdateManager
1754             </td>
1755         </tr>
1756
1757           <tr class="method-row expandable config-row-alt1 notInherited">
1758             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1759
1760             <td class="sig">
1761                 <a id="Roo.UpdateManager-event-*failure"></a>
1762
1763                <div class="fixedFont">
1764                 <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>)
1765
1766                 </div>
1767
1768                 <div class="mdesc">
1769
1770                    <div class="short">Fired on update failure.
1771
1772                 </div>
1773
1774                     <div class="long">
1775
1776                         Fired on update failure.
1777
1778
1779
1780
1781
1782                                 <dl class="detailList">
1783                                 <dt class="heading">Parameters:</dt>
1784
1785                                         <dt>
1786                                                 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> <b>el</b>
1787
1788                                         </dt>
1789                                         <dd></dd>
1790
1791                                         <dt>
1792                                                 <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>
1793
1794                                         </dt>
1795                                         <dd>The response Object</dd>
1796
1797                                 </dl>
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809                     </div>
1810                 </div>
1811
1812             </td>
1813             <td class="msource">
1814                 Roo.UpdateManager
1815             </td>
1816         </tr>
1817
1818           <tr class="method-row expandable config-row-alt0 notInherited">
1819             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1820
1821             <td class="sig">
1822                 <a id="Roo.UpdateManager-event-*update"></a>
1823
1824                <div class="fixedFont">
1825                 <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>)
1826
1827                 </div>
1828
1829                 <div class="mdesc">
1830
1831                    <div class="short">Fired after successful update is made.
1832
1833                 </div>
1834
1835                     <div class="long">
1836
1837                         Fired after successful update is made.
1838
1839
1840
1841
1842
1843                                 <dl class="detailList">
1844                                 <dt class="heading">Parameters:</dt>
1845
1846                                         <dt>
1847                                                 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> <b>el</b>
1848
1849                                         </dt>
1850                                         <dd></dd>
1851
1852                                         <dt>
1853                                                 <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>
1854
1855                                         </dt>
1856                                         <dd>The response Object</dd>
1857
1858                                 </dl>
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870                     </div>
1871                 </div>
1872
1873             </td>
1874             <td class="msource">
1875                 Roo.UpdateManager
1876             </td>
1877         </tr>
1878
1879
1880     </table>
1881
1882
1883
1884
1885
1886 <!-- ============================== footer ================================= -->
1887                 <div class="fineprint" style="clear:both">
1888
1889                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 13 2018 14:10:53 GMT+0800 (HKT)
1890                         Based on
1891                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1892                 </div>
1893         </body>
1894 </html>