git.roojs.org Git - roojs1/blob - docs/symbols/Roo.util.Observable.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.util.Observable</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.util.Observable-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.util.Observable-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.util.Observable-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.util.Observable-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
  38         <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
  39         -->
  40     </div>
  41
  42
  43 <!-- ============================== inheritance Block. ================================= -->
  44
  45 <!-- ============================== class title / details ============================ -->
  46
  47
  48     <h1 class="classTitle">
  49
  50                                 Class Roo.util.Observable
  51                         </h1>
  52
  53     <table cellspacing="0" class="class-summary-table">
  54
  55                 <tr><td class="label">Package:</td><td class="hd-info">Roo.util</td></tr>
  56
  57         <tr><td class="label">Defined In:</td><td class="hd-info">
  58
  59                                         <a href="./src/Roo_util_Observable.js.html">Roo/util/Observable.js</a>.
  60
  61         </td></tr>
  62         <tr><td class="label">Class:</td><td class="hd-info">Observable</td></tr>
  63
  64
  65         <tr><td class="label">Subclasses:</td><td class="hd-info">
  66                 <a href="./Roo.Ajax.html#constructor" roo:cls="Roo.Ajax.html#constructor">Roo.Ajax</a>, <a href="./Roo.BasicDialog.html#constructor" roo:cls="Roo.BasicDialog.html#constructor">Roo.BasicDialog</a>, <a href="./Roo.BasicLayoutRegion.html#constructor" roo:cls="Roo.BasicLayoutRegion.html#constructor">Roo.BasicLayoutRegion</a>, <a href="./Roo.BorderLayout.html#constructor" roo:cls="Roo.BorderLayout.html#constructor">Roo.BorderLayout</a>, <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>, <a href="./Roo.Button.html#constructor" roo:cls="Roo.Button.html#constructor">Roo.Button</a>, <a href="./Roo.ColorPalette.html#constructor" roo:cls="Roo.ColorPalette.html#constructor">Roo.ColorPalette</a>, <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>, <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>, <a href="./Roo.DatePicker.html#constructor" roo:cls="Roo.DatePicker.html#constructor">Roo.DatePicker</a>, <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>, <a href="./Roo.GridPanel.html#constructor" roo:cls="Roo.GridPanel.html#constructor">Roo.GridPanel</a>, <a href="./Roo.JsonView.html#constructor" roo:cls="Roo.JsonView.html#constructor">Roo.JsonView</a>, <a href="./Roo.LayoutDialog.html#constructor" roo:cls="Roo.LayoutDialog.html#constructor">Roo.LayoutDialog</a>, <a href="./Roo.LayoutManager.html#constructor" roo:cls="Roo.LayoutManager.html#constructor">Roo.LayoutManager</a>, <a href="./Roo.LayoutRegion.html#constructor" roo:cls="Roo.LayoutRegion.html#constructor">Roo.LayoutRegion</a>, <a href="./Roo.Login.html#constructor" roo:cls="Roo.Login.html#constructor">Roo.Login</a>, <a href="./Roo.NestedLayoutPanel.html#constructor" roo:cls="Roo.NestedLayoutPanel.html#constructor">Roo.NestedLayoutPanel</a>, <a href="./Roo.ReaderLayout.html#constructor" roo:cls="Roo.ReaderLayout.html#constructor">Roo.ReaderLayout</a>, <a href="./Roo.Resizable.html#constructor" roo:cls="Roo.Resizable.html#constructor">Roo.Resizable</a>, <a href="./Roo.SplitBar.html#constructor" roo:cls="Roo.SplitBar.html#constructor">Roo.SplitBar</a>, <a href="./Roo.SplitButton.html#constructor" roo:cls="Roo.SplitButton.html#constructor">Roo.SplitButton</a>, <a href="./Roo.SplitLayoutRegion.html#constructor" roo:cls="Roo.SplitLayoutRegion.html#constructor">Roo.SplitLayoutRegion</a>, <a href="./Roo.TabPanel.html#constructor" roo:cls="Roo.TabPanel.html#constructor">Roo.TabPanel</a>, <a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a>, <a href="./Roo.Toolbar.Button.html#constructor" roo:cls="Roo.Toolbar.Button.html#constructor">Roo.Toolbar.Button</a>, <a href="./Roo.Toolbar.SplitButton.html#constructor" roo:cls="Roo.Toolbar.SplitButton.html#constructor">Roo.Toolbar.SplitButton</a>, <a href="./Roo.TreePanel.html#constructor" roo:cls="Roo.TreePanel.html#constructor">Roo.TreePanel</a>, <a href="./Roo.UpdateManager.html#constructor" roo:cls="Roo.UpdateManager.html#constructor">Roo.UpdateManager</a>, <a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a>, <a href="./Roo.XComponent.html#constructor" roo:cls="Roo.XComponent.html#constructor">Roo.XComponent</a>, <a href="./Roo.data.Connection.html#constructor" roo:cls="Roo.data.Connection.html#constructor">Roo.data.Connection</a>, <a href="./Roo.data.JsonStore.html#constructor" roo:cls="Roo.data.JsonStore.html#constructor">Roo.data.JsonStore</a>, <a href="./Roo.data.Node.html#constructor" roo:cls="Roo.data.Node.html#constructor">Roo.data.Node</a>, <a href="./Roo.data.SimpleStore.html#constructor" roo:cls="Roo.data.SimpleStore.html#constructor">Roo.data.SimpleStore</a>, <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>, <a href="./Roo.data.Tree.html#constructor" roo:cls="Roo.data.Tree.html#constructor">Roo.data.Tree</a>, <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>, <a href="./Roo.form.Checkbox.html#constructor" roo:cls="Roo.form.Checkbox.html#constructor">Roo.form.Checkbox</a>, <a href="./Roo.form.Column.html#constructor" roo:cls="Roo.form.Column.html#constructor">Roo.form.Column</a>, <a href="./Roo.form.ComboBox.html#constructor" roo:cls="Roo.form.ComboBox.html#constructor">Roo.form.ComboBox</a>, <a href="./Roo.form.DateField.html#constructor" roo:cls="Roo.form.DateField.html#constructor">Roo.form.DateField</a>, <a href="./Roo.form.FCKeditor.html#constructor" roo:cls="Roo.form.FCKeditor.html#constructor">Roo.form.FCKeditor</a>, <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>, <a href="./Roo.form.FieldSet.html#constructor" roo:cls="Roo.form.FieldSet.html#constructor">Roo.form.FieldSet</a>, <a href="./Roo.form.Form.html#constructor" roo:cls="Roo.form.Form.html#constructor">Roo.form.Form</a>, <a href="./Roo.form.GridField.html#constructor" roo:cls="Roo.form.GridField.html#constructor">Roo.form.GridField</a>, <a href="./Roo.form.Hidden.html#constructor" roo:cls="Roo.form.Hidden.html#constructor">Roo.form.Hidden</a>, <a href="./Roo.form.Layout.html#constructor" roo:cls="Roo.form.Layout.html#constructor">Roo.form.Layout</a>, <a href="./Roo.form.NumberField.html#constructor" roo:cls="Roo.form.NumberField.html#constructor">Roo.form.NumberField</a>, <a href="./Roo.form.Radio.html#constructor" roo:cls="Roo.form.Radio.html#constructor">Roo.form.Radio</a>, <a href="./Roo.form.Row.html#constructor" roo:cls="Roo.form.Row.html#constructor">Roo.form.Row</a>, <a href="./Roo.form.TextArea.html#constructor" roo:cls="Roo.form.TextArea.html#constructor">Roo.form.TextArea</a>, <a href="./Roo.form.TextField.html#constructor" roo:cls="Roo.form.TextField.html#constructor">Roo.form.TextField</a>, <a href="./Roo.form.TriggerField.html#constructor" roo:cls="Roo.form.TriggerField.html#constructor">Roo.form.TriggerField</a>, <a href="./Roo.grid.AbstractSelectionModel.html#constructor" roo:cls="Roo.grid.AbstractSelectionModel.html#constructor">Roo.grid.AbstractSelectionModel</a>, <a href="./Roo.grid.CellSelectionModel.html#constructor" roo:cls="Roo.grid.CellSelectionModel.html#constructor">Roo.grid.CellSelectionModel</a>, <a href="./Roo.grid.ColumnModel.html#constructor" roo:cls="Roo.grid.ColumnModel.html#constructor">Roo.grid.ColumnModel</a>, <a href="./Roo.grid.EditorGrid.html#constructor" roo:cls="Roo.grid.EditorGrid.html#constructor">Roo.grid.EditorGrid</a>, <a href="./Roo.grid.Grid.html#constructor" roo:cls="Roo.grid.Grid.html#constructor">Roo.grid.Grid</a>, <a href="./Roo.grid.GridEditor.html#constructor" roo:cls="Roo.grid.GridEditor.html#constructor">Roo.grid.GridEditor</a>, <a href="./Roo.grid.GridView.html#constructor" roo:cls="Roo.grid.GridView.html#constructor">Roo.grid.GridView</a>, <a href="./Roo.grid.PropertyGrid.html#constructor" roo:cls="Roo.grid.PropertyGrid.html#constructor">Roo.grid.PropertyGrid</a>, <a href="./Roo.grid.RowSelectionModel.html#constructor" roo:cls="Roo.grid.RowSelectionModel.html#constructor">Roo.grid.RowSelectionModel</a>, <a href="./Roo.menu.Adapter.html#constructor" roo:cls="Roo.menu.Adapter.html#constructor">Roo.menu.Adapter</a>, <a href="./Roo.menu.BaseItem.html#constructor" roo:cls="Roo.menu.BaseItem.html#constructor">Roo.menu.BaseItem</a>, <a href="./Roo.menu.CheckItem.html#constructor" roo:cls="Roo.menu.CheckItem.html#constructor">Roo.menu.CheckItem</a>, <a href="./Roo.menu.ColorItem.html#constructor" roo:cls="Roo.menu.ColorItem.html#constructor">Roo.menu.ColorItem</a>, <a href="./Roo.menu.ColorMenu.html#constructor" roo:cls="Roo.menu.ColorMenu.html#constructor">Roo.menu.ColorMenu</a>, <a href="./Roo.menu.DateItem.html#constructor" roo:cls="Roo.menu.DateItem.html#constructor">Roo.menu.DateItem</a>, <a href="./Roo.menu.DateMenu.html#constructor" roo:cls="Roo.menu.DateMenu.html#constructor">Roo.menu.DateMenu</a>, <a href="./Roo.menu.Item.html#constructor" roo:cls="Roo.menu.Item.html#constructor">Roo.menu.Item</a>, <a href="./Roo.menu.Menu.html#constructor" roo:cls="Roo.menu.Menu.html#constructor">Roo.menu.Menu</a>, <a href="./Roo.menu.Separator.html#constructor" roo:cls="Roo.menu.Separator.html#constructor">Roo.menu.Separator</a>, <a href="./Roo.menu.TextItem.html#constructor" roo:cls="Roo.menu.TextItem.html#constructor">Roo.menu.TextItem</a>, <a href="./Roo.tree.AsyncTreeNode.html#constructor" roo:cls="Roo.tree.AsyncTreeNode.html#constructor">Roo.tree.AsyncTreeNode</a>, <a href="./Roo.tree.DefaultSelectionModel.html#constructor" roo:cls="Roo.tree.DefaultSelectionModel.html#constructor">Roo.tree.DefaultSelectionModel</a>, <a href="./Roo.tree.MultiSelectionModel.html#constructor" roo:cls="Roo.tree.MultiSelectionModel.html#constructor">Roo.tree.MultiSelectionModel</a>, <a href="./Roo.tree.TreeEditor.html#constructor" roo:cls="Roo.tree.TreeEditor.html#constructor">Roo.tree.TreeEditor</a>, <a href="./Roo.tree.TreeLoader.html#constructor" roo:cls="Roo.tree.TreeLoader.html#constructor">Roo.tree.TreeLoader</a>, <a href="./Roo.tree.TreeNode.html#constructor" roo:cls="Roo.tree.TreeNode.html#constructor">Roo.tree.TreeNode</a>, <a href="./Roo.tree.TreePanel.html#constructor" roo:cls="Roo.tree.TreePanel.html#constructor">Roo.tree.TreePanel</a>, <a href="./Roo.util.ClickRepeater.html#constructor" roo:cls="Roo.util.ClickRepeater.html#constructor">Roo.util.ClickRepeater</a>, <a href="./Roo.util.MixedCollection.html#constructor" roo:cls="Roo.util.MixedCollection.html#constructor">Roo.util.MixedCollection</a>
  67
  68
  69
  70         </td></tr>
  71
  72
  73
  74     </table>
  75
  76
  77 <!-- ============================== class summary ========================== -->
  78     <div class="description">
  79         Base class that provides a common interface for publishing events. Subclasses are expected to<br/>to have a property "events" with all the events defined.<br><br/>For example:<br/><pre><code><br/> Employee = function(name){<br/>    this.name = name;<br/>    this.addEvents({<br/>        "fired" : true,<br/>        "quit" : true<br/>    });<br/> }<br/> Roo.extend(Employee, Roo.util.Observable);<br/></code></pre>
  80     </div>
  81
  82
  83 <!-- ============================== Class comment block... ========================== -->
  84
  85 <div class="comments">
  86         <b>Class Comments / Notes</B> =>
  87         <u onclick="parent.CommentDialog.showCommentId = 'Roo.util.Observable';">[Add Your comment/notes about this class]</u>
  88         <br/>
  89         <iframe frameborder="0"  id="comments-Roo.util" style="border: none;width:100%;"
  90                 src="/blog.php/GtkDjsComments/Roo.util.Observable.html"></iframe>
  91 </div>
  92
  93
  94
  95 <!-- ============================== config options ========================== -->
  96
  97
  98
  99
 100     <div class="hr"></div>
 101     <a id="Roo.util.Observable-configs"></a>
 102
 103
 104
 105
 106
 107       <table cellspacing="0" class="member-table">
 108       <caption>Config Options (Usually are also Properties)</caption>
 109
 110
 111         <tr>
 112             <th class="sig-header" colspan="2">Options</th>
 113
 114             <th class="msource-header">Defined By</th>
 115         </tr>
 116
 117
 118
 119
 120
 121                 <tr class="config-row expandable config-row-alt0 notInherited">
 122                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 123                     <td class="sig">
 124
 125                         <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
 126                         <div class="fixedFont">
 127                                 <b  class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 128
 129
 130                         </div>
 131
 132                         <div class="mdesc">
 133                             <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>
 134                         </div>
 135
 136                         <div class="mdesc">
 137                             <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>
 138                         </div>
 139
 140
 141
 142                     </td>
 143                     <td class="msource">
 144
 145                         Roo.util.Observable
 146
 147                     </td>
 148                 </tr>
 149
 150
 151     </table>
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161   <!-- ============================== public properties ==================== -->
 162
 163
 164
 165     <a id="Roo.util.Observable-props"></a>
 166
 167
 168
 169
 170
 171      <table cellspacing="0" class="member-table">
 172       <caption class="Empty">Public Properties - Has None</caption>
 173      </table>
 174
 175
 176
 177
 178   <!-- ============================== methods summary / details ======================== -->
 179
 180
 181   <a id="Roo.util.Observable-methods"></a>
 182         <!-- constructor?? -->
 183
 184         <!-- static's first
 185
 186
 187         -->
 188
 189         <!-- then dynamics first -->
 190
 191
 192
 193
 194
 195
 196       <table cellspacing="0" class="member-table">
 197       <caption>Public Methods</caption>
 198         <tr>
 199             <th class="sig-header" colspan="2">Method</th>
 200             <th class="msource-header">Defined By</th>
 201
 202         </tr>
 203
 204
 205
 206
 207
 208
 209
 210           <tr class="method-row config-row-alt0 expandable notInherited">
 211             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 212
 213
 214             <td class="sig">
 215                 <a id="Roo.util-method-Observable"   name=".Observable"></a>
 216                 <div class="fixedFont">
 217                         <span class="attributes">new <B>Roo.util.</B></span><b class="itemname">Observable</b>
 218
 219                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 220
 221
 222
 223                 </div>
 224                 <div class="mdesc">
 225
 226
 227                         <div class="short">Create a new Roo.util.Observable</div>
 228
 229
 230                     <div class="long">
 231
 232
 233
 234                                 Create a new Roo.util.Observable
 235
 236
 237                                 <dl class="detailList">
 238                                 <dt class="heading">Parameters:</dt>
 239
 240                                         <dt>
 241                                                 <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>
 242
 243                                         </dt>
 244                                         <dd>properties to use (incuding events / listeners)</dd>
 245
 246                                 </dl>
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258                     </div>
 259                 </div>
 260
 261             </td>
 262             <td class="msource">
 263                 &nbsp;
 264             </td>
 265         </tr>
 266
 267
 268           <tr class="method-row config-row-alt1 expandable notInherited">
 269             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 270
 271
 272             <td class="sig">
 273                 <a id="Roo.util.Observable-method-capture"   name=".capture"></a>
 274                 <div class="fixedFont">
 275                         <span class="attributes">Roo.util.Observable.</span><b class="itemname">capture</b>
 276
 277                                  (Observable <B><i>o</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
 278
 279
 280
 281                 </div>
 282                 <div class="mdesc">
 283
 284                    <div class="short">Starts capture on the specified Observable.</div>
 285
 286
 287
 288                     <div class="long">
 289
 290                                 Starts capture on the specified Observable. All events will be passed<br/>to the supplied function with the event name + standard signature of the event<br/><b>before</b> the event is fired. If the supplied function returns false,<br/>the event will not fire.
 291
 292
 293
 294
 295
 296
 297                                 <dl class="detailList">
 298                                 <dt class="heading">Parameters:</dt>
 299
 300                                         <dt>
 301                                                 <span class="fixedFont">Observable</span>  <b>o</b>
 302
 303                                         </dt>
 304                                         <dd>The Observable to capture</dd>
 305
 306                                         <dt>
 307                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>fn</b>
 308
 309                                         </dt>
 310                                         <dd>The function to call</dd>
 311
 312                                         <dt>
 313                                                 <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>
 314
 315                                         </dt>
 316                                         <dd>(optional) The scope (this object) for the fn</dd>
 317
 318                                 </dl>
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330                     </div>
 331                 </div>
 332
 333             </td>
 334             <td class="msource">
 335
 336                         Roo.util.Observable
 337                 &nbsp;
 338             </td>
 339         </tr>
 340
 341
 342           <tr class="method-row config-row-alt0 expandable notInherited">
 343             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 344
 345
 346             <td class="sig">
 347                 <a id="Roo.util.Observable-method-releaseCapture"   name=".releaseCapture"></a>
 348                 <div class="fixedFont">
 349                         <span class="attributes">Roo.util.Observable.</span><b class="itemname">releaseCapture</b>
 350
 351                                  (Observable <B><i>o</i></B>)
 352
 353
 354
 355                 </div>
 356                 <div class="mdesc">
 357
 358                    <div class="short">Removes <b>all</b> added captures from the Observable.</div>
 359
 360
 361
 362                     <div class="long">
 363
 364                                 Removes <b>all</b> added captures from the Observable.
 365
 366
 367
 368
 369
 370
 371                                 <dl class="detailList">
 372                                 <dt class="heading">Parameters:</dt>
 373
 374                                         <dt>
 375                                                 <span class="fixedFont">Observable</span>  <b>o</b>
 376
 377                                         </dt>
 378                                         <dd>The Observable to release</dd>
 379
 380                                 </dl>
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392                     </div>
 393                 </div>
 394
 395             </td>
 396             <td class="msource">
 397
 398                         Roo.util.Observable
 399                 &nbsp;
 400             </td>
 401         </tr>
 402
 403
 404           <tr class="method-row config-row-alt1 expandable notInherited">
 405             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 406
 407
 408             <td class="sig">
 409                 <a id="Roo.util.Observable-method-addEvents"   name=".addEvents"></a>
 410                 <div class="fixedFont">
 411                         <span class="attributes"></span><b class="itemname">addEvents</b>
 412
 413                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
 414
 415
 416
 417                 </div>
 418                 <div class="mdesc">
 419
 420                    <div class="short">Used to define events on this Observable</div>
 421
 422
 423
 424                     <div class="long">
 425
 426                                 Used to define events on this Observable
 427
 428
 429
 430
 431
 432
 433                                 <dl class="detailList">
 434                                 <dt class="heading">Parameters:</dt>
 435
 436                                         <dt>
 437                                                 <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>
 438
 439                                         </dt>
 440                                         <dd>The object with the events defined</dd>
 441
 442                                 </dl>
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454                     </div>
 455                 </div>
 456
 457             </td>
 458             <td class="msource">
 459
 460                         Roo.util.Observable
 461                 &nbsp;
 462             </td>
 463         </tr>
 464
 465
 466           <tr class="method-row config-row-alt0 expandable notInherited">
 467             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 468
 469
 470             <td class="sig">
 471                 <a id="Roo.util.Observable-method-addListener"   name=".addListener"></a>
 472                 <div class="fixedFont">
 473                         <span class="attributes"></span><b class="itemname">addListener</b>
 474
 475                                  (<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>)
 476
 477
 478
 479                 </div>
 480                 <div class="mdesc">
 481
 482                    <div class="short">Appends an event handler to this component</div>
 483
 484
 485
 486                     <div class="long">
 487
 488                                 Appends an event handler to this component
 489
 490
 491
 492
 493
 494
 495                                 <dl class="detailList">
 496                                 <dt class="heading">Parameters:</dt>
 497
 498                                         <dt>
 499                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 500
 501                                         </dt>
 502                                         <dd>The type of event to listen for</dd>
 503
 504                                         <dt>
 505                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 506
 507                                         </dt>
 508                                         <dd>The method the event invokes</dd>
 509
 510                                         <dt>
 511                                                 <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>
 512
 513                                         </dt>
 514                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 515
 516                                         <dt>
 517                                                 <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>
 518
 519                                         </dt>
 520                                         <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>
 521
 522                                 </dl>
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534                     </div>
 535                 </div>
 536
 537             </td>
 538             <td class="msource">
 539
 540                         Roo.util.Observable
 541                 &nbsp;
 542             </td>
 543         </tr>
 544
 545
 546           <tr class="method-row config-row-alt1 expandable notInherited">
 547             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 548
 549
 550             <td class="sig">
 551                 <a id="Roo.util.Observable-method-fireEvent"   name=".fireEvent"></a>
 552                 <div class="fixedFont">
 553                         <span class="attributes"></span><b class="itemname">fireEvent</b>
 554
 555                                  (<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>)
 556
 557
 558                                          :
 559
 560
 561                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 562
 563
 564
 565
 566
 567                 </div>
 568                 <div class="mdesc">
 569
 570                    <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
 571
 572
 573
 574                     <div class="long">
 575
 576                                 Fires the specified event with the passed parameters (minus the event name).
 577
 578
 579
 580
 581
 582
 583                                 <dl class="detailList">
 584                                 <dt class="heading">Parameters:</dt>
 585
 586                                         <dt>
 587                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 588
 589                                         </dt>
 590                                         <dd></dd>
 591
 592                                         <dt>
 593                                                 <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>
 594
 595                                         </dt>
 596                                         <dd>Variable number of parameters are passed to handlers</dd>
 597
 598                                 </dl>
 599
 600
 601
 602
 603
 604                                 <dl class="detailList">
 605                                 <dt class="heading">Returns:</dt>
 606
 607                                         <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>
 608
 609                                 </dl>
 610
 611
 612
 613
 614
 615
 616
 617                     </div>
 618                 </div>
 619
 620             </td>
 621             <td class="msource">
 622
 623                         Roo.util.Observable
 624                 &nbsp;
 625             </td>
 626         </tr>
 627
 628
 629           <tr class="method-row config-row-alt0 expandable notInherited">
 630             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 631
 632
 633             <td class="sig">
 634                 <a id="Roo.util.Observable-method-hasListener"   name=".hasListener"></a>
 635                 <div class="fixedFont">
 636                         <span class="attributes"></span><b class="itemname">hasListener</b>
 637
 638                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
 639
 640
 641                                          :
 642
 643
 644                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 645
 646
 647
 648
 649
 650                 </div>
 651                 <div class="mdesc">
 652
 653                    <div class="short">Checks to see if this object has any listeners for a specified event</div>
 654
 655
 656
 657                     <div class="long">
 658
 659                                 Checks to see if this object has any listeners for a specified event
 660
 661
 662
 663
 664
 665
 666                                 <dl class="detailList">
 667                                 <dt class="heading">Parameters:</dt>
 668
 669                                         <dt>
 670                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 671
 672                                         </dt>
 673                                         <dd>The name of the event to check for</dd>
 674
 675                                 </dl>
 676
 677
 678
 679
 680
 681                                 <dl class="detailList">
 682                                 <dt class="heading">Returns:</dt>
 683
 684                                         <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>
 685
 686                                 </dl>
 687
 688
 689
 690
 691
 692
 693
 694                     </div>
 695                 </div>
 696
 697             </td>
 698             <td class="msource">
 699
 700                         Roo.util.Observable
 701                 &nbsp;
 702             </td>
 703         </tr>
 704
 705
 706           <tr class="method-row config-row-alt1 expandable notInherited">
 707             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 708
 709
 710             <td class="sig">
 711                 <a id="Roo.util.Observable-method-on"   name=".on"></a>
 712                 <div class="fixedFont">
 713                         <span class="attributes"></span><b class="itemname">on</b>
 714
 715                                  (<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>)
 716
 717
 718
 719                 </div>
 720                 <div class="mdesc">
 721
 722                    <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
 723
 724
 725
 726                     <div class="long">
 727
 728                                 Appends an event handler to this element (shorthand for addListener)
 729
 730
 731
 732
 733
 734
 735                                 <dl class="detailList">
 736                                 <dt class="heading">Parameters:</dt>
 737
 738                                         <dt>
 739                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 740
 741                                         </dt>
 742                                         <dd>The type of event to listen for</dd>
 743
 744                                         <dt>
 745                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 746
 747                                         </dt>
 748                                         <dd>The method the event invokes</dd>
 749
 750                                         <dt>
 751                                                 <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>
 752
 753                                         </dt>
 754                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 755
 756                                         <dt>
 757                                                 <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>
 758
 759                                         </dt>
 760                                         <dd>(optional)</dd>
 761
 762                                 </dl>
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774                     </div>
 775                 </div>
 776
 777             </td>
 778             <td class="msource">
 779
 780                         Roo.util.Observable
 781                 &nbsp;
 782             </td>
 783         </tr>
 784
 785
 786           <tr class="method-row config-row-alt0 expandable notInherited">
 787             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 788
 789
 790             <td class="sig">
 791                 <a id="Roo.util.Observable-method-purgeListeners"   name=".purgeListeners"></a>
 792                 <div class="fixedFont">
 793                         <span class="attributes"></span><b class="itemname">purgeListeners</b>
 794
 795                                  ()
 796
 797
 798
 799                 </div>
 800                 <div class="mdesc">
 801
 802                    <div class="short">Removes all listeners for this object</div>
 803
 804
 805
 806                     <div class="long">
 807
 808                                 Removes all listeners for this object
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825                     </div>
 826                 </div>
 827
 828             </td>
 829             <td class="msource">
 830
 831                         Roo.util.Observable
 832                 &nbsp;
 833             </td>
 834         </tr>
 835
 836
 837           <tr class="method-row config-row-alt1 expandable notInherited">
 838             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 839
 840
 841             <td class="sig">
 842                 <a id="Roo.util.Observable-method-removeListener"   name=".removeListener"></a>
 843                 <div class="fixedFont">
 844                         <span class="attributes"></span><b class="itemname">removeListener</b>
 845
 846                                  (<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>)
 847
 848
 849
 850                 </div>
 851                 <div class="mdesc">
 852
 853                    <div class="short">Removes a listener</div>
 854
 855
 856
 857                     <div class="long">
 858
 859                                 Removes a listener
 860
 861
 862
 863
 864
 865
 866                                 <dl class="detailList">
 867                                 <dt class="heading">Parameters:</dt>
 868
 869                                         <dt>
 870                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 871
 872                                         </dt>
 873                                         <dd>The type of event to listen for</dd>
 874
 875                                         <dt>
 876                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 877
 878                                         </dt>
 879                                         <dd>The handler to remove</dd>
 880
 881                                         <dt>
 882                                                 <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>
 883
 884                                         </dt>
 885                                         <dd>(optional) The scope (this object) for the handler</dd>
 886
 887                                 </dl>
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899                     </div>
 900                 </div>
 901
 902             </td>
 903             <td class="msource">
 904
 905                         Roo.util.Observable
 906                 &nbsp;
 907             </td>
 908         </tr>
 909
 910
 911           <tr class="method-row config-row-alt0 expandable notInherited">
 912             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 913
 914
 915             <td class="sig">
 916                 <a id="Roo.util.Observable-method-un"   name=".un"></a>
 917                 <div class="fixedFont">
 918                         <span class="attributes"></span><b class="itemname">un</b>
 919
 920                                  (<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>)
 921
 922
 923
 924                 </div>
 925                 <div class="mdesc">
 926
 927                    <div class="short">Removes a listener (shorthand for removeListener)</div>
 928
 929
 930
 931                     <div class="long">
 932
 933                                 Removes a listener (shorthand for removeListener)
 934
 935
 936
 937
 938
 939
 940                                 <dl class="detailList">
 941                                 <dt class="heading">Parameters:</dt>
 942
 943                                         <dt>
 944                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 945
 946                                         </dt>
 947                                         <dd>The type of event to listen for</dd>
 948
 949                                         <dt>
 950                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 951
 952                                         </dt>
 953                                         <dd>The handler to remove</dd>
 954
 955                                         <dt>
 956                                                 <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>
 957
 958                                         </dt>
 959                                         <dd>(optional) The scope (this object) for the handler</dd>
 960
 961                                 </dl>
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973                     </div>
 974                 </div>
 975
 976             </td>
 977             <td class="msource">
 978
 979                         Roo.util.Observable
 980                 &nbsp;
 981             </td>
 982         </tr>
 983
 984
 985     </table>
 986
 987
 988   <!-- ============================== events summary / details ======================== -->
 989
 990
 991   <a id="Roo.util.Observable-events"></a>
 992
 993
 994
 995
 996
 997      <table cellspacing="0" class="member-table">
 998       <caption class="Empty">Events - Has None</caption>
 999      </table>
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009 <!-- ============================== footer ================================= -->
1010                 <div class="fineprint" style="clear:both">
1011
1012                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Tue Jul 27 2010 11:05:09 GMT+0800 (HKT)
1013                         Based on
1014                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1015                 </div>
1016         </body>
1017 </html>