Listening For Attribute Change Events

In this example, we'll look at how you can setup listeners for attribute change events, and work with the event payload which the listeners receive, using the SpeedDater class, introduced in the "Attribute Based Speed Dating" example.

We'll create two SpeedDater instances, jane and john, and use the attribute events they generate both internally (within the class code), to wire up UI refreshes, and externally, to have jane react to changes in the john's state.

Setting Up The SpeedDater Class With Attribute

We start by setting up the same basic class we created for the "Attribute Based Speed Dating" example, with an additional attribute, interests, using the code below:

// Setup custom class which we want to add managed attribute support to
function SpeedDater(cfg) {
    // When constructed, setup the initial attributes for the instance, 
    // by calling the addAttrs method.
    var attrs = {
        name : {
            writeOnce:true
        },
 
        personality : {
            value:50
        },

        available : {
            value:true
        }, 
        
        interests : {
            value : []
        }
    };

    this.addAttrs(attrs, cfg);
}

// Augment custom class with Attribute
Y.augment(SpeedDater, Y.Attribute);

We then create two instances of SpeedDaters, jane and john:

// Create a john instance...
john = new SpeedDater({
    name: "John",
    personality: 78
});
// ... and render to the page
john.applyNameTag("#john .shirt");

// Create a jane instance...
jane = new SpeedDater({
    name: "Jane",
    personality: 82,
    interests: ["Popcorn", "Saving Whales"]
});
jane.applyNameTag("#jane .shirt");

Registering Event Listeners

For this event based example, we no longer have an updateNameTag() method which the user is responsible for calling when they want to refresh the name tag rendered on the page, as we did in the basic example. Instead the SpeedDater class sets up some internal attribute change event listeners in its listenForChanges() method, which will refresh the UI for a particular attribute, each time its value is modified:

// Method used to attach attribute change event listeners, so that 
// the SpeedDater instance will react to changes in attribute state, 
// and update what's rendered on the page
SpeedDater.prototype.listenForChanges = function() {

    // Sync up the UI for "available", after the value of the "available" 
    // attribute has changed:
    this.after("availableChange", function(e) {
        var taken = (e.newVal) ? "" : "Oh, is that the time?";
        this.nameTag.one(".sd-availability").set("innerHTML", taken);
    });

    // Sync up the UI for "name", after the value of the "name" 
    // attribute has changed:
    this.after("nameChange", function(e) {
        var name = e.newVal;
        this.nameTag.one(".sd-name").set("innerHTML", name);
    });

    // Sync up the UI for "personality", after the value of the "personality" 
    // attribute has changed:
    this.after("personalityChange", function(e) {
        var personality = e.newVal;

        var personalityEl = this.nameTag.one(".sd-personality");
        personalityEl.set("innerHTML", personality);

        if (personality > 90) {
            personalityEl.addClass("sd-max");
        }
    });

    // Sync up the UI for "interests", after the value of the "interests" 
    // attribute has changed:
    this.after("interestsChange", function(e) {
        var interests = (e.newVal.length == 0) ? 
                    "absolutely nothing" : this.get("interests").join(", ");
        this.nameTag.one(".sd-interests").set("innerHTML", interests);
    });
};

As seen in the above code, the event type for attribute change events is created by concatenating the attribute name with "Change" (e.g. "availableChange"). Whenever an attribute value is changed through Attribute's set() method, both "on" and "after" subscribers are notified.

In the code snippet above, all the subscribers are listening for the "after" moment using the after() subscription method, since they're only interested in being notified after the value has actually changed. However, as we'll see below, the example also shows you how to use an "on" listener, to prevent the attribute state change from occuring under certain conditions.

On vs. After

A single attribute change event has two moments which can be subscribed to, depending on what the subscriber wants to do when notified.

on : Subscribers to the "on" moment, will be notified before any actual state change has occurred. This provides the opportunity to prevent the state change from occurring, using the preventDefault() method of the event facade object passed to the subscriber. If you use get() to retrieve the value of the attribute in an "on" subscriber, you will receive the current, unchanged value. However the event facade provides access to the value which the attribute is being set to, through it's newVal property.

after : Subscribers to the "after" moment, will be notified after the attribute's state has been updated. This provides the opportunity to update state in other parts of your application, in response to a change in the attribute's state.

Based on the definition above, after listeners are not invoked if state change is prevented; for example, due to one of the "on" listeners calling preventDefault() on the event object passed to the subscriber.

Having Jane React To John

Aside from the internal listeners set up by the class, in this example jane also sets up two more subscribers. The first is a subscriber, which allows jane to "reconsider" changing the state of her available attribute, under certain conditions. Since she may want to prevent the available attribute from being modified in this case, we use Attribute's on() method to listen for the "on" moment, so that the default behavior can be prevented:

// We can also listen before an attribute changes its value, and 
// decide if we want to allow the state change to occur or not. 

// Invoking e.preventDefault() stops the state from being updated. 

