1 Ext.data.JsonP.Ext_grid_plugin_HeaderReorderer({
3 "name": "Ext.grid.plugin.HeaderReorderer",
5 "extends": "Ext.util.Observable",
9 "alternateClassNames": [
21 "member": "Ext.util.Observable",
23 "doc": "<p>(optional) <p>A config object containing one or more event handlers to be added to this\nobject during initialization. This should be a valid listeners config object as specified in the\n<a href=\"#/api/Ext.grid.plugin.HeaderReorderer-method-addListener\" rel=\"Ext.grid.plugin.HeaderReorderer-method-addListener\" class=\"docClass\">addListener</a> example for attaching multiple handlers at once.</p></p>\n\n<br><p><b><u>DOM events from ExtJs <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a></u></b></p>\n\n\n<br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n<p>is usually only done when extra value can be added. For example the <a href=\"#/api/Ext.view.View\" rel=\"Ext.view.View\" class=\"docClass\">DataView</a>'s\n<b><code><a href=\"#/api/Ext.view.View--click\" rel=\"Ext.view.View--click\" class=\"docClass\">click</a></code></b> event passing the node clicked on. To access DOM\nevents directly from a child element of a Component, we need to specify the <code>element</code> option to\nidentify the Component property to add a DOM listener to:</p>\n\n<pre><code>new Ext.panel.Panel({\n width: 400,\n height: 200,\n dockedItems: [{\n xtype: 'toolbar'\n }],\n listeners: {\n click: {\n element: 'el', //bind to the underlying el property on the panel\n fn: function(){ console.log('click el'); }\n },\n dblclick: {\n element: 'body', //bind to the underlying body property on the panel\n fn: function(){ console.log('dblclick body'); }\n }\n }\n});\n</code></pre>\n\n\n<p></p></p>\n",
25 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
27 "html_filename": "Observable.html",
28 "href": "Observable.html#Ext-util-Observable-cfg-listeners",
29 "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization. T..."
36 "member": "Ext.util.Observable",
37 "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
40 "type": "Object/String",
42 "doc": "<p>Either an object with event names as properties with a value of <code>true</code>\nor the first event name string if multiple event names are being passed as separate parameters.</p>\n",
48 "doc": "<p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:</p>\n\n<pre><code>this.addEvents('storeloaded', 'storecleared');\n</code></pre>\n\n",
58 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
60 "html_filename": "Observable.html",
61 "href": "Observable.html#Ext-util-Observable-method-addEvents",
62 "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
66 "name": "addListener",
67 "member": "Ext.util.Observable",
68 "doc": "<p>Appends an event handler to this object.</p>\n",
73 "doc": "<p>The name of the event to listen for. May also be an object who's property names are event names. See</p>\n",
79 "doc": "<p>The method the event invokes.</p>\n",
85 "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
91 "doc": "<p>(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:<ul>\n<li><b>scope</b> : Object<div class=\"sub-desc\">The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></div></li>\n<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>\n<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>\n<li><b>buffer</b> : Number<div class=\"sub-desc\">Causes the handler to be scheduled to run in an <a href=\"#/api/Ext.util.DelayedTask\" rel=\"Ext.util.DelayedTask\" class=\"docClass\">Ext.util.DelayedTask</a> delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>\n<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>\nif the event was bubbled up from a child Observable.</div></li>\n<li><b>element</b> : String<div class=\"sub-desc\"><b>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</b>\nThe name of a Component property which references an element to add a listener to.</p>\n\n<p>This option is useful during Component construction to add DOM event listeners to elements of <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which\nwill exist only after the Component is rendered. For example, to add a click listener to a Panel's body:\n<pre><code>new Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n</code></pre></p>\n\n\n<p>When added in this way, the options available are the options applicable to <a href=\"#/api/Ext.core.Element-method-addListener\" rel=\"Ext.core.Element-method-addListener\" class=\"docClass\">Ext.core.Element.addListener</a></p>\n\n\n<p></div></li>\n</ul><br></p>\n\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA delayed, one-time listener.\n<pre><code>myPanel.on('hide', this.handleClick, this, {\nsingle: true,\ndelay: 100\n});</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple events. For example:\n<pre><code>myGridPanel.on({\n cellClick: this.onCellClick,\n mouseover: this.onMouseOver,\n mouseout: this.onMouseOut,\n scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n</code></pre>.\n<p>\n\n",
101 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
103 "html_filename": "Observable.html",
104 "href": "Observable.html#Ext-util-Observable-method-addListener",
105 "shortDoc": "<p>Appends an event handler to this object.</p>\n"
109 "name": "addManagedListener",
110 "member": "Ext.util.Observable",
111 "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
114 "type": "Observable/Element",
116 "doc": "<p>The item to which to add a listener/listeners.</p>\n",
120 "type": "Object/String",
122 "doc": "<p>The event name, or an object containing event name properties.</p>\n",
128 "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
134 "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
140 "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
150 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
152 "html_filename": "Observable.html",
153 "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
154 "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
159 "member": "Ext.util.Observable",
160 "doc": "<p>Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.</p>\n",
163 "type": "Observable",
165 "doc": "<p>The Observable to capture events from.</p>\n",
171 "doc": "<p>The function to call when an event is fired.</p>\n",
177 "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
187 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
189 "html_filename": "Observable.html",
190 "href": "Observable.html#Ext-util-Observable-method-capture",
191 "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
195 "name": "clearListeners",
196 "member": "Ext.util.Observable",
197 "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
207 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
209 "html_filename": "Observable.html",
210 "href": "Observable.html#Ext-util-Observable-method-clearListeners",
211 "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
215 "name": "clearManagedListeners",
216 "member": "Ext.util.Observable",
217 "doc": "<p>Removes all managed listeners for this object.</p>\n",
227 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
229 "html_filename": "Observable.html",
230 "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
231 "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
235 "name": "enableBubble",
236 "member": "Ext.util.Observable",
237 "doc": "<p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\n<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\n\n\n<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>. The default\nimplementation in <a href=\"#/api/Ext.Component\" 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\naccess the required target more quickly.</p>\n\n\n<p>Example:</p>\n\n\n<pre><code>Ext.override(Ext.form.field.Base, {\n// Add functionality to Field's initComponent to enable the change event to bubble\ninitComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n this.enableBubble('change');\n}),\n\n// We know that we want Field's events to bubble directly to the FormPanel.\ngetBubbleTarget : function() {\n if (!this.formPanel) {\n this.formPanel = this.findParentByType('form');\n }\n return this.formPanel;\n}\n});\n\nvar myForm = new Ext.formPanel({\ntitle: 'User Details',\nitems: [{\n ...\n}],\nlisteners: {\n change: function() {\n // Title goes red if form has been modified.\n myForm.header.setStyle('color', 'red');\n }\n}\n});\n</code></pre>\n\n",
240 "type": "String/Array",
242 "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
252 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
254 "html_filename": "Observable.html",
255 "href": "Observable.html#Ext-util-Observable-method-enableBubble",
256 "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
261 "member": "Ext.util.Observable",
262 "doc": "<p>Fires the specified event with the passed parameters (minus the event name).</p>\n\n\n<p>An event may be set to bubble up an Observable parent hierarchy (See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>)\nby calling <a href=\"#/api/Ext.grid.plugin.HeaderReorderer-method-enableBubble\" rel=\"Ext.grid.plugin.HeaderReorderer-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
267 "doc": "<p>The name of the event to fire.</p>\n",
273 "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
279 "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
283 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
285 "html_filename": "Observable.html",
286 "href": "Observable.html#Ext-util-Observable-method-fireEvent",
287 "shortDoc": "Fires the specified event with the passed parameters (minus the event name).\n\n\nAn event may be set to bubble up an Ob..."
291 "name": "hasListener",
292 "member": "Ext.util.Observable",
293 "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
298 "doc": "<p>The name of the event to check for</p>\n",
304 "doc": "<p>True if the event is being listened for, else false</p>\n"
308 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
310 "html_filename": "Observable.html",
311 "href": "Observable.html#Ext-util-Observable-method-hasListener",
312 "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
317 "member": "Ext.util.Observable",
318 "doc": "<p>Sets observability on the passed class constructor.</p>\n\n<p>This makes any event fired on any instance of the passed class also fire a single event through\nthe <strong>class</strong> allowing for central handling of events on many instances at once.</p>\n\n<p>Usage:</p>\n\n<pre><code>Ext.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n console.log('Ajax request made to ' + options.url);\n});\n</code></pre>\n",
323 "doc": "<p>The class constructor to make observable.</p>\n",
329 "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.grid.plugin.HeaderReorderer-method-addListener\" rel=\"Ext.grid.plugin.HeaderReorderer-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
339 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
341 "html_filename": "Observable.html",
342 "href": "Observable.html#Ext-util-Observable-method-observe",
343 "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
348 "member": "Ext.util.Observable",
349 "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.grid.plugin.HeaderReorderer-method-addListener\" rel=\"Ext.grid.plugin.HeaderReorderer-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
354 "doc": "<p>The type of event to listen for</p>\n",
360 "doc": "<p>The method the event invokes</p>\n",
366 "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
372 "doc": "<p>(optional) An object containing handler configuration.</p>\n",
382 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
384 "html_filename": "Observable.html",
385 "href": "Observable.html#Ext-util-Observable-method-on",
386 "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.grid.plugin.HeaderReorderer-method-addListener\" rel=\"Ext.grid.plugin.HeaderReorderer-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
390 "name": "relayEvents",
391 "member": "Ext.util.Observable",
392 "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
397 "doc": "<p>The Observable whose events this object is to relay.</p>\n",
403 "doc": "<p>Array of event names to relay.</p>\n",
419 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
421 "html_filename": "Observable.html",
422 "href": "Observable.html#Ext-util-Observable-method-relayEvents",
423 "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
427 "name": "releaseCapture",
428 "member": "Ext.util.Observable",
429 "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
432 "type": "Observable",
434 "doc": "<p>The Observable to release</p>\n",
444 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
446 "html_filename": "Observable.html",
447 "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
448 "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
452 "name": "removeListener",
453 "member": "Ext.util.Observable",
454 "doc": "<p>Removes an event handler.</p>\n",
459 "doc": "<p>The type of event the handler was associated with.</p>\n",
465 "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.grid.plugin.HeaderReorderer-method-addListener\" rel=\"Ext.grid.plugin.HeaderReorderer-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
471 "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
481 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
483 "html_filename": "Observable.html",
484 "href": "Observable.html#Ext-util-Observable-method-removeListener",
485 "shortDoc": "<p>Removes an event handler.</p>\n"
489 "name": "removeManagedListener",
490 "member": "Ext.util.Observable",
491 "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.grid.plugin.HeaderReorderer--mon\" rel=\"Ext.grid.plugin.HeaderReorderer--mon\" class=\"docClass\">mon</a> method.</p>\n",
494 "type": "Observable|Element",
496 "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
500 "type": "Object|String",
502 "doc": "<p>The event name, or an object containing event name properties.</p>\n",
508 "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
514 "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
524 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
526 "html_filename": "Observable.html",
527 "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
528 "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.grid.plugin.HeaderReorderer--mon\" rel=\"Ext.grid.plugin.HeaderReorderer--mon\" class=\"docClass\">mon</a> method.</p>\n"
532 "name": "resumeEvents",
533 "member": "Ext.util.Observable",
534 "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.grid.plugin.HeaderReorderer-method-suspendEvents\" rel=\"Ext.grid.plugin.HeaderReorderer-method-suspendEvents\" class=\"docClass\">suspendEvents</a>)\nIf events were suspended using the <code><b>queueSuspended</b></code> parameter, then all\nevents fired during event suspension will be sent to any listeners now.</p>\n",
544 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
546 "html_filename": "Observable.html",
547 "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
548 "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
552 "name": "suspendEvents",
553 "member": "Ext.util.Observable",
554 "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.grid.plugin.HeaderReorderer-method-resumeEvents\" rel=\"Ext.grid.plugin.HeaderReorderer-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
558 "name": "queueSuspended",
559 "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.grid.plugin.HeaderReorderer-method-resumeEvents\" rel=\"Ext.grid.plugin.HeaderReorderer-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
569 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
571 "html_filename": "Observable.html",
572 "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
573 "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.grid.plugin.HeaderReorderer-method-resumeEvents\" rel=\"Ext.grid.plugin.HeaderReorderer-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
578 "member": "Ext.util.Observable",
579 "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.grid.plugin.HeaderReorderer-method-removeListener\" rel=\"Ext.grid.plugin.HeaderReorderer-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
584 "doc": "<p>The type of event the handler was associated with.</p>\n",
590 "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.grid.plugin.HeaderReorderer-method-addListener\" rel=\"Ext.grid.plugin.HeaderReorderer-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
596 "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
606 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
608 "html_filename": "Observable.html",
609 "href": "Observable.html#Ext-util-Observable-method-un",
610 "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.grid.plugin.HeaderReorderer-method-removeListener\" rel=\"Ext.grid.plugin.HeaderReorderer-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
619 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/plugin/HeaderReorderer.js",
621 "html_filename": "HeaderReorderer.html",
622 "href": "HeaderReorderer.html#Ext-grid-plugin-HeaderReorderer",
631 "Ext.util.Observable"