Class Ember.View

Defined in: packages/ember-views/lib/views/view.js:287

Module: ember

Ember.View is the class in Ember responsible for encapsulating templates of HTML content, combining templates with data to render as sections of a page's DOM, and registering and responding to user-initiated events.

HTML Tag

The default HTML tag name used for a view's DOM representation is div. This can be customized by setting the tagName property. The following view class:

        
              ParagraphView = Ember.View.extend({
  tagName: 'em'
});

Would result in instances with the following HTML:

        
              <em id="ember1" class="ember-view"></em>

HTML `class` Attribute

The HTML class attribute of a view's tag can be set by providing a classNames property that is set to an array of strings:

        
              MyView = Ember.View.extend({
  classNames: ['my-class', 'my-other-class']
});

Will result in view instances with an HTML representation of:

        
              <div id="ember1" class="ember-view my-class my-other-class"></div>

class attribute values can also be set by providing a classNameBindings property set to an array of properties names for the view. The return value of these properties will be added as part of the value for the view's class attribute. These properties can be computed properties:

        
              MyView = Ember.View.extend({
  classNameBindings: ['propertyA', 'propertyB'],
  propertyA: 'from-a',
  propertyB: function() {
    if (someLogic) { return 'from-b'; }
  }.property()
});

Will result in view instances with an HTML representation of:

        
              <div id="ember1" class="ember-view from-a from-b"></div>

If the value of a class name binding returns a boolean the property name itself will be used as the class name if the property is true. The class name will not be added if the value is false or undefined.

        
              MyView = Ember.View.extend({
  classNameBindings: ['hovered'],
  hovered: true
});

Will result in view instances with an HTML representation of:

        
              <div id="ember1" class="ember-view hovered"></div>

When using boolean class name bindings you can supply a string value other than the property name for use as the class HTML attribute by appending the preferred value after a ":" character when defining the binding:

        
              MyView = Ember.View.extend({
  classNameBindings: ['awesome:so-very-cool'],
  awesome: true
});

Will result in view instances with an HTML representation of:

        
              <div id="ember1" class="ember-view so-very-cool"></div>

Boolean value class name bindings whose property names are in a camelCase-style format will be converted to a dasherized format:

        
              MyView = Ember.View.extend({
  classNameBindings: ['isUrgent'],
  isUrgent: true
});

Will result in view instances with an HTML representation of:

        
              <div id="ember1" class="ember-view is-urgent"></div>

Class name bindings can also refer to object values that are found by traversing a path relative to the view itself:

        
              MyView = Ember.View.extend({
  classNameBindings: ['messages.empty']
  messages: Ember.Object.create({
    empty: true
  })
});

Will result in view instances with an HTML representation of:

        
              <div id="ember1" class="ember-view empty"></div>

If you want to add a class name for a property which evaluates to true and and a different class name if it evaluates to false, you can pass a binding like this:

        
              // Applies 'enabled' class when isEnabled is true and 'disabled' when isEnabled is false
Ember.View.extend({
  classNameBindings: ['isEnabled:enabled:disabled']
  isEnabled: true
});

Will result in view instances with an HTML representation of:

        
              <div id="ember1" class="ember-view enabled"></div>

When isEnabled is false, the resulting HTML reprensentation looks like this:

        
              <div id="ember1" class="ember-view disabled"></div>

This syntax offers the convenience to add a class if a property is false:

        
              // Applies no class when isEnabled is true and class 'disabled' when isEnabled is false
Ember.View.extend({
  classNameBindings: ['isEnabled::disabled']
  isEnabled: true
});

Will result in view instances with an HTML representation of:

        
              <div id="ember1" class="ember-view"></div>

When the isEnabled property on the view is set to false, it will result in view instances with an HTML representation of:

        
              <div id="ember1" class="ember-view disabled"></div>

Updates to the the value of a class name binding will result in automatic update of the HTML class attribute in the view's rendered HTML representation. If the value becomes false or undefined the class name will be removed.

Both classNames and classNameBindings are concatenated properties. See Ember.Object documentation for more information about concatenated properties.

HTML Attributes

The HTML attribute section of a view's tag can be set by providing an attributeBindings property set to an array of property names on the view. The return value of these properties will be used as the value of the view's HTML associated attribute:

        
              AnchorView = Ember.View.extend({
  tagName: 'a',
  attributeBindings: ['href'],
  href: 'http://google.com'
});

Will result in view instances with an HTML representation of:

        
              <a id="ember1" class="ember-view" href="http://google.com"></a>

