xmlplus组件设计系列之网格（DataGrid）(10）

这一章我们要实现是一个网格组件，该组件除了最基本的数据展示功能外，还提供排序以及数据过滤功能。

数据源

为了测试我们即将编写好网格组件，我们采用如下格式的数据源。此数据源包含两部分的内容，分别是表头数据集和表体数据集。网格组件实例最终的列数由表头数据集的长度决定。

var data = {
 gridcolumns: ['name', 'power'],
 griddata: [
 { name: 'chuck norris', power: infinity },
 { name: 'bruce lee', power: 9000 },
 { name: '*', power: 7000 },
 { name: 'jet li', power: 8000 }
 ]
};

顶层设计

从视觉上，我们很自然地把网格组件划分为表头与表体。此网格组件有三个功能，所以应该提供三个动态接口。但我们注意到排序功能是通过点击表头进行的，而表头属于网格组件的一部分，所以该功能应该内置。从而，实际上我们的网格组件对外只暴露两个动态接口：一个用于过滤，另一个用于接收数据源。所以我们可以得到如下的一个顶层设计。

datagrid: {
 xml: `<table id='table'>
  <thead id='thead'/>
  <tbody id='tbody'/>
  </table>`,
 fun: function (sys, items, opts) {
 function setvalue(data) {
  items.thead.val(data.gridcolumns);
  items.tbody.val(data.gridcolumns, data.griddata);
 }
 function filter(filterkey) {
  // 过滤函数
 }
 return { val: setvalue, filter: filter };
 }
}

设计表头

表头只有一行，所以可以直接给它提供一个 tr 元素。tr 元素的子级项 th 的个数取决于表头数据集的长度，所以需要动态创建。由于 th 元素包含了排序功能，所以需要另行封装。下面是我们给出的表头的设计。

thead: {
 xml: `<thead id='thead'>
  <tr id='tr'/>
  </thead>`,
 fun: function (sys, items, opts) {
 function setvalue(value) {
  sys.tr.children().call("remove");
  data.foreach(item => sys.tr.append("th").value().val(item));
 }
 return { val: setvalue };
 }
}

表头数据项组件提供一个文本设置接口。该组件本身并不负责排序，它只完成自身视图状态的变更以及排序命令的派发。排序命令的派发需要携带两个数据：一个是排序关键字，也就是表头文本；另一个排序方向，升或者降。

th: {
 css: "#active { color: #fff; } #active #arrow { opacity: 1; } #active #key { color: #fff; }\
  #arrow { display: inline-block; vertical-align: middle; width: 0; height: 0; margin-left: 5px; opacity: 0.66; }\
  #asc { border-left: 4px solid transparent; border-right: 4px solid transparent; border-bottom: 4px solid #fff;}\
  #dsc { border-left: 4px solid transparent; border-right: 4px solid transparent; border-top: 4px solid #fff; }",
 xml: "<th id='th'>\
  <span id='key'/><span id='arrow'/>\
  </th>",
 fun: function (sys, items, opts) {
 var order = "#asc";
 this.watch("sort", function (e, key, order) {
  sys.key.text().tolowercase() == key || sys.th.removeclass("#active");
 });
 this.on("click", function (e) {
  sys.th.addclass("#active");
  sys.arrow.removeclass(order);
  order = order == "#asc" ? "#dsc" : "#asc";
  sys.arrow.addclass(order).notify("sort", [sys.key.text().tolowercase(), order]);
 });
 sys.arrow.addclass("#asc");
 return { val: sys.key.text };
 }
}

设计表体

表体可以有多行，但表体只负责展示数据，所以实现起来比表头要简单的多。

tbody: {
 xml: `<tbody id='tbody'/>`,
 fun: function (sys, items, opts) {
 function setvalue(gridcolumns, griddata) {
  sys.tbody.children().call("remove");
  griddata.foreach(data => 
  tr = sys.tbody.append("tr");
  gridcolumns.foreach(key => tr.append("td").text(data[key]));
  ));
 }
 return { val: setvalue };
 }
}

加入排序功能

为了便于管理，我们把排序功能单独封装成一个组件，该组件提供一个排序接口，同时侦听一个排序消息。一旦接收到排序消息，则记录下关键字与排序方向，并派发一个表体刷新命令。

