X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=src%2Fmkws-widget.js;h=4cace293c2025351d227161f2968715517153d08;hp=faee22d54a30a314d854295052dbac871578d640;hb=058ce4a204a9ce4d63b2d319037f60cd9f94ff1b;hpb=87b2c72772dfc8cfcb820e52f40e0694e4bb2dd3 diff --git a/src/mkws-widget.js b/src/mkws-widget.js index faee22d..4cace29 100644 --- a/src/mkws-widget.js +++ b/src/mkws-widget.js @@ -1,129 +1,188 @@ // Factory function for widget objects. -function widget($, team, type, node) { - // Static register of attributes that do not contribute to config - var ignoreAttrs = { - id:1, 'class':1, style:1, name:1, action:1, type:1, size:1, - value:1, width:1, valign:1 - }; - - var that = { - team: team, - type: type, - node: node, - config: mkws.objectInheritingFrom(team.config()) - }; - - function log(s) { - team.log(s); +mkws.makeWidget = function($, team, type, node) { + // Static register of attributes that do not contribute to config + var ignoreAttrs = { + id:1, 'class':1, style:1, name:1, action:1, type:1, size:1, + value:1, width:1, valign:1 + }; + + var that = { + team: team, + type: type, + node: $(node), + config: mkws.objectInheritingFrom(team.config) + }; + + that.trace = team.trace; + that.debug = team.debug; + that.info = team.info; + that.warn = team.warn; + that.error = team.error; + that.fatal = team.fatal; + + that.toString = function() { + return '[Widget ' + team.name() + ':' + type + ']'; + }; + + that.value = function() { + return node.value; + }; + + // Returns the HTML of a subwidget of the specified type. It gets + // the same attributes at the parent widget that invokes this + // function, except where overrides are passed in. If defaults are + // also provided, then these are used when the parent widget + // provides no values. + that.subwidget = function(type, overrides, defaults) { + var attrs = { _team: team.name() }; + + // Copy locally-set properties from the parent widget + for (var name in this.config) { + if (this.config.hasOwnProperty(name)) { + attrs[name] = this.config[name]; + this.info(this + " copied property " + name + "='" + attrs[name] + "' to " + type + " subwidget"); + } } - that.log = log; - - that.toString = function() { - return '[Widget ' + team.name() + ':' + type + ']'; - }; - - that.value = function() { - return node.value; + + for (var name in overrides) { + this.info(this + " overrode property " + name + "='" + overrides[name] + "' (was '" + attrs[name] + "') for " + type + " subwidget"); + attrs[name] = overrides[name]; } - for (var i = 0; i < node.attributes.length; i++) { - var a = node.attributes[i]; - if (a.name === 'data-mkws-config') { - // Treat as a JSON fragment configuring just this widget - log(node + ": parsing config fragment '" + a.value + "'"); - var data; - try { - data = $.parseJSON(a.value); - for (var key in data) { - log(node + ": adding config element " + key + "='" + data[key] + "'"); - that.config[key] = data[key]; - } - } catch (err) { - alert("Can't parse " + node + " data-mkws-config as JSON: " + a.value); - } - } else if (a.name.match (/^data-mkws-/)) { - var name = a.name.replace(/^data-mkws-/, '') - that.config[name] = a.value; - log(node + ": set data-mkws attribute " + name + "='" + a.value + "'"); - } else if (!ignoreAttrs[a.name]) { - that.config[a.name] = a.value; - log(node + ": set regular attribute " + a.name + "='" + a.value + "'"); - } + if (defaults) { + for (var name in defaults) { + if (!attrs[name]) { + attrs[name] = defaults[name]; + this.info(this + " fell back to default property " + name + "='" + attrs[name] + "' for " + type + " subwidget"); + } + } } - var fn = mkws.promotionFunction(type); - if (fn) { - fn.call(that); - log("made " + type + " widget(node=" + node + ")"); - } else { - log("made UNPROMOTED widget(type=" + type + ", node=" + node + ")"); + var s = []; + s.push('
'); + return s.join(''); + }; + + function expandValue(val) { + if (val.match(/^!param!/)) { + var param = val.replace(/^!param!/, ''); + var optional = param.match(/^\?/); + if (optional) { + param = param.replace(/^\?/, ''); + } + val = mkws.getParameterByName(param); + that.info("obtained val '" + val + "' from param '" + param + "'"); + if (!val && !optional) { + alert("This page has a MasterKey widget that needs a val specified by the '" + param + "' parameter"); + } + } else if (val.match(/^!path!/)) { + var index = val.replace(/^!path!/, ''); + var path = window.location.pathname.split('/'); + val = path[path.length - index]; + that.info("obtained val '" + val + "' from path-component '" + index + "'"); + if (!val) { + alert("This page has a MasterKey widget that needs a val specified by the path-component " + index); + } + } else if (val.match(/^!var!/)) { + var name = val.replace(/^!var!/, ''); + val = window[name]; // It's ridiculous that this works + that.info("obtained val '" + val + "' from variable '" + name + "'"); + if (!val) { + alert("This page has a MasterKey widget that needs a val specified by the '" + name + "' variable"); + } + } + return val; + }; + + // Utility function for use by all widgets that can invoke autosearch. + that.autosearch = function() { + var that = this; + var query = this.config.autosearch; + if (query) { + // Should do this more elegantly with message passing + var widget = this.team.widget('query'); + if (widget) { widget.node.val(query); } + + this.team.queue("ready").subscribe(function() { + // Postpone testing for the configuration items: these are not + // yet set for Record subclass widgets that fill them in in the + // subclass, as widget.autosearch is called in the superclass, + // before the subclass fiddles with the configuration. + var sortOrder = that.config.sort; + var maxrecs = that.config.maxrecs; + var perpage = that.config.perpage; + var limit = that.config.limit; + var targets = that.config.targets; + var targetfilter = that.config.targetfilter; + var target = that.config.target; + if (target) targetfilter = 'udb=="' + target + '"'; + + var s = "running auto search: '" + query + "'"; + if (sortOrder) s += " sorted by '" + sortOrder + "'"; + if (maxrecs) s += " restricted to " + maxrecs + " records"; + if (perpage) s += " with " + perpage + " per page"; + if (limit) s += " limited by '" + limit + "'"; + if (targets) s += " in targets '" + targets + "'"; + if (targetfilter) s += " constrained by targetfilter '" + targetfilter + "'"; + that.info(s); + + that.team.newSearch(query, sortOrder, maxrecs, perpage, limit, targets, targetfilter); + }); + } + }; - return that; -} - - -// Utility function for use by all widgets that can invoke autosearch. -widget.autosearch = function(widget) { - widget.team.queue("ready").subscribe(function() { - var query = widget.config.autosearch; - if (query) { - if (query.match(/^!param!/)) { - var param = query.replace(/^!param!/, ''); - query = mkws.getParameterByName(param); - widget.log("obtained query '" + query + "' from param '" + param + "'"); - if (!query) { - alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter"); - } - } else if (query.match(/^!path!/)) { - var index = query.replace(/^!path!/, ''); - var path = window.location.pathname.split('/'); - query = path[path.length - index]; - widget.log("obtained query '" + query + "' from path-component '" + index + "'"); - if (!query) { - alert("This page has a MasterKey widget that needs a query specified by the path-component " + index); - } - } else if (query.match(/^!var!/)) { - var name = query.replace(/^!var!/, ''); - query = window[name]; // It's ridiculous that this works - widget.log("obtained query '" + query + "' from variable '" + name + "'"); - if (!query) { - alert("This page has a MasterKey widget that needs a query specified by the '" + name + "' variable"); - } - } - - var sortOrder = widget.config.sort; - var maxrecs = widget.config.maxrecs; - var perpage = widget.config.perpage; - var limit = widget.config.limit; - var targets = widget.config.targets; - var targetfilter = widget.config.targetfilter; - var target = widget.config.target; - if (target) targetfilter = 'udb=="' + target + '"'; - - var s = "running auto search: '" + query + "'"; - if (sortOrder) s += " sorted by '" + sortOrder + "'"; - if (maxrecs) s += " restricted to " + maxrecs + " records"; - if (perpage) s += " with " + perpage + " per page"; - if (limit) s += " limited by '" + limit + "'"; - if (targets) s += " in targets '" + targets + "'"; - if (targetfilter) s += " constrained by targetfilter '" + targetfilter + "'"; - widget.log(s); - - widget.team.newSearch(query, sortOrder, maxrecs, perpage, limit, targets, targetfilter); - } - }); -}; - - -// Utility function for all widgets that want to hide in narrow windows -widget.hideWhenNarrow = function(widget) { - widget.team.queue("resize-narrow").subscribe(function(n) { - $(widget.node).hide(); + // Utility function for all widgets that want to hide in narrow windows + that.hideWhenNarrow = function() { + var that = this; + this.team.queue("resize-narrow").subscribe(function(n) { + that.node.hide(); }); - widget.team.queue("resize-wide").subscribe(function(n) { - $(widget.node).show(); + this.team.queue("resize-wide").subscribe(function(n) { + that.node.show(); }); + }; + + + for (var i = 0; i < node.attributes.length; i++) { + var a = node.attributes[i]; + var val = expandValue(a.value); + if (a.name === 'data-mkws-config') { + // Treat as a JSON fragment configuring just this widget + this.info(node + ": parsing config fragment '" + val + "'"); + var data; + try { + data = $.parseJSON(val); + for (var key in data) { + this.info(node + ": adding config element " + key + "='" + data[key] + "'"); + that.config[key] = data[key]; + } + } catch (err) { + alert("Can't parse " + node + " data-mkws-config as JSON: " + val); + } + } else if (a.name.match (/^data-mkws-/)) { + var name = a.name.replace(/^data-mkws-/, '') + that.config[name] = val; + this.info(that + ": set data-mkws attribute " + name + "='" + val + "'"); + } else if (!ignoreAttrs[a.name]) { + that.config[a.name] = val; + this.info(that + ": set regular attribute " + a.name + "='" + val + "'"); + } + } + + var fn = mkws.promotionFunction(type); + if (fn) { + fn.call(that); + this.info("made " + type + " widget(node=" + node + ")"); + } else if (type.match(/-[Cc]ontainer-(narrow|wide)$/)) { + // Not really a widget: no need to log its lack of promotion + } else { + this.info("made UNPROMOTED widget(type=" + type + ", node=" + node + ")"); + } + + return that; }; - -