If the return value of an attributeBindings monitored property is a boolean the property will follow HTML's pattern of repeating the attribute's name as its value:

        
              MyTextInput = Ember.View.extend({
  tagName: 'input',
  attributeBindings: ['disabled'],
  disabled: true
});

Will result in view instances with an HTML representation of:

        
              <input id="ember1" class="ember-view" disabled="disabled" />

attributeBindings can refer to computed properties:

        
          
              
              MyTextInput = Ember.View.extend({
  tagName: 'input',
  attributeBindings: ['disabled'],
  disabled: function() {
    if (someLogic) {
      return true;
    } else {
      return false;
    }
  }.property()
});
            

        
      

Updates to the the property of an attribute binding will result in automatic update of the HTML attribute in the view's rendered HTML representation.

attributeBindings is a concatenated property. See Ember.Object documentation for more information about concatenated properties.

Templates

The HTML contents of a view's rendered representation are determined by its template. Templates can be any function that accepts an optional context parameter and returns a string of HTML that will be inserted within the view's tag. Most typically in Ember this function will be a compiled Ember.Handlebars template.

        
              AView = Ember.View.extend({
  template: Ember.Handlebars.compile('I am the template')
});

Will result in view instances with an HTML representation of:

        
              <div id="ember1" class="ember-view">I am the template</div>

Within an Ember application is more common to define a Handlebars templates as part of a page:

        
              <script type='text/x-handlebars' data-template-name='some-template'>
  Hello
</script>

And associate it by name using a view's templateName property:

        
              AView = Ember.View.extend({
  templateName: 'some-template'
});

Using a value for templateName that does not have a Handlebars template with a matching data-template-name attribute will throw an error.

For views classes that may have a template later defined (e.g. as the block portion of a {{view}} Handlebars helper call in another template or in a subclass), you can provide a defaultTemplate property set to compiled template function. If a template is not later provided for the view instance the defaultTemplate value will be used:

        
              AView = Ember.View.extend({
  defaultTemplate: Ember.Handlebars.compile('I was the default'),
  template: null,
  templateName: null
});

Will result in instances with an HTML representation of:

        
              <div id="ember1" class="ember-view">I was the default</div>

If a template or templateName is provided it will take precedence over defaultTemplate:

        
              AView = Ember.View.extend({
  defaultTemplate: Ember.Handlebars.compile('I was the default')
});

aView = AView.create({
  template: Ember.Handlebars.compile('I was the template, not default')
});

Will result in the following HTML representation when rendered:

        
              <div id="ember1" class="ember-view">I was the template, not default</div>

View Context

The default context of the compiled template is the view's controller:

        
              AView = Ember.View.extend({
  template: Ember.Handlebars.compile('Hello {{excitedGreeting}}')
});

aController = Ember.Object.create({
  firstName: 'Barry',
  excitedGreeting: function() {
    return this.get("content.firstName") + "!!!"
  }.property()
});

aView = AView.create({
  controller: aController,
});

Will result in an HTML representation of:

        
              <div id="ember1" class="ember-view">Hello Barry!!!</div>

A context can also be explicitly supplied through the view's context property. If the view has neither context nor controller properties, the parentView's context will be used.

Layouts

Views can have a secondary template that wraps their main template. Like primary templates, layouts can be any function that accepts an optional context parameter and returns a string of HTML that will be inserted inside view's tag. Views whose HTML element is self closing (e.g. <input />) cannot have a layout and this property will be ignored.

Most typically in Ember a layout will be a compiled Ember.Handlebars template.

A view's layout can be set directly with the layout property or reference an existing Handlebars template by name with the layoutName property.

A template used as a layout must contain a single use of the Handlebars {{yield}} helper. The HTML contents of a view's rendered template will be inserted at this location:

        
              AViewWithLayout = Ember.View.extend({
  layout: Ember.Handlebars.compile("<div class='my-decorative-class'>{{yield}}</div>")
  template: Ember.Handlebars.compile("I got wrapped"),
});

Will result in view instances with an HTML representation of:

        
              <div id="ember1" class="ember-view">
  <div class="my-decorative-class">
    I got wrapped
  </div>
</div>

See Ember.Handlebars.helpers.yield for more information.

Responding to Browser Events

Views can respond to user-initiated events in one of three ways: method implementation, through an event manager, and through {{action}} helper use in their template or layout.

Method Implementation

Views can respond to user-initiated events by implementing a method that matches the event name. A jQuery.Event object will be passed as the argument to this method.

        
              AView = Ember.View.extend({
  click: function(event) {
    // will be called when when an instance's
    // rendered element is clicked
  }
});

Event Managers

