src/mkws-widget.js

   1 // Factory function for widget objects.
   2 mkws.makeWidget = function($, team, type, node) {
   3   // Static register of attributes that do not contribute to config
   4   var ignoreAttrs = {
   5     id:1, 'class':1, style:1, name:1, action:1, type:1, size:1,
   6     value:1, width:1, valign:1
   7   };
   8
   9   var that = {
  10     team: team,
  11     type: type,
  12     node: $(node),
  13     config: mkws.objectInheritingFrom(team.config)
  14   };
  15
  16   that.trace = team.trace;
  17   that.debug = team.debug;
  18   that.info = team.info;
  19   that.warn = team.warn;
  20   that.error = team.error;
  21   that.fatal = team.fatal;
  22
  23   that.toString = function() {
  24     return '[Widget ' + team.name() + ':' + type + ']';
  25   };
  26
  27   that.value = function() {
  28     return node.value;
  29   };
  30
  31   // Returns the HTML of a subwidget of the specified type. It gets
  32   // the same attributes at the parent widget that invokes this
  33   // function, except where overrides are passed in. If defaults are
  34   // also provided, then these are used when the parent widget
  35   // provides no values.
  36   that.subwidget = function(type, overrides, defaults) {
  37     var attrs = { _team: team.name() };
  38
  39     // Copy locally-set properties from the parent widget
  40     for (var name in this.config) {
  41       if (this.config.hasOwnProperty(name)) {
  42         attrs[name] = this.config[name];
  43         this.info(this + " copied property " + name + "='" + attrs[name] + "' to " + type + " subwidget");
  44       }
  45     }
  46
  47     for (var name in overrides) {
  48       this.info(this + " overrode property " + name + "='" + overrides[name] + "' (was '" + attrs[name] + "') for " + type + " subwidget");
  49       attrs[name] = overrides[name];
  50     }
  51
  52     if (defaults) {
  53       for (var name in defaults) {
  54         if (!attrs[name]) {
  55           attrs[name] = defaults[name];
  56           this.info(this + " fell back to default property " + name + "='" + attrs[name] + "' for " + type + " subwidget");
  57         }
  58       }
  59     }
  60
  61     var s = [];
  62     s.push('<div class="mkws', type, ' mkws-team-', attrs._team, '"');
  63     for (var name in attrs) {
  64       if (name !== '_team')
  65         s.push(' ', name, '="', attrs[name], '"');
  66     }
  67     s.push('></div>');
  68     return s.join('');
  69   };
  70
  71   function expandValue(val) {
  72     if (val.match(/^!param!/)) {
  73       var param = val.replace(/^!param!/, '');
  74       var optional = param.match(/^\?/);
  75       if (optional) {
  76         param = param.replace(/^\?/, '');
  77       }
  78       val = mkws.getParameterByName(param);
  79       that.info("obtained val '" + val + "' from param '" + param + "'");
  80       if (!val && !optional) {
  81         alert("This page has a MasterKey widget that needs a val specified by the '" + param + "' parameter");
  82       }
  83     } else if (val.match(/^!path!/)) {
  84       var index = val.replace(/^!path!/, '');
  85       var path = window.location.pathname.split('/');
  86       val = path[path.length - index];
  87       that.info("obtained val '" + val + "' from path-component '" + index + "'");
  88       if (!val) {
  89         alert("This page has a MasterKey widget that needs a val specified by the path-component " + index);
  90       }
  91     } else if (val.match(/^!var!/)) {
  92       var name = val.replace(/^!var!/, '');
  93       val = window[name]; // It's ridiculous that this works
  94       that.info("obtained val '" + val + "' from variable '" + name + "'");
  95       if (!val) {
  96         alert("This page has a MasterKey widget that needs a val specified by the '" + name + "' variable");
  97       }
  98     }
  99     return val;
 100   };
 101
 102   // Utility function for use by all widgets that can invoke autosearch.
 103   that.autosearch = function() {
 104     var that = this;
 105     var query = this.config.autosearch;
 106     if (query) {
 107       var old = this.team.config.query;
 108       if (!old) {
 109         // Stash this for subsequent inspection
 110         this.team.config.query = query;
 111       } else if (old === query) {
 112         this.warn("duplicate autosearch: '" + query + "': ignoring");
 113         return;
 114       } else {
 115         this.warn("conflicting autosearch: '" + query + "' vs '" + old + "': ignoring");
 116         return;
 117       }
 118
 119       this.team.queue("ready").subscribe(function() {
 120         // Postpone testing for the configuration items: these are not
 121         // yet set for Record subclass widgets that fill them in in the
 122         // subclass, as widget.autosearch is called in the superclass,
 123         // before the subclass fiddles with the configuration.
 124         var sortOrder = that.config.sort;
 125         var maxrecs = that.config.maxrecs;
 126         var perpage = that.config.perpage;
 127         var limit = that.config.limit;
 128         var targets = that.config.targets;
 129         var targetfilter = that.config.targetfilter;
 130         var target = that.config.target;
 131         if (target) targetfilter = 'udb=="' + target + '"';
 132
 133         var s = "running auto search: '" + query + "'";
 134         if (sortOrder) s += " sorted by '" + sortOrder + "'";
 135         if (maxrecs) s += " restricted to " + maxrecs + " records";
 136         if (perpage) s += " with " + perpage + " per page";
 137         if (limit) s += " limited by '" + limit + "'";
 138         if (targets) s += " in targets '" + targets + "'";
 139         if (targetfilter) s += " constrained by targetfilter '" + targetfilter + "'";
 140         that.info(s);
 141
 142         that.team.newSearch(query, sortOrder, maxrecs, perpage, limit, targets, targetfilter);
 143       });
 144     }
 145   };
 146
 147   // Utility function for all widgets that want to hide in narrow windows
 148   that.hideWhenNarrow = function() {
 149     var that = this;
 150     this.team.queue("resize-narrow").subscribe(function(n) {
 151       that.node.hide();
 152     });
 153     this.team.queue("resize-wide").subscribe(function(n) {
 154       that.node.show();
 155     });
 156   };
 157
 158
 159   for (var i = 0; i < node.attributes.length; i++) {
 160     var a = node.attributes[i];
 161     var val = expandValue(a.value);
 162     if (a.name === 'data-mkws-config') {
 163       // Treat as a JSON fragment configuring just this widget
 164       this.info(node + ": parsing config fragment '" + val + "'");
 165       var data;
 166       try {
 167         data = $.parseJSON(val);
 168         for (var key in data) {
 169           this.info(node + ": adding config element " + key + "='" + data[key] + "'");
 170           that.config[key] = data[key];
 171         }
 172       } catch (err) {
 173         alert("Can't parse " + node + " data-mkws-config as JSON: " + val);
 174       }
 175     } else if (a.name.match (/^data-mkws-/)) {
 176       var name = a.name.replace(/^data-mkws-/, '')
 177       that.config[name] = val;
 178       this.info(that + ": set data-mkws attribute " + name + "='" + val + "'");
 179     } else if (!ignoreAttrs[a.name]) {
 180       that.config[a.name] = val;
 181       this.info(that + ": set regular attribute " + a.name + "='" + val + "'");
 182     }
 183   }
 184
 185   var fn = mkws.promotionFunction(type);
 186   if (fn) {
 187     fn.call(that);
 188     this.info("made " + type + " widget(node=" + node + ")");
 189   } else if (type.match(/-[Cc]ontainer-(narrow|wide)$/)) {
 190     // Not really a widget: no need to log its lack of promotion
 191   } else {
 192     this.info("made UNPROMOTED widget(type=" + type + ", node=" + node + ")");
 193   }
 194
 195   return that;
 196 };