mmir-lib
Version:
MMIR (Mobile Multimodal Interaction and Relay) library
90 lines (76 loc) • 2.28 kB
JavaScript
define(function(){
/**
* The Helper Class is a kind of interface-class which gives access to the methods and data of a helper (which itself belongs to a controller)<br>
*
* @constructor
* @class
* @name Helper
* @memberOf mmir.ctrl
* @param {mmir.ctrl.Controller} ctrl Controller instance / object
* @param {String} name Name of the Helper
* @param {Function} instanceConstr the constructor for creating a new helper instance
*
*/
function Helper(ctrl, name, instanceConstr){
/**
* The name of the helper.
*
* @type String
* @public
* @memberOf mmir.ctrl.Helper#
* @member name
*/
this.name=name;
/**
* The controller to which this helper belongs.
*
* @type mmir.ctrl.Controller
* @public
* @memberOf mmir.ctrl.Helper#
* @member controller
*/
this.controller = ctrl;
/**
* The definition of the helper object, i.e. its implementation,
* containing all properties and functions of the controller.<br>
*
* A method of the helper can be called via:
* <pre>
* this.impl.method(parameter);
* </pre>
*
* @type Object
* @public
* @memberOf mmir.ctrl.Helper#
* @member impl
*/
this.impl = new instanceConstr(this);
/**
* @deprecated use {@link #impl} instead
* @protected
* @memberOf mmir.ctrl.Helper#
* @member script
*/
this.script = this.impl;
}
/**
* This function performs an action of a helper.<br>
*
* @function perform
* @param {String} actionName Name of the method to be executed
* @param {Object} data Data to pass to the method of the helper as argument
* @returns {Object} The return value of the executed method
* @public
* @memberOf mmir.ctrl.Helper#
*/
Helper.prototype.perform = function(actionName, data){
// if(logger.isv()) logger.v("should perform '" + actionName + "' of '" + this.name + "'" + ((typeof data !== 'undefined' && data !== null)? " with data: "+JSON.stringify(data): ""));//debug
if(arguments.length > 2){
return this.impl[actionName](this.controller, data, arguments[2]);
}
else {
return this.impl[actionName](this.controller, data);
}
};
return Helper;
});//END: define(...