1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.util.Observable</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
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>
43 <!-- ============================== inheritance Block. ================================= -->
45 <!-- ============================== class title / details ============================ -->
48 <h1 class="classTitle">
50 Class Roo.util.Observable
53 <table cellspacing="0" class="class-summary-table">
55 <tr><td class="label">Package:</td><td class="hd-info">Roo.util</td></tr>
57 <tr><td class="label">Defined In:</td><td class="hd-info">
59 <a href="./src/Roo_util_Observable.js.html">Roo/util/Observable.js</a>.
62 <tr><td class="label">Class:</td><td class="hd-info">Observable</td></tr>
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.ViewPanel.html#constructor" roo:cls="Roo.ViewPanel.html#constructor">Roo.ViewPanel</a>, <a href="./Roo.XComponent.html#constructor" roo:cls="Roo.XComponent.html#constructor">Roo.XComponent</a>, <a href="./Roo.bootstrap.Button.html#constructor" roo:cls="Roo.bootstrap.Button.html#constructor">Roo.bootstrap.Button</a>, <a href="./Roo.bootstrap.ButtonGroup.html#constructor" roo:cls="Roo.bootstrap.ButtonGroup.html#constructor">Roo.bootstrap.ButtonGroup</a>, <a href="./Roo.bootstrap.Calendar.html#constructor" roo:cls="Roo.bootstrap.Calendar.html#constructor">Roo.bootstrap.Calendar</a>, <a href="./Roo.bootstrap.Column.html#constructor" roo:cls="Roo.bootstrap.Column.html#constructor">Roo.bootstrap.Column</a>, <a href="./Roo.bootstrap.ComboBox.html#constructor" roo:cls="Roo.bootstrap.ComboBox.html#constructor">Roo.bootstrap.ComboBox</a>, <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>, <a href="./Roo.bootstrap.Container.html#constructor" roo:cls="Roo.bootstrap.Container.html#constructor">Roo.bootstrap.Container</a>, <a href="./Roo.bootstrap.Element.html#constructor" roo:cls="Roo.bootstrap.Element.html#constructor">Roo.bootstrap.Element</a>, <a href="./Roo.bootstrap.Form.html#constructor" roo:cls="Roo.bootstrap.Form.html#constructor">Roo.bootstrap.Form</a>, <a href="./Roo.bootstrap.Header.html#constructor" roo:cls="Roo.bootstrap.Header.html#constructor">Roo.bootstrap.Header</a>, <a href="./Roo.bootstrap.Img.html#constructor" roo:cls="Roo.bootstrap.Img.html#constructor">Roo.bootstrap.Img</a>, <a href="./Roo.bootstrap.Input.html#constructor" roo:cls="Roo.bootstrap.Input.html#constructor">Roo.bootstrap.Input</a>, <a href="./Roo.bootstrap.Menu.html#constructor" roo:cls="Roo.bootstrap.Menu.html#constructor">Roo.bootstrap.Menu</a>, <a href="./Roo.bootstrap.MenuItem.html#constructor" roo:cls="Roo.bootstrap.MenuItem.html#constructor">Roo.bootstrap.MenuItem</a>, <a href="./Roo.bootstrap.MenuSeparator.html#constructor" roo:cls="Roo.bootstrap.MenuSeparator.html#constructor">Roo.bootstrap.MenuSeparator</a>, <a href="./Roo.bootstrap.Modal.html#constructor" roo:cls="Roo.bootstrap.Modal.html#constructor">Roo.bootstrap.Modal</a>, <a href="./Roo.bootstrap.NavGroup.html#constructor" roo:cls="Roo.bootstrap.NavGroup.html#constructor">Roo.bootstrap.NavGroup</a>, <a href="./Roo.bootstrap.Navbar.html#constructor" roo:cls="Roo.bootstrap.Navbar.html#constructor">Roo.bootstrap.Navbar</a>, <a href="./Roo.bootstrap.Navbar.Item.html#constructor" roo:cls="Roo.bootstrap.Navbar.Item.html#constructor">Roo.bootstrap.Navbar.Item</a>, <a href="./Roo.bootstrap.Pagination.html#constructor" roo:cls="Roo.bootstrap.Pagination.html#constructor">Roo.bootstrap.Pagination</a>, <a href="./Roo.bootstrap.Popover.html#constructor" roo:cls="Roo.bootstrap.Popover.html#constructor">Roo.bootstrap.Popover</a>, <a href="./Roo.bootstrap.Row.html#constructor" roo:cls="Roo.bootstrap.Row.html#constructor">Roo.bootstrap.Row</a>, <a href="./Roo.bootstrap.Slider.html#constructor" roo:cls="Roo.bootstrap.Slider.html#constructor">Roo.bootstrap.Slider</a>, <a href="./Roo.bootstrap.Table.html#constructor" roo:cls="Roo.bootstrap.Table.html#constructor">Roo.bootstrap.Table</a>, <a href="./Roo.bootstrap.TableBody.html#constructor" roo:cls="Roo.bootstrap.TableBody.html#constructor">Roo.bootstrap.TableBody</a>, <a href="./Roo.bootstrap.TableCell.html#constructor" roo:cls="Roo.bootstrap.TableCell.html#constructor">Roo.bootstrap.TableCell</a>, <a href="./Roo.bootstrap.TableRow.html#constructor" roo:cls="Roo.bootstrap.TableRow.html#constructor">Roo.bootstrap.TableRow</a>, <a href="./Roo.bootstrap.TextArea.html#constructor" roo:cls="Roo.bootstrap.TextArea.html#constructor">Roo.bootstrap.TextArea</a>, <a href="./Roo.bootstrap.TriggerField.html#constructor" roo:cls="Roo.bootstrap.TriggerField.html#constructor">Roo.bootstrap.TriggerField</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.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>, <a href="./Roo.dd.DDProxy.html#constructor" roo:cls="Roo.dd.DDProxy.html#constructor">Roo.dd.DDProxy</a>, <a href="./Roo.dd.DDTarget.html#constructor" roo:cls="Roo.dd.DDTarget.html#constructor">Roo.dd.DDTarget</a>, <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>, <a href="./Roo.dd.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a>, <a href="./Roo.dd.DragZone.html#constructor" roo:cls="Roo.dd.DragZone.html#constructor">Roo.dd.DragZone</a>, <a href="./Roo.dd.DropTarget.html#constructor" roo:cls="Roo.dd.DropTarget.html#constructor">Roo.dd.DropTarget</a>, <a href="./Roo.dd.DropZone.html#constructor" roo:cls="Roo.dd.DropZone.html#constructor">Roo.dd.DropZone</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.ComboBoxArray.html#constructor" roo:cls="Roo.form.ComboBoxArray.html#constructor">Roo.form.ComboBoxArray</a>, <a href="./Roo.form.ComboBoxArray.Item.html#constructor" roo:cls="Roo.form.ComboBoxArray.Item.html#constructor">Roo.form.ComboBoxArray.Item</a>, <a href="./Roo.form.ComboCheck.html#constructor" roo:cls="Roo.form.ComboCheck.html#constructor">Roo.form.ComboCheck</a>, <a href="./Roo.form.DateField.html#constructor" roo:cls="Roo.form.DateField.html#constructor">Roo.form.DateField</a>, <a href="./Roo.form.DayPicker.html#constructor" roo:cls="Roo.form.DayPicker.html#constructor">Roo.form.DayPicker</a>, <a href="./Roo.form.DisplayField.html#constructor" roo:cls="Roo.form.DisplayField.html#constructor">Roo.form.DisplayField</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.MonthField.html#constructor" roo:cls="Roo.form.MonthField.html#constructor">Roo.form.MonthField</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.Select.html#constructor" roo:cls="Roo.form.Select.html#constructor">Roo.form.Select</a>, <a href="./Roo.form.Signature.html#constructor" roo:cls="Roo.form.Signature.html#constructor">Roo.form.Signature</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>
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>
83 <!-- ============================== Class comment block... ========================== -->
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>
89 <iframe frameborder="0" id="comments-Roo.util" style="border: none;width:100%;"
90 src="/blog.php/GtkDjsComments/Roo.util.Observable.html"></iframe>
95 <!-- ============================== config options ========================== -->
100 <div class="hr"></div>
101 <a id="Roo.util.Observable-configs"></a>
107 <table cellspacing="0" class="member-table">
108 <caption>Config Options (Usually are also Properties)</caption>
112 <th class="sig-header" colspan="2">Options</th>
114 <th class="msource-header">Defined By</th>
121 <tr class="config-row expandable config-row-alt0 notInherited">
122 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>
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>
161 <!-- ============================== public properties ==================== -->
165 <a id="Roo.util.Observable-props"></a>
171 <table cellspacing="0" class="member-table">
172 <caption class="Empty">Public Properties - Has None</caption>
178 <!-- ============================== methods summary / details ======================== -->
181 <a id="Roo.util.Observable-methods"></a>
182 <!-- constructor?? -->
189 <!-- then dynamics first -->
196 <table cellspacing="0" class="member-table">
197 <caption>Public Methods</caption>
199 <th class="sig-header" colspan="2">Method</th>
200 <th class="msource-header">Defined By</th>
210 <tr class="method-row config-row-alt0 expandable notInherited">
211 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
219 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
227 <div class="short">Create a new Roo.util.Observable</div>
234 Create a new Roo.util.Observable
237 <dl class="detailList">
238 <dt class="heading">Parameters:</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>
244 <dd>properties to use (incuding events / listeners)</dd>
268 <tr class="method-row config-row-alt1 expandable notInherited">
269 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>)
284 <div class="short">Starts capture on the specified Observable.</div>
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.
297 <dl class="detailList">
298 <dt class="heading">Parameters:</dt>
301 <span class="fixedFont">Observable</span> <b>o</b>
304 <dd>The Observable to capture</dd>
307 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
310 <dd>The function to call</dd>
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>
316 <dd>(optional) The scope (this object) for the fn</dd>
342 <tr class="method-row config-row-alt0 expandable notInherited">
343 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
351 (Observable <B><i>o</i></B>)
358 <div class="short">Removes <b>all</b> added captures from the Observable.</div>
364 Removes <b>all</b> added captures from the Observable.
371 <dl class="detailList">
372 <dt class="heading">Parameters:</dt>
375 <span class="fixedFont">Observable</span> <b>o</b>
378 <dd>The Observable to release</dd>
404 <tr class="method-row config-row-alt1 expandable notInherited">
405 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
413 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
420 <div class="short">Used to define events on this Observable</div>
426 Used to define events on this Observable
433 <dl class="detailList">
434 <dt class="heading">Parameters:</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>
440 <dd>The object with the events defined</dd>
466 <tr class="method-row config-row-alt0 expandable notInherited">
467 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>)
482 <div class="short">Appends an event handler to this component</div>
488 Appends an event handler to this component
495 <dl class="detailList">
496 <dt class="heading">Parameters:</dt>
499 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
502 <dd>The type of event to listen for</dd>
505 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
508 <dd>The method the event invokes</dd>
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>
514 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
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>
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>
546 <tr class="method-row config-row-alt1 expandable notInherited">
547 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>)
561 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
570 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
576 Fires the specified event with the passed parameters (minus the event name).
583 <dl class="detailList">
584 <dt class="heading">Parameters:</dt>
587 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
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>
596 <dd>Variable number of parameters are passed to handlers</dd>
604 <dl class="detailList">
605 <dt class="heading">Returns:</dt>
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>
629 <tr class="method-row config-row-alt0 expandable notInherited">
630 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
638 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
644 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
653 <div class="short">Checks to see if this object has any listeners for a specified event</div>
659 Checks to see if this object has any listeners for a specified event
666 <dl class="detailList">
667 <dt class="heading">Parameters:</dt>
670 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
673 <dd>The name of the event to check for</dd>
681 <dl class="detailList">
682 <dt class="heading">Returns:</dt>
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>
706 <tr class="method-row config-row-alt1 expandable notInherited">
707 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>)
722 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
728 Appends an event handler to this element (shorthand for addListener)
735 <dl class="detailList">
736 <dt class="heading">Parameters:</dt>
739 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
742 <dd>The type of event to listen for</dd>
745 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
748 <dd>The method the event invokes</dd>
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>
754 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
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>
786 <tr class="method-row config-row-alt0 expandable notInherited">
787 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
802 <div class="short">Removes all listeners for this object</div>
808 Removes all listeners for this object
837 <tr class="method-row config-row-alt1 expandable notInherited">
838 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>)
853 <div class="short">Removes a listener</div>
866 <dl class="detailList">
867 <dt class="heading">Parameters:</dt>
870 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
873 <dd>The type of event to listen for</dd>
876 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
879 <dd>The handler to remove</dd>
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>
885 <dd>(optional) The scope (this object) for the handler</dd>
911 <tr class="method-row config-row-alt0 expandable notInherited">
912 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>)
927 <div class="short">Removes a listener (shorthand for removeListener)</div>
933 Removes a listener (shorthand for removeListener)
940 <dl class="detailList">
941 <dt class="heading">Parameters:</dt>
944 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
947 <dd>The type of event to listen for</dd>
950 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
953 <dd>The handler to remove</dd>
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>
959 <dd>(optional) The scope (this object) for the handler</dd>
988 <!-- ============================== events summary / details ======================== -->
991 <a id="Roo.util.Observable-events"></a>
997 <table cellspacing="0" class="member-table">
998 <caption class="Empty">Events - Has None</caption>
1009 <!-- ============================== footer ================================= -->
1010 <div class="fineprint" style="clear:both">
1012 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Tue Apr 08 2014 18:07:22 GMT+0800 (HKT)
1014 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>