Ember.Application Class
An instance of Ember.Application
is the starting point for every Ember
application. It helps to instantiate, initialize and coordinate the many
objects that make up your app.
Each Ember app has one and only one Ember.Application
object. In fact, the
very first thing you should do in your application is create the instance:
window.App = Ember.Application.create();
Typically, the application object is the only global variable. All other
classes in your app should be properties on the Ember.Application
instance,
which highlights its first role: a global namespace.
For example, if you define a view class, it might look like this:
App.MyView = Ember.View.extend();
By default, calling Ember.Application.create()
will automatically initialize
your application by calling the Ember.Application.initialize()
method. If
you need to delay initialization, you can call your app's deferReadiness()
method. When you are ready for your app to be initialized, call its
advanceReadiness()
method.
You can define a ready
method on the Ember.Application
instance, which
will be run by Ember when the application is initialized.
Because Ember.Application
inherits from Ember.Namespace
, any classes
you create will have useful string representations when calling toString()
.
See the Ember.Namespace
documentation for more information.
While you can think of your Ember.Application
as a container that holds the
other classes in your application, there are several other responsibilities
going on under-the-hood that you may want to understand.
Event Delegation
Ember uses a technique called event delegation. This allows the framework
to set up a global, shared event listener instead of requiring each view to
do it manually. For example, instead of each view registering its own
mousedown
listener on its associated element, Ember sets up a mousedown
listener on the body
.
If a mousedown
event occurs, Ember will look at the target of the event and
start walking up the DOM node tree, finding corresponding views and invoking
their mouseDown
method as it goes.
Ember.Application
has a number of default events that it listens for, as
well as a mapping from lowercase events to camel-cased view method names. For
example, the keypress
event causes the keyPress
method on the view to be
called, the dblclick
event causes doubleClick
to be called, and so on.
If there is a bubbling browser event that Ember does not listen for by
default, you can specify custom events and their corresponding view method
names by setting the application's customEvents
property:
App = Ember.Application.create({
customEvents: {
// add support for the paste event
paste: "paste"
}
});
By default, the application sets up these event listeners on the document body. However, in cases where you are embedding an Ember application inside an existing page, you may want it to set up the listeners on an element inside the body.
For example, if only events inside a DOM element with the ID of ember-app
should be delegated, set your application's rootElement
property:
window.App = Ember.Application.create({
rootElement: '#ember-app'
});
The rootElement
can be either a DOM element or a jQuery-compatible selector
string. Note that views appended to the DOM outside the root element will
not receive events. If you specify a custom root element, make sure you only
append views inside it!
To learn more about the advantages of event delegation and the Ember view layer, and a list of the event listeners that are setup by default, visit the Ember View Layer guide.
Initializers
Libraries on top of Ember can add initializers, like so:
Ember.Application.initializer({
name: 'api-adapter',
initialize: function(container, application) {
application.register('api-adapter:main', ApiAdapter);
}
});
Initializers provide an opportunity to access the container, which organizes the different components of an Ember application. Additionally they provide a chance to access the instantiated application. Beyond being used for libraries, initializers are also a great way to organize dependency injection or setup in your own application.
Routing
In addition to creating your application's router, Ember.Application
is
also responsible for telling the router when to start routing. Transitions
between routes can be logged with the LOG_TRANSITIONS
flag, and more
detailed intra-transition logging can be logged with
the LOG_TRANSITIONS_INTERNAL
flag:
window.App = Ember.Application.create({
LOG_TRANSITIONS: true, // basic logging of successful transitions
LOG_TRANSITIONS_INTERNAL: true // detailed logging of all routing steps
});
By default, the router will begin trying to translate the current URL into
application state once the browser emits the DOMContentReady
event. If you
need to defer routing, you can call the application's deferReadiness()
method. Once routing can begin, call the advanceReadiness()
method.
If there is any setup required before routing begins, you can implement a
ready()
method on your app that will be invoked immediately before routing
begins.
Item Index
Methods
- _initialize
- _scheduledDestroy
- addObserver
- advanceReadiness
- beginPropertyChanges
- buildContainer
- buildContainer static
- cacheFor
- decrementProperty
- defaultRouter
- deferReadiness
- destroy
- didBecomeReady
- eachComputedProperty
- endPropertyChanges
- get
- getProperties
- getWithDefault
- hasObserverFor
- incrementProperty
- init
- initialize deprecated
- inject
- metaForProperty
- notifyPropertyChange
- propertyDidChange
- propertyWillChange
- register
- removeObserver
- reopen
- reopenClass
- reset
- resolverFor
- runInitializers
- scheduleInitialize
- set
- setProperties
- setupEventDispatcher
- toggleProperty
- toString
- willDestroy
Properties
Events
Methods
_initialize
()
private
Initialize the application. This happens automatically.
Run any initializers and run the application load hook. These hooks may choose to defer readiness. For example, an authentication hook might want to defer readiness until the auth token has been retrieved.
_scheduledDestroy
()
private
destroy
method.
addObserver
-
key
-
target
-
method
context
parameter:
`
javascript
fooDidChange: function(sender, key, value, rev) { };
`
The sender is the object that changed. The key is the property that
changes. The value property is currently reserved and unused. The rev
is the last property revision of the object when it changed, which you can
use to detect if the key value has really changed or not.
If you pass a context
parameter, the context will be passed before the
revision like so:
`
javascript
fooDidChange: function(sender, key, value, context, rev) { };
`
Usually you will not need the value, context or revision parameters at
the end. In this case, it is common to write observer methods that take
only a sender and key value as parameters or, if you aren't interested in
any of these values, to write an observer that has no parameters at all.
advanceReadiness
()
Call advanceReadiness
after any asynchronous setup logic has completed.
Each call to deferReadiness
must be matched by a call to advanceReadiness
or the application will never become ready and routing will not begin.
beginPropertyChanges
()
Ember.Observable
endPropertyChanges()
to deliver the deferred change notifications and end
deferring.
Returns:
buildContainer
()
Ember.Container
private
Build the container for the current application.
Also register a default application view in case the application itself does not.
Returns:
the configured container
buildContainer
-
namespace
This creates a container with the default Ember naming conventions.
It also configures the container:
- registered views are created every time they are looked up (they are not singletons)
- registered templates are not factories; the registered value is returned directly.
- the router receives the application as its
namespace
property - all controllers receive the router as their
target
andcontrollers
properties - all controllers receive the application as their
namespace
property - the application view receives the application controller as its
controller
property - the application view receives the application template as its
defaultTemplate
property
Parameters:
-
namespace
Ember.Applicationthe application to build the container for.
Returns:
the built container
cacheFor
-
keyName
Parameters:
-
keyName
String
Returns:
decrementProperty
-
keyName
-
decrement
`
javascript
player.decrementProperty('lives');
orc.decrementProperty('health', 5);
`
Parameters:
-
keyName
StringThe name of the property to decrement -
decrement
NumberThe amount to decrement by. Defaults to 1
Returns:
defaultRouter
()
Ember.Router
private
If the application has not opted out of routing and has not explicitly defined a router, supply a default router for the application author to configure.
This allows application developers to do:
var App = Ember.Application.create();
App.Router.map(function() {
this.resource('posts');
});
Returns:
the default router
deferReadiness
()
Use this to defer readiness until some condition is true.
Example:
App = Ember.Application.create();
App.deferReadiness();
jQuery.getJSON("/auth-token", function(token) {
App.token = token;
App.advanceReadiness();
});
This allows you to perform asynchronous setup logic and defer booting your application until the setup has finished.
However, if the setup requires a loading UI, it might be better to use the router for this purpose.
destroy
()
Ember.Object
isDestroyed
flag and removing its
metadata, which effectively destroys observers and bindings.
If you try to set a property on a destroyed object, an exception will be
raised.
Note that destruction is scheduled for the end of the run loop and does not
happen immediately. It will set an isDestroying flag immediately.
Returns:
didBecomeReady
()
private
eachComputedProperty
-
callback
-
binding
metaForProperty
) to the callback.
Parameters:
-
callback
Function -
binding
Object
endPropertyChanges
()
Ember.Observable
beginPropertyChanges()
at the beginning of the changes to defer change
notifications. When you are done making changes, call this method to
deliver the deferred change notifications and end deferring.
Returns:
get
-
keyName
object[keyName]
or object.keyName
,
however it supports both computed properties and the unknownProperty
handler.
Because get
unifies the syntax for accessing all these kinds
of properties, it can make many refactorings easier, such as replacing a
simple property with a computed property, or vice versa.
### Computed Properties
Computed properties are methods defined with the property
modifier
declared at the end, such as:
`
javascript
fullName: function() {
return this.get('firstName') + ' ' + this.get('lastName');
}.property('firstName', 'lastName')
`
When you call get
on a computed property, the function will be
called and the return value will be returned instead of the function
itself.
### Unknown Properties
Likewise, if you try to call get
on a property whose value is
undefined
, the unknownProperty()
method will be called on the object.
If this method returns any value other than undefined
, it will be returned
instead. This allows you to implement "virtual" properties that are
not defined upfront.
Parameters:
-
keyName
StringThe property to retrieve
Returns:
getProperties
-
list
getProperties
with a list of strings or an array:
`
javascript
record.getProperties('firstName', 'lastName', 'zipCode'); // { firstName: 'John', lastName: 'Doe', zipCode: '10011' }
`
is equivalent to:
`
javascript
record.getProperties(['firstName', 'lastName', 'zipCode']); // { firstName: 'John', lastName: 'Doe', zipCode: '10011' }
`
Parameters:
-
list
String... | Arrayof keys to get
Returns:
getWithDefault
-
keyName
-
defaultValue
undefined
.
`
javascript
person.getWithDefault('lastName', 'Doe');
`
Parameters:
-
keyName
StringThe name of the property to retrieve -
defaultValue
ObjectThe value to return if the property value is undefined
Returns:
hasObserverFor
-
key
true
if the object currently has observers registered for a
particular key. You can use this method to potentially defer performing
an expensive action until someone begins observing a particular property
on the object.
Parameters:
-
key
StringKey to check
Returns:
incrementProperty
-
keyName
-
increment
`
javascript
person.incrementProperty('age');
team.incrementProperty('score', 2);
`
Parameters:
-
keyName
StringThe name of the property to increment -
increment
NumberThe amount to increment by. Defaults to 1
Returns:
init
()
`
javascript
App.Person = Ember.Object.extend({
init: function() {
alert('Name is ' + this.get('name'));
}
});
var steve = App.Person.create({
name: "Steve"
});
// alerts 'Name is Steve'.
`
NOTE: If you do override init
for a framework class like Ember.View
or
Ember.ArrayController
, be sure to call this._super()
in your
init
declaration! If you don't, Ember may not have an opportunity to
do important setup work, and you'll see strange behavior in your
application.
initialize
()
deprecated
private
Calling initialize manually is not supported.
Please see Ember.Application#advanceReadiness and Ember.Application#deferReadiness.
inject
-
factoryNameOrType
-
property
-
injectionName
Define a dependency injection onto a specific factory or all factories of a type.
When Ember instantiates a controller, view, or other framework component it can attach a dependency to that component. This is often used to provide services to a set of framework components.
An example of providing a session object to all controllers:
var App = Ember.Application.create(),
Session = Ember.Object.extend({ isAuthenticated: false });
// A factory must be registered before it can be injected
App.register('session:main', Session);
// Inject 'session:main' onto all factories of the type 'controller'
// with the name 'session'
App.inject('controller', 'session', 'session:main');
App.IndexController = Ember.Controller.extend({
isLoggedIn: Ember.computed.alias('session.isAuthenticated')
});
Injections can also be performed on specific factories.
App.inject(<full_name or type>, <property name>, <full_name>)
App.inject('route', 'source', 'source:main')
App.inject('route:application', 'email', 'model:email')
It is important to note that injections can only be performed on
classes that are instantiated by Ember itself. Instantiating a class
directly (via create
or new
) bypasses the dependency injection
system.
Ember-Data instantiates its models in a unique manner, and consequently
injections onto models (or all models) will not work as expected. Injections
on models can be enabled by setting Ember.MODEL_FACTORY_INJECTIONS
to true
.
metaForProperty
-
key
`
javascript
person: function() {
var personId = this.get('personId');
return App.Person.create({ id: personId });
}.property().meta({ type: App.Person })
`
Once you've done this, you can retrieve the values saved to the computed
property from your class like this:
`
javascript
MyClass.metaForProperty('person');
`
This will return the original hash that was passed to meta()
.
Parameters:
-
key
Stringproperty name
notifyPropertyChange
-
keyName
propertyWillChange
and propertyDidChange
in
succession.
Parameters:
-
keyName
StringThe property key to be notified about.
Returns:
propertyDidChange
-
keyName
get()
or set()
on it. In this case, you can use this
method and propertyWillChange()
instead. Calling these two methods
together will notify all observers that the property has potentially
changed value.
Note that you must always call propertyWillChange
and propertyDidChange
as a pair. If you do not, it may get the property change groups out of
order and cause notifications to be delivered more often than you would
like.
Parameters:
-
keyName
StringThe property key that has just changed.
Returns:
propertyWillChange
-
keyName
get()
or set()
on it. In this case, you can use this
method and propertyDidChange()
instead. Calling these two methods
together will notify all observers that the property has potentially
changed value.
Note that you must always call propertyWillChange
and propertyDidChange
as a pair. If you do not, it may get the property change groups out of
order and cause notifications to be delivered more often than you would
like.
Parameters:
-
keyName
StringThe property key that is about to change.
Returns:
register
-
fullName
-
factory
-
options
Registers a factory that can be used for dependency injection (with
App.inject
) or for service lookup. Each factory is registered with
a full name including two parts: type:name
.
A simple example:
var App = Ember.Application.create();
App.Orange = Ember.Object.extend();
App.register('fruit:favorite', App.Orange);
Ember will resolve factories from the App
namespace automatically.
For example App.CarsController
will be discovered and returned if
an application requests controller:cars
.
An example of registering a controller with a non-standard name:
var App = Ember.Application.create(),
Session = Ember.Controller.extend();
App.register('controller:session', Session);
// The Session controller can now be treated like a normal controller,
// despite its non-standard name.
App.ApplicationController = Ember.Controller.extend({
needs: ['session']
});
Registered factories are instantiated by having create
called on them. Additionally they are singletons, each time
they are looked up they return the same instance.
Some examples modifying that default behavior:
var App = Ember.Application.create();
App.Person = Ember.Object.extend();
App.Orange = Ember.Object.extend();
App.Email = Ember.Object.extend();
App.session = Ember.Object.create();
App.register('model:user', App.Person, {singleton: false });
App.register('fruit:favorite', App.Orange);
App.register('communication:main', App.Email, {singleton: false});
App.register('session', App.session, {instantiate: false});
removeObserver
-
key
-
target
-
method
addObserver()
and your
target will no longer receive notifications.
reopen
()
`
javascript
MyObject = Ember.Object.extend({
name: 'an object'
});
o = MyObject.create();
o.get('name'); // 'an object'
MyObject.reopen({
say: function(msg){
console.log(msg);
}
})
o2 = MyObject.create();
o2.say("hello"); // logs "hello"
o.say("goodbye"); // logs "goodbye"
`
To add functions and properties to the constructor itself,
see reopenClass
reopenClass
()
`
javascript
MyObject = Ember.Object.extend({
name: 'an object'
});
MyObject.reopenClass({
canBuild: false
});
MyObject.canBuild; // false
o = MyObject.create();
`
In other words, this creates static properties and functions for the class. These are only available on the class
and not on any instance of that class.
`
javascript
App.Person = Ember.Object.extend({
name : "",
sayHello : function(){
alert("Hello. My name is " + this.get('name'));
}
});
App.Person.reopenClass({
species : "Homo sapiens",
createPerson: function(newPersonsName){
return App.Person.create({
name:newPersonsName
});
}
});
var tom = App.Person.create({
name : "Tom Dale"
});
var yehuda = App.Person.createPerson("Yehuda Katz");
tom.sayHello(); // "Hello. My name is Tom Dale"
yehuda.sayHello(); // "Hello. My name is Yehuda Katz"
alert(App.Person.species); // "Homo sapiens"
`
Note that species
and createPerson
are *not* valid on the tom
and yehuda
variables. They are only valid on App.Person
.
To add functions and properties to instances of
a constructor by extending the constructor's prototype
see reopen
reset
()
Reset the application. This is typically used only in tests. It cleans up the application in the following order:
- Deactivate existing routes
- Destroy all objects in the container
- Create a new application container
- Re-route to the existing url
Typical Example:
var App;
run(function() {
App = Ember.Application.create();
});
module("acceptance test", {
setup: function() {
App.reset();
}
});
test("first test", function() {
// App is freshly reset
});
test("first test", function() {
// App is again freshly reset
});
Advanced Example:
Occasionally you may want to prevent the app from initializing during setup. This could enable extra configuration, or enable asserting prior to the app becoming ready.
var App;
run(function() {
App = Ember.Application.create();
});
module("acceptance test", {
setup: function() {
run(function() {
App.reset();
App.deferReadiness();
});
}
});
test("first test", function() {
ok(true, 'something before app is initialized');
run(function() {
App.advanceReadiness();
});
ok(true, 'something after app is initialized');
});
resolverFor
-
namespace
This function defines the default lookup rules for container lookups:
- templates are looked up on
Ember.TEMPLATES
- other names are looked up on the application after classifying the name.
For example,
controller:post
looks upApp.PostController
by default. - if the default lookup fails, look for registered classes on the container
This allows the application to register default injections in the container that could be overridden by the normal naming convention.
Parameters:
-
namespace
Ember.Namespacethe namespace to look for classes
Returns:
the resolved value for a given lookup
runInitializers
()
private
scheduleInitialize
()
private
Automatically initialize the application once the DOM has become ready.
The initialization itself is scheduled on the actions queue which ensures that application loading finishes before booting.
If you are asynchronously loading code, you should call
deferReadiness()
to defer booting, and then call
advanceReadiness()
once all of your code has finished
loading.
set
-
keyName
-
value
object[key] = value
or
object.key = value
, except that it provides support for computed
properties, the setUnknownProperty()
method and property observers.
### Computed Properties
If you try to set a value on a key that has a computed property handler
defined (see the get()
method for an example), then set()
will call
that method, passing both the value and key instead of simply changing
the value itself. This is useful for those times when you need to
implement a property that is composed of one or more member
properties.
### Unknown Properties
If you try to set a value on a key that is undefined in the target
object, then the setUnknownProperty()
handler will be called instead. This
gives you an opportunity to implement complex "virtual" properties that
are not predefined on the object. If setUnknownProperty()
returns
undefined, then set()
will simply set the value on the object.
### Property Observers
In addition to changing the property, set()
will also register a property
change with the object. Unless you have placed this call inside of a
beginPropertyChanges()
and endPropertyChanges(),
any "local" observers
(i.e. observer methods declared on the same object), will be called
immediately. Any "remote" observers (i.e. observer methods declared on
another object) will be placed in a queue and called at a later time in a
coalesced manner.
### Chaining
In addition to property changes, set()
returns the value of the object
itself so you can do chaining like this:
`
javascript
record.set('firstName', 'Charles').set('lastName', 'Jolley');
`
Parameters:
-
keyName
StringThe property to set -
value
ObjectThe value to set ornull
.
Returns:
setProperties
-
hash
beginPropertyChanges
and endPropertyChanges
batch, so
observers will be buffered.
`
javascript
record.setProperties({ firstName: 'Charles', lastName: 'Jolley' });
`
Parameters:
-
hash
Hashthe hash of keys and values to set
Returns:
setupEventDispatcher
()
private
Setup up the event dispatcher to receive events on the
application's rootElement
with any registered
customEvents
.
toggleProperty
-
keyName
`
javascript
starship.toggleProperty('warpDriveEngaged');
`
Parameters:
-
keyName
StringThe name of the property to toggle
Returns:
toString
()
String
toString
typically does, in a generic way for all Ember
objects.
`
javascript
App.Person = Em.Object.extend()
person = App.Person.create()
person.toString() //=> "`
If the object's class is not defined on an Ember namespace, it will
indicate it is a subclass of the registered superclass:
`
javascript
Student = App.Person.extend()
student = Student.create()
student.toString() //=> "<(subclass of App.Person):ember1025>"
`
If the method toStringExtension
is defined, its return value will be
included in the output.
`
javascript
App.Teacher = App.Person.extend({
toStringExtension: function() {
return this.get('fullName');
}
});
teacher = App.Teacher.create()
teacher.toString(); //=> "`
Returns:
willDestroy
()
Properties
concatenatedProperties
Array
classNames
property of Ember.View
.
Here is some sample code showing the difference between a concatenated
property and a normal one:
`
javascript
App.BarView = Ember.View.extend({
someNonConcatenatedProperty: ['bar'],
classNames: ['bar']
});
App.FooBarView = App.BarView.extend({
someNonConcatenatedProperty: ['foo'],
classNames: ['foo'],
});
var fooBarView = App.FooBarView.create();
fooBarView.get('someNonConcatenatedProperty'); // ['foo']
fooBarView.get('classNames'); // ['ember-view', 'bar', 'foo']
`
This behavior extends to object creation as well. Continuing the
above example:
`
javascript
var view = App.FooBarView.create({
someNonConcatenatedProperty: ['baz'],
classNames: ['baz']
})
view.get('someNonConcatenatedProperty'); // ['baz']
view.get('classNames'); // ['ember-view', 'bar', 'foo', 'baz']
`
Adding a single property that is not an array will just add it in the array:
`
javascript
var view = App.FooBarView.create({
classNames: 'baz'
})
view.get('classNames'); // ['ember-view', 'bar', 'foo', 'baz']
`
Using the concatenatedProperties
property, we can tell to Ember that mix
the content of the properties.
In Ember.View
the classNameBindings
and attributeBindings
properties
are also concatenated, in addition to classNames
.
This feature is available for you to use throughout the Ember object model,
although typical app developers are likely to use it infrequently. Since
it changes expectations about behavior of properties, you should properly
document its usage in each individual concatenated property (to not
mislead your users to think they can override the property in a subclass).
Default: null
customEvents
Object
The DOM events for which the event dispatcher should listen.
By default, the application's Ember.EventDispatcher
listens
for a set of standard DOM events, such as mousedown
and
keyup
, and delegates them to your application's Ember.View
instances.
If you would like additional bubbling events to be delegated to your
views, set your Ember.Application
's customEvents
property
to a hash containing the DOM event name as the key and the
corresponding view method name as the value. For example:
App = Ember.Application.create({
customEvents: {
// add support for the paste event
paste: "paste"
}
});
Default: null
eventDispatcher
Ember.EventDispatcher
The Ember.EventDispatcher
responsible for delegating events to this
application's views.
The event dispatcher is created by the application at initialization time
and sets up event listeners on the DOM element described by the
application's rootElement
property.
See the documentation for Ember.EventDispatcher
for more information.
Default: null
isDestroyed
Unknown
true
the observers and bindings were already
removed by the effect of calling the destroy()
method.
Default: false
isDestroying
Unknown
destroy()
method has been called.
The object stays intact until the end of the run loop at which point
the isDestroyed
flag is set.
Default: false
resolver
Unknown
deprecated
resolver
Unknown
Set this to provide an alternate class to Ember.DefaultResolver
rootElement
DOMElement
The root DOM element of the Application. This can be specified as an element or a jQuery-compatible selector string.
This is the element that will be passed to the Application's,
eventDispatcher
, which sets up the listeners for event delegation. Every
view in your application should be a child of the element you specify here.
Default: 'body'
router
Ember.Router
private
If the application has a router, use it to route to the current URL, and
trigger a new call to route
whenever the URL changes.
Events
ready
Called when the Application has become ready. The call will be delayed until the DOM has become ready.