extern/egroupware_official
1
0
Fork 0
mirror of https://github.com/EGroupware/egroupware.git synced 2024-11-25 01:13:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

Convert et2_radiobox to TS

Browse Source
This commit is contained in:
Hadi Nategh 2020-01-23 15:14:46 +01:00
parent 5e81f94aec
commit 5d2600ddbd
4 changed files with 896 additions and 425 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
api/js/etemplate/et2_widget_number.js
View File

@ -115,6 +115,35 @@ var et2_number = /** @class */ (function (_super_1) {
this.input.attr("max", this.max);
}
};
et2_number._attributes = {
"value": {
"type": "float"
},
// Override default width, numbers are usually shorter
"size": {
"default": 5
},
"min": {
"name": "Minimum",
"type": "integer",
"default": et2_no_init,
"description": "Minimum allowed value"
},
"max": {
"name": "Maximum",
"type": "integer",
"default": et2_no_init,
"description": "Maximum allowed value"
},
"precision": {
// TODO: Implement this in some nice way other than HTML5's step attribute
"name": "Precision",
"type": "integer",
"default": et2_no_init,
"description": "Allowed precision - # of decimal places",
"ignore": true
}
};
return et2_number;
}(et2_widget_textbox_1.et2_textbox));
et2_core_widget_1.et2_register_widget(et2_number, ["int", "integer", "float"]);
@ -135,6 +164,18 @@ var et2_number_ro = /** @class */ (function (_super_1) {
}
this._super.call(this, _value);
};
et2_number_ro._attributes = {
min: { ignore: true },
max: { ignore: true },
precision: {
name: "Precision",
type: "integer",
default: et2_no_init,
description: "Allowed precision - # of decimal places",
ignore: true
},
value: { type: "float" }
};
return et2_number_ro;
}(et2_textbox_ro));
et2_core_widget_1.et2_register_widget(et2_number_ro, ["int_ro", "integer_ro", "float_ro"]);

4
api/js/etemplate/et2_widget_number.ts
View File

