docs/source/Application.html

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   5   <title>The source code</title>
   6   <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
   7   <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
   8   <style type="text/css">
   9     .highlight { display: block; background-color: #ddd; }
  10   </style>
  11   <script type="text/javascript">
  12     function highlight() {
  13       document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
  14     }
  15   </script>
  16 </head>
  17 <body onload="prettyPrint(); highlight();">
  18   <pre class="prettyprint lang-js"><span id='Ext-app-Application'>/**
  19 </span> * Represents an Ext JS 4 application, which is typically a single page app using a {@link Ext.container.Viewport Viewport}.
  20  * A typical Ext.app.Application might look like this:
  21  *
  22  *     Ext.application({
  23  *         name: 'MyApp',
  24  *         launch: function() {
  25  *             Ext.create('Ext.container.Viewport', {
  26  *                 items: {
  27  *                     html: 'My App'
  28  *                 }
  29  *             });
  30  *         }
  31  *     });
  32  *
  33  * This does several things. First it creates a global variable called 'MyApp' - all of your Application's classes (such
  34  * as its Models, Views and Controllers) will reside under this single namespace, which drastically lowers the chances
  35  * of colliding global variables.
  36  *
  37  * When the page is ready and all of your JavaScript has loaded, your Application's {@link #launch} function is called,
  38  * at which time you can run the code that starts your app. Usually this consists of creating a Viewport, as we do in
  39  * the example above.
  40  *
  41  * # Telling Application about the rest of the app
  42  *
  43  * Because an Ext.app.Application represents an entire app, we should tell it about the other parts of the app - namely
  44  * the Models, Views and Controllers that are bundled with the application. Let's say we have a blog management app; we
  45  * might have Models and Controllers for Posts and Comments, and Views for listing, adding and editing Posts and Comments.
  46  * Here's how we'd tell our Application about all these things:
  47  *
  48  *     Ext.application({
  49  *         name: 'Blog',
  50  *         models: ['Post', 'Comment'],
  51  *         controllers: ['Posts', 'Comments'],
  52  *
  53  *         launch: function() {
  54  *             ...
  55  *         }
  56  *     });
  57  *
  58  * Note that we didn't actually list the Views directly in the Application itself. This is because Views are managed by
  59  * Controllers, so it makes sense to keep those dependencies there. The Application will load each of the specified
  60  * Controllers using the pathing conventions laid out in the [application architecture guide][mvc] -
  61  * in this case expecting the controllers to reside in `app/controller/Posts.js` and
  62  * `app/controller/Comments.js`. In turn, each Controller simply needs to list the Views it uses and they will be
  63  * automatically loaded. Here's how our Posts controller like be defined:
  64  *
  65  *     Ext.define('MyApp.controller.Posts', {
  66  *         extend: 'Ext.app.Controller',
  67  *         views: ['posts.List', 'posts.Edit'],
  68  *
  69  *         //the rest of the Controller here
  70  *     });
  71  *
  72  * Because we told our Application about our Models and Controllers, and our Controllers about their Views, Ext JS will
  73  * automatically load all of our app files for us. This means we don't have to manually add script tags into our html
  74  * files whenever we add a new class, but more importantly it enables us to create a minimized build of our entire
  75  * application using the Ext JS 4 SDK Tools.
  76  *
  77  * For more information about writing Ext JS 4 applications, please see the
  78  * [application architecture guide][mvc].
  79  *
  80  * [mvc]: #!/guide/application_architecture
  81  *
  82  * @docauthor Ed Spencer
  83  */
  84 Ext.define('Ext.app.Application', {
  85     extend: 'Ext.app.Controller',
  86
  87     requires: [
  88         'Ext.ModelManager',
  89         'Ext.data.Model',
  90         'Ext.data.StoreManager',
  91         'Ext.tip.QuickTipManager',
  92         'Ext.ComponentManager',
  93         'Ext.app.EventBus'
  94     ],
  95
  96 <span id='Ext-app-Application-cfg-name'>    /**
  97 </span>     * @cfg {String} name The name of your application. This will also be the namespace for your views, controllers
  98      * models and stores. Don't use spaces or special characters in the name.
  99      */
 100
 101 <span id='Ext-app-Application-cfg-scope'>    /**
 102 </span>     * @cfg {Object} scope The scope to execute the {@link #launch} function in. Defaults to the Application
 103      * instance.
 104      */
 105     scope: undefined,
 106
 107 <span id='Ext-app-Application-cfg-enableQuickTips'>    /**
 108 </span>     * @cfg {Boolean} enableQuickTips True to automatically set up Ext.tip.QuickTip support.
 109      */
 110     enableQuickTips: true,
 111
 112 <span id='Ext-app-Application-cfg-defaultUrl'>    /**
 113 </span>     * @cfg {String} defaultUrl When the app is first loaded, this url will be redirected to.
 114      */
 115
 116 <span id='Ext-app-Application-cfg-appFolder'>    /**
 117 </span>     * @cfg {String} appFolder The path to the directory which contains all application's classes.
 118      * This path will be registered via {@link Ext.Loader#setPath} for the namespace specified in the {@link #name name} config.
 119      */
 120     appFolder: 'app',
 121
 122 <span id='Ext-app-Application-cfg-autoCreateViewport'>    /**
 123 </span>     * @cfg {Boolean} autoCreateViewport True to automatically load and instantiate AppName.view.Viewport
 124      * before firing the launch function.
 125      */
 126     autoCreateViewport: false,
 127
 128 <span id='Ext-app-Application-method-constructor'>    /**
 129 </span>     * Creates new Application.
 130      * @param {Object} [config] Config object.
 131      */
 132     constructor: function(config) {
 133         config = config || {};
 134         Ext.apply(this, config);
 135
 136         var requires = config.requires || [];
 137
 138         Ext.Loader.setPath(this.name, this.appFolder);
 139
 140         if (this.paths) {
 141             Ext.Object.each(this.paths, function(key, value) {
 142                 Ext.Loader.setPath(key, value);
 143             });
 144         }
 145
 146         this.callParent(arguments);
 147
 148         this.eventbus = Ext.create('Ext.app.EventBus');
 149
 150         var controllers = Ext.Array.from(this.controllers),
 151             ln = controllers &amp;&amp; controllers.length,
 152             i, controller;
 153
 154         this.controllers = Ext.create('Ext.util.MixedCollection');
 155
 156         if (this.autoCreateViewport) {
 157             requires.push(this.getModuleClassName('Viewport', 'view'));
 158         }
 159
 160         for (i = 0; i &lt; ln; i++) {
 161             requires.push(this.getModuleClassName(controllers[i], 'controller'));
 162         }
 163
 164         Ext.require(requires);
 165
 166         Ext.onReady(function() {
 167             for (i = 0; i &lt; ln; i++) {
 168                 controller = this.getController(controllers[i]);
 169                 controller.init(this);
 170             }
 171
 172             this.onBeforeLaunch.call(this);
 173         }, this);
 174     },
 175
 176     control: function(selectors, listeners, controller) {
 177         this.eventbus.control(selectors, listeners, controller);
 178     },
 179
 180 <span id='Ext-app-Application-property-launch'>    /**
 181 </span>     * Called automatically when the page has completely loaded. This is an empty function that should be
 182      * overridden by each application that needs to take action on page load
 183      * @property launch
 184      * @type Function
 185      * @param {String} profile The detected {@link #profiles application profile}
 186      * @return {Boolean} By default, the Application will dispatch to the configured startup controller and
 187      * action immediately after running the launch function. Return false to prevent this behavior.
 188      */
 189     launch: Ext.emptyFn,
 190
 191 <span id='Ext-app-Application-method-onBeforeLaunch'>    /**
 192 </span>     * @private
 193      */
 194     onBeforeLaunch: function() {
 195         if (this.enableQuickTips) {
 196             Ext.tip.QuickTipManager.init();
 197         }
 198
 199         if (this.autoCreateViewport) {
 200             this.getView('Viewport').create();
 201         }
 202
 203         this.launch.call(this.scope || this);
 204         this.launched = true;
 205         this.fireEvent('launch', this);
 206
 207         this.controllers.each(function(controller) {
 208             controller.onLaunch(this);
 209         }, this);
 210     },
 211
 212     getModuleClassName: function(name, type) {
 213         var namespace = Ext.Loader.getPrefix(name);
 214
 215         if (namespace.length &gt; 0 &amp;&amp; namespace !== name) {
 216             return name;
 217         }
 218
 219         return this.name + '.' + type + '.' + name;
 220     },
 221
 222     getController: function(name) {
 223         var controller = this.controllers.get(name);
 224
 225         if (!controller) {
 226             controller = Ext.create(this.getModuleClassName(name, 'controller'), {
 227                 application: this,
 228                 id: name
 229             });
 230
 231             this.controllers.add(controller);
 232         }
 233
 234         return controller;
 235     },
 236
 237     getStore: function(name) {
 238         var store = Ext.StoreManager.get(name);
 239
 240         if (!store) {
 241             store = Ext.create(this.getModuleClassName(name, 'store'), {
 242                 storeId: name
 243             });
 244         }
 245
 246         return store;
 247     },
 248
 249     getModel: function(model) {
 250         model = this.getModuleClassName(model, 'model');
 251
 252         return Ext.ModelManager.getModel(model);
 253     },
 254
 255     getView: function(view) {
 256         view = this.getModuleClassName(view, 'view');
 257
 258         return Ext.ClassManager.get(view);
 259     }
 260 });
 261 </pre>
 262 </body>
 263 </html>