Convert et2_widget_checkbox to TS

This commit is contained in:
Hadi Nategh 2020-02-07 10:52:45 +01:00
parent 1d69d52d32
commit 5e80a05cd1
2 changed files with 522 additions and 244 deletions

View File

@ -1,3 +1,4 @@
"use strict";
/** /**
* EGroupware eTemplate2 - JS Checkbox object * EGroupware eTemplate2 - JS Checkbox object
* *
@ -9,255 +10,256 @@
* @copyright Nathan Gray 2011 * @copyright Nathan Gray 2011
* @version $Id$ * @version $Id$
*/ */
var __extends = (this && this.__extends) || (function () {
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
/*egw:uses /*egw:uses
/vendor/bower-asset/jquery/dist/jquery.js; /vendor/bower-asset/jquery/dist/jquery.js;
et2_core_inputWidget; et2_core_inputWidget;
et2_core_valueWidget; et2_core_valueWidget;
*/ */
var et2_core_widget_1 = require("./et2_core_widget");
var et2_core_inputWidget_1 = require("./et2_core_inputWidget");
var et2_core_inheritance_1 = require("./et2_core_inheritance");
/** /**
* Class which implements the "checkbox" XET-Tag * Class which implements the "checkbox" XET-Tag
* *
* @augments et2_inputWidget * @augments et2_inputWidget
*/ */
var et2_checkbox = (function(){ "use strict"; return et2_inputWidget.extend( var et2_checkbox = /** @class */ (function (_super) {
{ __extends(et2_checkbox, _super);
attributes: { /**
"selected_value": { * Constructor
"name": "Set value", *
"type": "string", * @memberOf et2_checkbox
"default": "true", */
"description": "Value when checked" function et2_checkbox(_parent, _attrs, _child) {
}, var _this =
"unselected_value": { // Call the inherited constructor
"name": "Unset value", _super.call(this, _parent, _attrs, et2_core_inheritance_1.ClassWithAttributes.extendAttributes(et2_checkbox._attributes, _child || {})) || this;
"type": "string", _this.legacyOptions = ["selected_value", "unselected_value", "ro_true", "ro_false"];
"default": "", _this.input = null;
"description": "Value when not checked" _this.toggle = null;
}, _this.input = null;
"ro_true": { _this.createInputWidget();
"name": "Read only selected", return _this;
"type": "string", }
"default": "X ", et2_checkbox.prototype.createInputWidget = function () {
"description": "What should be displayed when readonly and selected" this.input = jQuery(document.createElement("input")).attr("type", "checkbox");
}, this.input.addClass("et2_checkbox");
"ro_false": { if (this.options.toggle_on || this.options.toggle_off) {
"name": "Read only unselected", var self_1 = this;
"type": "string", // checkbox container
"default": "", this.toggle = jQuery(document.createElement('span'))
"description": "What should be displayed when readonly and not selected" .addClass('et2_checkbox_slideSwitch')
}, .append(this.input);
"value": { // update switch status on change
// Stop framework from messing with value this.input.change(function () {
"type": "any" self_1.getValue();
}, return true;
"toggle_on": { });
"name": "Toggle on caption", // switch container
"type": "string", var area = jQuery(document.createElement('span')).addClass('slideSwitch_container').appendTo(this.toggle);
"default": "", // on span tag
"description": "String caption to show for ON status", var on = jQuery(document.createElement('span')).addClass('on').appendTo(area);
"translate": true // off span tag
}, var off = jQuery(document.createElement('span')).addClass('off').appendTo(area);
"toggle_off": { on.text(this.options.toggle_on);
"name": "Toggle off caption", off.text(this.options.toggle_off);
"type": "string", // handle a tag
"default": "", jQuery(document.createElement('a')).appendTo(area);
"description": "String caption to show OFF status", this.setDOMNode(this.toggle[0]);
"translate": true }
} else {
}, this.setDOMNode(this.input[0]);
}
legacyOptions: ["selected_value", "unselected_value", "ro_true", "ro_false"], };
/**
/** * Override default to place checkbox before label, if there is no %s in the label
* Constructor *
* * @param {string} label
* @memberOf et2_checkbox */
*/ et2_checkbox.prototype.set_label = function (label) {
init: function() { if (label.length && label.indexOf('%s') < 0) {
this._super.apply(this, arguments); label = '%s' + label;
}
this.input = null; _super.prototype.set_label.call(this, label);
jQuery(this.getSurroundings().getWidgetSurroundings()).addClass('et2_checkbox_label');
this.createInputWidget(); };
/**
}, * Override default to match against set/unset value
*
createInputWidget: function() { * @param {string|boolean} _value
this.input = jQuery(document.createElement("input")).attr("type", "checkbox"); */
et2_checkbox.prototype.set_value = function (_value) {
this.input.addClass("et2_checkbox"); // in php, our database storage and et2_checkType(): "0" == false
if (_value === "0" && this.options.selected_value != "0") {
if (this.options.toggle_on || this.options.toggle_off) _value = false;
{ }
var self = this; if (_value != this.value) {
// checkbox container if (_value == this.options.selected_value ||
this.toggle = jQuery(document.createElement('span')) _value && this.options.selected_value == this.attributes["selected_value"]["default"] &&
.addClass('et2_checkbox_slideSwitch') _value != this.options.unselected_value) {
.append(this.input); if (this.options.toggle_on || this.options.toggle_off)
// update switch status on change this.toggle.addClass('switchOn');
this.input.change(function(){ this.input.prop("checked", true);
self.getValue(); }
return true; else {
}); this.input.prop("checked", false);
// switch container if (this.options.toggle_on || this.options.toggle_off)
var area = jQuery(document.createElement('span')).addClass('slideSwitch_container').appendTo(this.toggle); this.toggle.removeClass('switchOn');
// on span tag }
var on = jQuery(document.createElement('span')).addClass('on').appendTo(area); }
// off span tag };
var off = jQuery(document.createElement('span')).addClass('off').appendTo(area); /**
on.text(this.options.toggle_on); * Disable checkbox on runtime
off.text(this.options.toggle_off); *
* @param {boolean} _ro
// handle a tag */
var handle = jQuery(document.createElement('a')).appendTo(area); et2_checkbox.prototype.set_readonly = function (_ro) {
this.setDOMNode(this.toggle[0]); jQuery(this.getDOMNode()).attr('disabled', _ro);
} };
else /**
{ * Override default to return unchecked value
this.setDOMNode(this.input[0]); */
} et2_checkbox.prototype.getValue = function () {
if (this.input.prop("checked")) {
}, if (this.options.toggle_on || this.options.toggle_off)
this.toggle.addClass('switchOn');
/** return this.options.selected_value;
* Override default to place checkbox before label, if there is no %s in the label }
* else {
* @param {string} label if (this.options.toggle_on || this.options.toggle_off)
*/ this.toggle.removeClass('switchOn');
set_label: function(label) { return this.options.unselected_value;
if(label.length && label.indexOf('%s') < 0) }
{ };
label = '%s'+label; et2_checkbox._attributes = {
} "selected_value": {
this._super.apply(this, [label]); "name": "Set value",
jQuery(this.getSurroundings()._widgetSurroundings).addClass('et2_checkbox_label'); "type": "string",
}, "default": "true",
/** "description": "Value when checked"
* Override default to match against set/unset value },
* "unselected_value": {
* @param {string|boolean} _value "name": "Unset value",
*/ "type": "string",
set_value: function(_value) "default": "",
{ "description": "Value when not checked"
// in php, our database storage and et2_checkType(): "0" == false },
if (_value === "0" && this.options.selected_value != "0") "ro_true": {
{ "name": "Read only selected",
_value = false; "type": "string",
} "default": "X ",
if(_value != this.value) { "description": "What should be displayed when readonly and selected"
if(_value == this.options.selected_value || },
_value && this.options.selected_value == this.attributes.selected_value["default"] && "ro_false": {
_value != this.options.unselected_value) { "name": "Read only unselected",
if (this.options.toggle_on || this.options.toggle_off) this.toggle.addClass('switchOn'); "type": "string",
this.input.prop("checked", true); "default": "",
} else { "description": "What should be displayed when readonly and not selected"
this.input.prop("checked", false); },
if (this.options.toggle_on || this.options.toggle_off) this.toggle.removeClass('switchOn'); "value": {
} // Stop framework from messing with value
} "type": "any"
}, },
"toggle_on": {
/** "name": "Toggle on caption",
* Disable checkbox on runtime "type": "string",
* "default": "",
* @param {boolean} _ro "description": "String caption to show for ON status",
*/ "translate": true
set_readonly: function(_ro) },
{ "toggle_off": {
jQuery(this.getDOMNode()).attr('disabled', _ro); "name": "Toggle off caption",
}, "type": "string",
"default": "",
/** "description": "String caption to show OFF status",
* Override default to return unchecked value "translate": true
*/ }
getValue: function() { };
if(this.input.prop("checked")) { return et2_checkbox;
if (this.options.toggle_on || this.options.toggle_off) this.toggle.addClass('switchOn'); }(et2_core_inputWidget_1.et2_inputWidget));
return this.options.selected_value; et2_core_widget_1.et2_register_widget(et2_checkbox, ["checkbox"]);
} else {
if (this.options.toggle_on || this.options.toggle_off) this.toggle.removeClass('switchOn');
return this.options.unselected_value;
}
}
});}).call(this);
et2_register_widget(et2_checkbox, ["checkbox"]);
/** /**
* et2_checkbox_ro is the dummy readonly implementation of the checkbox * et2_checkbox_ro is the dummy readonly implementation of the checkbox
* @augments et2_checkbox * @augments et2_checkbox
*/ */
var et2_checkbox_ro = (function(){ "use strict"; return et2_checkbox.extend([et2_IDetachedDOM], var et2_checkbox_ro = /** @class */ (function (_super) {
{ __extends(et2_checkbox_ro, _super);
/** /**
* Ignore unset value * Constructor
*/ *
attributes: { * @memberOf et2_checkbox_ro
"unselected_value": { */
"ignore": true function et2_checkbox_ro(_parent, _attrs, _child) {
} var _this =
}, // Call the inherited constructor
_super.call(this, _parent, _attrs, et2_core_inheritance_1.ClassWithAttributes.extendAttributes(et2_checkbox_ro._attributes, _child || {})) || this;
/** _this.span = null;
* Constructor _this.value = "";
* _this.span = jQuery(document.createElement("span"))
* @memberOf et2_checkbox_ro .addClass("et2_checkbox_ro");
*/ _this.setDOMNode(_this.span[0]);
init: function() { return _this;
this._super.apply(this, arguments); }
/**
this.value = ""; * note: checkbox is checked if even there is a value but not only if the _value is only "true"
this.span = jQuery(document.createElement("span")) * it's an exceptional validation for cases that we pass non boolean values as checkbox _value
.addClass("et2_checkbox_ro"); *
* @param {string|boolean} _value
this.setDOMNode(this.span[0]); */
}, et2_checkbox_ro.prototype.set_value = function (_value) {
if (_value == this.options.selected_value || _value && this.options.selected_value == this.attributes["selected_value"]["default"] &&
/** _value != this.options.unselected_value) {
* note: checkbox is checked if even there is a value but not only if the _value is only "true" this.span.text(this.options.ro_true);
* it's an exceptional validation for cases that we pass non boolean values as checkbox _value this.value = _value;
* }
* @param {string|boolean} _value else {
*/ this.span.text(this.options.ro_false);
set_value: function(_value) { }
if(_value == this.options.selected_value ||_value && this.options.selected_value == this.attributes.selected_value["default"] && };
_value != this.options.unselected_value) { /**
this.span.text(this.options.ro_true); * Code for implementing et2_IDetachedDOM
this.value = _value; *
} else { * @param {array} _attrs
this.span.text(this.options.ro_false); */
} et2_checkbox_ro.prototype.getDetachedAttributes = function (_attrs) {
}, _attrs.push("value", "class");
};
/** et2_checkbox_ro.prototype.getDetachedNodes = function () {
* Code for implementing et2_IDetachedDOM return [this.span[0]];
* };
* @param {array} _attrs et2_checkbox_ro.prototype.setDetachedAttributes = function (_nodes, _values) {
*/ // Update the properties
getDetachedAttributes: function(_attrs) if (typeof _values["value"] != "undefined") {
{ this.span = jQuery(_nodes[0]);
_attrs.push("value", "class"); this.set_value(_values["value"]);
}, }
if (typeof _values["class"] != "undefined") {
getDetachedNodes: function() _nodes[0].setAttribute("class", _values["class"]);
{ }
return [this.span[0]]; };
}, /**
* Ignore unset value
setDetachedAttributes: function(_nodes, _values) */
{ et2_checkbox_ro._attributes = {
// Update the properties "unselected_value": {
if (typeof _values["value"] != "undefined") "ignore": true
{ }
this.span = jQuery(_nodes[0]); };
this.set_value(_values["value"]); return et2_checkbox_ro;
} }(et2_checkbox));
et2_core_widget_1.et2_register_widget(et2_checkbox_ro, ["checkbox_ro"]);
if (typeof _values["class"] != "undefined") //# sourceMappingURL=et2_widget_checkbox.js.map
{
_nodes[0].setAttribute("class", _values["class"]);
}
}
});}).call(this);
et2_register_widget(et2_checkbox_ro, ["checkbox_ro"]);

