Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.FocusManager.html
1 <!DOCTYPE html><html><head><title>Ext.FocusManager | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
2 <style type="text/css">.head-band { display: none; }
3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
4 .doc-tab .members .member a.more { background-color: #efefef; }
5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit 
7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
8
9     req = {
10         liveURL: '.',
11         standAloneMode: true,
12         origDocClass: 'Ext.FocusManager',
13         docClass: 'Ext.FocusManager',
14         docReq: 'Ext.FocusManager',
15         version: '4.0',
16         baseURL: '.',
17         baseDocURL: '.',
18         baseProdURL: '.'
19     };
20
21     clsInfo = {};
22
23
24
25 </script>
26
27 <script type="text/javascript" src="../search.js"></script>
28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
29 <script type="text/javascript" src="../class_tree.js"></script>
30 <script type="text/javascript" src="../class_doc.js"></script>
31 <script type="text/javascript">
32     req.source = 'FocusManager.html#Ext-FocusManager';
33     clsInfo = {"methods":["addEvents","addListener","addManagedListener","addXTypeToWhitelist","capture","clearListeners","clearManagedListeners","disable","enable","enableBubble","fireEvent","hasListener","observe","on","relayEvents","releaseCapture","removeListener","removeManagedListener","removeXTypeFromWhitelist","resumeEvents","subscribe","suspendEvents","un","unsubscribe"],"cfgs":["listeners"],"properties":["enabled","focusedCmp","whitelist"],"events":["beforecomponentfocus","componentfocus","disable","enable"],"subclasses":[]};
34     Ext.onReady(function() {
35         Ext.create('Docs.classPanel');
36     });
37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/FocusManager.html#Ext-FocusManager" target="_blank">Ext.FocusManager</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Mixins</h4><div class="mixin"><a href="Ext.util.Observable.html" rel="Ext.util.Observable" class="cls docClass">Ext.util.Observable</a></div></pre><p>The FocusManager is responsible for globally:</p>
38
39 <ol>
40 <li>Managing component focus</li>
41 <li>Providing basic keyboard navigation</li>
42 <li>(optional) Provide a visual cue for focused components, in the form of a focus ring/frame.</li>
43 </ol>
44
45
46 <p>To activate the FocusManager, simply call <a href="Ext.FocusManager.html#enable" rel="Ext.FocusManager#enable" class="docClass">&lt;code&gt;Ext.FocusManager.enable();&lt;/code&gt;</a>. In turn, you may
47 deactivate the FocusManager by subsequently calling <a href="Ext.FocusManager.html#disable" rel="Ext.FocusManager#disable" class="docClass">&lt;code&gt;Ext.FocusManager.disable();&lt;/code&gt;</a>.  The
48 FocusManager is disabled by default.</p>
49
50 <p>To enable the optional focus frame, pass <code>true</code> or <code>{focusFrame: true}</code> to <a href="Ext.FocusManager.html#enable" rel="Ext.FocusManager#enable" class="docClass">enable</a>.</p>
51
52 <p>Another feature of the FocusManager is to provide basic keyboard focus navigation scoped to any <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Ext.container.Container</a>
53 that would like to have navigation between its child <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a>'s. The <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Ext.container.Container</a> can simply
54 call <a href="Ext.FocusManager.html#subscribe" rel="Ext.FocusManager#subscribe" class="docClass">Ext.FocusManager.subscribe</a> to take advantage of this feature, and can at any time call
55 <a href="Ext.FocusManager.html#unsubscribe" rel="Ext.FocusManager#unsubscribe" class="docClass">Ext.FocusManager.unsubscribe</a> to turn the navigation off.</p>
56 <div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">Other Configs</h4><div id="config-listeners" class="member f inherited"><a href="Ext.FocusManager.html#config-listeners" rel="config-listeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-cfg-listeners" class="viewSource">view source</a></div><a name="listeners"></a><a name="config-listeners"></a><a href="Ext.FocusManager.html#" rel="config-listeners" class="cls expand">listeners</a><span> : Object</span></div><div class="description"><div class="short">(optional) A config object containing one or more event handlers to be added to this
57 object during initialization.  T...</div><div class="long"><p>(optional) <p>A config object containing one or more event handlers to be added to this
58 object during initialization.  This should be a valid listeners config object as specified in the
59 <a href="Ext.FocusManager.html#addListener" rel="Ext.FocusManager#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
60
61 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
62
63
64 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
65
66
67 <p>is usually only done when extra value can be added. For example the <a href="Ext.view.View.html" rel="Ext.view.View" class="docClass">DataView</a>'s
68 <b><code><a href="Ext.view.View.html#click" rel="Ext.view.View#click" class="docClass">click</a></code></b> event passing the node clicked on. To access DOM
69 events directly from a child element of a Component, we need to specify the <code>element</code> option to
70 identify the Component property to add a DOM listener to:</p>
71
72 <pre><code>new Ext.panel.Panel({
73     width: 400,
74     height: 200,
75     dockedItems: [{
76         xtype: 'toolbar'
77     }],
78     listeners: {
79         click: {
80             element: 'el', //bind to the underlying el property on the panel
81             fn: function(){ console.log('click el'); }
82         },
83         dblclick: {
84             element: 'body', //bind to the underlying body property on the panel
85             fn: function(){ console.log('dblclick body'); }
86         }
87     }
88 });
89 </code></pre>
90
91
92 <p></p></p>
93 </div></div></div></div><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-enabled" class="member f ni"><a href="Ext.FocusManager.html#property-enabled" rel="property-enabled" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.FocusManager.html" class="definedIn docClass">Ext.FocusManager</a><br/><a href="../source/FocusManager.html#Ext-FocusManager-property-enabled" class="viewSource">view source</a></div><a name="enabled"></a><a name="property-enabled"></a><a href="Ext.FocusManager.html#" rel="property-enabled" class="cls expand">enabled</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Whether or not the FocusManager is currently enabled</p>
94 </div><div class="long"><p>Whether or not the FocusManager is currently enabled</p>
95 </div></div></div><div id="property-focusedCmp" class="member ni"><a href="Ext.FocusManager.html#property-focusedCmp" rel="property-focusedCmp" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.FocusManager.html" class="definedIn docClass">Ext.FocusManager</a><br/><a href="../source/FocusManager.html#Ext-FocusManager-property-focusedCmp" class="viewSource">view source</a></div><a name="focusedCmp"></a><a name="property-focusedCmp"></a><a href="Ext.FocusManager.html#" rel="property-focusedCmp" class="cls expand">focusedCmp</a><span> : Ext.Component</span></div><div class="description"><div class="short"><p>The currently focused component. Defaults to <code>undefined</code>.</p>
96 </div><div class="long"><p>The currently focused component. Defaults to <code>undefined</code>.</p>
97 </div></div></div><div id="property-whitelist" class="member ni"><a href="Ext.FocusManager.html#property-whitelist" rel="property-whitelist" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.FocusManager.html" class="definedIn docClass">Ext.FocusManager</a><br/><a href="../source/FocusManager.html#Ext-FocusManager-property-whitelist" class="viewSource">view source</a></div><a name="whitelist"></a><a name="property-whitelist"></a><a href="Ext.FocusManager.html#" rel="property-whitelist" class="cls expand">whitelist</a><span> : Array</span></div><div class="description"><div class="short">A list of xtypes that should ignore certain navigation input keys and
98 allow for the default browser event/behavior. T...</div><div class="long"><p>A list of xtypes that should ignore certain navigation input keys and
99 allow for the default browser event/behavior. These input keys include:</p>
100
101 <ol>
102 <li>Backspace</li>
103 <li>Delete</li>
104 <li>Left</li>
105 <li>Right</li>
106 <li>Up</li>
107 <li>Down</li>
108 </ol>
109
110
111 <p>The FocusManager will not attempt to navigate when a component is an xtype (or descendents thereof)
112 that belongs to this whitelist. E.g., an <a href="Ext.form.field.Text.html" rel="Ext.form.field.Text" class="docClass">Ext.form.field.Text</a> should allow
113 the user to move the input cursor left and right, and to delete characters, etc.</p>
114
115 <p>This whitelist currently defaults to <code>['textfield']</code>.</p>
116 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-addEvents" class="member f inherited"><a href="Ext.FocusManager.html#method-addEvents" rel="method-addEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addEvents" class="viewSource">view source</a></div><a name="addEvents"></a><a name="method-addEvents"></a><a href="Ext.FocusManager.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
117 <span class="pre">Object/String o, String </span>)
118  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
119 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
120 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Object/String<div class="sub-desc"><p>Either an object with event names as properties with a value of <code>true</code>
121 or the first event name string if multiple event names are being passed as separate parameters.</p>
122 </div></li><li><span class="pre"></span> : String<div class="sub-desc"><p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.
123 Usage:</p>
124
125 <pre><code>this.addEvents('storeloaded', 'storecleared');
126 </code></pre>
127
128 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
129 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.FocusManager.html#method-addListener" rel="method-addListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addListener" class="viewSource">view source</a></div><a name="addListener"></a><a name="method-addListener"></a><a href="Ext.FocusManager.html#" rel="method-addListener" class="cls expand">addListener</a>(
130 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
131  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
132 </div><div class="long"><p>Appends an event handler to this object.</p>
133 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to listen for. May also be an object who's property names are event names. See</p>
134 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
135 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
136 <b>If omitted, defaults to the object which fired the event.</b></p>
137 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
138 properties. This may contain any of the following properties:<ul>
139 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
140 <b>If omitted, defaults to the object which fired the event.</b></div></li>
141 <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>
142 <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>
143 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="Ext.util.DelayedTask.html" rel="Ext.util.DelayedTask" class="docClass">Ext.util.DelayedTask</a> delayed
144 by the specified number of milliseconds. If the event fires again within that time, the original
145 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
146 <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>
147 if the event was bubbled up from a child Observable.</div></li>
148 <li><b>element</b> : String<div class="sub-desc"><b>This option is only valid for listeners bound to <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a>.</b>
149 The name of a Component property which references an element to add a listener to.</p>
150
151 <p>This option is useful during Component construction to add DOM event listeners to elements of <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a> which
152 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
153 <pre><code>new Ext.panel.Panel({
154     title: 'The title',
155     listeners: {
156         click: this.handlePanelClick,
157         element: 'body'
158     }
159 });
160 </code></pre></p>
161
162
163 <p>When added in this way, the options available are the options applicable to <a href="Ext.core.Element.html#addListener" rel="Ext.core.Element#addListener" class="docClass">Ext.core.Element.addListener</a></p>
164
165
166 <p></div></li>
167 </ul><br></p>
168
169 <p>
170 <b>Combining Options</b><br>
171 Using the options argument, it is possible to combine different types of listeners:<br>
172 <br>
173 A delayed, one-time listener.
174 <pre><code>myPanel.on('hide', this.handleClick, this, {
175 single: true,
176 delay: 100
177 });</code></pre>
178 <p>
179 <b>Attaching multiple handlers in 1 call</b><br>
180 The method also allows for a single argument to be passed which is a config object containing properties
181 which specify multiple events. For example:
182 <pre><code>myGridPanel.on({
183     cellClick: this.onCellClick,
184     mouseover: this.onMouseOver,
185     mouseout: this.onMouseOut,
186     scope: this // Important. Ensure "this" is correct during handler execution
187 });
188 </code></pre>.
189 <p>
190
191 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
192 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.FocusManager.html#method-addManagedListener" rel="method-addManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addManagedListener" class="viewSource">view source</a></div><a name="addManagedListener"></a><a name="method-addManagedListener"></a><a href="Ext.FocusManager.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
193 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
194  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
195 is destroyed.
196
197 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
198 is destroyed.
199
200 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable/Element<div class="sub-desc"><p>The item to which to add a listener/listeners.</p>
201 </div></li><li><span class="pre">ename</span> : Object/String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
202 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
203 is the handler function.</p>
204 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
205 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
206 </div></li><li><span class="pre">opt</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
207 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
208 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
209 </li></ul></div></div></div><div id="method-addXTypeToWhitelist" class="member ni"><a href="Ext.FocusManager.html#method-addXTypeToWhitelist" rel="method-addXTypeToWhitelist" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.FocusManager.html" class="definedIn docClass">Ext.FocusManager</a><br/><a href="../source/FocusManager.html#Ext-FocusManager-method-addXTypeToWhitelist" class="viewSource">view source</a></div><a name="addXTypeToWhitelist"></a><a name="method-addXTypeToWhitelist"></a><a href="Ext.FocusManager.html#" rel="method-addXTypeToWhitelist" class="cls expand">addXTypeToWhitelist</a>(
210 <span class="pre">String/Array xtype</span>)
211  : void</div><div class="description"><div class="short"><p>Adds the specified xtype to the <a href="Ext.FocusManager.html#whitelist" rel="Ext.FocusManager#whitelist" class="docClass">whitelist</a>.</p>
212 </div><div class="long"><p>Adds the specified xtype to the <a href="Ext.FocusManager.html#whitelist" rel="Ext.FocusManager#whitelist" class="docClass">whitelist</a>.</p>
213 <h3 class="pa">Parameters</h3><ul><li><span class="pre">xtype</span> : String/Array<div class="sub-desc"><p>Adds the xtype(s) to the <a href="Ext.FocusManager.html#whitelist" rel="Ext.FocusManager#whitelist" class="docClass">whitelist</a>.</p>
214 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
215 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.FocusManager.html#method-capture" rel="method-capture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-capture" class="viewSource">view source</a></div><a name="capture"></a><a name="method-capture"></a><a href="Ext.FocusManager.html#" rel="method-capture" class="cls expand">capture</a>(
216 <span class="pre">Observable o, Function fn, [Object scope]</span>)
217  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
218 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
219 to the supplied function with the event name + standard signature of the event
220 <b>before</b> the event is fired. If the supplied function returns false,
221 the event will not fire.</p>
222 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to capture events from.</p>
223 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
224 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>
225 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
226 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.FocusManager.html#method-clearListeners" rel="method-clearListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearListeners" class="viewSource">view source</a></div><a name="clearListeners"></a><a name="method-clearListeners"></a><a href="Ext.FocusManager.html#" rel="method-clearListeners" class="cls expand">clearListeners</a> : void</div><div class="description"><div class="short"><p>Removes all listeners for this object including the managed listeners</p>
227 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
228 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
229 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.FocusManager.html#method-clearManagedListeners" rel="method-clearManagedListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearManagedListeners" class="viewSource">view source</a></div><a name="clearManagedListeners"></a><a name="method-clearManagedListeners"></a><a href="Ext.FocusManager.html#" rel="method-clearManagedListeners" class="cls expand">clearManagedListeners</a> : void</div><div class="description"><div class="short"><p>Removes all managed listeners for this object.</p>
230 </div><div class="long"><p>Removes all managed listeners for this object.</p>
231 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
232 </li></ul></div></div></div><div id="method-disable" class="member ni"><a href="Ext.FocusManager.html#method-disable" rel="method-disable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.FocusManager.html" class="definedIn docClass">Ext.FocusManager</a><br/><a href="../source/FocusManager.html#Ext-FocusManager-method-disable" class="viewSource">view source</a></div><a name="disable"></a><a name="method-disable"></a><a href="Ext.FocusManager.html#" rel="method-disable" class="cls expand">disable</a> : void</div><div class="description"><div class="short"><p>Disables the FocusManager by turning of all automatic focus management and keyboard navigation</p>
233 </div><div class="long"><p>Disables the FocusManager by turning of all automatic focus management and keyboard navigation</p>
234 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
235 </li></ul></div></div></div><div id="method-enable" class="member ni"><a href="Ext.FocusManager.html#method-enable" rel="method-enable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.FocusManager.html" class="definedIn docClass">Ext.FocusManager</a><br/><a href="../source/FocusManager.html#Ext-FocusManager-method-enable" class="viewSource">view source</a></div><a name="enable"></a><a name="method-enable"></a><a href="Ext.FocusManager.html#" rel="method-enable" class="cls expand">enable</a>(
236 <span class="pre">Boolean/Object options</span>)
237  : void</div><div class="description"><div class="short"><p>Enables the FocusManager by turning on all automatic focus management and keyboard navigation</p>
238 </div><div class="long"><p>Enables the FocusManager by turning on all automatic focus management and keyboard navigation</p>
239 <h3 class="pa">Parameters</h3><ul><li><span class="pre">options</span> : Boolean/Object<div class="sub-desc"><p>Either <code>true</code>/<code>false</code> to turn on the focus frame, or an object of the following options:</p>
240
241 <pre><code>    - focusFrame : Boolean
242         `true` to show the focus frame around a component when it is focused. Defaults to `false`.
243 </code></pre>
244 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
245 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.FocusManager.html#method-enableBubble" rel="method-enableBubble" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-enableBubble" class="viewSource">view source</a></div><a name="enableBubble"></a><a name="method-enableBubble"></a><a href="Ext.FocusManager.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
246 <span class="pre">String/Array events</span>)
247  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
248 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
249 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
250
251
252 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>. The default
253 implementation in <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> returns the Component's immediate owner. But if a known target is required, this can be overridden to
254 access the required target more quickly.</p>
255
256
257 <p>Example:</p>
258
259
260 <pre><code>Ext.override(Ext.form.field.Base, {
261 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
262 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
263     this.enableBubble('change');
264 }),
265
266 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
267 getBubbleTarget : function() {
268     if (!this.formPanel) {
269         this.formPanel = this.findParentByType('form');
270     }
271     return this.formPanel;
272 }
273 });
274
275 var myForm = new Ext.formPanel({
276 title: 'User Details',
277 items: [{
278     ...
279 }],
280 listeners: {
281     change: function() {
282         // Title goes red if form has been modified.
283         myForm.header.setStyle('color', 'red');
284     }
285 }
286 });
287 </code></pre>
288
289 <h3 class="pa">Parameters</h3><ul><li><span class="pre">events</span> : String/Array<div class="sub-desc"><p>The event name to bubble, or an Array of event names.</p>
290 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
291 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.FocusManager.html#method-fireEvent" rel="method-fireEvent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-fireEvent" class="viewSource">view source</a></div><a name="fireEvent"></a><a name="method-fireEvent"></a><a href="Ext.FocusManager.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
292 <span class="pre">String eventName, Object... args</span>)
293  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
294
295
296 An event may be set to bubble up an Ob...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
297
298
299 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>)
300 by calling <a href="Ext.FocusManager.html#enableBubble" rel="Ext.FocusManager#enableBubble" class="docClass">enableBubble</a>.</p>
301
302 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to fire.</p>
303 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
304 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>returns false if any of the handlers return false otherwise it returns true.</p>
305 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.FocusManager.html#method-hasListener" rel="method-hasListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-hasListener" class="viewSource">view source</a></div><a name="hasListener"></a><a name="method-hasListener"></a><a href="Ext.FocusManager.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
306 <span class="pre">String eventName</span>)
307  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
308 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
309 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to check for</p>
310 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the event is being listened for, else false</p>
311 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.FocusManager.html#method-observe" rel="method-observe" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-observe" class="viewSource">view source</a></div><a name="observe"></a><a name="method-observe"></a><a href="Ext.FocusManager.html#" rel="method-observe" class="cls expand">observe</a>(
312 <span class="pre">Function c, Object listeners</span>)
313  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
314
315 This makes any event fired on any instance of the passed class a...</div><div class="long"><p>Sets observability on the passed class constructor.</p>
316
317 <p>This makes any event fired on any instance of the passed class also fire a single event through
318 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
319
320 <p>Usage:</p>
321
322 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
323 Ext.data.Connection.on('beforerequest', function(con, options) {
324     console.log('Ajax request made to ' + options.url);
325 });
326 </code></pre>
327 <h3 class="pa">Parameters</h3><ul><li><span class="pre">c</span> : Function<div class="sub-desc"><p>The class constructor to make observable.</p>
328 </div></li><li><span class="pre">listeners</span> : Object<div class="sub-desc"><p>An object containing a series of listeners to add. See <a href="Ext.FocusManager.html#addListener" rel="Ext.FocusManager#addListener" class="docClass">addListener</a>.</p>
329 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
330 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.FocusManager.html#method-on" rel="method-on" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-on" class="viewSource">view source</a></div><a name="on"></a><a name="method-on"></a><a href="Ext.FocusManager.html#" rel="method-on" class="cls expand">on</a>(
331 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
332  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.FocusManager.html#addListener" rel="Ext.FocusManager#addListener" class="docClass">addListener</a>.)</p>
333 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.FocusManager.html#addListener" rel="Ext.FocusManager#addListener" class="docClass">addListener</a>.)</p>
334 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event to listen for</p>
335 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
336 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
337 <b>If omitted, defaults to the object which fired the event.</b></p>
338 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
339 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
340 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.FocusManager.html#method-relayEvents" rel="method-relayEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-relayEvents" class="viewSource">view source</a></div><a name="relayEvents"></a><a name="method-relayEvents"></a><a href="Ext.FocusManager.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
341 <span class="pre">Object origin, Array events, Object prefix</span>)
342  : void</div><div class="description"><div class="short"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
343 </div><div class="long"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
344 <h3 class="pa">Parameters</h3><ul><li><span class="pre">origin</span> : Object<div class="sub-desc"><p>The Observable whose events this object is to relay.</p>
345 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
346 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
347 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
348 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.FocusManager.html#method-releaseCapture" rel="method-releaseCapture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-releaseCapture" class="viewSource">view source</a></div><a name="releaseCapture"></a><a name="method-releaseCapture"></a><a href="Ext.FocusManager.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
349 <span class="pre">Observable o</span>)
350  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
351 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
352 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
353 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
354 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.FocusManager.html#method-removeListener" rel="method-removeListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeListener" class="viewSource">view source</a></div><a name="removeListener"></a><a name="method-removeListener"></a><a href="Ext.FocusManager.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
355 <span class="pre">String eventName, Function handler, [Object scope]</span>)
356  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
357 </div><div class="long"><p>Removes an event handler.</p>
358 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
359 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.FocusManager.html#addListener" rel="Ext.FocusManager#addListener" class="docClass">addListener</a> call.</b></p>
360 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
361 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
362 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.FocusManager.html#method-removeManagedListener" rel="method-removeManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeManagedListener" class="viewSource">view source</a></div><a name="removeManagedListener"></a><a name="method-removeManagedListener"></a><a href="Ext.FocusManager.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
363 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
364  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.FocusManager.html#mon" rel="Ext.FocusManager#mon" class="docClass">mon</a> method.</p>
365 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.FocusManager.html#mon" rel="Ext.FocusManager#mon" class="docClass">mon</a> method.</p>
366 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable|Element<div class="sub-desc"><p>The item from which to remove a listener/listeners.</p>
367 </div></li><li><span class="pre">ename</span> : Object|String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
368 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
369 is the handler function.</p>
370 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
371 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
372 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
373 </li></ul></div></div></div><div id="method-removeXTypeFromWhitelist" class="member ni"><a href="Ext.FocusManager.html#method-removeXTypeFromWhitelist" rel="method-removeXTypeFromWhitelist" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.FocusManager.html" class="definedIn docClass">Ext.FocusManager</a><br/><a href="../source/FocusManager.html#Ext-FocusManager-method-removeXTypeFromWhitelist" class="viewSource">view source</a></div><a name="removeXTypeFromWhitelist"></a><a name="method-removeXTypeFromWhitelist"></a><a href="Ext.FocusManager.html#" rel="method-removeXTypeFromWhitelist" class="cls expand">removeXTypeFromWhitelist</a>(
374 <span class="pre">String/Array xtype</span>)
375  : void</div><div class="description"><div class="short"><p>Removes the specified xtype from the <a href="Ext.FocusManager.html#whitelist" rel="Ext.FocusManager#whitelist" class="docClass">whitelist</a>.</p>
376 </div><div class="long"><p>Removes the specified xtype from the <a href="Ext.FocusManager.html#whitelist" rel="Ext.FocusManager#whitelist" class="docClass">whitelist</a>.</p>
377 <h3 class="pa">Parameters</h3><ul><li><span class="pre">xtype</span> : String/Array<div class="sub-desc"><p>Removes the xtype(s) from the <a href="Ext.FocusManager.html#whitelist" rel="Ext.FocusManager#whitelist" class="docClass">whitelist</a>.</p>
378 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
379 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.FocusManager.html#method-resumeEvents" rel="method-resumeEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-resumeEvents" class="viewSource">view source</a></div><a name="resumeEvents"></a><a name="method-resumeEvents"></a><a href="Ext.FocusManager.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
380 If events were suspended using the queueSuspended parameter, then all
381 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.FocusManager.html#suspendEvents" rel="Ext.FocusManager#suspendEvents" class="docClass">suspendEvents</a>)
382 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
383 events fired during event suspension will be sent to any listeners now.</p>
384 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
385 </li></ul></div></div></div><div id="method-subscribe" class="member ni"><a href="Ext.FocusManager.html#method-subscribe" rel="method-subscribe" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.FocusManager.html" class="definedIn docClass">Ext.FocusManager</a><br/><a href="../source/FocusManager.html#Ext-FocusManager-method-subscribe" class="viewSource">view source</a></div><a name="subscribe"></a><a name="method-subscribe"></a><a href="Ext.FocusManager.html#" rel="method-subscribe" class="cls expand">subscribe</a>(
386 <span class="pre">Ext.container.Container container, [Boolean/Object options]</span>)
387  : void</div><div class="description"><div class="short"><p>Subscribes an <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Ext.container.Container</a> to provide basic keyboard focus navigation between its child <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a>'s.</p>
388 </div><div class="long"><p>Subscribes an <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Ext.container.Container</a> to provide basic keyboard focus navigation between its child <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a>'s.</p>
389 <h3 class="pa">Parameters</h3><ul><li><span class="pre">container</span> : Ext.container.Container<div class="sub-desc"><p>A reference to the <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Ext.container.Container</a> on which to enable keyboard functionality and focus management.</p>
390 </div></li><li><span class="pre">options</span> : Boolean/Object<div class="sub-desc"><p>An object of the following options:</p>
391
392 <pre><code>    - keys : Array/Object
393         An array containing the string names of navigation keys to be supported. The allowed values are:
394
395         - 'left'
396         - 'right'
397         - 'up'
398         - 'down'
399
400         Or, an object containing those key names as keys with `true` or a callback function as their value. A scope may also be passed. E.g.:
401
402             {
403                 left: this.onLeftKey,
404                 right: this.onRightKey,
405                 scope: this
406             }
407
408     - focusFrame : Boolean (optional)
409         `true` to show the focus frame around a component when it is focused. Defaults to `false`.
410 </code></pre>
411 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
412 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.FocusManager.html#method-suspendEvents" rel="method-suspendEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-suspendEvents" class="viewSource">view source</a></div><a name="suspendEvents"></a><a name="method-suspendEvents"></a><a href="Ext.FocusManager.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
413 <span class="pre">Boolean queueSuspended</span>)
414  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.FocusManager.html#resumeEvents" rel="Ext.FocusManager#resumeEvents" class="docClass">resumeEvents</a>)</p>
415 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.FocusManager.html#resumeEvents" rel="Ext.FocusManager#resumeEvents" class="docClass">resumeEvents</a>)</p>
416 <h3 class="pa">Parameters</h3><ul><li><span class="pre">queueSuspended</span> : Boolean<div class="sub-desc"><p>Pass as true to queue up suspended events to be fired
417 after the <a href="Ext.FocusManager.html#resumeEvents" rel="Ext.FocusManager#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
418 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
419 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.FocusManager.html#method-un" rel="method-un" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-un" class="viewSource">view source</a></div><a name="un"></a><a name="method-un"></a><a href="Ext.FocusManager.html#" rel="method-un" class="cls expand">un</a>(
420 <span class="pre">String eventName, Function handler, [Object scope]</span>)
421  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.FocusManager.html#removeListener" rel="Ext.FocusManager#removeListener" class="docClass">removeListener</a>.)</p>
422 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.FocusManager.html#removeListener" rel="Ext.FocusManager#removeListener" class="docClass">removeListener</a>.)</p>
423 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
424 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.FocusManager.html#addListener" rel="Ext.FocusManager#addListener" class="docClass">addListener</a> call.</b></p>
425 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
426 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
427 </li></ul></div></div></div><div id="method-unsubscribe" class="member ni"><a href="Ext.FocusManager.html#method-unsubscribe" rel="method-unsubscribe" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.FocusManager.html" class="definedIn docClass">Ext.FocusManager</a><br/><a href="../source/FocusManager.html#Ext-FocusManager-method-unsubscribe" class="viewSource">view source</a></div><a name="unsubscribe"></a><a name="method-unsubscribe"></a><a href="Ext.FocusManager.html#" rel="method-unsubscribe" class="cls expand">unsubscribe</a>(
428 <span class="pre">Ext.container.Container container</span>)
429  : void</div><div class="description"><div class="short"><p>Unsubscribes an <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Ext.container.Container</a> from keyboard focus management.</p>
430 </div><div class="long"><p>Unsubscribes an <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Ext.container.Container</a> from keyboard focus management.</p>
431 <h3 class="pa">Parameters</h3><ul><li><span class="pre">container</span> : Ext.container.Container<div class="sub-desc"><p>A reference to the <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Ext.container.Container</a> to unsubscribe from the FocusManager.</p>
432 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
433 </li></ul></div></div></div></div><div class="m-events"><a name="events"></a><div class="definedBy">Defined By</div><h3 class="evt p">Events</h3><div id="event-beforecomponentfocus" class="member f ni"><a href="Ext.FocusManager.html#event-beforecomponentfocus" rel="event-beforecomponentfocus" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.FocusManager.html" class="definedIn docClass">Ext.FocusManager</a><br/><a href="../source/FocusManager.html#Ext-FocusManager-event-beforecomponentfocus" class="viewSource">view source</a></div><a name="beforecomponentfocus"></a><a name="event-beforecomponentfocus"></a><a href="Ext.FocusManager.html#" rel="event-beforecomponentfocus" class="cls expand">beforecomponentfocus</a>(
434 <span class="pre">Ext.FocusManager fm, Ext.Component cmp, Ext.Component previousCmp</span>)
435 </div><div class="description"><div class="short"><p>Fires before a component becomes focused. Return <code>false</code> to prevent
436 the component from gaining focus.</p>
437 </div><div class="long"><p>Fires before a component becomes focused. Return <code>false</code> to prevent
438 the component from gaining focus.</p>
439 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fm</span> : Ext.FocusManager<div class="sub-desc"><p>A reference to the FocusManager singleton</p>
440 </div></li><li><span class="pre">cmp</span> : Ext.Component<div class="sub-desc"><p>The component that is being focused</p>
441 </div></li><li><span class="pre">previousCmp</span> : Ext.Component<div class="sub-desc"><p>The component that was previously focused,
442 or <code>undefined</code> if there was no previously focused component.</p>
443 </div></li></ul></div></div></div><div id="event-componentfocus" class="member ni"><a href="Ext.FocusManager.html#event-componentfocus" rel="event-componentfocus" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.FocusManager.html" class="definedIn docClass">Ext.FocusManager</a><br/><a href="../source/FocusManager.html#Ext-FocusManager-event-componentfocus" class="viewSource">view source</a></div><a name="componentfocus"></a><a name="event-componentfocus"></a><a href="Ext.FocusManager.html#" rel="event-componentfocus" class="cls expand">componentfocus</a>(
444 <span class="pre">Ext.FocusManager fm, Ext.Component cmp, Ext.Component previousCmp</span>)
445 </div><div class="description"><div class="short"><p>Fires after a component becomes focused.</p>
446 </div><div class="long"><p>Fires after a component becomes focused.</p>
447 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fm</span> : Ext.FocusManager<div class="sub-desc"><p>A reference to the FocusManager singleton</p>
448 </div></li><li><span class="pre">cmp</span> : Ext.Component<div class="sub-desc"><p>The component that has been focused</p>
449 </div></li><li><span class="pre">previousCmp</span> : Ext.Component<div class="sub-desc"><p>The component that was previously focused,
450 or <code>undefined</code> if there was no previously focused component.</p>
451 </div></li></ul></div></div></div><div id="event-disable" class="member ni"><a href="Ext.FocusManager.html#event-disable" rel="event-disable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.FocusManager.html" class="definedIn docClass">Ext.FocusManager</a><br/><a href="../source/FocusManager.html#Ext-FocusManager-event-disable" class="viewSource">view source</a></div><a name="disable"></a><a name="event-disable"></a><a href="Ext.FocusManager.html#" rel="event-disable" class="cls expand">disable</a>(
452 <span class="pre">Ext.FocusManager fm</span>)
453 </div><div class="description"><div class="short"><p>Fires when the FocusManager is disabled</p>
454 </div><div class="long"><p>Fires when the FocusManager is disabled</p>
455 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fm</span> : Ext.FocusManager<div class="sub-desc"><p>A reference to the FocusManager singleton</p>
456 </div></li></ul></div></div></div><div id="event-enable" class="member ni"><a href="Ext.FocusManager.html#event-enable" rel="event-enable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.FocusManager.html" class="definedIn docClass">Ext.FocusManager</a><br/><a href="../source/FocusManager.html#Ext-FocusManager-event-enable" class="viewSource">view source</a></div><a name="enable"></a><a name="event-enable"></a><a href="Ext.FocusManager.html#" rel="event-enable" class="cls expand">enable</a>(
457 <span class="pre">Ext.FocusManager fm</span>)
458 </div><div class="description"><div class="short"><p>Fires when the FocusManager is enabled</p>
459 </div><div class="long"><p>Fires when the FocusManager is enabled</p>
460 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fm</span> : Ext.FocusManager<div class="sub-desc"><p>A reference to the FocusManager singleton</p>
461 </div></li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>