Jump To …

module.js

Mod.Module

 
             		           
                               
                            
                                
               
Modules are responsible for defining the specific behavior
of pieces of your application. All the functionality of your 
application will be defined in modules.
             		                            
Mod.Module = (function() {
             		           
                               
                            
                                
               
Each module contains a dom property which is a Mod.DOM 
instance to act as the module's API to the DOM. The data attribute 
is a simple object literal that serves to store module-wide configuration 
and properties (which prevents polluting the modules namespace and collision with public methods). 
The name property is a convenience to be able to ask a module it's name.
             		                            
    function Module(name) {
        if (is_undefined(name)) {
            throw new Error("Mod.Module(name): name is undefined");
        }

        this.dom = new Mod.DOM;
        this.data = {};
        this.name = name;
    }
             		           
                               
                            
                                
               
actions



The actions method is a placholder to be overwritten in each instance
             		                            
    Module.prototype.actions = function() {};
             		           
                               
                            
                                
               
run



Wait for the DOM to be ready and execute the actions
             		                            
    Module.prototype.run = function() {
        var mod = this;
        this.dom.call_when_ready(function() {
            mod.execute();
        });
    };
             		           
                               
                            
                                
               
execute



Execute the actions immediately
             		                            
    Module.prototype.execute = function() {
        this.actions();
    };
             		           
                               
                            
                                
               
elements



Serves as an api to set and get elements from the module's dom property.
passing a string retrieves an element, passing an object sets elements
             		                            
    Module.prototype.elements = function(elements) {
        if (is_undefined(elements)) {
            return this.dom.cache;
        }
             		           
                               
                            
                                
               
Look up cached element by string key
             		                            
        if (is_string(elements)) {
            var name = elements;
            return this.dom.cache[name];
        }
             		           
                               
                            
                                
               
cache the DOM objects
             		                            
        else {
            this.dom.add_elements(elements);
        }
    };
             		           
                               
                            
                                
               
set_data



Convenience method to add properties to the data property of the module
             		                            
    Module.prototype.set_data = function(key, value) {
        if (is_undefined(key)) {
            throw new Error(this.name + '.set_data(key, value): key is undefined');
        }

        if (is_typeof(String, key) && is_undefined(value)) {
            throw new SyntaxError(this.name + 'Module.set_data(key, value): value is undefined');
        }

        if (is_typeof(String, key)) {
            this.data[key] = value;
        }
        else if (is_typeof(Object, key)) {
            var data = key;
            for(var property in data) {
                this.data[property] = data[property];
            }
        }

        return this;
    };

    return Module;
})();