@ -23,7 +23,7 @@ import {ClassWithAttributes} from "./et2_core_inheritance";
*/
class et2_number extends et2_textbox
{
static readonly _attributes: {
static readonly _attributes : any = {
"value": {
"type": "float"
},
@ -160,7 +160,7 @@ et2_register_widget(et2_number, ["int", "integer", "float"]);
*/
class et2_number_ro extends et2_textbox_ro
{
static readonly _attributes: {
static readonly _attributes : any = {
min: { ignore: true},
max: { ignore: true},
precision: {

809
api/js/etemplate/et2_widget_radiobox.js
View File

@ -1,3 +1,4 @@
"use strict";
/**
* EGroupware eTemplate2 - JS Radiobox object
*
@ -9,12 +10,28 @@
* @copyright Nathan Gray 2011
* @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
/vendor/bower-asset/jquery/dist/jquery.js;
et2_core_inputWidget;
/vendor/bower-asset/jquery/dist/jquery.js;
et2_core_inputWidget;
*/
var et2_core_inputWidget_1 = require("./et2_core_inputWidget");
var et2_core_inheritance_1 = require("./et2_core_inheritance");
var et2_core_widget_1 = require("./et2_core_widget");
var et2_core_valueWidget_1 = require("./et2_core_valueWidget");
/**
* Class which implements the "radiobox" XET-Tag
*
@ -24,431 +41,377 @@
*
* @augments et2_inputWidget
*/
var et2_radiobox = (function(){ "use strict"; return et2_inputWidget.extend(
{
attributes: {
"set_value": {
"name": "Set value",
"type": "string",
"default": "true",
"description": "Value when selected"
},
"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"
}
},
legacyOptions: ["set_value", "ro_true", "ro_false"],
/**
* Constructor
*
* @memberOf et2_radiobox
*/
init: function() {
this._super.apply(this, arguments);
this.input = null;
this.id = "";
this.createInputWidget();
},
transformAttributes: function(_attrs) {
this._super.apply(this, arguments);
var readonly = this.getArrayMgr('readonlys').getEntry(this.id);
if(readonly && readonly.hasOwnProperty(_attrs.set_value))
{
_attrs.readonly = readonly[_attrs.set_value];
}
},
createInputWidget: function() {
this.input = jQuery(document.createElement("input"))
.val(this.options.set_value)
.attr("type", "radio")
.attr("disabled", this.options.readonly);
this.input.addClass("et2_radiobox");
this.setDOMNode(this.input[0]);
},
/**
* Overwritten to set different DOM level ids by appending set_value
*
* @param _id
*/
set_id: function(_id)
{
this._super.apply(this, arguments);
this.dom_id = this.dom_id.replace('[]', '')+'-'+this.options.set_value;
if (this.input) this.input.attr('id', this.dom_id);
},
/**
* Default for radio buttons is label after button
*
* @param _label String New label for radio button. Use %s to locate the radio button somewhere else in the label
*/
set_label: function(_label) {
if(_label.length > 0 && _label.indexOf('%s')==-1)
{
_label = '%s'+_label;
}
this._super.apply(this, [_label]);
},
/**
* Override default to match against set/unset value AND iterate over all siblings with same id
*
* @param {string} _value
*/
set_value: function(_value)
{
this.getRoot().iterateOver(function(radio)
{
if (radio.id == this.id)
{
radio.input.prop('checked', _value == radio.options.set_value);
}
}, this, et2_radiobox);
},
/**
* Override default to iterate over all siblings with same id
*
* @return {string}
*/
getValue: function()
{
var val = this.options.value; // initial value, when form is loaded
var values = [];
this.getRoot().iterateOver(function(radio)
{
values.push(radio.options.set_value);
if (radio.id == this.id && radio.input && radio.input.prop('checked'))
{
val = radio.options.set_value;
}
}, this, et2_radiobox);
return val && val.indexOf(values) ? val : null;
},
/**
* Overridden from parent so if it's required, only 1 in a group needs a value
*
* @param {array} messages
* @returns {Boolean}
*/
isValid: function(messages) {
var ok = true;
// Check for required
if (this.options && this.options.needed && !this.options.readonly && !this.disabled &&
(this.getValue() == null || this.getValue().valueOf() == ''))
{
if(jQuery.isEmptyObject(this.getInstanceManager().getValues(this.getInstanceManager().widgetContainer)[this.id.replace('[]', '')]))
{
messages.push(this.egw().lang('Field must not be empty !!!'));
ok = false;
}
}
return ok;
}
});}).call(this);
et2_register_widget(et2_radiobox, ["radio"]);
var et2_radiobox = /** @class */ (function (_super) {
__extends(et2_radiobox, _super);
/**
* Constructor
*
* @memberOf et2_radiobox
*/
function et2_radiobox(_parent, _attrs, _child) {
var _this = _super.call(this, _parent, _attrs, et2_core_inheritance_1.ClassWithAttributes.extendAttributes(et2_radiobox._attributes, _child || {})) || this;
_this.legacyOptions = ["set_value", "ro_true", "ro_false"];
_this.input = null;
_this.id = "";
_this.createInputWidget();
return _this;
}
et2_radiobox.prototype.transformAttributes = function (_attrs) {
_super.prototype.transformAttributes.call(this, _attrs);
var readonly = this.getArrayMgr('readonlys').getEntry(this.id);
if (readonly && readonly.hasOwnProperty(_attrs.set_value)) {
_attrs.readonly = readonly[_attrs.set_value];
}
};
et2_radiobox.prototype.createInputWidget = function () {
this.input = jQuery(document.createElement("input"))
.val(this.options.set_value)
.attr("type", "radio")
.attr("disabled", this.options.readonly);
this.input.addClass("et2_radiobox");
this.setDOMNode(this.input[0]);
};
/**
* Overwritten to set different DOM level ids by appending set_value
*
* @param _id
*/
et2_radiobox.prototype.set_id = function (_id) {
_super.prototype.set_id.call(this, _id);
this.dom_id = this.dom_id.replace('[]', '') + '-' + this.options.set_value;
if (this.input)
this.input.attr('id', this.dom_id);
};
/**
* Default for radio buttons is label after button
*
* @param _label String New label for radio button. Use %s to locate the radio button somewhere else in the label
*/
et2_radiobox.prototype.set_label = function (_label) {
if (_label.length > 0 && _label.indexOf('%s') == -1) {
_label = '%s' + _label;
}
_super.prototype.set_label.call(this, _label);
};
/**
* Override default to match against set/unset value AND iterate over all siblings with same id
*
* @param {string} _value
*/
et2_radiobox.prototype.set_value = function (_value) {
this.getRoot().iterateOver(function (radio) {
if (radio.id == this.id) {
radio.input.prop('checked', _value == radio.options.set_value);
}
}, this, et2_radiobox);
};
/**
* Override default to iterate over all siblings with same id
*
* @return {string}
*/
et2_radiobox.prototype.getValue = function () {
var val = this.options.value; // initial value, when form is loaded
var values = [];
this.getRoot().iterateOver(function (radio) {
values.push(radio.options.set_value);
if (radio.id == this.id && radio.input && radio.input.prop('checked')) {
val = radio.options.set_value;
}
}, this, et2_radiobox);
return val && val.indexOf(values) ? val : null;
};
/**
* Overridden from parent so if it's required, only 1 in a group needs a value
*
* @param {array} messages
* @returns {Boolean}
*/
et2_radiobox.prototype.isValid = function (messages) {
var ok = true;
// Check for required
if (this.options && this.options.needed && !this.options.readonly && !this.disabled &&
(this.getValue() == null || this.getValue().valueOf() == '')) {
if (jQuery.isEmptyObject(this.getInstanceManager().getValues(this.getInstanceManager().widgetContainer)[this.id.replace('[]', '')])) {
messages.push(this.egw().lang('Field must not be empty !!!'));
ok = false;
}
}
return ok;
};
et2_radiobox._attributes = {
"set_value": {
"name": "Set value",
"type": "string",
"default": "true",
"description": "Value when selected"
},
"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"
}
};
return et2_radiobox;
}(et2_core_inputWidget_1.et2_inputWidget));
et2_core_widget_1.et2_register_widget(et2_radiobox, ["radio"]);
/**
* @augments et2_valueWidget
*/
var et2_radiobox_ro = (function(){ "use strict"; return et2_valueWidget.extend([et2_IDetachedDOM],
{
attributes: {
"set_value": {
"name": "Set value",
"type": "string",
"default": "true",
"description": "Value when selected"
},
"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"
},
"label": {
"name": "Label",
"default": "",
"type": "string"
}
},
legacyOptions: ["set_value", "ro_true", "ro_false"],
/**
* Constructor
*
* @memberOf et2_radiobox_ro
*/
init: function() {
this._super.apply(this, arguments);
this.value = "";
this.span = jQuery(document.createElement("span"))
.addClass("et2_radiobox");
this.setDOMNode(this.span[0]);
},
/**
* Override default to match against set/unset value
*
* @param {string} _value
*/
set_value: function(_value) {
this.value = _value;
if(_value == this.options.set_value) {
this.span.text(this.options.ro_true);
} else {
this.span.text(this.options.ro_false);
}
},
set_label: function(_label) {
// no label for ro radio, we show label of checked option as content
},
/**
* Code for implementing et2_IDetachedDOM
*
* @param {array} _attrs
*/
getDetachedAttributes: function(_attrs)
{
// Show label in nextmatch instead of just x
this.options.ro_true = this.options.label;
_attrs.push("value");
},
getDetachedNodes: function()
{
return [this.span[0]];
},
setDetachedAttributes: function(_nodes, _values)
{
this.span = jQuery(_nodes[0]);
this.set_value(_values["value"]);
}
});}).call(this);
et2_register_widget(et2_radiobox_ro, ["radio_ro"]);
var et2_radiobox_ro = /** @class */ (function (_super) {
__extends(et2_radiobox_ro, _super);
/**
* Constructor
*
* @memberOf et2_radiobox_ro
*/
function et2_radiobox_ro(_parent, _attrs, _child) {
var _this =
// Call the inherited constructor
_super.call(this, _parent, _attrs, et2_core_inheritance_1.ClassWithAttributes.extendAttributes(et2_radiobox_ro._attributes, _child || {})) || this;
_this.legacyOptions = ["set_value", "ro_true", "ro_false"];
_this.value = "";
_this.span = null;
_this.span = jQuery(document.createElement("span"))
.addClass("et2_radiobox");
_this.setDOMNode(_this.span[0]);
return _this;
}
/**
* Override default to match against set/unset value
*
* @param {string} _value
*/
et2_radiobox_ro.prototype.set_value = function (_value) {
this.value = _value;
if (_value == this.options.set_value) {
this.span.text(this.options.ro_true);
}
else {
this.span.text(this.options.ro_false);
}
};
et2_radiobox_ro.prototype.set_label = function (_label) {
// no label for ro radio, we show label of checked option as content
};
/**
* Code for implementing et2_IDetachedDOM
*
* @param {array} _attrs
*/
et2_radiobox_ro.prototype.getDetachedAttributes = function (_attrs) {
// Show label in nextmatch instead of just x
this.options.ro_true = this.options.label;
_attrs.push("value");
};
et2_radiobox_ro.prototype.getDetachedNodes = function () {
return [this.span[0]];
};
et2_radiobox_ro.prototype.setDetachedAttributes = function (_nodes, _values) {
this.span = jQuery(_nodes[0]);
this.set_value(_values["value"]);
};
et2_radiobox_ro._attributes = {
"set_value": {
"name": "Set value",
"type": "string",
"default": "true",
"description": "Value when selected"
},
"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"
},
"label": {
"name": "Label",
"default": "",
"type": "string"
}
};
return et2_radiobox_ro;
}(et2_core_valueWidget_1.et2_valueWidget));
et2_core_widget_1.et2_register_widget(et2_radiobox_ro, ["radio_ro"]);
/**
* A group of radio buttons
*
* @augments et2_valueWidget
*/
var et2_radioGroup = (function(){ "use strict"; return et2_valueWidget.extend([et2_IDetachedDOM],
{
attributes: {
"label": {
"name": "Label",
"default": "",
"type": "string",
"description": "The label is displayed above the list of radio buttons. The label can contain variables, as descript for name. If the label starts with a '@' it is replaced by the value of the content-array at this index (with the '@'-removed and after expanding the variables).",
"translate": true
},
"value": {
"name": "Value",
"type": "string",
"default": "true",
"description": "Value for each radio button"
},
"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"
},
"options": {
"name": "Radio options",
"type": "any",
"default": {},
"description": "Options for radio buttons. Should be {value: label, ...}"
},
"needed": {
"name": "Required",
"default": false,
"type": "boolean",
"description": "If required, the user must select one of the options before the form can be submitted"
}
},
createNamespace: false,
/**
* Constructor
*
* @param parent
* @param attrs
* @memberOf et2_radioGroup
*/
init: function(parent, attrs) {
this._super.apply(this, arguments);
this.node = jQuery(document.createElement("div"))
.addClass("et2_vbox")
.addClass("et2_box_widget");
if(this.options.needed)
{
// This isn't strictly allowed, but it works
this.node.attr("required","required");
}
this.setDOMNode(this.node[0]);
// The supported widget classes array defines a whitelist for all widget
// classes or interfaces child widgets have to support.
this.supportedWidgetClasses = [et2_radiobox,et2_radiobox_ro];
},
set_value: function(_value) {
this.value = _value;
for (var i = 0; i < this._children.length; i++)
{
var radio = this._children[i];
radio.set_value(_value);
}
},
getValue: function() {
return jQuery("input:checked", this.getDOMNode()).val();
},
/**
* Set a bunch of radio buttons
*
* @param {object} _options object with value: label pairs
*/
set_options: function(_options) {
// Call the destructor of all children
for (var i = this._children.length - 1; i >= 0; i--)
{
this._children[i].free();
}
this._children = [];
// create radio buttons for each option
for(var key in _options)
{
var attrs = {
// Add index so radios work properly
"id": (this.options.readonly ? this.id : this.id + "[" + "]"),
set_value: key,
label: _options[key],
ro_true: this.options.ro_true,
ro_false: this.options.ro_false,
readonly: this.options.readonly
};
if(typeof _options[key] === 'object' && _options[key].label)
{
attrs.set_value = _options[key].value;
attrs.label = _options[key].label;
}
// Can't have a required readonly, it will warn & be removed later, so avoid the warning
if(attrs.readonly === false)
{
attrs.needed = this.options.needed;
}
var radio = et2_createWidget("radio", attrs, this);
}
this.set_value(this.value);
},
/**
* Set a label on the group of radio buttons
*
* @param {string} _value
*/
set_label: function(_value) {
// Abort if ther was no change in the label
if (_value == this.label)
{
return;
}
if (_value)
{
// Create the label container if it didn't exist yet
if (this._labelContainer == null)
{
this._labelContainer = jQuery(document.createElement("label"));
this.getSurroundings().insertDOMNode(this._labelContainer[0]);
}
// Clear the label container.
this._labelContainer.empty();
// Create the placeholder element and set it
var ph = document.createElement("span");
this.getSurroundings().setWidgetPlaceholder(ph);
this._labelContainer
.append(document.createTextNode(_value))
.append(ph);
}
else
{
// Delete the labelContainer from the surroundings object
if (this._labelContainer)
{
this.getSurroundings().removeDOMNode(this._labelContainer[0]);
}
this._labelContainer = null;
}
},
/**
* Code for implementing et2_IDetachedDOM
* This doesn't need to be implemented.
* Individual widgets are detected and handled by the grid, but the interface is needed for this to happen
*
* @param {object} _attrs
*/
getDetachedAttributes: function(_attrs)
{
},
getDetachedNodes: function()
{
return [this.getDOMNode()];
},
setDetachedAttributes: function(_nodes, _values)
{
}
});}).call(this);
var et2_radioGroup = /** @class */ (function (_super) {
__extends(et2_radioGroup, _super);
/**
* Constructor
*
* @param parent
* @param attrs
* @memberOf et2_radioGroup
*/
function et2_radioGroup(_parent, _attrs, _child) {
var _this =
// Call the inherited constructor
_super.call(this, _parent, _attrs, et2_core_inheritance_1.ClassWithAttributes.extendAttributes(et2_radioGroup._attributes, _child || {})) || this;
_this.createNamespace = false;
_this.node = null;
_this.value = null;
_this.node = jQuery(document.createElement("div"))
.addClass("et2_vbox")
.addClass("et2_box_widget");
if (_this.options.needed) {
// This isn't strictly allowed, but it works
_this.node.attr("required", "required");
}
_this.setDOMNode(_this.node[0]);
// The supported widget classes array defines a whitelist for all widget
// classes or interfaces child widgets have to support.
_this.supportedWidgetClasses = [et2_radiobox, et2_radiobox_ro];
return _this;
}
et2_radioGroup.prototype.set_value = function (_value) {
this.value = _value;
for (var i = 0; i < this._children.length; i++) {
var radio = this._children[i];
radio.set_value(_value);
}
};
et2_radioGroup.prototype.getValue = function () {
return jQuery("input:checked", this.getDOMNode()).val();
};
/**
* Set a bunch of radio buttons
*
* @param {object} _options object with value: label pairs
*/
et2_radioGroup.prototype.set_options = function (_options) {
// Call the destructor of all children
for (var i = this._children.length - 1; i >= 0; i--) {
this._children[i].free();
}
this._children = [];
// create radio buttons for each option
for (var key in _options) {
var attrs = {
// Add index so radios work properly
"id": (this.options.readonly ? this.id : this.id + "[" + "]"),
set_value: key,
label: _options[key],
ro_true: this.options.ro_true,
ro_false: this.options.ro_false,
readonly: this.options.readonly
};
if (typeof _options[key] === 'object' && _options[key].label) {
attrs.set_value = _options[key].value;
attrs.label = _options[key].label;
}
// Can't have a required readonly, it will warn & be removed later, so avoid the warning
if (attrs.readonly === false) {
attrs['needed'] = this.options.needed;
}
et2_createWidget("radio", attrs, this);
}
this.set_value(this.value);
};
/**
* Set a label on the group of radio buttons
*
* @param {string} _value
*/
et2_radioGroup.prototype.set_label = function (_value) {
// Abort if ther was no change in the label
if (_value == this.label) {
return;
}
if (_value) {
// Create the label container if it didn't exist yet
if (this._labelContainer == null) {
this._labelContainer = jQuery(document.createElement("label"));
this.getSurroundings().insertDOMNode(this._labelContainer[0]);
}
// Clear the label container.
this._labelContainer.empty();
// Create the placeholder element and set it
var ph = document.createElement("span");
this.getSurroundings().setWidgetPlaceholder(ph);
this._labelContainer
.append(document.createTextNode(_value))
.append(ph);
}
else {
// Delete the labelContainer from the surroundings object
if (this._labelContainer) {
this.getSurroundings().removeDOMNode(this._labelContainer[0]);
}
this._labelContainer = null;
}
};
/**
* Code for implementing et2_IDetachedDOM
* This doesn't need to be implemented.
* Individual widgets are detected and handled by the grid, but the interface is needed for this to happen
*
* @param {object} _attrs
*/
et2_radioGroup.prototype.getDetachedAttributes = function (_attrs) {
};
et2_radioGroup.prototype.getDetachedNodes = function () {
return [this.getDOMNode()];
};
et2_radioGroup.prototype.setDetachedAttributes = function (_nodes, _values) {
};
et2_radioGroup._attributes = {
"label": {
"name": "Label",
"default": "",
"type": "string",
"description": "The label is displayed above the list of radio buttons. The label can contain variables, as descript for name. If the label starts with a '@' it is replaced by the value of the content-array at this index (with the '@'-removed and after expanding the variables).",
"translate": true
},
"value": {
"name": "Value",
"type": "string",
"default": "true",
"description": "Value for each radio button"
},
"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"
},
"options": {
"name": "Radio options",
"type": "any",
"default": {},
"description": "Options for radio buttons. Should be {value: label, ...}"
},
"needed": {
"name": "Required",
"default": false,
"type": "boolean",
"description": "If required, the user must select one of the options before the form can be submitted"
}
};
return et2_radioGroup;
}(et2_core_valueWidget_1.et2_valueWidget));
// No such tag as 'radiogroup', but it needs something
et2_register_widget(et2_radioGroup, ["radiogroup"]);
et2_core_widget_1.et2_register_widget(et2_radioGroup, ["radiogroup"]);
//# sourceMappingURL=et2_widget_radiobox.js.map

467
api/js/etemplate/et2_widget_radiobox.ts Normal file
View File

@ -0,0 +1,467 @@
/**
* EGroupware eTemplate2 - JS Radiobox 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;
*/
import {et2_inputWidget} from "./et2_core_inputWidget";
import {ClassWithAttributes} from "./et2_core_inheritance";
import {WidgetConfig, et2_register_widget} from "./et2_core_widget";
import {et2_valueWidget} from './et2_core_valueWidget';
/**
* Class which implements the "radiobox" XET-Tag
*
* A radio button belongs to same group by giving all buttons of a group same id!
*
* set_value iterates over all of them and (un)checks them depending on given value.
*
* @augments et2_inputWidget
*/
class et2_radiobox extends et2_inputWidget
{
static readonly _attributes : any = {
"set_value": {
"name": "Set value",
"type": "string",
"default": "true",
"description": "Value when selected"
},
"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"
}
};
legacyOptions : string[] = ["set_value", "ro_true", "ro_false"];
input : JQuery = null;
id : string = "";
/**
* Constructor
*
* @memberOf et2_radiobox
*/
constructor(_parent, _attrs? : WidgetConfig, _child? : object) {
super(_parent, _attrs, ClassWithAttributes.extendAttributes(et2_radiobox._attributes, _child || {}));
this.createInputWidget();
}
transformAttributes(_attrs) {
super.transformAttributes(_attrs);
let readonly = this.getArrayMgr('readonlys').getEntry(this.id);
if(readonly && readonly.hasOwnProperty(_attrs.set_value))
{
_attrs.readonly = readonly[_attrs.set_value];
}
}
createInputWidget() {
this.input = jQuery(document.createElement("input"))
.val(this.options.set_value)
.attr("type", "radio")
.attr("disabled", this.options.readonly);
this.input.addClass("et2_radiobox");
this.setDOMNode(this.input[0]);
}
/**
* Overwritten to set different DOM level ids by appending set_value
*
* @param _id
*/
set_id(_id)
{
super.set_id(_id);
this.dom_id = this.dom_id.replace('[]', '')+'-'+this.options.set_value;
if (this.input) this.input.attr('id', this.dom_id);
}
/**
* Default for radio buttons is label after button
*
* @param _label String New label for radio button. Use %s to locate the radio button somewhere else in the label
*/
set_label(_label)
{
if(_label.length > 0 && _label.indexOf('%s')==-1)
{
_label = '%s'+_label;
}
super.set_label(_label);
}
/**
* Override default to match against set/unset value AND iterate over all siblings with same id
*
* @param {string} _value
*/
set_value(_value)
{
this.getRoot().iterateOver(function(radio)
{
if (radio.id == this.id)
{
radio.input.prop('checked', _value == radio.options.set_value);
}
}, this, et2_radiobox);
}
/**
* Override default to iterate over all siblings with same id
*
* @return {string}
*/
getValue()
{
let val = this.options.value; // initial value, when form is loaded
let values = [];
this.getRoot().iterateOver(function(radio)
{
values.push(radio.options.set_value);
if (radio.id == this.id && radio.input && radio.input.prop('checked'))
{
val = radio.options.set_value;
}
}, this, et2_radiobox);
return val && val.indexOf(values) ? val : null;
}
/**
* Overridden from parent so if it's required, only 1 in a group needs a value
*
* @param {array} messages
* @returns {Boolean}
*/
isValid(messages) {
let ok = true;
// Check for required
if (this.options && this.options.needed && !this.options.readonly && !this.disabled &&
(this.getValue() == null || this.getValue().valueOf() == ''))
{
if(jQuery.isEmptyObject(this.getInstanceManager().getValues(this.getInstanceManager().widgetContainer)[this.id.replace('[]', '')]))
{
messages.push(this.egw().lang('Field must not be empty !!!'));
ok = false;
}
}
return ok;
}
}
et2_register_widget(et2_radiobox, ["radio"]);
/**
* @augments et2_valueWidget
*/
class et2_radiobox_ro extends et2_valueWidget implements et2_IDetachedDOM
{
static readonly _attributes : any = {
"set_value": {
"name": "Set value",
"type": "string",
"default": "true",
"description": "Value when selected"
},
"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"
},
"label": {
"name": "Label",
"default": "",
"type": "string"
}
};
legacyOptions : string[] = ["set_value", "ro_true", "ro_false"];
value : string = "";
span : JQuery = null;
/**
* Constructor
*
* @memberOf et2_radiobox_ro
*/
constructor(_parent, _attrs? : WidgetConfig, _child? : object)
{
// Call the inherited constructor
super(_parent, _attrs, ClassWithAttributes.extendAttributes(et2_radiobox_ro._attributes, _child || {}));
this.span = jQuery(document.createElement("span"))
.addClass("et2_radiobox");
this.setDOMNode(this.span[0]);
}
/**
* Override default to match against set/unset value
*
* @param {string} _value
*/
set_value(_value) {
this.value = _value;
if(_value == this.options.set_value) {
this.span.text(this.options.ro_true);
} else {
this.span.text(this.options.ro_false);
}
}
set_label(_label) {
// no label for ro radio, we show label of checked option as content
}
/**
* Code for implementing et2_IDetachedDOM
*
* @param {array} _attrs
*/
getDetachedAttributes(_attrs)
{
// Show label in nextmatch instead of just x
this.options.ro_true = this.options.label;
_attrs.push("value");
}
getDetachedNodes()
{
return [this.span[0]];
}
setDetachedAttributes(_nodes, _values)
{
this.span = jQuery(_nodes[0]);
this.set_value(_values["value"]);
}
}
et2_register_widget(et2_radiobox_ro, ["radio_ro"]);
/**
* A group of radio buttons
*
* @augments et2_valueWidget
*/
class et2_radioGroup extends et2_valueWidget implements et2_IDetachedDOM
{
static readonly _attributes : any = {
"label": {
"name": "Label",
"default": "",
"type": "string",
"description": "The label is displayed above the list of radio buttons. The label can contain variables, as descript for name. If the label starts with a '@' it is replaced by the value of the content-array at this index (with the '@'-removed and after expanding the variables).",
"translate": true
},
"value": {
"name": "Value",
"type": "string",
"default": "true",
"description": "Value for each radio button"
},
"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"
},
"options": {
"name": "Radio options",
"type": "any",
"default": {},
"description": "Options for radio buttons. Should be {value: label, ...}"
},
"needed": {
"name": "Required",
"default": false,
"type": "boolean",
"description": "If required, the user must select one of the options before the form can be submitted"
}
};
createNamespace : boolean = false;
node : JQuery = null;
value : any = null;
/**
* Constructor
*
* @param parent
* @param attrs
* @memberOf et2_radioGroup
*/
constructor(_parent, _attrs? : WidgetConfig, _child? : object)
{
// Call the inherited constructor
super(_parent, _attrs, ClassWithAttributes.extendAttributes(et2_radioGroup._attributes, _child || {}));
this.node = jQuery(document.createElement("div"))
.addClass("et2_vbox")
.addClass("et2_box_widget");
if(this.options.needed)
{
// This isn't strictly allowed, but it works
this.node.attr("required","required");
}
this.setDOMNode(this.node[0]);
// The supported widget classes array defines a whitelist for all widget
// classes or interfaces child widgets have to support.
this.supportedWidgetClasses = [et2_radiobox,et2_radiobox_ro];
}
set_value(_value)
{
this.value = _value;
for (let i = 0; i < this._children.length; i++)
{
let radio = this._children[i];
radio.set_value(_value);
}
}
getValue()
{
return jQuery("input:checked", this.getDOMNode()).val();
}
/**
* Set a bunch of radio buttons
*
* @param {object} _options object with value: label pairs
*/
set_options(_options)
{
// Call the destructor of all children
for (let i = this._children.length - 1; i >= 0; i--)
{
this._children[i].free();
}
this._children = [];
// create radio buttons for each option
for(let key in _options)
{
let attrs = {
// Add index so radios work properly
"id": (this.options.readonly ? this.id : this.id + "[" + "]"),
set_value: key,
label: _options[key],
ro_true: this.options.ro_true,
ro_false: this.options.ro_false,
readonly: this.options.readonly
};
if(typeof _options[key] === 'object' && _options[key].label)
{
attrs.set_value = _options[key].value;
attrs.label = _options[key].label;
}
// Can't have a required readonly, it will warn & be removed later, so avoid the warning
if(attrs.readonly === false)
{
attrs['needed'] = this.options.needed;
}
et2_createWidget("radio", attrs, this);
}
this.set_value(this.value);
}
/**
* Set a label on the group of radio buttons
*
* @param {string} _value
*/
set_label(_value) {
// Abort if ther was no change in the label
if (_value == this.label)
{
return;
}
if (_value)
{
// Create the label container if it didn't exist yet
if (this._labelContainer == null)
{
this._labelContainer = jQuery(document.createElement("label"));
this.getSurroundings().insertDOMNode(this._labelContainer[0]);
}
// Clear the label container.
this._labelContainer.empty();
// Create the placeholder element and set it
var ph = document.createElement("span");
this.getSurroundings().setWidgetPlaceholder(ph);
this._labelContainer
.append(document.createTextNode(_value))
.append(ph);
}
else
{
// Delete the labelContainer from the surroundings object
if (this._labelContainer)
{
this.getSurroundings().removeDOMNode(this._labelContainer[0]);
}
this._labelContainer = null;
}
}
/**
* Code for implementing et2_IDetachedDOM
* This doesn't need to be implemented.
* Individual widgets are detected and handled by the grid, but the interface is needed for this to happen
*
* @param {object} _attrs
*/
getDetachedAttributes(_attrs)
{
}
getDetachedNodes()
{
return [this.getDOMNode()];
}
setDetachedAttributes(_nodes, _values)
{
}
}
// No such tag as 'radiogroup', but it needs something
et2_register_widget(et2_radioGroup, ["radiogroup"]);