Views can define an object as their eventManager property. This object can then implement methods that match the desired event names. Matching events that occur on the view's rendered HTML or the rendered HTML of any of its DOM descendants will trigger this method. A jQuery.Event object will be passed as the first argument to the method and an Ember.View object as the second. The Ember.View will be the view whose rendered HTML was interacted with. This may be the view with the eventManager property or one of its descendent views.

        
              AView = Ember.View.extend({
  eventManager: Ember.Object.create({
    doubleClick: function(event, view) {
      // will be called when when an instance's
      // rendered element or any rendering
      // of this views's descendent
      // elements is clicked
    }
  })
});

An event defined for an event manager takes precedence over events of the same name handled through methods on the view.

        
              AView = Ember.View.extend({
  mouseEnter: function(event) {
    // will never trigger.
  },
  eventManager: Ember.Object.create({
    mouseEnter: function(event, view) {
      // takes precedence over AView#mouseEnter
    }
  })
});

Similarly a view's event manager will take precedence for events of any views rendered as a descendent. A method name that matches an event name will not be called if the view instance was rendered inside the HTML representation of a view that has an eventManager property defined that handles events of the name. Events not handled by the event manager will still trigger method calls on the descendent.

        
          
              
              OuterView = Ember.View.extend({
  template: Ember.Handlebars.compile("outer {{#view InnerView}}inner{{/view}} outer"),
  eventManager: Ember.Object.create({
    mouseEnter: function(event, view) {
      // view might be instance of either
      // OuterView or InnerView depending on
      // where on the page the user interaction occured
    }
  })
});

InnerView = Ember.View.extend({
  click: function(event) {
    // will be called if rendered inside
    // an OuterView because OuterView's
    // eventManager doesn't handle click events
  },
  mouseEnter: function(event) {
    // will never be called if rendered inside
    // an OuterView.
  }
});
            

        
      

Handlebars `{{action}}` Helper

See Handlebars.helpers.action.

Event Names

All of the event handling approaches described above respond to the same set of events. The names of the built-in events are listed below. (The hash of built-in events exists in Ember.EventDispatcher.) Additional, custom events can be registered by using Ember.Application.customEvents.

Touch events:

touchStart
touchMove
touchEnd
touchCancel

Keyboard events

keyDown
keyUp
keyPress

Mouse events

mouseDown
mouseUp
contextMenu
click
doubleClick
mouseMove
focusIn
focusOut
mouseEnter
mouseLeave

Form events:

submit
change
focusIn
focusOut
input

HTML5 drag and drop events:

dragStart
drag
dragEnter
dragLeave
drop
dragEnd

Handlebars `{{view}}` Helper

Other Ember.View instances can be included as part of a view's template by using the {{view}} Handlebars helper. See Ember.Handlebars.helpers.view for additional information.

Show: Inherited Protected Private Deprecated

$ (selector) JQuery

Module: ember

Defined in packages/ember-views/lib/views/view.js:1418

selector: String; a jQuery-compatible selector string
returns: JQuery; the jQuery object for the DOM node

Returns a jQuery object for this view's element. If you pass in a selector string, this method will return a jQuery object, using the current element as its buffer.

For example, calling view.$('li') will return a jQuery object containing all of the li elements inside the DOM element of this view.

addObserver (key, target, method) Ember.Object

Module: ember

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:

        
              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:

        
              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.

append Ember.View

Module: ember

Defined in packages/ember-views/lib/views/view.js:1552

returns: Ember.View; receiver

Appends the view's element to the document body. If the view does not have an HTML representation yet, createElement() will be called automatically.

If your application uses the rootElement property, you must append the view within that element. Rendering views outside of the rootElement is not supported.

Note that this method just schedules the view to be appended; the DOM element will not be appended to the document body until all bindings have finished synchronizing.

appendTo (A) Ember.View

Module: ember

Defined in packages/ember-views/lib/views/view.js:1463

A: String|DOMElement|jQuery; selector, element, HTML string, or jQuery object
returns: Ember.View; receiver

Appends the view's element to the specified parent element.

If the view does not have an HTML representation yet, createElement() will be called automatically.

Note that this method just schedules the view to be appended; the DOM element will not be appended to the given element until all bindings have finished synchronizing.

This is not typically a function that you will need to call directly when building your application. You might consider using Ember.ContainerView instead. If you do need to use appendTo, be sure that the target element you are providing is associated with an Ember.Application and does not have an ancestor element that is associated with an Ember view.

beginPropertyChanges Ember.Observable

Module: ember

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

Module: ember

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)

Module: ember

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.

        
              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:

        
              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.

