Class: SC.ActionSupport

Implements basic target + action support for views. To use, simply set the action property on the view to the name of a method handled by an object in the current responder chain and call fireAction. If the target property is also set, the action will only be attempted on that target object. If not set, then the responder chain will be searched for an object that implements the named action. Note* Because searching the responder chain is slower, it is recommended to specify an actual target whenever possible.

Implementing Actions in a Target

The method signature for target + action implementors is,

methodName: function (sender, context) {
  return; // Optional: return a value to the sender.
}

For views implementing SC.ActionSupport, the sender will always be this, which can be useful when an action may be called by multiple views and the target needs to know from which view it was triggered. For example, here is an action that will hide the sender's (any sender's) pane,

// Hides the pane of the current sender.
hidePane: function (sender) {
  var pane = sender.get('pane');
  pane.set('isVisible', false);
}

In order to pass additional information to the target, the target's action method may accept a second argument, context. This argument will be the value of the same-named context argument passed to fireAction() of the view. Here is a simple example to help illustrate this,

// Target
var theTargetObject = SC.Object.create({

  theActionMethod: function (sender, context) {
    console.log("theActionMethod was called at: %@".fmt(context.calledAt))
  }

});

// View with SC.ActionSupport
var view = SC.View.create(SC.ActionSupport, {
  action: 'theActionMethod',
  target: theTargetObject,

  someEvent: function () {
    var addedContext = {
      calledAt: new Date() // Calling specific information to pass to the target.
    };

    this.fireAction(addedContext);
  }

});

Defined in: action_support.js

Since:

SproutCore 1.7

Field Summary

Instance Methods

• fireAction(context)
• initMixin()

methodName: function (sender, context) {
  return; // Optional: return a value to the sender.
}

mouseUp: function () {
  var isReady = this.get('isReady');

  if (isReady) {
    this.set('action', 'doReadyAction');
  } else {
    this.set('action', 'doNotReadyAction');
  }

  this.fireAction();
}

action: function () {
  return this.get('isReady') ? 'doReadyAction' : 'doNotReadyAction';
}.property('isReady'), // .cacheable() - optional to cache the result (consider memory used to cache result vs. computation time to compute result)

mouseUp: function () {
  this.fireAction(); // Fires with current value of `action`.
}

methodName: function (sender, context) {
  return; // Optional: return a value to the sender.
}

mouseUp: function () {
  var isReady = this.get('isReady');

  if (isReady) {
    this.set('target', MyApp.readyTarget);
  } else {
    this.set('target', MyApp.notReadyTarget);
  }

  this.fireAction();
}

target: function () {
  return this.get('isReady') ? MyApp.readyTarget : MyApp.notReadyTarget;
}.property('isReady'), // .cacheable() - optional to cache the result (consider memory used to cache result vs. computation time to compute result)

mouseUp: function () {
  this.fireAction(); // Fires with current value of `target`.
}