// In this case, Jane can change her mind about making herself 
// unavailable, if John likes saving whales, as long as he doesn't 
// dig knitting too.

jane.on("availableChange", function(e) {
    var johnsInterests = john.get("interests");
    var janeAvailable = e.newVal;

    if (janeAvailable === false && Y.Array.indexOf(johnsInterests, "Saving Whales") !== -1 
            && Y.Array.indexOf(johnsInterests, "Knitting") == -1 ) {
        // Reconsider..
        e.preventDefault();
    };
});

We also set up an "after" listener on the john instance, which allows jane to update her interests, so she can admit to enjoying "Reading Specifications", if john admits it first:

// Consider updating Jane's interests state, after John's interests 
// state changes...
john.after("interestsChange", function(e) {

    var janesInterests = jane.get("interests"),

        // Get john's new interests from the attribute change event...
        johnsInterests = e.newVal,

        readingSpecs = "Reading Specifications";

    // If it turns out that John enjoys reading specs, then Jane can admit it too...
    if (Y.Array.indexOf(johnsInterests, readingSpecs) !== -1) {
        if(Y.Array.indexOf(janesInterests, readingSpecs) == -1) {
            janesInterests.push(readingSpecs);
        }
    } else {
        // Otherwise, we use Y.Array.reject, provided by the "collection" module, 
        // to remove "Reading Specifications" from jane's interests..
        janesInterests = Y.Array.reject(janesInterests, 
                            function(item){return (item == readingSpecs);});
    }

    jane.set("interests", janesInterests);
    jane.set("available", true);

    ...
});

Event Facade

The event object (an instance of EventFacade) passed to attribute change event subscribers, has the following interesting properties and methods related to attribute management:

newVal

