Class Ember.ObjectController

addObserver (key, target, method) Ember.Object

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:312

key

String

The key to observer

target

Object

The target object to invoke

method

String|Function

The method to invoke.

returns

Ember.Object

self

Adds an observer on a property.

This is the core method used to register an observer for a property.

Once you call this method, any time the key's value is set, your observer will be notified. Note that the observers are triggered any time the value is set, regardless of whether it has actually changed. Your observer should be prepared to handle that.

You can also pass an optional context parameter to this method. The context will be passed to your observer method whenever it is triggered. Note that if you add the same target/method pair on a key multiple times with different context parameters, your observer will only be called once with the last context you passed.

Observer Methods

Observer methods you pass should generally have the following signature if you do not pass a context parameter:

1

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:

1

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.

beginPropertyChanges Ember.Observable

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:211

returns

Ember.Observable

Begins a grouping of property changes.

You can use this method to group property changes so that notifications will not be sent until the changes are finished. If you plan to make a large number of changes to an object at one time, you should call this method at the beginning of the changes to begin deferring change notifications. When you are done making changes, call endPropertyChanges() to deliver the deferred change notifications and end deferring.

cacheFor (keyName) Object

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:490

keyName

String

returns

Object

The cached value of the computed property, if any

Returns the cached value of a computed property, if it exists. This allows you to inspect the value of a computed property without accidentally invoking it if it is intended to be generated lazily.

create (arguments)

Inherited from Ember.CoreObject packages/ember-runtime/lib/system/core_object.js:435

arguments

Creates an instance of a class. Accepts either no arguments, or an object containing values to initialize the newly instantiated object with.

1
2
3
4
5
6
7
8
9
10
11

App.Person = Ember.Object.extend({
  helloWorld: function() {
    alert("Hi, my name is " + this.get('name'));
  }
});

var tom = App.Person.create({
  name: 'Tom Dale'
});

tom.helloWorld(); // alerts "Hi, my name is Tom Dale".

create will call the init function if defined during Ember.AnyObject.extend

If no arguments are passed to create, it will not set values to the new instance during initialization:

1
2

var noName = App.Person.create();
noName.helloWorld(); // alerts undefined

NOTE: For performance reasons, you cannot declare methods or computed properties during create. You should instead declare methods and computed properties when using extend or use the createWithMixins shorthand.

createWithMixins (arguments)

Inherited from Ember.CoreObject packages/ember-runtime/lib/system/core_object.js:421

arguments

Equivalent to doing extend(arguments).create(). If possible use the normal create method instead.

decrementProperty (keyName, decrement) Number

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:453

keyName

String

The name of the property to decrement

decrement

Number

The amount to decrement by. Defaults to 1

returns

Number

The new property value

Set the value of a property to the current value minus some amount.

1
2

player.decrementProperty('lives');
orc.decrementProperty('health', 5);

destroy Ember.Object

Inherited from Ember.CoreObject packages/ember-runtime/lib/system/core_object.js:289

returns

Ember.Object

receiver

Destroys an object by setting the 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.

eachComputedProperty (callback, binding)

Inherited from Ember.CoreObject packages/ember-runtime/lib/system/core_object.js:590

callback

Function

binding

Object

Iterate over each computed property for the class, passing its name and any associated metadata (see metaForProperty) to the callback.

endPropertyChanges Ember.Observable

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:230

returns

Ember.Observable

Ends a grouping of property changes.

You can use this method to group property changes so that notifications will not be sent until the changes are finished. If you plan to make a large number of changes to an object at one time, you should call 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.

get (keyName) Object

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:78

keyName

String

The property to retrieve

returns

Object

The property value or undefined.

Retrieves the value of a property from the object.

This method is usually similar to using 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:

1
2
3

fullName: function() {
  return this.getEach('firstName', 'lastName').compact().join(' ');
}.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.

getProperties (list) Hash

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:120

list

String...|Array

of keys to get

returns

Hash

To get multiple properties at once, call getProperties with a list of strings or an array:

1

record.getProperties('firstName', 'lastName', 'zipCode');  // { firstName: 'John', lastName: 'Doe', zipCode: '10011' }

is equivalent to:

1

record.getProperties(['firstName', 'lastName', 'zipCode']);  // { firstName: 'John', lastName: 'Doe', zipCode: '10011' }

getWithDefault (keyName, defaultValue) Object

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:416

keyName

String

The name of the property to retrieve

defaultValue

Object

The value to return if the property value is undefined

returns

Object

The property value or the defaultValue.

Retrieves the value of a property, or a default value in the case that the property returns undefined.

1

person.getWithDefault('lastName', 'Doe');

hasObserverFor (key) Boolean

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:379

key

String

Key to check

returns

Boolean

Returns 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.

incrementProperty (keyName, increment) Number

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:433

keyName

String

The name of the property to increment

increment

Number

The amount to increment by. Defaults to 1

returns

Number

The new property value

Set the value of a property to the current value plus some amount.

1
2

person.incrementProperty('age');
team.incrementProperty('score', 2);

init

Inherited from Ember.CoreObject packages/ember-runtime/lib/system/core_object.js:171