createChildView (viewClass, attrs) Ember.View

Module: ember

Defined in packages/ember-views/lib/views/view.js:2093

viewClass: Class|String
attrs: Hash; Attributes to add
returns: Ember.View; new instance

Instantiates a view to be added to the childViews array during view initialization. You generally will not call this method directly unless you are overriding createChildViews(). Note that this method will automatically configure the correct settings on the new view instance to act as a child of the parent.

createElement Ember.View

Module: ember

Defined in packages/ember-views/lib/views/view.js:1608

returns: Ember.View; receiver

Creates a DOM representation of the view and all of its child views by recursively calling the render() method.

After the element has been created, didInsertElement will be called on this view and all of its child views.

createWithMixins (arguments)

Module: ember

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

Module: ember

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.

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

destroy

Module: ember

Defined in packages/ember-views/lib/views/view.js:2058

You must call destroy on a view to destroy the view (and all of its child views). This will remove the view from any parent node, then make sure that the DOM element managed by the view can be released by the memory manager.

destroyElement Ember.View

Module: ember

Defined in packages/ember-views/lib/views/view.js:1712

returns: Ember.View; receiver

Destroys any existing element along with the element for any child views as well. If the view does not currently have a element, then this method will do nothing.

If you implement willDestroyElement() on your view, then this method will be invoked on your view before your element is destroyed to give you a chance to clean up any event handlers, etc.

If you write a willDestroyElement() handler, you can assume that your didInsertElement() handler was called earlier for the same element.

Normally you will not call or override this method yourself, but you may want to implement the above callbacks when it is run.

eachComputedProperty (callback, binding)

Module: ember

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

Module: ember

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.

findElementInParentElement (parentElement) DOMElement

Module: ember

Defined in packages/ember-views/lib/views/view.js:1592

parentElement: DOMElement; The parent's DOM element
returns: DOMElement; The discovered element

Attempts to discover the element in the parent element. The default implementation looks for an element with an ID of elementId (or the view's guid if elementId is null). You can override this method to provide your own form of lookup. For example, if you want to discover your element using a CSS class name instead of an ID.

get (keyName) Object

Module: ember

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:

        
              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

Module: ember

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:

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

is equivalent to:

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

getWithDefault (keyName, defaultValue) Object

Module: ember

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.

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

has (name) Boolean

Module: ember

Inherited from Ember.Evented packages/ember-runtime/lib/mixins/evented.js:133

name: String; The name of the event
returns: Boolean; does the object have a subscription for event

Checks to see if object has any subscriptions for named event.

hasObserverFor (key) Boolean

Module: ember

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

Module: ember

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.

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

init

Module: ember

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:

        
              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)

Module: ember

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:

        
              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:

        
              MyClass.metaForProperty('person');

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

notifyPropertyChange (keyName) Ember.Observable

Module: ember

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.

off (name, target, method)

Module: ember

Inherited from Ember.Evented packages/ember-runtime/lib/mixins/evented.js:119

name: String; The name of the event
target: Object; The target of the subscription
method: Function; The function of the subscription
returns: this

Cancels subscription for given name, target, and method.

on (name, target, method)

Module: ember

Inherited from Ember.Evented packages/ember-runtime/lib/mixins/evented.js:43

name: String; The name of the event
target: Object; The "this" binding for the callback
method: Function; The callback to execute
returns: this

Subscribes to a named event with given function.

        
              person.on('didLoad', function() {
  // fired once the person has loaded
});

An optional target can be passed in as the 2nd argument that will be set as the "this" for the callback. This is a good way to give your function access to the object triggering the event. When the target parameter is used the callback becomes the third argument.

one (name, target, method)

Module: ember

Inherited from Ember.Evented packages/ember-runtime/lib/mixins/evented.js:68

name: String; The name of the event
target: Object; The "this" binding for the callback
method: Function; The callback to execute
returns: this

Subscribes a function to a named event and then cancels the subscription after the first time the event is triggered. It is good to use one when you only care about the first time an event has taken place.

This function takes an optional 2nd argument that will become the "this" value for the callback. If this argument is passed then the 3rd argument becomes the function.

propertyDidChange (keyName) Ember.Observable

Module: ember

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

Module: ember

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.

remove Ember.View

Module: ember

Defined in packages/ember-views/lib/views/view.js:1572

returns: Ember.View; receiver

Removes the view's element from the element to which it is attached.

removeAllChildren Ember.View

Module: ember

Defined in packages/ember-views/lib/views/view.js:2023

returns: Ember.View; receiver

Removes all children from the parentView.

