DIV CSS 佈局教程網

jQuery EasyUI Treegrid 加載 checkbox 並實現父子聯動
編輯:JQuery入門技巧     

這篇記錄一個相對繁瑣的實戰需求:在 EasyUI 的 treegrid 裡動態渲染 checkbox,並實現三層行為——父節點勾選帶動子節點、子節點全選反推父節點、同一行不同業務類型的 checkbox 互斥禁用。

最終效果:

需求要點整理如下:

  • 數據動態加載;
  • 級聯勾選(父子聯動);
  • 根據「通關類型」判斷當前展示的是包庫還是鏡像,兩者的列不完全相同(鏡像多幾列);
  • 勾選某一列的 checkbox 後,同一行其他類型的 checkbox 變為不可勾選。

一、初始化 treegrid

下面代碼中的 type1、type3、type4、type5 等字段名由後端提供,用來標識不同的價格類型。

var root = 20543; // 初始化產品樹

function InitProductTreeGrid(rootid) {
  var type = '<%=Controler.ProductType%>';
  var ishowPack = true;
  var ishowMirro = true;

  // 1 為包庫,2 為鏡像
  if (type == '1') {
    ishowPack = false;
    ishowMirro = true;
  } else {
    ishowPack = true;
    ishowMirro = false;
  }

  $('#tt_Product').treegrid({
    url: '../Handlers/Contract_ProductHandler.ashx',
    queryParams: {
      handlertype: 'InitProductTreeGrid',
      ContractId: $('#ContractId').val(),
      CatalogId: rootid,
      pindex: $('#pindex').val()
    },
    idField: 'id',
    width: 930,
    treeField: 'CatalogName',
    fitColumns: true,      // 寬度自適應窗口
    rownumbers: false,     // 是否加行號
    singleSelect: true,
    scrollbarSize: 0,      // 去除滾動條,否則最後一列會多出一塊
    columns: [[
      { title: '產品列表', field: 'CatalogName', width: 210 },
      { title: '產品ID', field: 'CatalogId', hidden: true },
      { title: '父產品ID', field: 'ParentId', hidden: true },
      { title: '父產品名稱', field: 'ParentName', hidden: true },
      { title: '產品類型', field: 'ProductType', hidden: true },
      { title: '是否為子節點', field: 'isLeaf', hidden: true },   // 1 是,0 否
      { title: '是否為父節點', field: 'isParent', hidden: true },
      { title: 'IsChecked', field: 'IsCheck', hidden: true },
      { title: 'CurrentYearPrices', field: 'type1', hidden: true },
      { title: 'MirrorCurrentYearPrices', field: 'type3', hidden: true },
      { title: 'MirrorEarlyPrices', field: 'type4', hidden: true },
      { title: 'MirrorPrevious3YearPrices', field: 'type5', hidden: true },
      {
        field: 'CurrentYearPrices',
        title: '當前價格',
        width: 200,
        hidden: ishowPack,
        formatter: function (value, rec, index) {
          var d = '<input type="checkbox" name="CurrentYearPrices" catalogid="' + rec.CatalogId + '" '
            + (rec.type1 == 'True' ? 'checked="checked"' : '')
            + ' id="CurrentYearPrices' + rec.CatalogId + '"'
            + ' onclick="showProductTree(this,\'CurrentYearPrices\',' + rec.CatalogId + ',' + rec.isParent + ');"'
            + ' parent="CurrentYearPrices' + rec.ParentId + '"'
            + ' isparent="' + rec.isParent + '"'
            + ' value="' + value + '" />  '
            + (value != 0 ? value.substr(0, value.length - 2) : '0.00');
          return d;
        }
      },
      {
        field: 'MirrorCurrentYearPrices',
        title: '當前價格',
        width: 200,
        hidden: ishowMirro,
        formatter: function (value, rec, index) {
          var d = '<input type="checkbox" name="MirrorCurrentYearPrices" catalogid="' + rec.CatalogId + '" '
            + (rec.type3 == 'True' ? 'checked="checked"' : '')
            + ' id="MirrorCurrentYearPrices' + rec.CatalogId + '"'
            + ' onclick="showProductTree(this,\'MirrorCurrentYearPrices\',' + rec.CatalogId + ',' + rec.isParent + ');"'
            + ' parent="MirrorCurrentYearPrices' + rec.ParentId + '"'
            + ' isparent="' + rec.isParent + '"'
            + ' value="' + value + '" />  '
            + value.substr(0, value.length - 2);
          return d;
        }
      },
      {
        field: 'MirrorPrevious3YearPrices',
        title: '前階段價格',
        width: 200,
        hidden: ishowMirro,
        formatter: function (value, rec, index) {
          var d = '<input type="checkbox" name="MirrorPrevious3YearPrices" catalogid="' + rec.CatalogId + '" '
            + (rec.type5 == 'True' ? 'checked="checked"' : '')
            + ' id="MirrorPrevious3YearPrices' + rec.CatalogId + '"'
            + ' onclick="showProductTree(this,\'MirrorPrevious3YearPrices\',' + rec.CatalogId + ',' + rec.isParent + ');"'
            + ' parent="MirrorPrevious3YearPrices' + rec.ParentId + '"'
            + ' isparent="' + rec.isParent + '"'
            + ' value="' + value + '" />  '
            + value.substr(0, value.length - 2);
          return d;
        }
      },
      {
        field: 'MirrorEarlyPrices',
        title: '早期價格',
        width: 200,
        hidden: ishowMirro,
        formatter: function (value, rec, index) {
          var d = '<input type="checkbox" name="MirrorEarlyPrices" catalogid="' + rec.CatalogId + '" '
            + (rec.type4 == 'True' ? 'checked="checked"' : '')
            + ' id="MirrorEarlyPrices' + rec.CatalogId + '"'
            + ' onclick="showProductTree(this,\'MirrorEarlyPrices\',' + rec.CatalogId + ',' + rec.isParent + ');"'
            + ' parent="MirrorEarlyPrices' + rec.ParentId + '"'
            + ' isparent="' + rec.isParent + '"'
            + ' value="' + value + '" />  '
            + value.substr(0, value.length - 2);
          return d;
        }
      },
      {
        field: 'type0',
        title: '是否贈送',
        width: 200,
        formatter: function (value, rec, index) {
          var d = '<input type="checkbox" name="IsPresent" catalogid="' + rec.CatalogId + '" '
            + (rec.type0 == 'True' ? 'checked="checked"' : '')
            + ' id="IsPresent' + rec.CatalogId + '"'
            + ' onclick="showProductTree(this,\'IsPresent\',' + rec.CatalogId + ',' + rec.isParent + ');"'
            + ' parent="IsPresent' + rec.ParentId + '"'
            + ' isparent="' + rec.isParent + '"'
            + ' value="0" />  ';
          return d;
        }
      }
    ]],
    loadFilter: function (data, parentId) {
      // 逐層加載
      function setData() {
        var todo = [];
        for (var i = 0; i < data.length; i++) {
          todo.push(data[i]);
        }
        while (todo.length) {
          var node = todo.shift();
          if (node.children) {
            node.state = 'closed';
            node.children1 = node.children;
            node.children = undefined;
            todo = todo.concat(node.children1);
          }
        }
      }

      setData(data);

      var tg = $(this);
      var opts = tg.treegrid('options');
      opts.onBeforeExpand = function (row) {
        if (row.children1) {
          tg.treegrid('append', {
            parent: row[opts.idField],
            data: row.children1
          });
          row.children1 = undefined;
          tg.treegrid('expand', row[opts.idField]);
        }
        return row.children1 == undefined;
      };

      return data;
    },
    onLoadSuccess: function (row, data) {
      RelativeTreeGridCheck();
    }
  });
}