sort: {
 fun: function (sys, items, opts) {
 var sortkey, sortorder;
 this.watch("sort", function (e, key, order) {
  sortkey = key, sortorder = order;
  this.trigger("update");
 });
 return function (data) {
  return sortkey ? data.slice().sort(function (a, b) {
  a = a[sortkey], b = b[sortkey];
  return (a === b ? 0 : a > b ? 1 : -1) * (sortorder == "#asc" ? 1 : -1);
  }) : data;
 };
 }
}

要完整地实现排序功能，对组件 datagrid 作一些修正，主要是内置上述的排序功能组件并侦听表体刷新指令。一旦接收到刷新指令，则对表体数据完成排序并刷新表体。

datagrid: {
 xml: `<table id='table'>
  <thead id='thead'/>
  <tbody id='tbody'/>
  <sort id='sort'/>
  </table>`,
 fun: function (sys, items, opts) {
 var data = {gridcolumns: [], griddata: []};
 function setvalue(value) {
  data = value;
  items.thead.val(data.gridcolumns);
  items.tbody.val(data.gridcolumns, data.griddata);
 }
 function filter(filterkey) {
  // 过滤函数
 }
 this.on("update", function() {
  items.tbody.val(items.sort(data.griddata));
 });
 return { val: setvalue, filter: filter };
 }
}

加入过滤功能

与排序功能的加入流程类似，我们把过滤功能单独封装成一个组件，该组件提供一个过滤接口，同时侦听一个过滤消息。一旦接收到消息，则记录下过滤关键字，并派发一个表体刷新命令。

filter: {
 fun: function (sys, items, opts) {
 var filterkey = "";
 this.watch("filter", function (e, key) {
  filterkey = key.tolowercase();
  this.trigger("update");
 });
 return function (data) {
  return data.filter(function (row) {
  return object.keys(row).some(function (key) {
   return string(row[key]).tolowercase().indexof(filterkey) > -1;
  });
  });
 };
 }
}

另外需要对组件 datagrid 作一些修正，修正内容与上述的排序功能的加入类似，区别在于额外完善了 filter 接口以及对消息作用域进行了限制。下面是我们最终的网格组件。

datagrid: {
 css: `#table { border: 2px solid #42b983; border-radius: 3px; background-color: #fff; }
  #table th { background-color: #42b983; color: rgba(255,255,255,0.66); cursor: pointer; -webkit-user-select: none; -moz-user-select: none; -ms-user-select: none; user-select: none; }
  #table td { background-color: #f9f9f9; }
  #table th, #table td { min-width: 120px; padding: 10px 20px; }`,
 xml: `<table id='table'>
  <thead id='thead'/>
  <tbody id='tbody'/>
  <sort id='sort'/>
  <filter id='filter'/>
  </table>`,
 map: { msgscope: true },
 fun: function (sys, items, opts) {
 var data = {gridcolumns: [], griddata: []};
 function setvalue(value) {
  data = value;
  items.thead.val(data.gridcolumns);
  items.tbody.val(data.gridcolumns, data.griddata);
 }
 function filter(filterkey) {
  sys.table.notify("filter", filterkey);
 }
 this.on("update", function() {
  items.tbody.val(items.filter(items.sort(data.griddata)));
 });
 return { val: setvalue, filter: filter };
 }
}

值得注意的是这里一定要在映射项中配置限制消息作用域的选项。否则，当在一个应用中实例化多个网格组件时，消息就会互相干扰。

测试

最后我们来测试下我们完成的组件，测试的功能主要就是刚开始提到的三个：数据展示、排序以及过滤。

index: {
 css: "#index { font-family: helvetica neue, arial, sans-serif; font-size: 14px; color: #444; }\
  #search { margin: 8px 0; }",
 xml: "<div id='index'>\
  search <input id='search'/>\
  <table id='table'/>\
  </div>",
 fun: function (sys, items, opts) {
 items.table.val(data);
 sys.search.on("input", e => items.table.filter(sys.search.prop("value")));
 }
}

本系列文章基于 xmlplus 框架。如果你对 xmlplus 没有多少了解，可以访问 。这里有详尽的入门文档可供参考。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。