git.roojs.org Git - roojs1/blob - docs.old/symbols/Roo.Document.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.Document</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.Document-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.Document-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.Document-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.Document-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.Document
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.Document
  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_Document.js.html">Roo/Document.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">Document</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         This is a convience class to wrap up the main document loading code.. , rather than adding Roo.onReady(......)
  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.Document';">[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.Document.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.Document-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.Document-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.Document-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-Document"   name=".Document"></a>
 225                 <div class="fixedFont">
 226                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">Document</b>
 227
 228                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 229
 230
 231
 232                 </div>
 233                 <div class="mdesc">
 234
 235
 236                         <div class="short">Create a new Roo.Document</div>
 237
 238
 239                     <div class="long">
 240
 241
 242
 243                                 Create a new Roo.Document
 244
 245
 246                                 <dl class="detailList">
 247                                 <dt class="heading">Parameters:</dt>
 248
 249                                         <dt>
 250                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>config</b>
 251
 252                                         </dt>
 253                                         <dd>the methods and properties of the 'base' class for the application.<br/><br/> Generic Page handler - implement this to start your app..<br/><br/>eg.<br/> MyProject = new Roo.Document({<br/>        events : {<br/>            'load' : true // your events..<br/>        },<br/>        listeners : {<br/>            'ready' : function() {<br/>                // fired on Roo.onReady()<br/>            }<br/>        }</dd>
 254
 255                                 </dl>
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267                     </div>
 268                 </div>
 269
 270             </td>
 271             <td class="msource">
 272                 &nbsp;
 273             </td>
 274         </tr>
 275
 276
 277           <tr class="method-row config-row-alt1 expandable">
 278             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 279
 280
 281             <td class="sig">
 282                 <a id="Roo.util.Observable-method-addEvents"   name=".addEvents"></a>
 283                 <div class="fixedFont">
 284                         <span class="attributes"></span><b class="itemname">addEvents</b>
 285
 286                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
 287
 288
 289
 290                 </div>
 291                 <div class="mdesc">
 292
 293                    <div class="short">Used to define events on this Observable</div>
 294
 295
 296
 297                     <div class="long">
 298
 299                                 Used to define events on this Observable
 300
 301
 302
 303
 304
 305
 306                                 <dl class="detailList">
 307                                 <dt class="heading">Parameters:</dt>
 308
 309                                         <dt>
 310                                                 <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>
 311
 312                                         </dt>
 313                                         <dd>The object with the events defined</dd>
 314
 315                                 </dl>
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327                     </div>
 328                 </div>
 329
 330             </td>
 331             <td class="msource">
 332
 333                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 334                 &nbsp;
 335             </td>
 336         </tr>
 337
 338
 339           <tr class="method-row config-row-alt0 expandable">
 340             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 341
 342
 343             <td class="sig">
 344                 <a id="Roo.util.Observable-method-addListener"   name=".addListener"></a>
 345                 <div class="fixedFont">
 346                         <span class="attributes"></span><b class="itemname">addListener</b>
 347
 348                                  (<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>)
 349
 350
 351
 352                 </div>
 353                 <div class="mdesc">
 354
 355                    <div class="short">Appends an event handler to this component</div>
 356
 357
 358
 359                     <div class="long">
 360
 361                                 Appends an event handler to this component
 362
 363
 364
 365
 366
 367
 368                                 <dl class="detailList">
 369                                 <dt class="heading">Parameters:</dt>
 370
 371                                         <dt>
 372                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 373
 374                                         </dt>
 375                                         <dd>The type of event to listen for</dd>
 376
 377                                         <dt>
 378                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 379
 380                                         </dt>
 381                                         <dd>The method the event invokes</dd>
 382
 383                                         <dt>
 384                                                 <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>
 385
 386                                         </dt>
 387                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 388
 389                                         <dt>
 390                                                 <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>
 391
 392                                         </dt>
 393                                         <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>
 394
 395                                 </dl>
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407                     </div>
 408                 </div>
 409
 410             </td>
 411             <td class="msource">
 412
 413                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 414                 &nbsp;
 415             </td>
 416         </tr>
 417
 418
 419           <tr class="method-row config-row-alt1 expandable">
 420             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 421
 422
 423             <td class="sig">
 424                 <a id="Roo.util.Observable-method-fireEvent"   name=".fireEvent"></a>
 425                 <div class="fixedFont">
 426                         <span class="attributes"></span><b class="itemname">fireEvent</b>
 427
 428                                  (<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>)
 429
 430
 431                                          :
 432
 433
 434                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 435
 436
 437
 438
 439
 440                 </div>
 441                 <div class="mdesc">
 442
 443                    <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
 444
 445
 446
 447                     <div class="long">
 448
 449                                 Fires the specified event with the passed parameters (minus the event name).
 450
 451
 452
 453
 454
 455
 456                                 <dl class="detailList">
 457                                 <dt class="heading">Parameters:</dt>
 458
 459                                         <dt>
 460                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 461
 462                                         </dt>
 463                                         <dd></dd>
 464
 465                                         <dt>
 466                                                 <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>
 467
 468                                         </dt>
 469                                         <dd>Variable number of parameters are passed to handlers</dd>
 470
 471                                 </dl>
 472
 473
 474
 475
 476
 477                                 <dl class="detailList">
 478                                 <dt class="heading">Returns:</dt>
 479
 480                                         <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>
 481
 482                                 </dl>
 483
 484
 485
 486
 487
 488
 489
 490                     </div>
 491                 </div>
 492
 493             </td>
 494             <td class="msource">
 495
 496                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 497                 &nbsp;
 498             </td>
 499         </tr>
 500
 501
 502           <tr class="method-row config-row-alt0 expandable">
 503             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 504
 505
 506             <td class="sig">
 507                 <a id="Roo.util.Observable-method-hasListener"   name=".hasListener"></a>
 508                 <div class="fixedFont">
 509                         <span class="attributes"></span><b class="itemname">hasListener</b>
 510
 511                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
 512
 513
 514                                          :
 515
 516
 517                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 518
 519
 520
 521
 522
 523                 </div>
 524                 <div class="mdesc">
 525
 526                    <div class="short">Checks to see if this object has any listeners for a specified event</div>
 527
 528
 529
 530                     <div class="long">
 531
 532                                 Checks to see if this object has any listeners for a specified event
 533
 534
 535
 536
 537
 538
 539                                 <dl class="detailList">
 540                                 <dt class="heading">Parameters:</dt>
 541
 542                                         <dt>
 543                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 544
 545                                         </dt>
 546                                         <dd>The name of the event to check for</dd>
 547
 548                                 </dl>
 549
 550
 551
 552
 553
 554                                 <dl class="detailList">
 555                                 <dt class="heading">Returns:</dt>
 556
 557                                         <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>
 558
 559                                 </dl>
 560
 561
 562
 563
 564
 565
 566
 567                     </div>
 568                 </div>
 569
 570             </td>
 571             <td class="msource">
 572
 573                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 574                 &nbsp;
 575             </td>
 576         </tr>
 577
 578
 579           <tr class="method-row config-row-alt1 expandable">
 580             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 581
 582
 583             <td class="sig">
 584                 <a id="Roo.util.Observable-method-on"   name=".on"></a>
 585                 <div class="fixedFont">
 586                         <span class="attributes"></span><b class="itemname">on</b>
 587
 588                                  (<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>)
 589
 590
 591
 592                 </div>
 593                 <div class="mdesc">
 594
 595                    <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
 596
 597
 598
 599                     <div class="long">
 600
 601                                 Appends an event handler to this element (shorthand for addListener)
 602
 603
 604
 605
 606
 607
 608                                 <dl class="detailList">
 609                                 <dt class="heading">Parameters:</dt>
 610
 611                                         <dt>
 612                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 613
 614                                         </dt>
 615                                         <dd>The type of event to listen for</dd>
 616
 617                                         <dt>
 618                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 619
 620                                         </dt>
 621                                         <dd>The method the event invokes</dd>
 622
 623                                         <dt>
 624                                                 <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>
 625
 626                                         </dt>
 627                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 628
 629                                         <dt>
 630                                                 <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>
 631
 632                                         </dt>
 633                                         <dd>(optional)</dd>
 634
 635                                 </dl>
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647                     </div>
 648                 </div>
 649
 650             </td>
 651             <td class="msource">
 652
 653                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 654                 &nbsp;
 655             </td>
 656         </tr>
 657
 658
 659           <tr class="method-row config-row-alt0 expandable">
 660             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 661
 662
 663             <td class="sig">
 664                 <a id="Roo.util.Observable-method-purgeListeners"   name=".purgeListeners"></a>
 665                 <div class="fixedFont">
 666                         <span class="attributes"></span><b class="itemname">purgeListeners</b>
 667
 668                                  ()
 669
 670
 671
 672                 </div>
 673                 <div class="mdesc">
 674
 675                    <div class="short">Removes all listeners for this object</div>
 676
 677
 678
 679                     <div class="long">
 680
 681                                 Removes all listeners for this object
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698                     </div>
 699                 </div>
 700
 701             </td>
 702             <td class="msource">
 703
 704                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 705                 &nbsp;
 706             </td>
 707         </tr>
 708
 709
 710           <tr class="method-row config-row-alt1 expandable">
 711             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 712
 713
 714             <td class="sig">
 715                 <a id="Roo.util.Observable-method-removeListener"   name=".removeListener"></a>
 716                 <div class="fixedFont">
 717                         <span class="attributes"></span><b class="itemname">removeListener</b>
 718
 719                                  (<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>)
 720
 721
 722
 723                 </div>
 724                 <div class="mdesc">
 725
 726                    <div class="short">Removes a listener</div>
 727
 728
 729
 730                     <div class="long">
 731
 732                                 Removes a listener
 733
 734
 735
 736
 737
 738
 739                                 <dl class="detailList">
 740                                 <dt class="heading">Parameters:</dt>
 741
 742                                         <dt>
 743                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 744
 745                                         </dt>
 746                                         <dd>The type of event to listen for</dd>
 747
 748                                         <dt>
 749                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 750
 751                                         </dt>
 752                                         <dd>The handler to remove</dd>
 753
 754                                         <dt>
 755                                                 <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>
 756
 757                                         </dt>
 758                                         <dd>(optional) The scope (this object) for the handler</dd>
 759
 760                                 </dl>
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772                     </div>
 773                 </div>
 774
 775             </td>
 776             <td class="msource">
 777
 778                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 779                 &nbsp;
 780             </td>
 781         </tr>
 782
 783
 784           <tr class="method-row config-row-alt0 expandable">
 785             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 786
 787
 788             <td class="sig">
 789                 <a id="Roo.util.Observable-method-un"   name=".un"></a>
 790                 <div class="fixedFont">
 791                         <span class="attributes"></span><b class="itemname">un</b>
 792
 793                                  (<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>)
 794
 795
 796
 797                 </div>
 798                 <div class="mdesc">
 799
 800                    <div class="short">Removes a listener (shorthand for removeListener)</div>
 801
 802
 803
 804                     <div class="long">
 805
 806                                 Removes a listener (shorthand for removeListener)
 807
 808
 809
 810
 811
 812
 813                                 <dl class="detailList">
 814                                 <dt class="heading">Parameters:</dt>
 815
 816                                         <dt>
 817                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 818
 819                                         </dt>
 820                                         <dd>The type of event to listen for</dd>
 821
 822                                         <dt>
 823                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 824
 825                                         </dt>
 826                                         <dd>The handler to remove</dd>
 827
 828                                         <dt>
 829                                                 <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>
 830
 831                                         </dt>
 832                                         <dd>(optional) The scope (this object) for the handler</dd>
 833
 834                                 </dl>
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846                     </div>
 847                 </div>
 848
 849             </td>
 850             <td class="msource">
 851
 852                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 853                 &nbsp;
 854             </td>
 855         </tr>
 856
 857
 858     </table>
 859
 860
 861   <!-- ============================== events summary / details ======================== -->
 862
 863
 864   <a id="Roo.Document-events"></a>
 865
 866
 867
 868
 869
 870      <table cellspacing="0" class="member-table">
 871       <caption class="Empty">Events - Has None</caption>
 872      </table>
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882 <!-- ============================== footer ================================= -->
 883                 <div class="fineprint" style="clear:both">
 884
 885                         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)
 886                         Based on
 887                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 888                 </div>
 889         </body>
 890 </html>