removeChild (view) Ember.View

Module: ember

Defined in packages/ember-views/lib/views/view.js:1997

view: Ember.View
returns: Ember.View; receiver

Removes the child view from the parent view.

removeFromParent Ember.View

Module: ember

Defined in packages/ember-views/lib/views/view.js:2041

returns: Ember.View; receiver

Removes the view from its parentView, if one is found. Otherwise does nothing.

removeObserver (key, target, method) Ember.Observable

Module: ember

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.

render (buffer)

Module: ember

Defined in packages/ember-views/lib/views/view.js:1181

buffer: Ember.RenderBuffer; The render buffer

Called on your view when it should push strings of HTML into a Ember.RenderBuffer. Most users will want to override the template or templateName properties instead of this method.

By default, Ember.View will look for a function in the template property and invoke it with the value of context. The value of context will be the view's controller unless you override it.

reopen

Module: ember

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' });

        
              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

Module: ember

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

Augments a constructor's own properties and functions:

        
              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

replaceIn (A) Ember.View

Module: ember

Defined in packages/ember-views/lib/views/view.js:1495

A: String|DOMElement|jQuery; selector, element, HTML string, or jQuery object
returns: Ember.View; received

Replaces the content of the specified parent element with this view's element. If the view does not have an HTML representation yet, createElement() will be called automatically.

Note that this method just schedules the view to be appended; the DOM element will not be appended to the given element until all bindings have finished synchronizing

rerender

Module: ember

Defined in packages/ember-views/lib/views/view.js:1227

Renders the view again. This will work regardless of whether the view is already in the DOM or not. If the view is in the DOM, the rendering process will be deferred to give bindings a chance to synchronize.

If children were added during the rendering process using appendChild, rerender will remove them, because they will be added again if needed by the next render.

In general, if the display of your view changes, you should modify the DOM element directly instead of manually calling rerender, which can be slow.

set (keyName, value) Ember.Observable

Module: ember

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:

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

setProperties (hash) Ember.Observable

Module: ember

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:

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

toString String

Module: ember

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.

        
              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:

        
              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.

        
              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

Module: ember

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.

        
              starship.toggleProperty('warpDriveEngaged');

trigger (name, args)

Module: ember

Inherited from Ember.Evented packages/ember-runtime/lib/mixins/evented.js:93

name: String; The name of the event
args: Object...; Optional arguments to pass on

Triggers a named event for the object. Any additional arguments will be passed as parameters to the functions that are subscribed to the event.

        
              person.on('didEat', function(food) {
  console.log('person ate some ' + food);
});

person.trigger('didEat', 'broccoli');

// outputs: person ate some broccoli

willDestroy

Module: ember

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

Override to implement teardown.

Class Ember.View

HTML Tag

HTML class Attribute

HTML Attributes

Templates

View Context

Layouts

Responding to Browser Events

Method Implementation

Event Managers

Handlebars {{action}} Helper

Event Names

Handlebars {{view}} Helper

$ (selector) JQuery

addObserver (key, target, method) Ember.Object

Observer Methods

append Ember.View

appendTo (A) Ember.View

beginPropertyChanges Ember.Observable

cacheFor (keyName) Object

create (arguments)

createChildView (viewClass, attrs) Ember.View

createElement Ember.View

createWithMixins (arguments)

decrementProperty (keyName, decrement) Number

destroy

destroyElement Ember.View

eachComputedProperty (callback, binding)

endPropertyChanges Ember.Observable

findElementInParentElement (parentElement) DOMElement

get (keyName) Object

Computed Properties

Unknown Properties

getProperties (list) Hash

getWithDefault (keyName, defaultValue) Object

has (name) Boolean

hasObserverFor (key) Boolean

incrementProperty (keyName, increment) Number

init

metaForProperty (key)

notifyPropertyChange (keyName) Ember.Observable

off (name, target, method)

on (name, target, method)

one (name, target, method)

propertyDidChange (keyName) Ember.Observable

propertyWillChange (keyName) Ember.Observable

remove Ember.View

removeAllChildren Ember.View

removeChild (view) Ember.View

removeFromParent Ember.View

removeObserver (key, target, method) Ember.Observable

render (buffer)

reopen

reopenClass

replaceIn (A) Ember.View

rerender

set (keyName, value) Ember.Observable

Computed Properties

Unknown Properties

Property Observers

Chaining

setProperties (hash) Ember.Observable

toString String

toggleProperty (keyName) Object

trigger (name, args)

willDestroy

HTML `class` Attribute

Handlebars `{{action}}` Helper

Handlebars `{{view}}` Helper