egroupware/api/js/etemplate/et2_core_inheritance.js

206 lines
7.6 KiB
JavaScript
Raw Normal View History

2020-01-21 10:12:39 +01:00
"use strict";
/**
* EGroupware eTemplate2 - JS code for implementing inheritance with attributes
*
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* @package etemplate
* @subpackage api
2020-01-21 10:12:39 +01:00
* @link: https://www.egroupware.org
* @author Andreas Stöckel
*/
2020-01-21 10:12:39 +01:00
Object.defineProperty(exports, "__esModule", { value: true });
/*egw:uses
2020-01-21 10:12:39 +01:00
et2_core_common;
*/
2020-01-21 10:12:39 +01:00
require("../jsapi/egw_global");
require("et2_core_common");
var ClassWithAttributes = /** @class */ (function () {
function ClassWithAttributes() {
}
/**
* Returns the value of the given attribute. If the property does not
* exist, an error message is issued.
*
* @param {string} _name
* @return {*}
*/
ClassWithAttributes.prototype.getAttribute = function (_name) {
if (typeof this.attributes[_name] != "undefined" &&
!this.attributes[_name].ignore) {
if (typeof this["get_" + _name] == "function") {
return this["get_" + _name]();
}
else {
return this[_name];
}
}
else {
egw.debug("error", this, "Attribute '" + _name + "' does not exist!");
}
};
/**
* The setAttribute function sets the attribute with the given name to
* the given value. _override defines, whether this[_name] will be set,
* if this key already exists. _override defaults to true. A warning
* is issued if the attribute does not exist.
*
* @param {string} _name
* @param {*} _value
* @param {boolean} _override
*/
ClassWithAttributes.prototype.setAttribute = function (_name, _value, _override) {
if (typeof this.attributes[_name] != "undefined") {
if (!this.attributes[_name].ignore) {
if (typeof _override == "undefined") {
_override = true;
}
var val = et2_checkType(_value, this.attributes[_name].type, _name, this);
if (typeof this["set_" + _name] == "function") {
this["set_" + _name](val);
}
else if (_override || typeof this[_name] == "undefined") {
this[_name] = val;
}
}
}
else {
egw.debug("warn", this, "Attribute '" + _name + "' does not exist!");
}
};
/**
* generateAttributeSet sanitizes the given associative array of attributes
* (by passing each entry to "et2_checkType" and checking for existance of
* the attribute) and adds the default values to the associative array.
*
* @param {object} _attrs is the associative array containing the attributes.
*/
2020-01-21 19:45:21 +01:00
ClassWithAttributes.generateAttributeSet = function (widget, _attrs) {
2020-01-21 10:12:39 +01:00
// Sanity check and validation
for (var key in _attrs) {
2020-01-21 19:45:21 +01:00
if (typeof widget[key] != "undefined") {
if (!widget[key].ignore) {
_attrs[key] = et2_checkType(_attrs[key], widget[key].type, key, this);
2020-01-21 10:12:39 +01:00
}
}
else {
// Key does not exist - delete it and issue a warning
delete (_attrs[key]);
egw.debug("warn", this, "Attribute '" + key +
"' does not exist in " + _attrs.type + "!");
}
}
// Include default values or already set values for this attribute
2020-01-21 19:45:21 +01:00
for (var key in widget) {
2020-01-21 10:12:39 +01:00
if (typeof _attrs[key] == "undefined") {
2020-01-21 19:45:21 +01:00
var _default = widget[key]["default"];
2020-01-21 10:12:39 +01:00
if (_default == et2_no_init) {
_default = undefined;
}
_attrs[key] = _default;
}
}
return _attrs;
};
/**
* The initAttributes function sets the attributes to their default
* values. The attributes are not overwritten, which means, that the
* default is only set, if either a setter exists or this[propName] does
* not exist yet.
*
* @param {object} _attrs is the associative array containing the attributes.
*/
ClassWithAttributes.prototype.initAttributes = function (_attrs) {
for (var key in _attrs) {
if (typeof this.attributes[key] != "undefined" && !this.attributes[key].ignore && !(_attrs[key] == undefined)) {
this.setAttribute(key, _attrs[key], false);
}
}
};
2020-01-21 19:45:21 +01:00
ClassWithAttributes.buildAttributes = function (class_prototype) {
var class_tree = [];
var attributes = {};
var n = 0;
do {
n++;
class_tree.push(class_prototype);
class_prototype = Object.getPrototypeOf(class_prototype);
} while (class_prototype !== ClassWithAttributes && n < 50);
for (var i = class_tree.length - 1; i >= 0; i--) {
attributes = ClassWithAttributes.extendAttributes(attributes, class_tree[i]._attributes);
2020-01-21 19:45:21 +01:00
}
return attributes;
2020-01-21 19:45:21 +01:00
};
2020-01-21 10:12:39 +01:00
/**
* Extend current _attributes with the one from the parent class
*
* This gives inheritance from the parent plus the ability to override in the current class.
*
* @param _attributes
* @param _parent
*/
ClassWithAttributes.extendAttributes = function (_attributes, _parent) {
function _copyMerge(_new, _old) {
var result = {};
// Copy the new object
if (typeof _new != "undefined") {
for (var key in _new) {
result[key] = _new[key];
}
}
// Merge the old object
for (var key in _old) {
if (typeof result[key] == "undefined") {
result[key] = _old[key];
}
}
return result;
}
var attributes = {};
// Copy the old attributes
for (var key in _attributes) {
attributes[key] = _copyMerge({}, _attributes[key]);
}
// Add the old attributes to the new ones. If the attributes already
// exist, they are merged.
for (var key in _parent) {
var _old = _parent[key];
attributes[key] = _copyMerge(attributes[key], _old);
}
// Validate the attributes
for (var key in attributes) {
et2_validateAttrib(key, attributes[key]);
}
return attributes;
};
/**
* The implements function can be used to check whether the object
* implements the given interface.
*
* As TypeScript can not (yet) check if an objects implements an interface on runtime,
* we currently implements with each interface a function called 'implements_'+interfacename
* to be able to check here.
*
* @param _iface name of interface to check
*/
ClassWithAttributes.prototype.implements = function (_iface_name) {
if (typeof window['implements_' + _iface_name] === 'function' &&
window['implements_' + _iface_name](this)) {
return true;
}
return false;
};
/**
* Check if object is an instance of a class or implements an interface (specified by the interfaces name)
*
* @param _class_or_interfacename class(-name) or string with name of interface
*/
ClassWithAttributes.prototype.instanceOf = function (_class_or_interfacename) {
if (typeof _class_or_interfacename === 'string') {
return this.implements(_class_or_interfacename);
}
return this instanceof _class_or_interfacename;
};
2020-01-21 10:12:39 +01:00
return ClassWithAttributes;
}());
exports.ClassWithAttributes = ClassWithAttributes;
2020-01-21 19:45:21 +01:00
//# sourceMappingURL=et2_core_inheritance.js.map