Upgrade to ExtJS 3.2.1 - Released 04/27/2010
[extjs.git] / docs / output / Ext.SplitBar.html
1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.SplitBar-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.SplitBar-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.SplitBar-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.SplitBar-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.SplitBar"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a>&#13;&nbsp;&nbsp;<img src="resources/elbow-end.gif">SplitBar</pre></div><h1>Class <a href="source/SplitBar.html#cls-Ext.SplitBar">Ext.SplitBar</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/SplitBar.html#cls-Ext.SplitBar">SplitBar.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/SplitBar.html#cls-Ext.SplitBar">SplitBar</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.util.Observable.html" ext:cls="Ext.util.Observable" ext:member="">Observable</a></td></tr></table><div class="description">Creates draggable splitter bar functionality from two elements (element to be dragged and element to be resized).
2 <br><br>
3 Usage:
4 <pre><code><b>var</b> split = <b>new</b> Ext.SplitBar(<em>"elementToDrag"</em>, <em>"elementToSize"</em>,
5                    Ext.SplitBar.HORIZONTAL, Ext.SplitBar.LEFT);
6 split.setAdapter(<b>new</b> Ext.SplitBar.AbsoluteLayoutAdapter(<em>"container"</em>));
7 split.minSize = 100;
8 split.maxSize = 600;
9 split.animate = true;
10 split.on(<em>'moved'</em>, splitterMoved);</code></pre></div><div class="hr"></div><a id="Ext.SplitBar-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-listeners"></a><b><a href="source/Observable.html#cfg-Ext.util.Observable-listeners">listeners</a></b> : Object<div class="mdesc"><div class="short">A config object containing one or more event handlers to be added to this
11 object during initialization.  This should ...</div><div class="long"><p>A config object containing one or more event handlers to be added to this
12 object during initialization.  This should be a valid listeners config object as specified in the
13 <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> example for attaching multiple handlers at once.</p>
14 <br><p><b><u>DOM events from ExtJs <a href="output/Ext.Component.html" ext:cls="Ext.Component">Components</a></u></b></p>
15 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
16 is usually only done when extra value can be added. For example the <a href="output/Ext.DataView.html" ext:cls="Ext.DataView">DataView</a>'s
17 <b><code><a href="output/Ext.DataView.html#Ext.DataView-click" ext:member="click" ext:cls="Ext.DataView">click</a></code></b> event passing the node clicked on. To access DOM
18 events directly from a Component's HTMLElement, listeners must be added to the <i><a href="output/Ext.Component.html#Ext.Component-getEl" ext:member="getEl" ext:cls="Ext.Component">Element</a></i> after the Component
19 has been rendered. A plugin can simplify this step:<pre><code><i>// Plugin is configured <b>with</b> a listeners config object.</i>
20 <i>// The Component is appended to the argument list of all handler functions.</i>
21 Ext.DomObserver = Ext.extend(Object, {
22     constructor: <b>function</b>(config) {
23         this.listeners = config.listeners ? config.listeners : config;
24     },
25
26     <i>// Component passes itself into plugin&#39;s init method</i>
27     init: <b>function</b>(c) {
28         <b>var</b> p, l = this.listeners;
29         <b>for</b> (p <b>in</b> l) {
30             <b>if</b> (Ext.isFunction(l[p])) {
31                 l[p] = this.createHandler(l[p], c);
32             } <b>else</b> {
33                 l[p].fn = this.createHandler(l[p].fn, c);
34             }
35         }
36
37         <i>// Add the listeners to the Element immediately following the render call</i>
38         c.render = c.render.<a href="output/Function.html#Function-createSequence" ext:member="createSequence" ext:cls="Function">createSequence</a>(<b>function</b>() {
39             <b>var</b> e = c.getEl();
40             <b>if</b> (e) {
41                 e.on(l);
42             }
43         });
44     },
45
46     createHandler: <b>function</b>(fn, c) {
47         <b>return</b> <b>function</b>(e) {
48             fn.call(this, e, c);
49         };
50     }
51 });
52
53 <b>var</b> combo = <b>new</b> Ext.form.ComboBox({
54
55     <i>// Collapse combo when its element is clicked on</i>
56     plugins: [ <b>new</b> Ext.DomObserver({
57         click: <b>function</b>(evt, comp) {
58             comp.collapse();
59         }
60     })],
61     store: myStore,
62     typeAhead: true,
63     mode: <em>'local'</em>,
64     triggerAction: <em>'all'</em>
65 });</code></pre></p></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#listeners" ext:member="#listeners" ext:cls="Ext.util.Observable">Observable</a></td></tr></tbody></table><a id="Ext.SplitBar-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.SplitBar-animate"></a><b><a href="source/SplitBar.html#prop-Ext.SplitBar-animate">animate</a></b> : Boolean<div class="mdesc">Whether to animate the transition to the new size</div></td><td class="msource">SplitBar</td></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.SplitBar-maxSize"></a><b><a href="source/SplitBar.html#prop-Ext.SplitBar-maxSize">maxSize</a></b> : Number<div class="mdesc">The maximum size of the resizing element. (Defaults to 2000)</div></td><td class="msource">SplitBar</td></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.SplitBar-minSize"></a><b><a href="source/SplitBar.html#prop-Ext.SplitBar-minSize">minSize</a></b> : Number<div class="mdesc">The minimum size of the resizing element. (Defaults to 0)</div></td><td class="msource">SplitBar</td></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.SplitBar-tickSize"></a><b><a href="source/SplitBar.html#prop-Ext.SplitBar-tickSize">tickSize</a></b> : Number<div class="mdesc">The increment, in pixels by which to move this SplitBar. When <i>undefined</i>, the SplitBar moves smoothly.</div></td><td class="msource">SplitBar</td></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.SplitBar-useShim"></a><b><a href="source/SplitBar.html#prop-Ext.SplitBar-useShim">useShim</a></b> : Boolean<div class="mdesc">Whether to create a transparent shim that overlays the page when dragging, enables dragging across iframes.</div></td><td class="msource">SplitBar</td></tr></tbody></table><a id="Ext.SplitBar-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.SplitBar-SplitBar"></a><b><a href="source/SplitBar.html#cls-Ext.SplitBar">SplitBar</a></b>(&nbsp;<code>Mixed&nbsp;dragElement</code>,&nbsp;<code>Mixed&nbsp;resizingElement</code>,&nbsp;<span title="Optional" class="optional">[<code>Number&nbsp;orientation</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Number&nbsp;placement</code>]</span>&nbsp;)
66     <div class="mdesc"><div class="short">Create a new SplitBar</div><div class="long">Create a new SplitBar<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>dragElement</code> : Mixed<div class="sub-desc">The element to be dragged and act as the SplitBar.</div></li><li><code>resizingElement</code> : Mixed<div class="sub-desc">The element to be resized based on where the SplitBar element is dragged</div></li><li><code>orientation</code> : Number<div class="sub-desc">(optional) Either Ext.SplitBar.HORIZONTAL or Ext.SplitBar.VERTICAL. (Defaults to HORIZONTAL)</div></li><li><code>placement</code> : Number<div class="sub-desc">(optional) Either Ext.SplitBar.LEFT or Ext.SplitBar.RIGHT for horizontal or
67                         Ext.SplitBar.TOP or Ext.SplitBar.BOTTOM for vertical. (By default, this is determined automatically by the initial
68                         position of the SplitBar).</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">SplitBar</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-addEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addEvents">addEvents</a></b>(&nbsp;<code>Object|String&nbsp;o</code>,&nbsp;<code>string&nbsp;Optional.</code>&nbsp;)
69     :
70                                         void<div class="mdesc"><div class="short">Adds the specified events to the list of events which this Observable may fire.</div><div class="long">Adds the specified events to the list of events which this Observable may fire.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object|String<div class="sub-desc">Either an object with event names as properties with a value of <code>true</code>
71 or the first event name string if multiple event names are being passed as separate parameters.</div></li><li><code>Optional.</code> : string<div class="sub-desc">Event name if multiple event names are being passed as separate parameters.
72 Usage:<pre><code>this.addEvents(<em>'storeloaded'</em>, <em>'storecleared'</em>);</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addEvents" ext:member="#addEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-addListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addListener">addListener</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)
73     :
74                                         void<div class="mdesc"><div class="short">Appends an event handler to this object.</div><div class="long">Appends an event handler to this object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to listen for.</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes.</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
75 <b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.
76 properties. This may contain any of the following properties:<ul>
77 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
78 <b>If omitted, defaults to the object which fired the event.</b></div></li>
79 <li><b>delay</b> : Number<div class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>
80 <li><b>single</b> : Boolean<div class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>
81 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="output/Ext.util.DelayedTask.html" ext:cls="Ext.util.DelayedTask">Ext.util.DelayedTask</a> delayed
82 by the specified number of milliseconds. If the event fires again within that time, the original
83 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
84 <li><b>target</b> : Observable<div class="sub-desc">Only call the handler if the event was fired on the target Observable, <i>not</i>
85 if the event was bubbled up from a child Observable.</div></li>
86 </ul><br>
87 <p>
88 <b>Combining Options</b><br>
89 Using the options argument, it is possible to combine different types of listeners:<br>
90 <br>
91 A delayed, one-time listener.
92 <pre><code>myDataView.on(<em>'click'</em>, this.onClick, this, {
93 single: true,
94 delay: 100
95 });</code></pre>
96 <p>
97 <b>Attaching multiple handlers in 1 call</b><br>
98 The method also allows for a single argument to be passed which is a config object containing properties
99 which specify multiple handlers.
100 <p>
101 <pre><code>myGridPanel.on({
102 <em>'click'</em> : {
103     fn: this.onClick,
104     scope: this,
105     delay: 100
106 },
107 <em>'mouseover'</em> : {
108     fn: this.onMouseOver,
109     scope: this
110 },
111 <em>'mouseout'</em> : {
112     fn: this.onMouseOut,
113     scope: this
114 }
115 });</code></pre>
116 <p>
117 Or a shorthand syntax:<br>
118 <pre><code>myGridPanel.on({
119 <em>'click'</em> : this.onClick,
120 <em>'mouseover'</em> : this.onMouseOver,
121 <em>'mouseout'</em> : this.onMouseOut,
122  scope: this
123 });</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addListener" ext:member="#addListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.SplitBar-destroy"></a><b><a href="source/SplitBar.html#method-Ext.SplitBar-destroy">destroy</a></b>(&nbsp;<code>Boolean&nbsp;removeEl</code>&nbsp;)
124     :
125                                         void<div class="mdesc"><div class="short">Destroy this splitbar.</div><div class="long">Destroy this splitbar.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>removeEl</code> : Boolean<div class="sub-desc">True to remove the element</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">SplitBar</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-enableBubble"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-enableBubble">enableBubble</a></b>(&nbsp;<code>String/Array&nbsp;events</code>&nbsp;)
126     :
127                                         void<div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
128 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
129 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
130 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="output/Ext.Component.getBubbleTarget.html" ext:cls="Ext.Component.getBubbleTarget">Ext.Component.getBubbleTarget</a>. The default
131 implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
132 access the required target more quickly.</p>
133 <p>Example:</p><pre><code>Ext.override(Ext.form.Field, {
134     <i>//  Add functionality to Field&#39;s initComponent to enable the change event to bubble</i>
135     initComponent : Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {
136         this.enableBubble(<em>'change'</em>);
137     }),
138
139     <i>//  We know that we want Field&#39;s events to bubble directly to the FormPanel.</i>
140     getBubbleTarget : <b>function</b>() {
141         <b>if</b> (!this.formPanel) {
142             this.formPanel = this.findParentByType(<em>'form'</em>);
143         }
144         <b>return</b> this.formPanel;
145     }
146 });
147
148 <b>var</b> myForm = <b>new</b> Ext.formPanel({
149     title: <em>'User Details'</em>,
150     items: [{
151         ...
152     }],
153     listeners: {
154         change: <b>function</b>() {
155             <i>// Title goes red <b>if</b> form has been modified.</i>
156             myForm.header.setStyle(<em>'color'</em>, <em>'red'</em>);
157         }
158     }
159 });</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> : String/Array<div class="sub-desc">The event name to bubble, or an Array of event names.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#enableBubble" ext:member="#enableBubble" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-fireEvent"></a><b><a href="source/Observable.html#method-Ext.util.Observable-fireEvent">fireEvent</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Object...&nbsp;args</code>&nbsp;)
160     :
161                                         Boolean<div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name).
162 An event may be set to bubble up an Obse...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
163 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="output/Ext.Component.html#Ext.Component-getBubbleTarget" ext:member="getBubbleTarget" ext:cls="Ext.Component">Ext.Component.getBubbleTarget</a>)
164 by calling <a href="output/Ext.util.Observable.html#Ext.util.Observable-enableBubble" ext:member="enableBubble" ext:cls="Ext.util.Observable">enableBubble</a>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to fire.</div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers.</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#fireEvent" ext:member="#fireEvent" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.SplitBar-getAdapter"></a><b><a href="source/SplitBar.html#method-Ext.SplitBar-getAdapter">getAdapter</a></b>()
165     :
166                                         The<div class="mdesc"><div class="short">Get the adapter this SplitBar uses</div><div class="long">Get the adapter this SplitBar uses<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>The</code><div class="sub-desc">adapter object</div></li></ul></div></div></div></td><td class="msource">SplitBar</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.SplitBar-getMaximumSize"></a><b><a href="source/SplitBar.html#method-Ext.SplitBar-getMaximumSize">getMaximumSize</a></b>()
167     :
168                                         Number<div class="mdesc"><div class="short">Gets the maximum size for the resizing element</div><div class="long">Gets the maximum size for the resizing element<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The maximum size</div></li></ul></div></div></div></td><td class="msource">SplitBar</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.SplitBar-getMinimumSize"></a><b><a href="source/SplitBar.html#method-Ext.SplitBar-getMinimumSize">getMinimumSize</a></b>()
169     :
170                                         Number<div class="mdesc"><div class="short">Gets the minimum size for the resizing element</div><div class="long">Gets the minimum size for the resizing element<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The minimum size</div></li></ul></div></div></div></td><td class="msource">SplitBar</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-hasListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-hasListener">hasListener</a></b>(&nbsp;<code>String&nbsp;eventName</code>&nbsp;)
171     :
172                                         Boolean<div class="mdesc"><div class="short">Checks to see if this object has any listeners for a specified event</div><div class="long">Checks to see if this object has any listeners for a specified event<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#hasListener" ext:member="#hasListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-on"></a><b><a href="source/Observable.html#method-Ext.util.Observable-on">on</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)
173     :
174                                         void<div class="mdesc"><div class="short">Appends an event handler to this object (shorthand for addListener.)</div><div class="long">Appends an event handler to this object (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
175 <b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#on" ext:member="#on" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-purgeListeners"></a><b><a href="source/Observable.html#method-Ext.util.Observable-purgeListeners">purgeListeners</a></b>()
176     :
177                                         void<div class="mdesc"><div class="short">Removes all listeners for this object</div><div class="long">Removes all listeners for this object<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#purgeListeners" ext:member="#purgeListeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-relayEvents"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-relayEvents">relayEvents</a></b>(&nbsp;<code>Object&nbsp;o</code>,&nbsp;<code>Array&nbsp;events</code>&nbsp;)
178     :
179                                         void<div class="mdesc"><div class="short">Relays selected events from the specified Observable as if the events were fired by this.</div><div class="long">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#relayEvents" ext:member="#relayEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-removeListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-removeListener">removeListener</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)
180     :
181                                         void<div class="mdesc"><div class="short">Removes an event handler.</div><div class="long">Removes an event handler.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#removeListener" ext:member="#removeListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-resumeEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-resumeEvents">resumeEvents</a></b>()
182     :
183                                         void<div class="mdesc"><div class="short">Resume firing events. (see suspendEvents)
184 If events were suspended using the queueSuspended parameter, then all
185 event...</div><div class="long">Resume firing events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-suspendEvents" ext:member="suspendEvents" ext:cls="Ext.util.Observable">suspendEvents</a>)
186 If events were suspended using the <tt><b>queueSuspended</b></tt> parameter, then all
187 events fired during event suspension will be sent to any listeners now.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#resumeEvents" ext:member="#resumeEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.SplitBar-setAdapter"></a><b><a href="source/SplitBar.html#method-Ext.SplitBar-setAdapter">setAdapter</a></b>(&nbsp;<code>Object&nbsp;adapter</code>&nbsp;)
188     :
189                                         void<div class="mdesc"><div class="short">Set the adapter this SplitBar uses</div><div class="long">Set the adapter this SplitBar uses<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>adapter</code> : Object<div class="sub-desc">A SplitBar adapter object</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">SplitBar</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.SplitBar-setCurrentSize"></a><b><a href="source/SplitBar.html#method-Ext.SplitBar-setCurrentSize">setCurrentSize</a></b>(&nbsp;<code>Number&nbsp;size</code>&nbsp;)
190     :
191                                         void<div class="mdesc"><div class="short">Sets the initialize size for the resizing element</div><div class="long">Sets the initialize size for the resizing element<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>size</code> : Number<div class="sub-desc">The initial size</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">SplitBar</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.SplitBar-setMaximumSize"></a><b><a href="source/SplitBar.html#method-Ext.SplitBar-setMaximumSize">setMaximumSize</a></b>(&nbsp;<code>Number&nbsp;maxSize</code>&nbsp;)
192     :
193                                         void<div class="mdesc"><div class="short">Sets the maximum size for the resizing element</div><div class="long">Sets the maximum size for the resizing element<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>maxSize</code> : Number<div class="sub-desc">The maximum size</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">SplitBar</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.SplitBar-setMinimumSize"></a><b><a href="source/SplitBar.html#method-Ext.SplitBar-setMinimumSize">setMinimumSize</a></b>(&nbsp;<code>Number&nbsp;minSize</code>&nbsp;)
194     :
195                                         void<div class="mdesc"><div class="short">Sets the minimum size for the resizing element</div><div class="long">Sets the minimum size for the resizing element<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>minSize</code> : Number<div class="sub-desc">The minimum size</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">SplitBar</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-suspendEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-suspendEvents">suspendEvents</a></b>(&nbsp;<code>Boolean&nbsp;queueSuspended</code>&nbsp;)
196     :
197                                         void<div class="mdesc"><div class="short">Suspend the firing of all events. (see resumeEvents)</div><div class="long">Suspend the firing of all events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a>)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>queueSuspended</code> : Boolean<div class="sub-desc">Pass as true to queue up suspended events to be fired
198 after the <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a> call instead of discarding all suspended events;</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#suspendEvents" ext:member="#suspendEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-un"></a><b><a href="source/Observable.html#method-Ext.util.Observable-un">un</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)
199     :
200                                         void<div class="mdesc"><div class="short">Removes an event handler (shorthand for removeListener.)</div><div class="long">Removes an event handler (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-removeListener" ext:member="removeListener" ext:cls="Ext.util.Observable">removeListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#un" ext:member="#un" ext:cls="Ext.util.Observable">Observable</a></td></tr></tbody></table><a id="Ext.SplitBar-events"></a><h2>Public Events</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Event</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.SplitBar-beforeresize"></a><b><a href="source/SplitBar.html#event-Ext.SplitBar-beforeresize">beforeresize</a></b> :
201                                       (&nbsp;<code>Ext.SplitBar&nbsp;this</code>&nbsp;)
202     <div class="mdesc"><div class="short">Fires before the splitter is dragged</div><div class="long">Fires before the splitter is dragged<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.SplitBar<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">SplitBar</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.SplitBar-moved"></a><b><a href="source/SplitBar.html#event-Ext.SplitBar-moved">moved</a></b> :
203                                       (&nbsp;<code>Ext.SplitBar&nbsp;this</code>,&nbsp;<code>Number&nbsp;newSize</code>&nbsp;)
204     <div class="mdesc"><div class="short">Fires when the splitter is moved</div><div class="long">Fires when the splitter is moved<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.SplitBar<div class="sub-desc"></div></li><li><code>newSize</code> : Number<div class="sub-desc">the new width or height</div></li></ul></div></div></div></td><td class="msource">SplitBar</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.SplitBar-resize"></a><b><a href="source/SplitBar.html#event-Ext.SplitBar-resize">resize</a></b> :
205                                       (&nbsp;<code>Ext.SplitBar&nbsp;this</code>,&nbsp;<code>Number&nbsp;newSize</code>&nbsp;)
206     <div class="mdesc"><div class="short">Fires when the splitter is moved (alias for moved)</div><div class="long">Fires when the splitter is moved (alias for <a href="output/Ext.SplitBar.html#Ext.SplitBar-moved" ext:member="moved" ext:cls="Ext.SplitBar">moved</a>)<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.SplitBar<div class="sub-desc"></div></li><li><code>newSize</code> : Number<div class="sub-desc">the new width or height</div></li></ul></div></div></div></td><td class="msource">SplitBar</td></tr></tbody></table></div>