The value which the attribute will be set to (in the case of "on" subscribers), or has been set to (in the case of "after" subscribers

prevVal

The value which the attribute is currently set to (in the case of "on" subscribers), or was previously set to (in the case of "after" subscribers

attrName

The name of the attribute which is being set

subAttrName

Attribute also allows you to set nested properties of attributes which have values which are objects through the set method (e.g. o1.set("x.y.z")). This property will contain the path to the property which was changed.

preventDefault()

This method can be called in an "on" subscriber to prevent the attribute's value from being updated (the default behavior). Calling this method in an "after" listener has no impact, since the default behavior has already been invoked.

stopImmediatePropagation()

This method can be called in "on" or "after" subscribers, and will prevent the rest of the subscriber stack from being invoked, but will not prevent the attribute's value from being updated.

Complete Example Source

<div id="speeddate">

    <h1>Communicating With Attribute Events On Speed Dates</h1>

    <div id="john">
        <button type="button" class="hi">Hi, I'm John</button>

        <span class="interests disabled">
            I enjoy: 
            <label><input type="checkbox" class="interest" value="Sunsets" disabled="disabled"> Sunsets</label>
            <label><input type="checkbox" class="interest" value="Reading Specifications" disabled="disabled"> Reading Specifications</label> 
            <label><input type="checkbox" class="interest" value="Saving Whales" disabled="disabled"> Saving Whales</label>
            <label><input type="checkbox" class="interest" value="Knitting" disabled="disabled"> Knitting</label>
        </span>
        <div class="shirt"></div>
    </div>

    <div id="jane">
        <button type="button" class="hi" disabled="disabled">Hey, I'm Jane</button>
        <button type="button" class="movingOn" disabled="disabled">I'm Moving On...</button> <span class="reconsider disabled">(unless he likes whales, and avoids knitting <em class="message"></em>)</span>
        <div class="shirt"></div>
    </div>
</div>

<script type="text/javascript">

// Get a new instance of YUI and 
// load it with the required set of modules

YUI().use("collection", "event", "node", "attribute", "substitute", function(Y) {

    // Setup custom class which we want to add managed attribute support to

    function SpeedDater(cfg) {
        // When constructed, setup the initial attributes for the instance, by calling the addAttrs method.
        var attrs = {
            name : {
                writeOnce:true
            },

            personality : {
                value:50
            },

            available : {
                value:true
            }, 

            interests : {
                value : []
            }
        };

        this.addAttrs(attrs, cfg);
    }

    // The HTML template representing the SpeedDater name tag.
    SpeedDater.NAMETAG = '<div class="sd-nametag"> \
                            <div class="sd-hd">Hello!</div> \
                            <div class="sd-bd"> \
                                <p>I\'m <span class="sd-name">{name}</span> and my PersonalityQuotientIndex is <span class="sd-personality">{personality}</span></p> \
                                <p>I enjoy <span class="sd-interests">{interests}</span>.</p> \
                            </div> \
                            <div class="sd-ft sd-availability">{available}</div> \
                         </div>';

    // Method used to render the visual representation of a SpeedDater object's state (in this case as a name tag)
    SpeedDater.prototype.applyNameTag = function(where) {

        var tokens = {
            name: this.get("name"),
            available: (this.get("available")) ? "" : "Sorry, moving on",
            personality: this.get("personality"),
            interests: (this.get("interests").length == 0) ? "absolutely nothing" : this.get("interests").join(", ")
        };

        this.nameTag = Y.Node.create(Y.substitute(SpeedDater.NAMETAG, tokens));
        Y.one(where).appendChild(this.nameTag);

        this.listenForChanges();
    };

    // Method used to attach attribute change event listeners, so that the SpeedDater instance 
    // will react to changes in attribute state, and update what's rendered on the page
    SpeedDater.prototype.listenForChanges = function() {

        // Sync up the UI for "available", after the value of the "available" attribute has changed:
        this.after("availableChange", function(e) {
            var taken = (e.newVal) ? "" : "Oh, is that the time?";
            this.nameTag.one(".sd-availability").set("innerHTML", taken);
        });

        // Sync up the UI for "name", after the value of the "name" attribute has changed:
        this.after("nameChange", function(e) {
            var name = e.newVal;
            this.nameTag.one(".sd-name").set("innerHTML", name);
        });

        // Sync up the UI for "personality", after the value of the "personality" attribute has changed:
        this.after("personalityChange", function(e) {
            var personality = e.newVal;

            var personalityEl = this.nameTag.one(".sd-personality");
            personalityEl.set("innerHTML", personality);

            if (personality > 90) {
                personalityEl.addClass("sd-max");
            }
        });

        // Sync up the UI for "interests", after the value of the "interests" attribute has changed:
        this.after("interestsChange", function(e) {
            var interests = (e.newVal.length == 0) ? "absolutely nothing" : this.get("interests").join(", ");
            this.nameTag.one(".sd-interests").set("innerHTML", interests);
        });
    };

    // Augment custom class with Attribute
    Y.augment(SpeedDater, Y.Attribute);

    var john, jane;

    Y.on("click", function() {

        if (!john) {

            john = new SpeedDater({
                name: "John",
                personality: 78
            });
            john.applyNameTag("#john .shirt");

            Y.one("#jane .hi").set("disabled", false); 
        }

    }, "#john .hi");

    Y.on("click", function() {

        if (!jane) {

            jane = new SpeedDater({
                name: "Jane",
                personality: 82,
                interests: ["Popcorn", "Saving Whales"]
            });
            jane.applyNameTag("#jane .shirt");

            // Update Jane's interests state, after John's interests state changes...
            john.after("interestsChange", function(e) {

                var janesInterests = jane.get("interests"),
                    johnsInterests = e.newVal,

                    readingSpecs = "Reading Specifications";
    
                // If it turns out that John enjoys reading specs, then Jane can admit it too...
                if (Y.Array.indexOf(johnsInterests, readingSpecs) !== -1) {
                    if(Y.Array.indexOf(janesInterests, readingSpecs) == -1) {
                        janesInterests.push(readingSpecs);
                    }
                } else {
                    janesInterests = Y.Array.reject(janesInterests, function(item){return (item == readingSpecs);});
                }

                jane.set("interests", janesInterests);
                jane.set("available", true);

                setMessage("");
            });

            // We can also listen before an attribute changes its value, and decide if we want to
            // allow the state change to occur or not. Invoking e.preventDefault() stops the state from
            // being updated. 

            // In this case, Jane can change her mind about making herself unavailable, if John likes 
            // saving whales, as long as he doesn't dig knitting too.
 
            jane.on("availableChange", function(e) {
                var johnsInterests = john.get("interests");
                var janeAvailable = e.newVal;
                if (janeAvailable === false && Y.Array.indexOf(johnsInterests, "Saving Whales") !== -1 &&  Y.Array.indexOf(johnsInterests, "Knitting") == -1 ) {
                    // Reconsider..
                    e.preventDefault();

                    setMessage("... which he does");
                };
            });

            enableExampleUI();
        }

    }, "#jane .hi");

    Y.on("click", function() { 
        jane.set("available", false); 
    }, "#jane .movingOn");

    // A delegate DOM event listener which will update John's interests, based on the checkbox state, whenever
    // a checkbox is clicked.
    Y.delegate("click", function() {
        var interests = [];

        Y.Node.all("#john input[type=checkbox].interest").each(function(checkbox) {
            if (checkbox.get("checked")) {
                interests.push(checkbox.get("value"));
            }
        });
        john.set("interests", interests);

    }, "#john", "input[type=checkbox].interest");


    // Example helpers...
    function enableExampleUI() {
        Y.all("#jane button").set("disabled", false);
        Y.all("#john button").set("disabled", false);
        Y.all("#john input").set("disabled", false);
        Y.one("#john .interests").removeClass("disabled");
        Y.one("#jane .reconsider").removeClass("disabled");
    }
    
    function setMessage(msg) {
        Y.one("#jane .message").set("innerHTML", msg);      
    }

 });
</script>