/** * EGroupware eTemplate2 - JS Selectbox 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 * @author Andreas Stöckel * @copyright Nathan Gray 2011 * @version $Id$ */ "use strict"; /*egw:uses jquery.jquery; /phpgwapi/js/jquery/chosen/chosen.jquery.js; et2_core_xml; et2_core_DOMWidget; et2_core_inputWidget; */ /** * @augments et2_inputWidget */ var et2_selectbox = et2_inputWidget.extend( { attributes: { "multiple": { "name": "multiple", "type": "boolean", "default": false, "description": "Allow selecting multiple options" }, "rows": { "name": "Rows", "type": "any", // Old options put either rows or empty_label in first space "default": 1, "description": "Number of rows to display" }, "empty_label": { "name": "Empty label", "type": "string", "default": "", "description": "Textual label for first row, eg: 'All' or 'None'. ID will be ''" }, "select_options": { "type": "any", "name": "Select options", "default": {}, "description": "Internaly used to hold the select options." }, "selected_first": { "name": "Selected options first", "type": "boolean", "default": true, "description": "For multi-selects, put the selected options at the top of the list when first loaded" }, // Chosen options "search": { "name": "Search", "type": "boolean", "default": false, "description": "For single selects, add a search box to the drop-down list" }, "tags": { "name": "Tag style", "type": "boolean", "default": false, "description": "For multi-selects, displays selected as a list of tags instead of a big list" }, // Value can be string or integer "value": { "type": "any" }, // Type specific legacy options. Avoid using. "other": { "ignore": true, "type": "any" } }, legacyOptions: ["rows","other"], // Other is sub-type specific /** * Construtor * * @memberOf et2_selectbox */ init: function() { this._super.apply(this, arguments); this.input = null; this.value = ''; // Allow no other widgets inside this one this.supportedWidgetClasses = []; // Legacy options could have row count or empty label in first slot if(typeof this.options.rows == "string") { if(isNaN(this.options.rows)) { this.options.empty_label = this.options.rows; this.options.rows = 1; } else { this.options.rows = parseInt(this.options.rows); } } if(this.options.rows > 1) { this.options.multiple = true; if(this.options.tags) { this.createInputWidget(); } else { this.createMultiSelect(); } } else { this.createInputWidget(); } }, destroy: function() { if(this.input != null) { this.input.unchosen(); } this._super.apply(this, arguments); this.input = null; }, transformAttributes: function(_attrs) { this._super.apply(this, arguments); // If select_options are already known, skip the rest if(this.options && this.options.select_options && !jQuery.isEmptyObject(this.options.select_options) || _attrs.select_options && !jQuery.isEmptyObject(_attrs.select_options) ) { return; } var name_parts = this.id.replace(/[/g,'[').replace(/]|]/g,'').split('['); // Try to find the options inside the "sel-options" array if(this.getArrayMgr("sel_options")) { var content_options = {}; // Try first according to ID content_options = this.getArrayMgr("sel_options").getEntry(this.id); // ID can get set to an array with 0 => ' ' - not useful if(content_options && content_options.length == 1 && typeof content_options[0] == 'string' && content_options[0].trim() == '') { content_options = null; } // We could wind up too far inside options if label,title are defined if(content_options && !isNaN(name_parts[name_parts.length -1]) && content_options.label && content_options.title) { name_parts.pop(); content_options = this.getArrayMgr("sel_options").getEntry(name_parts.join('[')); delete content_options["$row"]; } // Select options tend to be defined once, at the top level, so try that if(!content_options || content_options.length == 0) { content_options = this.getArrayMgr("sel_options").getRoot().getEntry(name_parts[name_parts.length-1]); } // Try in correct namespace (inside a grid or something) if(!content_options || content_options.length == 0) { content_options = this.getArrayMgr("sel_options").getEntry(name_parts[name_parts.length-1]); } // Try name like widget[$row] if(!content_options || content_options.length == 0) { var pop_that = jQuery.extend([],name_parts); while(pop_that.length > 0 && (!content_options || content_options.length == 0)) { pop_that.pop(); content_options = this.getArrayMgr('sel_options').getEntry(pop_that.join('[')); } } // Maybe in a row, and options got stuck in ${row} instead of top level var row_stuck = ['${row}','{$row}']; for(var i = 0; i < row_stuck.length; i++) { if((!content_options || content_options.length == 0) && ( // perspectiveData.row in nm, data["${row}"] in an auto-repeat grid this.getArrayMgr("sel_options").perspectiveData.row || this.getArrayMgr("sel_options").data[row_stuck[i]])) { var row_id = this.id.replace(/[0-9]+/,row_stuck[i]); content_options = this.getArrayMgr("sel_options").getEntry(row_id); if(!content_options || content_options.length == 0) { content_options = this.getArrayMgr("sel_options").getEntry(row_stuck[i] + '[' + this.id + ']'); } } } if(_attrs["select_options"] && content_options) { _attrs["select_options"] = jQuery.extend({},_attrs["select_options"],content_options); } else if (content_options) { _attrs["select_options"] = content_options; } } // Check whether the options entry was found, if not read it from the // content array. if (jQuery.isEmptyObject(_attrs["select_options"])) { // If that didn't work, check according to ID _attrs["select_options"] = content_options ? content_options : this.getArrayMgr('content') .getEntry("options-" + this.id); // Again, try last name part at top level - this is usually just the value var content_options = this.getArrayMgr('content').getRoot().getEntry(name_parts[name_parts.length-1]); } // Default to an empty object if (_attrs["select_options"] == null) { _attrs["select_options"] = {}; } }, /** * Switch instanciated widget to multi-selection and back, optionally enabeling tags too * * If you want to switch tags on too, you need to do so after switching to multiple! * * @param {boolean} _multiple * @param {integer} _size default=3 */ set_multiple: function(_multiple, _size) { this.options.multiple = _multiple; if (this.input) { if (_multiple) { this.input.attr('size', _size || 3); this.input.attr('multiple', true); this.input.attr('name', this.id + '[]'); if (this.input[0].options.length && this.input[0].options[0].value === '') { this.input[0].options[0] = null; } } else { this.input.attr('multiple', false); this.input.removeAttr('size'); this.input.attr('name', this.id); if (this.options.empty_label && this.input[0].options[0].value !== '') { this._appendOptionElement('', this.options.empty_label); } } } }, /** * Add an option to regular drop-down select */ _appendOptionElement: function(_value, _label, _title, dom_element) { if(_value == "" && (_label == null || _label == "")) { return; // empty_label is added in set_select_options anyway, ignoring it here to not add it twice } if(this.input == null) { return this._appendMultiOption(_value, _label, _title, dom_element); } var option = $j(document.createElement("option")) .attr("value", _value) .text(_label+""); if (typeof _title != "undefined" && _title) { option.attr("title", _title); } if(_label == this.options.empty_label || this.options.empty_label == "" && _value === "") { // Make sure empty / all option is first option.prependTo(this.input); } else { option.appendTo(dom_element || this.input); } }, /** * Append a value to multi-select */ _appendMultiOption: function(_value, _label, _title, dom_element) { var option_data = null; if(typeof _label == "object") { option_data = _label; _label = option_data.label; } // Already in header if(_label == this.options.empty_label) return; var opt_id = this.dom_id + "_opt_" + _value; var label = jQuery(document.createElement("label")) .attr("for", opt_id) .hover( function() {jQuery(this).addClass("ui-state-hover");}, function() {jQuery(this).removeClass("ui-state-hover");} ); var option = jQuery(document.createElement("input")) .attr("type", "checkbox") .attr("id",opt_id) .attr("value", _value) .appendTo(label); if(typeof _title !== "undefined") { option.attr("title",_title); } // Some special stuff for categories if(option_data ) { if(option_data.icon) { var img = this.egw().image(option_data.icon); jQuery(document.createElement("img")) .attr("src", img) .appendTo(label); } if(option_data.color) { label.css("background-color",option_data.color); } } label.append(jQuery(""+_label+"")); var li = jQuery(document.createElement("li")).append(label); li.appendTo(dom_element || this.multiOptions); }, /** * Create a regular drop-down select box */ createInputWidget: function() { // Create the base input widget this.input = $j(document.createElement("select")) .addClass("et2_selectbox") .attr("size", this.options.rows); this.setDOMNode(this.input[0]); // Add the empty label if(this.options.empty_label) { this._appendOptionElement("", this.options.empty_label); } // Set multiple if(this.options.multiple) { this.input.attr("multiple", "multiple"); } }, /** * Create a list of checkboxes */ createMultiSelect: function() { var node = jQuery(document.createElement("div")) .addClass("et2_selectbox"); var header = jQuery(document.createElement("div")) .addClass("ui-widget-header ui-helper-clearfix") .appendTo(node); var controls = jQuery(document.createElement("ul")) .addClass('ui-helper-reset') .appendTo(header); if(this.options.empty_label) { jQuery(document.createElement("span")) .text(this.options.empty_label) .addClass("ui-multiselect-header") .appendTo(header); } // Set up for options to be added later var options = this.multiOptions = jQuery(document.createElement("ul")); this.multiOptions.addClass("ui-multiselect-checkboxes ui-helper-reset") .css("height", 1.9*this.options.rows + "em") .appendTo(node); if(this.options.rows >= 5) { // Check / uncheck all var header_controls = { check: { icon_class: 'ui-icon-check', label: 'Check all', click: function(e) { var all_set = jQuery("input[type='checkbox']",e.data).prop("checked"); jQuery("input[type='checkbox']",e.data).prop("checked", !all_set); } }, }; for(var key in header_controls) { jQuery(document.createElement("li")) .addClass("et2_clickable") .click(options, header_controls[key].click) .attr("title", header_controls[key].label) .append('') .appendTo(controls); } } this.setDOMNode(node[0]); }, doLoadingFinished: function() { this._super.apply(this, arguments); this.set_tags(this.options.tags); return true; }, loadFromXML: function(_node) { // Handle special case where legacy option for empty label is used (conflicts with rows), and rows is set as an attribute var legacy; if(legacy = _node.getAttribute("options")) { var legacy = legacy.split(","); if(legacy.length && isNaN(legacy[0])) { this.options.empty_label = legacy[0]; } } // Read the option-tags var options = et2_directChildrenByTagName(_node, "options"); for (var i = 0; i < options.length; i++) { this.options.select_options[et2_readAttrWithDefault(options[i], "value", options[i].textContent)] = { "label": options[i].textContent, "title": et2_readAttrWithDefault(options[i], "title", "") }; } this.set_select_options(this.options.select_options); }, set_value: function(_value) { if(typeof _value == "string" && this.options.multiple && _value.match(/[,0-9A-Za-z]+$/) !== null) { _value = _value.split(','); } if(this.input !== null && this.options.select_options && this.input.children().length == 0) { // No options set yet this.set_select_options(this.options.select_options); } if(this.input !== null && (this.options.tags || this.options.search)) { this.input.val(_value); this.input.trigger("liszt:updated"); this.value = this.input.val(); return; } if(this.input == null) { return this.set_multi_value(_value); } if(typeof _value != 'string' && jQuery(this.value).not(_value).length == 0 && jQuery(_value).not(this.value).length == 0) { // Unchanged if(_value == this.value) return; } jQuery("option",this.input).prop("selected", false); if(typeof _value == "array") { for(var i = 0; i < _value.length; i++) { jQuery("option[value='"+_value[i]+"']", this.input).prop("selected", true); } } else if (typeof _value == "object") { for(var i in _value) { jQuery("option[value='"+_value[i]+"']", this.input).prop("selected", true); } } else { if(_value && jQuery("option[value='"+_value+"']", this.input).prop("selected", true).length == 0) { if(this.options.select_options[_value]) { // Options not set yet? Do that now, which will try again. return this.set_select_options(this.options.select_options); } else if (jQuery.isEmptyObject(this.options.select_options)) { this.egw().debug("warn", "Can't set value to '%s', widget has no options set",_value, this); } else { this.egw().debug("warn", "Tried to set value '%s' that isn't an option", _value, this); } return; } } this.value = _value; }, set_multi_value: function(_value) { jQuery("input",this.multiOptions).prop("checked", false); if(typeof _value == "array") { for(var i = 0; i < _value.length; i++) { jQuery("input[value='"+_value[i]+"']", this.multiOptions).prop("checked", true); } } else if (typeof _value == "object") { for(var i in _value) { jQuery("input[value='"+_value[i]+"']", this.multiOptions).prop("checked", true); } } else { if(jQuery("input[value='"+_value+"']", this.multiOptions).prop("checked", true).length == 0) { this.egw().debug("warning", "Tried to set value that isn't an option", this, _value); } } // Sort selected to the top if(this.selected_first) { this.multiOptions.find("li:has(input:checked)").prependTo(this.multiOptions); } this.value = _value; }, /** * Turn tag style on and off * * If you want to switch multiple on too, you need to do so before switching tags on! * * @param {boolean} _tags * @param {string} _width width to use, default width of selectbox */ set_tags: function(_tags, _width) { this.options.tags = _tags; // Can't actually do chosen until attached, loadingFinished should call again if(!this.isAttached()) return; if(this.input != null && !this.options.tags && !this.options.search) { this.input.unchosen().css('width', ''); return; } // Turn on tags, if desired if(this.input != null && (this.options.search || this.options.tags) && !this.options.disabled) { if(this.options.empty_label) { this.input.attr("data-placeholder", this.egw().lang(this.options.empty_label)); // Remove from list of options, if multiple if (this.options.multiple) { this.input.children('[value=""]').remove(); } } // Properly size chosen, even if on a hidden tab var size = egw.getHiddenDimensions(this.input); this.input.chosen({ inherit_select_classes: true, search_contains: true, width: _width || size.w + "px" }) .change(this.onchange); } }, /** * The set_select_options function is added, as the select options have to be * added after the "option"-widgets were added to selectbox. */ set_select_options: function(_options) { // Empty current options if(this.input) { this.input.empty(); } else if (this.multiOptions) { this.multiOptions.empty(); } // Re-add empty, it's usually not there (empty_label get's allways translated, independent of no_lang!) if(this.options.empty_label) { this._appendOptionElement('', this.egw().lang(this.options.empty_label)); } // Add the select_options for (var key in _options) { // Translate the options if(!this.options.no_lang) { if (typeof _options[key] === 'object') { if(_options[key]["label"]) _options[key]["label"] = this.egw().lang(_options[key]["label"]); if(_options[key]["title"]) _options[key]["title"] = this.egw().lang(_options[key]["title"]); } else { _options[key] = this.egw().lang(_options[key]); } } if (typeof _options[key] === 'object' && _options[key] != null) { // Optgroup if(typeof _options[key]["label"] == 'undefined' && typeof _options[key]["title"] == "undefined") { var group = $j(document.createElement("optgroup")) .attr("label", this.options.no_lang ? key : this.egw().lang(key)) .appendTo(this.input); if(this.input == null) { group = jQuery(document.createElement("ul")) .append('
  • '+key+'
  • ') .appendTo(this.multiOptions); } for(var sub in _options[key]) { if (typeof _options[key][sub] === 'object') { this._appendOptionElement(sub, _options[key][sub]["label"] ? _options[key][sub]["label"] : "", _options[key][sub]["title"] ? _options[key][sub]["title"] : "", group ); } else { this._appendOptionElement(key, _options[key][sub],undefined,group); } } } else if(this.input == null) { // Allow some special extras for objects by passing the whole thing _options[key]["label"] = _options[key]["label"] ? _options[key]["label"] : ""; this._appendMultiOption(typeof _options[key].value != 'undefined' ? _options[key].value : key, _options[key], _options[key]["title"]); } else { this._appendOptionElement(typeof _options[key].value != 'undefined' ? _options[key].value : key, _options[key]["label"] ? _options[key]["label"] : "", _options[key]["title"] ? _options[key]["title"] : ""); } } else { this._appendOptionElement(key, _options[key]); } } // Sometimes value gets set before options if(this.value || this.options.empty_label) this.set_value(this.value); }, getValue: function() { if(this.input == null) { var value = []; jQuery("input:checked",this.multiOptions).each(function(){value.push(this.value);}); this.value = value; } else { this.value = this._super.apply(this, arguments); } return this.value; }, isDirty: function() { if(this.input == null) { var value = this.getValue(); // Array comparison return !($j(this._oldValue).not(value).length == 0 && $j(value).not(this._oldValue).length == 0); } else { return this._super.apply(this, arguments); } } }); et2_register_widget(et2_selectbox, ["menupopup", "listbox", "select", "select-cat", "select-percent", 'select-priority', 'select-access', 'select-country', 'select-state', 'select-year', 'select-month', 'select-day', 'select-dow', 'select-hour', 'select-number', 'select-app', 'select-lang', 'select-bool', 'select-timezone' ]); /** * et2_selectbox_ro is the readonly implementation of the selectbox. * * @augments et2_selectbox */ var et2_selectbox_ro = et2_selectbox.extend([et2_IDetachedDOM], { /** * Constructor * * @memberOf et2_selectbox_ro */ init: function() { this._super.apply(this, arguments); this.supportedWidgetClasses = []; this.optionValues = {}; if(this.options.select_options) this.set_select_options(this.options.select_options); }, createInputWidget: function() { this.span = $j(document.createElement("span")) .addClass("et2_selectbox readonly") .text(this.options.empty_label); this.setDOMNode(this.span[0]); }, // Handle read-only multiselects in the same way createMultiSelect: function() { this.span = $j(document.createElement("ul")) .addClass("et2_selectbox readonly"); this.setDOMNode(this.span[0]); }, loadFromXML: function(_node) { // Read the option-tags var options = et2_directChildrenByTagName(_node, "options"); for (var i = 0; i < options.length; i++) { this.optionValues[et2_readAttrWithDefault(options[i], "value", 0)] = { "label": options[i].textContent, "title": et2_readAttrWithDefault(options[i], "title", "") }; } }, set_select_options: function(_options) { for (var key in _options) { // Translate the options if(!this.options.no_lang) { if (typeof _options[key] === 'object' && _options[key] != null) { if(_options[key]["label"]) _options[key]["label"] = this.egw().lang(_options[key]["label"]); if(_options[key]["title"]) _options[key]["title"] = this.egw().lang(_options[key]["title"]); } else { _options[key] = this.egw().lang(_options[key]); } } // Allow some special extras for objects by passing the whole thing - value might not be key var option_id = _options[key] == null ? key : _options[key].value || _options[key].id || key; if(option_id != key) { egw.debug('log', 'Options not indexed. TODO: what is up?', this); } this.optionValues[option_id] = _options[key]; } }, set_value: function(_value) { if(typeof _value == "string" && _value.match(/[,0-9A-Za-z]+$/) !== null) { _value = _value.split(','); } this.value = _value; if(typeof _value == "object") { this.span.empty(); if(_value) { for(var i = 0; i < _value.length; i++) { var option = this.optionValues[_value[i]]; if(typeof option === "object" && option != null) { option = option.label; } else if (typeof option == 'undefined') { // Not a valid option continue; } $j("
  • "+option+"
  • ") .attr('data-value', _value[i]) .appendTo(this.span); } } return; } var option = this.optionValues[_value]; if (typeof option === 'object' && option != null) { this.span.text(option.label); this.set_statustext(option.title); } else if (typeof option === 'string') { this.span.text(option); } else { this.span.text(""); } }, /** * Override parent to return null - no value, not node value */ getValue: function() { return null; }, /** * Functions for et2_IDetachedDOM */ /** * Creates a list of attributes which can be set when working in the * "detached" mode. The result is stored in the _attrs array which is provided * by the calling code. */ getDetachedAttributes: function(_attrs) { _attrs.push("value"); }, /** * Returns an array of DOM nodes. The (relatively) same DOM-Nodes have to be * passed to the "setDetachedAttributes" function in the same order. */ getDetachedNodes: function() { return [this.span[0]]; }, /** * Sets the given associative attribute->value array and applies the * attributes to the given DOM-Node. * * @param _nodes is an array of nodes which have to be in the same order as * the nodes returned by "getDetachedNodes" * @param _values is an associative array which contains a subset of attributes * returned by the "getDetachedAttributes" function and sets them to the * given values. */ setDetachedAttributes: function(_nodes, _values) { this.span = jQuery(_nodes[0]); this.set_value(_values["value"]); } }); et2_register_widget(et2_selectbox_ro, ["menupopup_ro", "listbox_ro", "select_ro", "select-cat_ro", "select-percent_ro", 'select-priority_ro', 'select-access_ro', 'select-country_ro', 'select-state_ro', 'select-year_ro', 'select-month_ro', 'select-day_ro', 'select-dow_ro', 'select-hour_ro', 'select-number_ro', 'select-app_ro', 'select-lang_ro', 'select-bool_ro', 'select-timezone_ro' ]); /** * Widget class which represents a single option inside a selectbox */ /*var et2_option = et2_baseWidget.extend({ attributes: { "value": { "name": "Value", "type": "string", "description": "Value which is sent back to the server when this entry is selected." }, "label": { "name": "Label", "type": "string", "description": "Caption of the option element" }, "width": { "ignore": true }, "height": { "ignore": true }, "align": { "ignore": true } }, init: function() { this._super.apply(this, arguments); // Only allow other options inside of this element this.supportedWidgetClasses = [et2_option]; this.option = $j(document.createElement("option")) .attr("value", this.options.value) .attr("selected", this._parent.options.value == this.options.value ? "selected" : ""); if (this.options.label) { this.option.text(this.options.label); } this.setDOMNode(this.option[0]); }, destroy: function() { this._super.apply(this, arguments); this.option = null; }, loadContent: function(_data) { this.option.text(_data); } /* Doesn't work either with selectboxes set_statustext: function(_value) { this.statustext = _value; this.option.attr("title", _value); }*/ //});*/ //et2_register_widget(et2_option, ["option"]); /** * Class which just implements the menulist container * * @augments et2_DOMWidget */ var et2_menulist = et2_DOMWidget.extend( { /** * Construtor * * @memberOf et2_menulist */ init: function() { this._super.apply(this, arguments); this.supportedWidgetClasses = [et2_selectbox, et2_selectbox_ro]; }, // Just pass the parent DOM node through getDOMNode: function(_sender) { if (_sender != this) { return this._parent.getDOMNode(this); } return null; }, // Also need to pass through parent's children getChildren: function() { return this._parent.getChildren(); } }); et2_register_widget(et2_menulist, ["menulist"]);