X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=src%2Fmkws-widgets.js;h=e17e7e03895410b001fd944f3442882384e45a07;hb=efb2e7adaf2d74aeb9433fedda5b03eaa3fde747;hp=ba42ff0d8e2851b98a1bbeab5aa610f5d1d1b87d;hpb=94b925b309c6dee3c2d4d09c455c5bd165f7c206;p=mkws-moved-to-github.git diff --git a/src/mkws-widgets.js b/src/mkws-widgets.js index ba42ff0..e17e7e0 100644 --- a/src/mkws-widgets.js +++ b/src/mkws-widgets.js @@ -1,9 +1,16 @@ // 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 + node: node, + config: mkws.objectInheritingFrom(team.config()) }; function log(s) { @@ -13,6 +20,35 @@ function widget($, team, type, node) { that.toString = function() { return '[Widget ' + team.name() + ':' + type + ']'; + }; + + that.value = function() { + return node.value; + } + + 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 + "'"); + } } var fn = mkws.promotionFunction(type); @@ -20,22 +56,81 @@ function widget($, team, type, node) { fn.call(that); log("made " + type + " widget(node=" + node + ")"); } else { - log("made UNENCAPSULATED widget(type=" + type + ", node=" + node + ")"); + log("made UNPROMOTED widget(type=" + type + ", node=" + node + ")"); } 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); + } + }); +}; + + // Functions follow for promoting the regular widget object into // widgets of specific types. These could be moved into their own // source files. -function promoteToTargets() { +mkws.registerWidgetType('Targets', function() { var that = this; var M = mkws.M; + $(this.node).html('\ +
\ +No information available yet.\ +
'); + $(this.node).css("display", "none"); + this.team.queue("targets").subscribe(function(data) { var table ='' + '' + @@ -57,10 +152,10 @@ function promoteToTargets() { var subnode = $(that.node).children('.mkwsBytarget'); subnode.html(table); }); -} +}); -function promoteToStat() { +mkws.registerWidgetType('Stat', function() { var that = this; var M = mkws.M; @@ -73,75 +168,10 @@ function promoteToStat() { ' -- ' + '' + M('Retrieved records') + ': ' + data.records + '/' + data.hits + ''); }); -} - - -function promoteToTermlists() { - var that = this; - var M = mkws.M; - - this.team.queue("termlists").subscribe(function(data) { - if (!that.node) { - alert("termlists event when there are no termlists"); - return; - } - - // no facets: this should never happen - if (!mkws_config.facets || mkws_config.facets.length == 0) { - alert("onTerm called even though we have no facets: " + $.toJSON(data)); - $(that.node).hide(); - return; - } - - // display if we first got results - $(that.node).show(); - - var acc = []; - acc.push('
' + M('Termlists') + '
'); - var facets = mkws_config.facets; - - for (var i = 0; i < facets.length; i++) { - if (facets[i] == "xtargets") { - addSingleFacet(acc, "Sources", data.xtargets, 16, null); - } else if (facets[i] == "subject") { - addSingleFacet(acc, "Subjects", data.subject, 10, "subject"); - } else if (facets[i] == "author") { - addSingleFacet(acc, "Authors", data.author, 10, "author"); - } else { - alert("bad facet configuration: '" + facets[i] + "'"); - } - } - - $(that.node).html(acc.join('')); - - function addSingleFacet(acc, caption, data, max, pzIndex) { - var teamName = that.team.name(); - acc.push('
'); - acc.push('
' + M(caption) + '
'); - for (var i = 0; i < data.length && i < max; i++) { - acc.push('
'); - acc.push('' + data[i].name + '' - + ' ' + data[i].freq + ''); - acc.push('
'); - } - acc.push('
'); - } - }); -} +}); -function promoteToPager() { +mkws.registerWidgetType('Pager', function() { var that = this; var M = mkws.M; @@ -168,24 +198,24 @@ function promoteToPager() { ? firstClkbl + 2*onsides : pages; - var prev = '<< ' + M('Prev') + ' | '; + var prev = '<< ' + M('Prev') + ' | '; if (currentPage > 1) prev = '' - +'<< ' + M('Prev') + ' | '; + +'<< ' + M('Prev') + ' | '; var middle = ''; for(var i = firstClkbl; i <= lastClkbl; i++) { var numLabel = i; if(i == currentPage) - numLabel = '' + i + ''; + numLabel = '' + i + ''; middle += ' ' + numLabel + ' '; } - var next = ' | ' + M('Next') + ' >>'; + var next = ' | ' + M('Next') + ' >>'; if (pages - currentPage > 0) - next = ' | ' + next = ' | ' + M('Next') + ' >>'; var predots = ''; @@ -202,10 +232,17 @@ function promoteToPager() { return s; } }); -} +}); + + +mkws.registerWidgetType('Results', function() { + // Nothing to do apart from act as an autosearch trigger + // Contained elements do all the real work + widget.autosearch(this); +}); -function promoteToRecords() { +mkws.registerWidgetType('Records', function() { var that = this; var team = this.team; @@ -213,6 +250,7 @@ function promoteToRecords() { var html = []; for (var i = 0; i < data.hits.length; i++) { var hit = data.hits[i]; + that.team.queue("record").publish(hit); var divId = team.recordElementId(hit.recid[0]); html.push('
', renderSummary(hit), '
'); // ### At some point, we may be able to move the @@ -225,18 +263,19 @@ function promoteToRecords() { } $(that.node).html(html.join('')); - function renderSummary(hit) - { - var template = team.loadTemplate("Summary"); + function renderSummary(hit) { + var template = team.loadTemplate(that.config.template || "Summary"); hit._id = team.recordElementId(hit.recid[0]); hit._onclick = "mkws.showDetails('" + team.name() + "', '" + hit.recid[0] + "');return false;" return template(hit); } }); -} + + widget.autosearch(that); +}); -function promoteToNavi() { +mkws.registerWidgetType('Navi', function() { var that = this; var teamName = this.team.name(); var M = mkws.M; @@ -245,59 +284,239 @@ function promoteToNavi() { var filters = that.team.filters(); var text = ""; - for (var i in filters) { - if (text) { - text += " | "; - } - var filter = filters[i]; - if (filter.id) { - text += M('source') + ': ' + filter.name + ''; - } else { - text += M(filter.field) + ': ' + filter.value + ''; - } - } + filters.visitTargets(function(id, name) { + if (text) text += " | "; + text += M('source') + ': ' + name + ''; + }); + + filters.visitFields(function(field, value) { + if (text) text += " | "; + text += M(field) + ': ' + value + ''; + }); $(that.node).html(text); }); -} +}); -function promoteToSort() { - // It seems this and the Perpage widget doen't need to - // subscribe to anything, since they produce events rather - // than consuming them. - $(this.node).change(function () { - this.team.set_sortOrder($(node).val()); - if (this.team.submitted()) { - this.team.resetPage(); - this.team.reShow(); +// It seems this and the Perpage widget doen't need to subscribe to +// anything, since they produce events rather than consuming them. +// +mkws.registerWidgetType('Sort', function() { + var that = this; + + $(this.node).change(function() { + that.team.set_sortOrder($(that.node).val()); + if (that.team.submitted()) { + that.team.reShow(); } return false; }); -} +}); -function promoteToPerpage() { +mkws.registerWidgetType('Perpage', function() { + var that = this; + $(this.node).change(function() { - this.team.set_perpage($(node).val()); - if (this.team.submitted()) { - this.team.resetPage(); - this.team.reShow(); + that.team.set_perpage($(that.node).val()); + if (that.team.submitted()) { + that.team.reShow(); } return false; }); -} +}); -mkws.registerWidgetType('Targets', promoteToTargets); -mkws.registerWidgetType('Stat', promoteToStat); -mkws.registerWidgetType('Termlists', promoteToTermlists); -mkws.registerWidgetType('Pager', promoteToPager); -mkws.registerWidgetType('Records', promoteToRecords); -mkws.registerWidgetType('Navi', promoteToNavi); -mkws.registerWidgetType('Sort', promoteToSort); -mkws.registerWidgetType('Perpage', promoteToPerpage); +mkws.registerWidgetType('Done', function() { + var that = this; + + this.team.queue("complete").subscribe(function(n) { + $(that.node).html("Search complete: found " + n + " records"); + }); +}); + + +mkws.registerWidgetType('Switch', function() { + var tname = this.team.name(); + $(this.node).html('\ +Records \ +| \ +Targets'); +}); + + +mkws.registerWidgetType('Search', function() { + var tname = this.team.name(); + var M = mkws.M; + + $(this.node).html('\ +\ + \ + \ +'); +}); + + +mkws.registerWidgetType('SearchForm', function() { + var team = this.team; + $(this.node).submit(function() { + var val = team.widget('Query').value(); + team.newSearch(val); + return false; + }); +}); + + +mkws.registerWidgetType('Results', function() { + var tname = this.team.name(); + + $(this.node).html('\ +
' + M('Target ID') + '
\ + \ + \ + \ + \ + \ + \ + \ +
\ +
\ +
\ +
\ +
\ +
\ +
\ +
\ +
\ +
'); +}); + + +mkws.registerWidgetType('Ranking', function() { + var tname = this.team.name(); + var that = this; + var M = mkws.M; + + var s = '
'; + if (this.config.show_sort) { + s += M('Sort by') + ' ' + mkwsHtmlSort() + ' '; + } + if (this.config.show_perpage) { + s += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.'; + } + s += '
'; + + $(this.node).html(s); + + + function mkwsHtmlSort() { + var order = that.team.sortOrder(); + + that.log("HTML sort, sortOrder = '" + order + "'"); + var sort_html = ''; + + return sort_html; + } + function mkwsHtmlPerpage() { + var perpage = that.team.perpage(); + + that.log("HTML perpage, perpage = " + perpage); + var perpage_html = ''; + + return perpage_html; + } +}); + + +mkws.registerWidgetType('Lang', function() { + // dynamic URL or static page? /path/foo?query=test + /* create locale language menu */ + if (!this.config.show_lang) return; + + var lang_default = "en"; + var lang = this.config.lang || lang_default; + var list = []; + + /* display a list of configured languages, or all */ + var lang_options = this.config.lang_options || []; + var toBeIncluded = {}; + for (var i = 0; i < lang_options.length; i++) { + toBeIncluded[lang_options[i]] = true; + } + + for (var k in mkws.locale_lang) { + if (toBeIncluded[k] || lang_options.length == 0) + list.push(k); + } + + // add english link + if (lang_options.length == 0 || toBeIncluded[lang_default]) + list.push(lang_default); + + this.log("Language menu for: " + list.join(", ")); + + /* the HTML part */ + var data = ""; + for (var i = 0; i < list.length; i++) { + var l = list[i]; + if (data) + data += ' | '; + + if (lang == l) { + data += ' ' + l + ' '; + } else { + data += ' ' + l + ' ' + } + } + + $(this.node).html(data); + + + // set or re-set "lang" URL parameter + function lang_url(lang) { + var query = location.search; + // no query parameters? done + if (!query) { + return "?lang=" + lang; + } + + // parameter does not exist + if (!query.match(/[\?&]lang=/)) { + return query + "&lang=" + lang; + } + + // replace existing parameter + query = query.replace(/\?lang=([^&#;]*)/, "?lang=" + lang); + query = query.replace(/\&lang=([^&#;]*)/, "&lang=" + lang); + return query; + } +});