mirror of
https://github.com/EGroupware/egroupware.git
synced 2024-12-30 18:49:08 +01:00
612 lines
16 KiB
JavaScript
612 lines
16 KiB
JavaScript
/**
|
|
* EGroupware eTemplate2 - JS Custom fields 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$
|
|
*/
|
|
|
|
"use strict";
|
|
|
|
/*egw:uses
|
|
lib/tooltip;
|
|
jquery.jquery;
|
|
et2_core_xml;
|
|
et2_core_DOMWidget;
|
|
et2_core_inputWidget;
|
|
*/
|
|
|
|
/**
|
|
* @augments et2_dataview
|
|
*/
|
|
var et2_customfields_list = et2_valueWidget.extend([et2_IDetachedDOM, et2_IInput],
|
|
{
|
|
attributes: {
|
|
'customfields': {
|
|
'name': 'Custom fields',
|
|
'description': 'Auto filled',
|
|
'type': 'any'
|
|
},
|
|
'fields': {
|
|
'name': 'Custom fields',
|
|
'description': 'Auto filled',
|
|
'type': 'any'
|
|
},
|
|
'value': {
|
|
'name': 'Custom fields',
|
|
'description': 'Auto filled',
|
|
'type': "any"
|
|
},
|
|
'type_filter': {
|
|
'name': 'Field filter',
|
|
"default": "",
|
|
"type": "any", // String or array
|
|
"description": "Filter displayed custom fields by their 'type2' attribute"
|
|
},
|
|
'private': {
|
|
ignore: true,
|
|
type: 'boolean'
|
|
}
|
|
},
|
|
|
|
legacyOptions: ["type_filter","private", "fields"], // Field restriction & private done server-side
|
|
|
|
prefix: '#',
|
|
|
|
DEFAULT_ID: "custom_fields",
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @memberOf et2_customfields_list
|
|
*/
|
|
init: function() {
|
|
// Some apps (infolog edit) don't give ID, so assign one to get settings
|
|
if(!arguments[1].id) arguments[1].id = this.DEFAULT_ID;
|
|
|
|
this._super.apply(this, arguments);
|
|
|
|
// Allows server side to override prefix - not an attribute though
|
|
if(typeof this.options.prefix != 'undefined') this.prefix = this.options.prefix;
|
|
|
|
// Create the table body and the table
|
|
this.tbody = $j(document.createElement("tbody"));
|
|
this.table = $j(document.createElement("table"))
|
|
.addClass("et2_grid et2_customfield_list");
|
|
this.table.append(this.tbody);
|
|
|
|
this.rows = {};
|
|
this.widgets = {};
|
|
this.detachedNodes = [];
|
|
if(!this.options.fields) this.options.fields = {};
|
|
|
|
if(this.options.type_filter && typeof this.options.type_filter == "string")
|
|
{
|
|
this.options.type_filter = this.options.type_filter.split(",");
|
|
}
|
|
if(this.options.type_filter)
|
|
{
|
|
var already_filtered = !jQuery.isEmptyObject(this.options.fields);
|
|
for(var field_name in this.options.customfields)
|
|
{
|
|
// Already excluded?
|
|
if(already_filtered && !this.options.fields[field_name]) continue;
|
|
|
|
if(!this.options.customfields[field_name].type2 || this.options.customfields[field_name].type2.length == 0 ||
|
|
this.options.customfields[field_name].type2 == '0')
|
|
{
|
|
// No restrictions
|
|
this.options.fields[field_name] = true;
|
|
continue;
|
|
}
|
|
var types = typeof this.options.customfields[field_name].type2 == 'string' ? this.options.customfields[field_name].type2.split(",") : this.options.customfields[field_name].type2;
|
|
this.options.fields[field_name] = false;
|
|
for(var i = 0; i < types.length; i++)
|
|
{
|
|
if(jQuery.inArray(types[i],this.options.type_filter) > -1)
|
|
{
|
|
this.options.fields[field_name] = true;
|
|
continue;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
this.setDOMNode(this.table[0]);
|
|
},
|
|
|
|
destroy: function() {
|
|
this._super.apply(this, arguments);
|
|
this.rows = {};
|
|
this.widgets = {};
|
|
this.detachedNodes = [];
|
|
this.tbody = null;
|
|
},
|
|
|
|
/**
|
|
* What does this do? I don't know, but when everything is done the second
|
|
* time, this makes it work. Otherwise, all custom fields are lost.
|
|
*/
|
|
assign: function(_obj) {
|
|
this.loadFields();
|
|
},
|
|
|
|
getDOMNode: function(_sender) {
|
|
|
|
// Check whether the _sender object exists inside the management array
|
|
if(this.rows && _sender.id && this.rows[_sender.id])
|
|
{
|
|
return this.rows[_sender.id];
|
|
}
|
|
|
|
return this._super.apply(this, arguments);
|
|
},
|
|
|
|
/**
|
|
* Initialize widgets for custom fields
|
|
*/
|
|
loadFields: function() {
|
|
if(!this.options || !this.options.customfields) return;
|
|
|
|
// Already set up - avoid duplicates in nextmatch
|
|
if(this._type == 'customfields-list' && !this.isInTree()) return;
|
|
if(!jQuery.isEmptyObject(this.widgets)) return;
|
|
|
|
// Check for global setting changes (visibility)
|
|
var global_data = this.getArrayMgr("modifications").getRoot().getEntry('~custom_fields~');
|
|
if(global_data && global_data.fields && !this.options.fields) this.options.fields = global_data.fields;
|
|
|
|
// For checking app entries
|
|
var apps = this.egw().link_app_list();
|
|
|
|
// Create the table rows
|
|
for(var field_name in this.options.customfields)
|
|
{
|
|
// Skip fields if we're filtering
|
|
if(this._type != 'customfields-list' && !jQuery.isEmptyObject(this.options.fields) && !this.options.fields[field_name]) continue;
|
|
|
|
var field = this.options.customfields[field_name];
|
|
|
|
var id = this.prefix+field_name;
|
|
|
|
// Need curlies around ID for nm row expansion
|
|
if(this.id == '$row')
|
|
{
|
|
id = "{" + this.id + "}" + "["+this.prefix + field_name+"]";
|
|
}
|
|
else if (this.id != this.DEFAULT_ID)
|
|
{
|
|
// Prefix this ID to avoid potential ID collisions
|
|
id = this.id + "["+id+"]";
|
|
}
|
|
|
|
// Avoid creating field twice
|
|
if(!this.rows[id])
|
|
{
|
|
|
|
var row = jQuery(document.createElement("tr"))
|
|
.appendTo(this.tbody)
|
|
.addClass(this.id+'_'+id);
|
|
var cf = jQuery(document.createElement("td"))
|
|
.appendTo(row);
|
|
if(!field.type) field.type = 'text";'
|
|
var setup_function = '_setup_'+(apps[field.type] ? 'link_entry' : field.type.replace("-","_"));
|
|
|
|
var attrs = {
|
|
'id': id,
|
|
'statustext': field.help,
|
|
'needed': field.needed,
|
|
'readonly': this.options.readonly ||
|
|
this.getArrayMgr("readonlys").isReadOnly(id),
|
|
'value': this.options.value[this.prefix+field_name]
|
|
};
|
|
// Can't have a required readonly, it will warn & be removed later, so avoid the warning
|
|
if(attrs.readonly === true) delete attrs.needed;
|
|
|
|
if(this[setup_function]) {
|
|
var no_skip = this[setup_function].call(this, field_name, field, attrs);
|
|
if(!no_skip) continue;
|
|
}
|
|
|
|
if(this._type == 'customfields-list') {
|
|
// No label, cust widget
|
|
attrs.readonly = true;
|
|
// Widget tooltips don't work in nextmatch because of the creation / binding separation
|
|
// Set title to field label so browser will show something
|
|
// Add field label & help as data attribute to row, so it can be stylied with CSS (title should be disabled)
|
|
row.attr('title', field.label);
|
|
row.attr('data-label', field.label);
|
|
row.attr('data-field', field_name);
|
|
row.attr('data-help', field.help);
|
|
this.detachedNodes.push(row[0]);
|
|
}
|
|
else
|
|
{
|
|
// Label in first column, widget in 2nd
|
|
cf.text(field.label + "");
|
|
cf = jQuery(document.createElement("td"))
|
|
.appendTo(row);
|
|
}
|
|
this.rows[id] = cf[0];
|
|
|
|
// Create widget
|
|
var widget = this.widgets[field_name] = et2_createWidget(attrs.type ? attrs.type : field.type, attrs, this);
|
|
}
|
|
|
|
// Field is not to be shown
|
|
if(!this.options.fields || jQuery.isEmptyObject(this.options.fields) || this.options.fields[field_name] == true)
|
|
{
|
|
jQuery(this.rows[field_name]).show();
|
|
}
|
|
else
|
|
{
|
|
jQuery(this.rows[field_name]).hide();
|
|
}
|
|
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Read needed info on available custom fields from various places it's stored.
|
|
*/
|
|
transformAttributes: function(_attrs) {
|
|
this._super.apply(this, arguments);
|
|
|
|
// Add in settings that are objects
|
|
|
|
// Customized settings for this widget (unlikely)
|
|
var data = this.getArrayMgr("modifications").getEntry(this.id);
|
|
// Check for global settings
|
|
var global_data = this.getArrayMgr("modifications").getRoot().getEntry('~custom_fields~', true);
|
|
if(global_data)
|
|
{
|
|
for(var key in data)
|
|
{
|
|
// Don't overwrite fields with global values
|
|
if(global_data[key] && key !== 'fields')
|
|
{
|
|
data[key] = jQuery.extend(true, {}, data[key], global_data[key]);
|
|
}
|
|
}
|
|
}
|
|
for(var key in data)
|
|
{
|
|
_attrs[key] = data[key];
|
|
}
|
|
for(var key in global_data)
|
|
{
|
|
if(typeof global_data[key] != 'undefined' && ! _attrs[key]) _attrs[key] = global_data[key];
|
|
}
|
|
|
|
if (this.id)
|
|
{
|
|
// Set the value for this element
|
|
var contentMgr = this.getArrayMgr("content");
|
|
if (contentMgr != null) {
|
|
var val = contentMgr.getEntry(this.id);
|
|
_attrs["value"] = {};
|
|
if (val !== null)
|
|
{
|
|
// Only set the values that match desired custom fields
|
|
for(var key in val)
|
|
{
|
|
if(key.indexOf(this.prefix) == 0) {
|
|
_attrs["value"][key] = val[key];
|
|
}
|
|
}
|
|
//_attrs["value"] = val;
|
|
}
|
|
else
|
|
{
|
|
// Check for custom fields directly in record
|
|
for(var key in _attrs.customfields)
|
|
{
|
|
_attrs["value"][this.prefix + key] = contentMgr.getEntry(this.prefix + key);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
|
|
loadFromXML: function(_node) {
|
|
this.loadFields();
|
|
|
|
// Load the nodes as usual
|
|
this._super.apply(this, arguments);
|
|
},
|
|
|
|
set_value: function(_value) {
|
|
if(!this.options.customfields) return;
|
|
for(var field_name in this.options.customfields)
|
|
{
|
|
// Skip fields if we're filtering
|
|
if(!jQuery.isEmptyObject(this.options.fields) && !this.options.fields[field_name]) continue;
|
|
|
|
// Make sure widget is created, and has the needed function
|
|
if(!this.widgets[field_name] || !this.widgets[field_name].set_value) continue;
|
|
var value = _value[this.prefix + field_name] ? _value[this.prefix + field_name] : null;
|
|
|
|
// Check if ID was missing
|
|
if(value == null && this.id == this.DEFAULT_ID && this.getArrayMgr("content").getEntry(this.prefix + field_name))
|
|
{
|
|
value = this.getArrayMgr("content").getEntry(this.prefix + field_name);
|
|
}
|
|
|
|
switch(this.options.customfields[field_name].type)
|
|
{
|
|
case 'date':
|
|
// Date custom fields are always in Y-m-d, which seldom matches user's preference
|
|
// which fails when sent to date widget. This is only used for nm rows, when possible
|
|
// this is fixed server side
|
|
if(value && isNaN(value))
|
|
{
|
|
value = jQuery.datepicker.parseDate("yy-mm-dd",value);
|
|
}
|
|
break;
|
|
}
|
|
this.widgets[field_name].set_value(value);
|
|
}
|
|
},
|
|
|
|
/**
|
|
* et2_IInput so the custom field can be it's own widget.
|
|
*/
|
|
getValue: function() {
|
|
// Not using an ID means we have to grab all the widget values, and put them where server knows to look
|
|
if(this.id != this.DEFAULT_ID)
|
|
{
|
|
return null;
|
|
}
|
|
var value = {};
|
|
for(var field_name in this.widgets)
|
|
{
|
|
if(this.widgets[field_name].getValue && !this.widgets[field_name].options.readonly)
|
|
{
|
|
value[this.prefix + field_name] = this.widgets[field_name].getValue();
|
|
}
|
|
}
|
|
return value;
|
|
},
|
|
|
|
isDirty: function() {
|
|
var dirty = true;
|
|
for(var field_name in this.widgets)
|
|
{
|
|
if(this.widgets[field_name].isDirty)
|
|
{
|
|
dirty = dirty && this.widgets[field_name].isDirty();
|
|
}
|
|
}
|
|
return dirty;
|
|
},
|
|
|
|
resetDirty: function() {
|
|
for(var field_name in this.widgets)
|
|
{
|
|
if(this.widgets[field_name].resetDirty)
|
|
{
|
|
this.widgets[field_name].resetDirty();
|
|
}
|
|
}
|
|
},
|
|
|
|
isValid: function() {
|
|
// Individual customfields will handle themselves
|
|
return true;
|
|
},
|
|
|
|
/**
|
|
* Adapt provided attributes to match options for widget
|
|
*
|
|
* rows > 1 --> textarea, with rows=rows and cols=len
|
|
* !rows --> input, with size=len
|
|
* rows = 1 --> input, with size=len, maxlength=len
|
|
*/
|
|
_setup_text: function(field_name, field, attrs) {
|
|
// No label on the widget itself
|
|
delete(attrs.label);
|
|
|
|
field.type = 'textbox';
|
|
attrs.rows = field.rows > 1 ? field.rows : null;
|
|
|
|
if(field.len)
|
|
{
|
|
attrs.size = field.len;
|
|
if (field.rows == 1) attrs.maxlength = field.len;
|
|
}
|
|
return true;
|
|
},
|
|
_setup_float: function(field_name, field, attrs) {
|
|
// No label on the widget itself
|
|
delete(attrs.label);
|
|
|
|
field.type = 'float';
|
|
|
|
if(field.len)
|
|
{
|
|
attrs.size = field.len;
|
|
}
|
|
return true;
|
|
},
|
|
_setup_select: function(field_name, field, attrs) {
|
|
// No label on the widget itself
|
|
delete(attrs.label);
|
|
|
|
attrs.rows = field.rows;
|
|
// select_options are now send from server-side incl. ones defined via a file in EGroupware root
|
|
attrs.tags = field.tags;
|
|
|
|
return true;
|
|
},
|
|
_setup_date: function(field_name, field, attrs) {
|
|
attrs.data_format = 'Y-m-d';
|
|
return true;
|
|
},
|
|
_setup_date_time: function(field_name, field, attrs) {
|
|
attrs.data_format = 'Y-m-d H:i:s';
|
|
return true;
|
|
},
|
|
_setup_htmlarea: function(field_name, field, attrs) {
|
|
attrs.config = field.config ? field.config : {};
|
|
attrs.config.toolbarStartupExpanded = false;
|
|
if(field.len)
|
|
{
|
|
attrs.config.width = field.len+'px';
|
|
}
|
|
attrs.config.height = (((field.rows > 0 && field.rows !='undefined') ? field.rows : 5) *16) +'px';
|
|
|
|
// We have to push the config modifications into the modifications array, or they'll
|
|
// be overwritten by the site config from the server
|
|
var data = this.getArrayMgr("modifications").getEntry(this.prefix+field_name);
|
|
if(data) jQuery.extend(data.config, attrs.config);
|
|
|
|
return true;
|
|
},
|
|
_setup_radio: function(field_name, field, attrs) {
|
|
// 'Empty' label will be first
|
|
delete(attrs.label);
|
|
|
|
if(field.values && field.values[''])
|
|
{
|
|
attrs.label = field.values[''];
|
|
delete field.values[''];
|
|
}
|
|
|
|
field.type = 'radiogroup';
|
|
attrs.options = field.values;
|
|
return true;
|
|
},
|
|
|
|
_setup_checkbox: function(field_name, field, attrs) {
|
|
// Read-only checkbox is just text
|
|
if(attrs.readonly)
|
|
{
|
|
attrs.ro_true = field.label;
|
|
}
|
|
return true;
|
|
},
|
|
|
|
/**
|
|
* People set button attributes as
|
|
* label: javascript
|
|
*/
|
|
_setup_button: function(field_name, field, attrs) {
|
|
// No label on the widget itself
|
|
delete(attrs.label);
|
|
|
|
attrs.label = field.label;
|
|
|
|
if (this._type == 'customfields-list')
|
|
{
|
|
// No buttons in a list, it causes problems with detached nodes
|
|
return false;
|
|
}
|
|
// Simple case, one widget for a custom field
|
|
if(!field.values || typeof field.values != 'object' || Object.keys(field.values).length == 1)
|
|
{
|
|
for(var key in field.values)
|
|
{
|
|
attrs.label = key;
|
|
attrs.onclick = field.values[key];
|
|
}
|
|
if (!attrs.label)
|
|
{
|
|
attrs.label = 'No "label=onclick" in values!';
|
|
attrs.onclick = function(){ return false; };
|
|
}
|
|
return !attrs.readonly;
|
|
}
|
|
else
|
|
{
|
|
// Complicated case, a single custom field you get multiple widgets
|
|
// Handle it all here, since this is the exception
|
|
var row = $j('tr',this.tbody).last();
|
|
var cf = $j('td',row);
|
|
// Label in first column, widget in 2nd
|
|
cf.text(field.label + "");
|
|
cf = jQuery(document.createElement("td"))
|
|
.appendTo(row);
|
|
|
|
for(var key in field.values)
|
|
{
|
|
var button_attrs = jQuery.extend({},attrs);
|
|
button_attrs.label = key;
|
|
button_attrs.onclick = field.values[key];
|
|
button_attrs.id = attrs.id + '_' + key;
|
|
|
|
// This controls where the button is placed in the DOM
|
|
this.rows[button_attrs.id] = cf[0];
|
|
|
|
// Do not store in the widgets list, one name for multiple widgets would cause problems
|
|
/*this.widgets[field_name] = */ et2_createWidget(attrs.type ? attrs.type : field.type, button_attrs, this);
|
|
}
|
|
return false;
|
|
}
|
|
},
|
|
_setup_link_entry: function(field_name, field, attrs) {
|
|
// No label on the widget itself
|
|
delete(attrs.label);
|
|
|
|
attrs.type = "link-entry";
|
|
attrs.only_app = field.type;
|
|
return true;
|
|
},
|
|
|
|
/**
|
|
* Set which fields are visible, by name
|
|
*
|
|
* Note: no # prefix on the name
|
|
*
|
|
*/
|
|
set_visible: function(_fields) {
|
|
for(var name in _fields)
|
|
{
|
|
if(this.rows[this.prefix + name])
|
|
{
|
|
if(_fields[name])
|
|
{
|
|
jQuery(this.rows[this.prefix+name]).show();
|
|
}
|
|
else
|
|
{
|
|
jQuery(this.rows[this.prefix+name]).hide();
|
|
}
|
|
}
|
|
this.options.fields[name] = _fields[name];
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Code for implementing et2_IDetachedDOM
|
|
*/
|
|
getDetachedAttributes: function(_attrs)
|
|
{
|
|
_attrs.push("value", "class");
|
|
},
|
|
|
|
getDetachedNodes: function()
|
|
{
|
|
return this.detachedNodes ? this.detachedNodes : [];
|
|
},
|
|
|
|
setDetachedAttributes: function(_nodes, _values)
|
|
{
|
|
// Individual widgets are detected and handled by the grid, but the interface is needed for this to happen
|
|
|
|
// Show the row if there's a value, hide it if there is no value
|
|
for(var i = 0; i < _nodes.length; i++)
|
|
{
|
|
// toggle() needs a boolean to do what we want
|
|
var key = _nodes[i].getAttribute('data-field');
|
|
$j(_nodes[i]).toggle(_values.fields[key] && _values.value[this.prefix + key]?true:false);
|
|
}
|
|
}
|
|
});
|
|
|
|
et2_register_widget(et2_customfields_list, ["customfields", "customfields-list"]);
|
|
|