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