View File

@ -0,0 +1,276 @@
/**
* EGroupware eTemplate2 - JS Checkbox object
*
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* @package etemplate
* @subpackage api
* @link http://www.egroupware.org
* @author Nathan Gray
* @copyright Nathan Gray 2011
* @version $Id$
*/
/*egw:uses
/vendor/bower-asset/jquery/dist/jquery.js;
et2_core_inputWidget;
et2_core_valueWidget;
*/
import {et2_register_widget, WidgetConfig} from "./et2_core_widget";
import {et2_inputWidget} from "./et2_core_inputWidget";
import {ClassWithAttributes} from "./et2_core_inheritance";
/**
* Class which implements the "checkbox" XET-Tag
*
* @augments et2_inputWidget
*/
class et2_checkbox extends et2_inputWidget
{
static readonly _attributes : any = {
"selected_value": {
"name": "Set value",
"type": "string",
"default": "true",
"description": "Value when checked"
},
"unselected_value": {
"name": "Unset value",
"type": "string",
"default": "",
"description": "Value when not checked"
},
"ro_true": {
"name": "Read only selected",
"type": "string",
"default": "X ",
"description": "What should be displayed when readonly and selected"
},
"ro_false": {
"name": "Read only unselected",
"type": "string",
"default": "",
"description": "What should be displayed when readonly and not selected"
},
"value": {
// Stop framework from messing with value
"type": "any"
},
"toggle_on": {
"name": "Toggle on caption",
"type": "string",
"default": "",
"description": "String caption to show for ON status",
"translate": true
},
"toggle_off": {
"name": "Toggle off caption",
"type": "string",
"default": "",
"description": "String caption to show OFF status",
"translate": true
}
};
legacyOptions : string[] = ["selected_value", "unselected_value", "ro_true", "ro_false"];
input : JQuery = null;
toggle : JQuery = null;
value : string | boolean;
/**
* Constructor
*
* @memberOf et2_checkbox
*/
constructor(_parent, _attrs? : WidgetConfig, _child? : object)
{
// Call the inherited constructor
super(_parent, _attrs, ClassWithAttributes.extendAttributes(et2_checkbox._attributes, _child || {}));
this.input = null;
this.createInputWidget();
}
createInputWidget()
{
this.input = jQuery(document.createElement("input")).attr("type", "checkbox");
this.input.addClass("et2_checkbox");
if (this.options.toggle_on || this.options.toggle_off)
{
let self = this;
// checkbox container
this.toggle = jQuery(document.createElement('span'))
.addClass('et2_checkbox_slideSwitch')
.append(this.input);
// update switch status on change
this.input.change(function(){
self.getValue();
return true;
});
// switch container
let area = jQuery(document.createElement('span')).addClass('slideSwitch_container').appendTo(this.toggle);
// on span tag
let on = jQuery(document.createElement('span')).addClass('on').appendTo(area);
// off span tag
let off = jQuery(document.createElement('span')).addClass('off').appendTo(area);
on.text(this.options.toggle_on);
off.text(this.options.toggle_off);
// handle a tag
jQuery(document.createElement('a')).appendTo(area);
this.setDOMNode(this.toggle[0]);
}
else
{
this.setDOMNode(this.input[0]);
}
}
/**
* Override default to place checkbox before label, if there is no %s in the label
*
* @param {string} label
*/
set_label(label) {
if(label.length && label.indexOf('%s') < 0)
{
label = '%s'+label;
}
super.set_label(label);
jQuery(this.getSurroundings().getWidgetSurroundings()).addClass('et2_checkbox_label');
}
/**
* Override default to match against set/unset value
*
* @param {string|boolean} _value
*/
set_value(_value : string | boolean)
{
// in php, our database storage and et2_checkType(): "0" == false
if (_value === "0" && this.options.selected_value != "0")
{
_value = false;
}
if(_value != this.value) {
if(_value == this.options.selected_value ||
_value && this.options.selected_value == this.attributes["selected_value"]["default"] &&
_value != this.options.unselected_value) {
if (this.options.toggle_on || this.options.toggle_off) this.toggle.addClass('switchOn');
this.input.prop("checked", true);
} else {
this.input.prop("checked", false);
if (this.options.toggle_on || this.options.toggle_off) this.toggle.removeClass('switchOn');
}
}
}
/**
* Disable checkbox on runtime
*
* @param {boolean} _ro
*/
set_readonly(_ro)
{
jQuery(this.getDOMNode()).attr('disabled', _ro);
}
/**
* Override default to return unchecked value
*/
getValue()
{
if(this.input.prop("checked")) {
if (this.options.toggle_on || this.options.toggle_off) this.toggle.addClass('switchOn');
return this.options.selected_value;
} else {
if (this.options.toggle_on || this.options.toggle_off) this.toggle.removeClass('switchOn');
return this.options.unselected_value;
}
}
}
et2_register_widget(et2_checkbox, ["checkbox"]);
/**
* et2_checkbox_ro is the dummy readonly implementation of the checkbox
* @augments et2_checkbox
*/
class et2_checkbox_ro extends et2_checkbox implements et2_IDetachedDOM
{
/**
* Ignore unset value
*/
static readonly _attributes : any = {
"unselected_value": {
"ignore": true
}
};
span : JQuery = null;
/**
* Constructor
*
* @memberOf et2_checkbox_ro
*/
constructor(_parent, _attrs? : WidgetConfig, _child? : object)
{
// Call the inherited constructor
super(_parent, _attrs, ClassWithAttributes.extendAttributes(et2_checkbox_ro._attributes, _child || {}));
this.value = "";
this.span = jQuery(document.createElement("span"))
.addClass("et2_checkbox_ro");
this.setDOMNode(this.span[0]);
}
/**
* note: checkbox is checked if even there is a value but not only if the _value is only "true"
* it's an exceptional validation for cases that we pass non boolean values as checkbox _value
*
* @param {string|boolean} _value
*/
set_value(_value)
{
if(_value == this.options.selected_value ||_value && this.options.selected_value == this.attributes["selected_value"]["default"] &&
_value != this.options.unselected_value) {
this.span.text(this.options.ro_true);
this.value = _value;
} else {
this.span.text(this.options.ro_false);
}
}
/**
* Code for implementing et2_IDetachedDOM
*
* @param {array} _attrs
*/
getDetachedAttributes(_attrs)
{
_attrs.push("value", "class");
}
getDetachedNodes()
{
return [this.span[0]];
}
setDetachedAttributes(_nodes, _values)
{
// Update the properties
if (typeof _values["value"] != "undefined")
{
this.span = jQuery(_nodes[0]);
this.set_value(_values["value"]);
}
if (typeof _values["class"] != "undefined")
{
_nodes[0].setAttribute("class", _values["class"]);
}
}
}
et2_register_widget(et2_checkbox_ro, ["checkbox_ro"]);