An overridable method called when objects are instantiated. By default, does nothing unless it is overridden during class definition.

Example:

1
2
3
4
5
6
7
8
9
10
11
12

App.Person = Ember.Object.extend({
  init: function() {
    this._super();
    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.

metaForProperty (key)

Inherited from Ember.CoreObject packages/ember-runtime/lib/system/core_object.js:556

key

String

property name

In some cases, you may want to annotate computed properties with additional metadata about how they function or what values they operate on. For example, computed property functions may close over variables that are then no longer available for introspection.

You can pass a hash of these values to a computed property like this:

1
2
3
4

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:

1

MyClass.metaForProperty('person');

This will return the original hash that was passed to meta().

notifyPropertyChange (keyName) Ember.Observable

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:294

keyName

String

The property key to be notified about.

returns

Ember.Observable

Convenience method to call propertyWillChange and propertyDidChange in succession.

propertyDidChange (keyName) Ember.Observable

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:271

keyName

String

The property key that has just changed.

returns

Ember.Observable

Notify the observer system that a property has just changed.

Sometimes you need to change a value directly or indirectly without actually calling 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.

propertyWillChange (keyName) Ember.Observable

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:248

keyName

String

The property key that is about to change.

returns

Ember.Observable

Notify the observer system that a property is about to change.

Sometimes you need to change a value directly or indirectly without actually calling 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.

removeObserver (key, target, method) Ember.Observable

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:364

key

String

The key to observer

target

Object

The target object to invoke

method

String|Function

The method to invoke.

returns

Ember.Observable

receiver

Remove an observer you have previously registered on this object. Pass the same key, target, and method you passed to addObserver() and your target will no longer receive notifications.

reopen

Inherited from Ember.CoreObject packages/ember-runtime/lib/system/core_object.js:478

Augments a constructor's prototype with additional properties and functions:

```javascript MyObject = Ember.Object.extend({ name: 'an object' });

1
2
3
4
5
6
7
8
9
10
11
12
13
14

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

Inherited from Ember.CoreObject packages/ember-runtime/lib/system/core_object.js:514

Augments a constructor's own properties and functions:

1
2
3
4
5
6
7
8
9
10
11

MyObject = Ember.Object.extend({
  name: 'an object'
});


MyObject.reopenClass({
  canBuild: false
});

MyObject.canBuild; // false
o = MyObject.create();

To add functions and properties to instances of a constructor by extending the constructor's prototype see reopen

replaceRoute (name, models)

Inherited from Ember.ControllerMixin packages/ember-routing/lib/ext/controller.js:48

name

String

the name of the route

models

...Object

the

Alernative to transitionToRoute. Transition the application into another route. The route may be either a single route or route path:

1
2

  aController.replaceRoute('blogPosts');
  aController.replaceRoute('blogPosts.recentEntries');

Optionally supply a model for the route in question. The model will be serialized into the URL using the serialize hook of the route:

1

  aController.replaceRoute('blogPost', aPost);

set (keyName, value) Ember.Observable

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:142

keyName

String

The property to set

value

Object

The value to set or `null`.

returns

Ember.Observable

Sets the provided key or path to the value.

This method is generally very similar to calling 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:

1

record.set('firstName', 'Charles').set('lastName', 'Jolley');

setProperties (hash) Ember.Observable

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:195

hash

Hash

the hash of keys and values to set

returns

Ember.Observable

To set multiple properties at once, call setProperties with a Hash:

1

record.setProperties({ firstName: 'Charles', lastName: 'Jolley' });

toString String

Inherited from Ember.CoreObject packages/ember-runtime/lib/system/core_object.js:338

returns

String

string representation

Returns a string representation which attempts to provide more information than Javascript's toString typically does, in a generic way for all Ember objects.

1
2
3

App.Person = Em.Object.extend()
person = App.Person.create()
person.toString() //=> "<App.Person:ember1024>"

If the object's class is not defined on an Ember namespace, it will indicate it is a subclass of the registered superclass:

1
2
3

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.

1
2
3
4
5
6
7

App.Teacher = App.Person.extend({
  toStringExtension: function() {
    return this.get('fullName');
  }
});
teacher = App.Teacher.create()
teacher.toString(); //=> "<App.Teacher:ember1026:Tom Dale>"

toggleProperty (keyName) Object

Inherited from Ember.Observable packages/ember-runtime/lib/mixins/observable.js:473

keyName

String

The name of the property to toggle

returns

Object

The new property value

Set the value of a boolean property to the opposite of it's current value.

1

starship.toggleProperty('warpDriveEngaged');

transitionToRoute (name, models)

Inherited from Ember.ControllerMixin packages/ember-routing/lib/ext/controller.js:9

name

String

the name of the route

models

...Object

the

Transition the application into another route. The route may be either a single route or route path:

1
2

  aController.transitionToRoute('blogPosts');
  aController.transitionToRoute('blogPosts.recentEntries');

Optionally supply a model for the route in question. The model will be serialized into the URL using the serialize hook of the route:

1

  aController.transitionToRoute('blogPost', aPost);

willDestroy

Inherited from Ember.CoreObject packages/ember-runtime/lib/system/core_object.js:311

Override to implement teardown.