formatter 裡拼接 checkbox 時,把 catalogid、parent、isparent 等信息掛在自定義屬性上,後續的聯動邏輯全靠這些屬性定位節點關係。loadFilter 則是把後端一次返回的樹形數據改造成「按需展開」,避免首次加載就把整棵樹全部渲染。

二、onLoadSuccess 中的級聯校驗

頁面加載完成後需要還原後端已保存的勾選狀態,並把父節點的勾選同步給子節點:

var parentcid;
var ispid;
var tempid;

// 父節點選中,關聯子節點選中
function RelativeTreeGridCheck() {
  var rows = $('#addProductTbl').find('.datagrid-view2 .datagrid-body .datagrid-btable tr');

  for (var i = 0; i < rows.length; i++) {
    if ($(rows).eq(i).attr('node-id') != undefined) {
      parentcid = '';
      ispid = -1;
      tempid = '';
      catalogid = $(rows).eq(i).attr('node-id');

      var cols = $(rows).eq(i).find('td');
      var fields = '';

      for (var j = 0; j < cols.length; j++) {
        fields = $(cols).eq(j).attr('field');

        switch (fields) {
          case 'CurrentYearPrices':
          case 'MirrorCurrentYearPrices':
          case 'MirrorPrevious3YearPrices':
          case 'MirrorEarlyPrices':
          case 'type0':
            if ($(cols).eq(j).find('div input:checked').length > 0) {
              parentcid = $(cols).eq(j).parent().find("td[field='CatalogId']").find('div').html();
              ispid = $(cols).eq(j).parent().find("td[field='isParent']").find('div').html();
              contractproducttype = $(cols).eq(j).find('div input').attr('name');

              if (ispid == '1') {
                var obj = $(cols).eq(j).find('div input:checkbox');
                showProductTree(obj, contractproducttype, parentcid, ispid);
              }
            }
            break;
        }
      }
    }
  }
}

