X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..refs/heads/master:/docs/output/Ext.app.Application.js?ds=inline diff --git a/docs/output/Ext.app.Application.js b/docs/output/Ext.app.Application.js index 8121792b..7b5c6e96 100644 --- a/docs/output/Ext.app.Application.js +++ b/docs/output/Ext.app.Application.js @@ -1,169 +1 @@ -Ext.data.JsonP.Ext_app_Application({ - "tagname": "class", - "name": "Ext.app.Application", - "doc": "
Represents an Ext JS 4 application, which is typically a single page app using a Viewport.\nA typical Ext.app.Application might look like this:
\n\nExt.application({\n name: 'MyApp',\n launch: function() {\n Ext.create('Ext.container.Viewport', {\n items: {\n html: 'My App'\n }\n });\n }\n});\n
\n\nThis does several things. First it creates a global variable called 'MyApp' - all of your Application's classes (such\nas its Models, Views and Controllers) will reside under this single namespace, which drastically lowers the chances\nof colliding global variables.
\n\nWhen the page is ready and all of your JavaScript has loaded, your Application's launch function is called,\nat which time you can run the code that starts your app. Usually this consists of creating a Viewport, as we do in\nthe example above.
\n\nTelling Application about the rest of the app
\n\nBecause an Ext.app.Application represents an entire app, we should tell it about the other parts of the app - namely\nthe Models, Views and Controllers that are bundled with the application. Let's say we have a blog management app; we\nmight have Models and Controllers for Posts and Comments, and Views for listing, adding and editing Posts and Comments.\nHere's how we'd tell our Application about all these things:
\n\nExt.application({\n name: 'Blog',\n models: ['Post', 'Comment'],\n controllers: ['Posts', 'Comments'],\n\n launch: function() {\n ...\n }\n});\n
\n\nNote that we didn't actually list the Views directly in the Application itself. This is because Views are managed by\nControllers, so it makes sense to keep those dependencies there. The Application will load each of the specified\nControllers using the pathing conventions laid out in the application\narchitecture guide - in this case expecting the controllers to reside in app/controller/Posts.js and\napp/controller/Comments.js. In turn, each Controller simply needs to list the Views it uses and they will be\nautomatically loaded. Here's how our Posts controller like be defined:
\n\nExt.define('MyApp.controller.Posts', {\n extend: 'Ext.app.Controller',\n views: ['posts.List', 'posts.Edit'],\n\n //the rest of the Controller here\n});\n
\n\nBecause we told our Application about our Models and Controllers, and our Controllers about their Views, Ext JS will\nautomatically load all of our app files for us. This means we don't have to manually add script tags into our html\nfiles whenever we add a new class, but more importantly it enables us to create a minimized build of our entire\napplication using the Ext JS 4 SDK Tools.
\n\nFor more information about writing Ext JS 4 applications, please see the \napplication architecture guide.
\n", - "extends": "Ext.app.Controller", - "mixins": [ - - ], - "alternateClassNames": [ - - ], - "xtype": null, - "author": null, - "docauthor": "Ed Spencer", - "singleton": false, - "private": false, - "cfg": [ - { - "tagname": "cfg", - "name": "appFolder", - "member": "Ext.app.Application", - "type": "String", - "doc": "The path to the directory which contains all application's classes.\nThis path will be registered via Ext.Loader.setPath for the namespace specified in the name config.\nDefaults to 'app'
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/app/Application.js", - "linenr": 101, - "html_filename": "Application.html", - "href": "Application.html#Ext-app-Application-cfg-appFolder", - "shortDoc": "The path to the directory which contains all application's classes.\nThis path will be registered via Ext.Loader.setPa..." - }, - { - "tagname": "cfg", - "name": "autoCreateViewport", - "member": "Ext.app.Application", - "type": "Boolean", - "doc": "True to automatically load and instantiate AppName.view.Viewport\nbefore firing the launch function (defaults to false).
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/app/Application.js", - "linenr": 108, - "html_filename": "Application.html", - "href": "Application.html#Ext-app-Application-cfg-autoCreateViewport" - }, - { - "tagname": "cfg", - "name": "defaultUrl", - "member": "Ext.app.Application", - "type": "String", - "doc": "When the app is first loaded, this url will be redirected to. Defaults to undefined
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/app/Application.js", - "linenr": 97, - "html_filename": "Application.html", - "href": "Application.html#Ext-app-Application-cfg-defaultUrl" - }, - { - "tagname": "cfg", - "name": "enableQuickTips", - "member": "Ext.app.Application", - "type": "Boolean", - "doc": "True to automatically set up Ext.tip.QuickTip support (defaults to true)
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/app/Application.js", - "linenr": 92, - "html_filename": "Application.html", - "href": "Application.html#Ext-app-Application-cfg-enableQuickTips" - }, - { - "tagname": "cfg", - "name": "id", - "member": "Ext.app.Controller", - "type": "String", - "doc": "The id of this controller. You can use this id when dispatching.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/app/Controller.js", - "linenr": 136, - "html_filename": "Controller.html", - "href": "Controller.html#Ext-app-Controller-cfg-id" - }, - { - "tagname": "cfg", - "name": "name", - "member": "Ext.app.Application", - "type": "String", - "doc": "The name of your application. This will also be the namespace for your views, controllers\nmodels and stores. Don't use spaces or special characters in the name.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/app/Application.js", - "linenr": 81, - "html_filename": "Application.html", - "href": "Application.html#Ext-app-Application-cfg-name", - "shortDoc": "The name of your application. This will also be the namespace for your views, controllers\nmodels and stores. Don't us..." - }, - { - "tagname": "cfg", - "name": "scope", - "member": "Ext.app.Application", - "type": "Object", - "doc": "The scope to execute the launch function in. Defaults to the Application\ninstance.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/app/Application.js", - "linenr": 86, - "html_filename": "Application.html", - "href": "Application.html#Ext-app-Application-cfg-scope" - } - ], - "method": [ - { - "tagname": "method", - "name": "Application", - "member": "Ext.app.Application", - "doc": "\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/app/Application.js", - "linenr": 1, - "html_filename": "Application.html", - "href": "Application.html#Ext-app-Application-method-constructor", - "shortDoc": "\n" - } - ], - "property": [ - { - "tagname": "property", - "name": "launch", - "member": "Ext.app.Application", - "type": "Function", - "doc": "Called automatically when the page has completely loaded. This is an empty function that should be\noverridden by each application that needs to take action on page load
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/app/Application.js", - "linenr": 162, - "html_filename": "Application.html", - "href": "Application.html#Ext-app-Application-property-launch", - "shortDoc": "Called automatically when the page has completely loaded. This is an empty function that should be\noverridden by each..." - } - ], - "event": [ - - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/app/Application.js", - "linenr": 1, - "html_filename": "Application.html", - "href": "Application.html#Ext-app-Application", - "cssVar": [ - - ], - "cssMixin": [ - - ], - "component": false, - "superclasses": [ - "Ext.app.Controller" - ], - "subclasses": [ - - ], - "mixedInto": [ - - ], - "allMixins": [ - - ] -}); \ No newline at end of file +Ext.data.JsonP.Ext_app_Application({"tagname":"class","html":"Hierarchy
Ext.BaseExt.app.ControllerExt.app.ApplicationMixins
Requires
Files
Represents an Ext JS 4 application, which is typically a single page app using a Viewport.\nA typical Ext.app.Application might look like this:
\n\nExt.application({\n name: 'MyApp',\n launch: function() {\n Ext.create('Ext.container.Viewport', {\n items: {\n html: 'My App'\n }\n });\n }\n});\n
\n\nThis does several things. First it creates a global variable called 'MyApp' - all of your Application's classes (such\nas its Models, Views and Controllers) will reside under this single namespace, which drastically lowers the chances\nof colliding global variables.
\n\nWhen the page is ready and all of your JavaScript has loaded, your Application's launch function is called,\nat which time you can run the code that starts your app. Usually this consists of creating a Viewport, as we do in\nthe example above.
\n\nBecause an Ext.app.Application represents an entire app, we should tell it about the other parts of the app - namely\nthe Models, Views and Controllers that are bundled with the application. Let's say we have a blog management app; we\nmight have Models and Controllers for Posts and Comments, and Views for listing, adding and editing Posts and Comments.\nHere's how we'd tell our Application about all these things:
\n\nExt.application({\n name: 'Blog',\n models: ['Post', 'Comment'],\n controllers: ['Posts', 'Comments'],\n\n launch: function() {\n ...\n }\n});\n
\n\nNote that we didn't actually list the Views directly in the Application itself. This is because Views are managed by\nControllers, so it makes sense to keep those dependencies there. The Application will load each of the specified\nControllers using the pathing conventions laid out in the application architecture guide -\nin this case expecting the controllers to reside in app/controller/Posts.js
and\napp/controller/Comments.js
. In turn, each Controller simply needs to list the Views it uses and they will be\nautomatically loaded. Here's how our Posts controller like be defined:
Ext.define('MyApp.controller.Posts', {\n extend: 'Ext.app.Controller',\n views: ['posts.List', 'posts.Edit'],\n\n //the rest of the Controller here\n});\n
\n\nBecause we told our Application about our Models and Controllers, and our Controllers about their Views, Ext JS will\nautomatically load all of our app files for us. This means we don't have to manually add script tags into our html\nfiles whenever we add a new class, but more importantly it enables us to create a minimized build of our entire\napplication using the Ext JS 4 SDK Tools.
\n\nFor more information about writing Ext JS 4 applications, please see the\napplication architecture guide.
\nThe path to the directory which contains all application's classes.\nThis path will be registered via Ext.Loader.setPath for the namespace specified in the name config.
\nDefaults to: "app"
True to automatically load and instantiate AppName.view.Viewport\nbefore firing the launch function.
\nDefaults to: false
When the app is first loaded, this url will be redirected to.
\nWhen the app is first loaded, this url will be redirected to.
\nTrue to automatically set up Ext.tip.QuickTip support.
\nDefaults to: true
A config object containing one or more event handlers to be added to this object during initialization. This\nshould be a valid listeners config object as specified in the addListener example for attaching multiple\nhandlers at once.
\n\nDOM events from Ext JS Components
\n\nWhile some Ext JS Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this is usually\nonly done when extra value can be added. For example the DataView's itemclick
event passing the node clicked on. To access DOM events directly from a\nchild element of a Component, we need to specify the element
option to identify the Component property to add a\nDOM listener to:
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
\nArray of models to require from AppName.model namespace. For example:
\n\nExt.define(\"MyApp.controller.Foo\", {\n extend: \"Ext.app.Controller\",\n models: ['User', 'Vehicle']\n});\n
\n\nThis is equivalent of:
\n\nExt.define(\"MyApp.controller.Foo\", {\n extend: \"Ext.app.Controller\",\n requires: ['MyApp.model.User', 'MyApp.model.Vehicle']\n});\n
\nThe name of your application. This will also be the namespace for your views, controllers\nmodels and stores. Don't use spaces or special characters in the name.
\nThe scope to execute the launch function in. Defaults to the Application\ninstance.
\nArray of stores to require from AppName.store namespace. For example:
\n\nExt.define(\"MyApp.controller.Foo\", {\n extend: \"Ext.app.Controller\",\n stores: ['Users', 'Vehicles']\n});\n
\n\nThis is equivalent of:
\n\nExt.define(\"MyApp.controller.Foo\", {\n extend: \"Ext.app.Controller\",\n requires: ['MyApp.store.Users', 'MyApp.store.Vehicles']\n});\n
\nArray of views to require from AppName.view namespace. For example:
\n\nExt.define(\"MyApp.controller.Foo\", {\n extend: \"Ext.app.Controller\",\n views: ['List', 'Detail']\n});\n
\n\nThis is equivalent of:
\n\nExt.define(\"MyApp.controller.Foo\", {\n extend: \"Ext.app.Controller\",\n requires: ['MyApp.view.List', 'MyApp.view.Detail']\n});\n
\nCalled automatically when the page has completely loaded. This is an empty function that should be\noverridden by each application that needs to take action on page load
\nGet the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self
is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison
Ext.define('My.Cat', {\n statics: {\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n alert(this.self.speciesName); / dependent on 'this'\n\n return this;\n },\n\n clone: function() {\n return new this.self();\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\n
\nAdds the specified events to the list of events which this Observable may fire.
\nEither an object with event names as properties with a value of true
or the first\nevent name string if multiple event names are being passed as separate parameters. Usage:
this.addEvents({\n storeloaded: true,\n storecleared: true\n});\n
\nAdditional event names if multiple event names are being passed as separate\nparameters. Usage:
\n\nthis.addEvents('storeloaded', 'storecleared');\n
\nAppends an event handler to this object.
\nThe name of the event to listen for. May also be an object who's property names are\nevent names.
\n\nThe method the event invokes. Will be called with arguments given to\nfireEvent plus the options
parameter described below.
The scope (this
reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
An object containing handler configuration.
\n\n\n\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\n\n\n\nThis object may contain any of the following properties:
\n\n\n\n\nscope : Object
\n\nThe scope (this
reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
Combining Options
\n\n\n\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\n\n\n\nA delayed, one-time listener.
\n\n\n\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n
\n\n\n\n\nAttaching multiple handlers in 1 call
\n\n\n\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\n\n\n\nmyGridPanel.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
\n\n\n\n\nOne can also specify options for each event handler separately:
\n\n\n\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n\nAdds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.
\nThe item to which to add a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
If the ename
parameter was an event name, this is the\naddListener options.
Call the original method that was previously overridden with override
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nThe arguments, either an array or the arguments
object
Returns the result after calling the overridden method
\nCall the parent's overridden method. For example:
\n\nExt.define('My.own.A', {\n constructor: function(test) {\n alert(test);\n }\n});\n\nExt.define('My.own.B', {\n extend: 'My.own.A',\n\n constructor: function(test) {\n alert(test);\n\n this.callParent([test + 1]);\n }\n});\n\nExt.define('My.own.C', {\n extend: 'My.own.B',\n\n constructor: function() {\n alert(\"Going to call parent's overriden constructor...\");\n\n this.callParent(arguments);\n }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n // alerts '2', then alerts '3'\n
\nThe arguments, either an array or the arguments
object\nfrom the current method, for example: this.callParent(arguments)
Returns the result from the superclass' method
\nRemoves all listeners for this object including the managed listeners
\nAdds listeners to components selected via Ext.ComponentQuery. Accepts an\nobject containing component paths mapped to a hash of listener functions.
\n\nIn the following example the updateUser
function is mapped to to the click
\nevent on a button component, which is a child of the useredit
component.
Ext.define('AM.controller.Users', {\n init: function() {\n this.control({\n 'useredit button[action=save]': {\n click: this.updateUser\n }\n });\n },\n\n updateUser: function(button) {\n console.log('clicked the Save button');\n }\n});\n
\n\nSee Ext.ComponentQuery for more information on component selectors.
\nEnables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget()
if\npresent. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers.\nSee Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the\nComponent's immediate owner. But if a known target is required, this can be overridden to access the\nrequired target more quickly.
\n\nExample:
\n\nExt.override(Ext.form.field.Base, {\n // Add functionality to Field's initComponent to enable the change event to bubble\n initComponent : 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.\n getBubbleTarget : function() {\n if (!this.formPanel) {\n this.formPanel = this.findParentByType('form');\n }\n return this.formPanel;\n }\n});\n\nvar myForm = new Ext.formPanel({\n title: 'User Details',\n items: [{\n ...\n }],\n listeners: {\n change: function() {\n // Title goes red if form has been modified.\n myForm.header.setStyle('color', 'red');\n }\n }\n});\n
\nFires the specified event with the passed parameters (minus the event name, plus the options
object passed\nto addListener).
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by\ncalling enableBubble.
\nThe name of the event to fire.
\nVariable number of parameters are passed to handlers.
\nreturns false if any of the handlers return false otherwise it returns true.
\nReturns instance of a controller with the given name.\nWhen controller doesn't exist yet, it's created.
\na controller instance.
\nReturns a Model class with the given name.\nA shorthand for using Ext.ModelManager.getModel.
\na model class.
\nReturns instance of a Store with the given name.\nWhen store doesn't exist yet, it's created.
\na store instance.
\nA template method that is called when your application boots. It is called before the\nApplication's launch function is executed so gives a hook point to run any code before\nyour Viewport is created.
\nThis is a template method. A hook into the functionality of this class.Feel free to override it in child classes.
Initialize configuration for this class. a typical example:
\n\nExt.define('My.awesome.Class', {\n // The default config\n config: {\n name: 'Awesome',\n isAwesome: true\n },\n\n constructor: function(config) {\n this.initConfig(config);\n\n return this;\n }\n});\n\nvar awesome = new My.awesome.Class({\n name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\nmixins The mixin prototypes as key - value pairs
\nShorthand for addManagedListener.
\n\nAdds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.
\nThe item to which to add a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
If the ename
parameter was an event name, this is the\naddListener options.
Shorthand for removeManagedListener.
\n\nRemoves listeners that were added by the mon method.
\nThe item from which to remove a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
Shorthand for addListener.
\n\nAppends an event handler to this object.
\nThe name of the event to listen for. May also be an object who's property names are\nevent names.
\n\nThe method the event invokes. Will be called with arguments given to\nfireEvent plus the options
parameter described below.
The scope (this
reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
An object containing handler configuration.
\n\n\n\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\n\n\n\nThis object may contain any of the following properties:
\n\n\n\n\nscope : Object
\n\nThe scope (this
reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
Combining Options
\n\n\n\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\n\n\n\nA delayed, one-time listener.
\n\n\n\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n
\n\n\n\n\nAttaching multiple handlers in 1 call
\n\n\n\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\n\n\n\nmyGridPanel.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
\n\n\n\n\nOne can also specify options for each event handler separately:
\n\n\n\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n\nA template method like init, but called after the viewport is created.\nThis is called after the launch method of Application is executed.
\nThis is a template method. A hook into the functionality of this class.Feel free to override it in child classes.
Removes an event handler.
\nThe type of event the handler was associated with.
\n\nThe handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\nThe scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\nRemoves listeners that were added by the mon method.
\nThe item from which to remove a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
Resumes firing events (see suspendEvents).
\n\nIf events were suspended using the queueSuspended
parameter, then all events fired\nduring event suspension will be sent to any listeners now.
Get the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics()
is scope-independent and it always returns the class from which it was called, regardless of what\nthis
points to during run-time
Ext.define('My.Cat', {\n statics: {\n totalCreated: 0,\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n var statics = this.statics();\n\n alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to\n // equivalent to: My.Cat.speciesName\n\n alert(this.self.speciesName); // dependent on 'this'\n\n statics.totalCreated++;\n\n return this;\n },\n\n clone: function() {\n var cloned = new this.self; // dependent on 'this'\n\n cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName\n\n return cloned;\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n },\n\n constructor: function() {\n this.callParent();\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\nalert(clone.groupName); // alerts 'Cat'\n\nalert(My.Cat.totalCreated); // alerts 3\n
\nSuspends the firing of all events. (see resumeEvents)
\nPass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.
\nShorthand for removeListener.
\n\nRemoves an event handler.
\nThe type of event the handler was associated with.
\n\nThe handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\nThe scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\nAdd / override static properties of this class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.addStatics({\n someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'\n method1: function() { ... }, // My.cool.Class.method1 = function() { ... };\n method2: function() { ... } // My.cool.Class.method2 = function() { ... };\n});\n
\nthis
\nBorrow another class' members to the prototype of this class.
\n\nExt.define('Bank', {\n money: '$$$',\n printMoney: function() {\n alert('$$$$$$$');\n }\n});\n\nExt.define('Thief', {\n ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n
\nThe class to borrow members from
\nThe names of the members to borrow
\nthis
\nCreate a new instance of this Class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\n
\n\nAll parameters are passed to the constructor of the class.
\nthe created instance.
\nCreate aliases for existing prototype methods. Example:
\n\nExt.define('My.cool.Class', {\n method1: function() { ... },\n method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n method3: 'method1',\n method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n
\nThe new method name, or an object to set multiple aliases. See\nflexSetter
\nThe original method name
\nGet the current class' name in string format.
\n\nExt.define('My.cool.Class', {\n constructor: function() {\n alert(this.self.getName()); // alerts 'My.cool.Class'\n }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n
\nclassName
\nAdd methods / properties to the prototype of this class.
\n\nExt.define('My.awesome.Cat', {\n constructor: function() {\n ...\n }\n});\n\n My.awesome.Cat.implement({\n meow: function() {\n alert('Meowww...');\n }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
\nOverride prototype members of this class. Overridden methods can be invoked via\ncallOverridden
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nthis
\n