/*
* Copyright (C) 2012-2013 DFKI GmbH
* Deutsches Forschungszentrum fuer Kuenstliche Intelligenz
* German Research Center for Artificial Intelligence
* http://www.dfki.de
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
define(
//this comment is needed by jsdoc2 [copy of comment for: function Helper(...]
/**
* 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>
*
* @param {Controller} ctrl Controller instance / object
* @param {String} name Name of the Helper
* @param {Object} [ctx] OPTIONAL the context for the helper implementation (DEFAULT: global context, i.e. window)
*
* @name Helper
* @class
*/
function(
){
//the next comment enables JSDoc2 to map all functions etc. to the correct class description
/** @scope Helper.prototype */
//set to @ignore in order to avoid doc-duplication in jsdoc3
/**
* @ignore
*
* 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>
*
* @constructs Helper
* @param {Controller} ctrl Controller instance / object
* @param {String} name Name of the Helper
* @param {Object} ctx the context for the helper implementation, i.e. where the constructor exists: ctx.<helper name>()
*/
function Helper(ctrl, name, ctx){
/**
* The name of the helper.
*
* @type String
* @public
*/
this.name=name;
/**
* The controller to which this helper belongs.
*
* @type Controller
* @public
*/
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
*/
// this can only be invoked, if a function with the name "name" exists in the object/context ctx
this.impl = new ctx[name](this);
/**
* @deprecated use {@link #impl} instead
* @protected
*/
this.script = this.impl;
}
/**
* This function performs an action of a helper.<br>
*
* @function
* @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
*/
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(...