三、聯動與互斥的核心函數

function showProductTree(obj, catalogtype, id, isparent) {
  if (isparent == 1) {
    // 當前節點是父節點,需要向下傳導
    var state = $(obj).attr('checked') == undefined ? false : true;

    // 找出所有子節點
    var nodes = $('input[name="' + catalogtype + '"][parent="' + catalogtype + id + '"]');

    nodes.each(function () {
      var curobjstate = $(this).attr('checked') == undefined ? false : true;

      disabledOthersCatalogType($(this), state, catalogtype);

      if (curobjstate == state && $(this).attr('isparent') == '0') {
        // 當前節點狀態與父節點一致,且不是父節點,直接同步
        $(this).attr('checked', state);
        $(this).prop('checked', state);
      } else {
        $(this).attr('checked', state);
        $(this).prop('checked', state);
        // 否則遞歸處理下一層
        showProductTree($(this), catalogtype, $(this).attr('catalogid'), $(this).attr('isparent'));
      }

      if (state) {
        $(this).removeAttr('disabled');
      }
    });

    $(obj).prop('checked', state);
    disabledOthersCatalogType($(obj), state, catalogtype);
  } else {
    // 當前節點是子節點,需要向上反推
    var state = $(obj).attr('checked') == undefined ? false : true;
    disabledOthersCatalogType($(obj), state, catalogtype);
    updateParentNodeCheckState($(obj), state, catalogtype);
  }
}

// 修改其他產品類型 checkbox 的只讀狀態
function disabledOthersCatalogType(obj, state, catalogtype) {
  $('input[catalogid="' + $(obj).attr('catalogid') + '"]').each(function () {
    if ($(this).attr('name') != catalogtype) {
      if (state) {
        $(this).attr('disabled', 'disabled');
      } else {
        $(this).removeAttr('disabled');
      }
      $(this).attr('checked', false).prop('checked', false);
    }
  });
}

// 向上查找父節點並修改其狀態
function updateParentNodeCheckState(obj, state, catalogtype) {
  var pid = $(obj).attr('parent');

  // 如果父節點是根節點,則不再往上
  if (pid == catalogtype + root || $('#' + pid).length == 0) return;

  var parent = $('#' + pid);

  if (!state) {
    parent.attr('checked', false);
    parent.prop('checked', false);
  } else {
    // 子節點全部選中時,父節點才勾選
    if ($('input[parent="' + pid + '"]:checked').length == $('input[parent="' + pid + '"]').length) {
      parent.attr('checked', true);
      parent.prop('checked', true);
    }
  }

  disabledOthersCatalogType(parent, state, catalogtype);

  // 繼續往上查找
  updateParentNodeCheckState(parent, state, catalogtype);
}

三個函數的分工很清晰:showProductTree 判斷方向(父節點向下、子節點向上),disabledOthersCatalogType 負責同行互斥禁用,updateParentNodeCheckState 用遞歸實現「子全選則父選」的反推。

四、收集數據並提交

由於 checkbox 是手寫拼接的,取值也得手動遍歷 DOM:

// 新增產品單擊操作處理
function subAddProduct() {
  var strJson = '';
  var selectedvalued = $('#cbo_selFirstCombbox').combobox('getValue');
  selectedvalued = selectedvalued == '' ? '20544' : selectedvalued;

  var ids = '';
  var rows = $('#addProductTbl').find('.datagrid-view2 .datagrid-body .datagrid-btable tr');

  strJson += '[';

  for (var i = 0; i < rows.length; i++) {
    catalogid = -1;
    catalogname = '';
    productfather = -1;
    contractproducttype = '';
    quoteprice = -1;
    isfather = -1;
    productfathername = '';

    if ($(rows).eq(i).attr('node-id') != undefined) {
      catalogid = $(rows).eq(i).attr('node-id');
      var cols = $(rows).eq(i).find('td');

      for (var j = 0; j < cols.length; j++) {
        var fields = $(cols).eq(j).attr('field');

        switch (fields) {
          case 'CatalogName':
            $(cols).eq(j).find('div span').each(function (index) {
              if ($(cols).eq(j).find('div span').eq(index).hasClass('tree-title')) {
                catalogname = $(cols).eq(j).find('div span').eq(index).html();
              }
            });
            break;

          case 'ParentId':
            productfather = $(cols).eq(j).find('div').html();
            break;

          case 'IsCheck':
            // 原樹選中節點 id(不含本次修改的節點)
            // 後端會先刪除當前版本下所有已選節點,再根據頁面最新狀態更新
            var oldcheck = $(cols).eq(j).find('div').html();
            if (oldcheck == 'True') {
              var cid = $(cols).eq(j).parent().find("td[field='CatalogId']").find('div').html();
              ids += cid + ',';
            }
            break;

          case 'CurrentYearPrices':
          case 'MirrorCurrentYearPrices':
          case 'MirrorPrevious3YearPrices':
          case 'MirrorEarlyPrices':
          case 'type0':
            if ($(cols).eq(j).find('div input:checked').length > 0) {
              isfather = $(cols).eq(j).parent().find("td[field='isParent']").find('div').html();
              productfathername = $(cols).eq(j).parent().find("td[field='ParentName']").find('div').html();
              contractproducttype = $(cols).eq(j).find('div input').attr('name');

              if (contractproducttype == 'IsPresent') {
                var type = '<%=Controler.ProductType%>';
                contractproducttype = type == '1' ? 'CurrentYearPrices' : 'MirrorCurrentYearPrices';
                quoteprice = $(cols).eq(j).parent()
                  .find("td[field='" + contractproducttype + "']").find('div input').val();
                ispresent = 1;
              } else {
                quoteprice = $(cols).eq(j).find('div input').val();
                ispresent = 0;
              }
            }
            break;
        }
      }

      if (catalogid != -1 && catalogname != '' && productfather != -1
        && contractproducttype != '' && quoteprice != -1 && productfathername != '') {
        strJson += '{"ProductID":"' + catalogid + '",'
          + '"ContractProductType":"' + contractproducttype + '",'
          + '"ProductFather":"' + productfather + '",'
          + '"Productname":"' + catalogname + '",'
          + '"Quotedprice":"' + quoteprice + '",'
          + '"IsPresent":"' + ispresent + '",'
          + '"ContractID":"' + $('#ContractId').val() + '",'
          + '"SelectedID":"' + selectedvalued + '",'
          + '"IsParent":"' + isfather + '",'
          + '"ProductFatherName":"' + productfathername + '",'
          + '"IsNull":"0"},';
      }
    }
  }

  // 一條都沒選時,也要告訴後端這是一次清空操作
  if (strJson == '[') {
    strJson = '[{"ContractID":"' + $('#ContractId').val() + '",'
      + '"SelectedID":"' + selectedvalued + '","IsNull":"1"}]';
  } else {
    strJson = strJson.substr(0, strJson.length - 1) + ']';
  }

  ids = ids.substr(0, ids.length - 1);
  subProduct(strJson, ids);
}

// 新增產品提交操作
function subProduct(strJson, ids) {
  $.post('../Handlers/Contract_ProductHandler.ashx', {
    'handlertype': 'subAddProduct',
    'strJson': strJson,
    'ids': ids,
    'pindex': $('#pindex').val()
  }, function (responseData) {
    switch (responseData.Status) {
      case 'success':
        $.messager.alert('提示', responseData.Msg);
        $('#ProductWinTree').window('close');
        $('#dg_Product').datagrid('reload');
        break;
      case 'failed':
        $.messager.alert('提示', responseData.Msg);
        break;
    }
  }, 'json');
}

經驗小結

回頭看,這套實現能跑,但有幾處明顯可以改進:

  • 用 attr 判斷勾選狀態不可靠。jQuery 1.6 之後,attr('checked') 反映的是 HTML 初始屬性而非當前狀態,判斷勾選應統一使用 .prop('checked') 或 .is(':checked')。文中大量 attr('checked') == undefined ? false : true 的寫法在動態操作後容易出錯。
  • 依賴 DOM 結構取值太脆弱。treegrid 內部 class 名一旦因版本升級而變化,取值邏輯全線崩盤。更穩妥的方式是用 $('#tt_Product').treegrid('getRows') 拿到數據數組,再配合自定義 formatter 記錄的狀態字段做判斷。
  • 遞歸缺少深度保護。層級異常或數據成環時,updateParentNodeCheckState 會無限遞歸,建議加上已訪問集合。
  • 手拼 JSON 有注入風險。字段值直接字符串拼接,遇到引號就會破壞結構,改用 JSON.stringify 更安全。

這個案例真正的價值不在代碼本身,而在於它把 treegrid 自定義列的幾個典型難點都踩了一遍:formatter 裡掛自定義屬性、loadFilter 做按需加載、手寫 checkbox 的父子聯動、以及從渲染后的 DOM 反推數據。理解這些之後,換成任何一棵樹形表格都能遷移。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved