DIV CSS 佈局教程網

自寫 LeftHeadGrid:左側為表頭的表格控制項完整實作
編輯:關於JavaScript     

專案裡需要一個「左側欄是表頭」的表格,找了一輪卻沒有現成合適的元件,於是決定自己動手。最終成果如下圖:

一、功能清單

  1. 左側欄作為表頭呈現,與一般「上方表頭」的表格不同。
  2. 支援多列、多層表頭。
  3. 表頭固定(捲動資料區時表頭不動)。
  4. 支援標題列。
  5. 可【讀取】表格中的資料。
  6. 支援 IE 與 Chrome。
  7. 表格能依內容自動置中、自適應寬度。

二、呼叫方式

元件的使用方式設計成宣告式的組態物件,這在當時算是相當先進的做法:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="https://www.w3.org/1999/xhtml">
<head runat="server">
<title>Grid 左側固定測試</title>
<script src="LeftHeadGrid.js"></script>
<link href="LeftHeadGrid.css" rel="stylesheet" type="text/css" />
</head>
<body>
<form id="form1" runat="server">
    <div id="testdiv" align="center"></div>
</form>
</body>

<script type="text/javascript">
var test = new LeftHeadGrid({
    id: "leftHeadGrid",
    width: 800,
    title: "danielinbiti",
    perUnitWidth: 300,
    rowHeads: [{
        width: "60",
        rowname: [{ name: "日期" }, { name: "數值" }]
    }],
    columnDatas: [{
        width: [1, 1],
        rows: [[10130501, 101011], [2, 3]]
    }]
});
test.RenderTo("testdiv");
</script>
</html>

組態分為兩半:rowHeads 描述左側表頭(有幾層、每層的名稱與寬度),columnDatas 描述資料區(各欄寬度倍數與二維資料陣列)。perUnitWidth 則是寬度單位的換算係數,讓 width:[1,1] 這種比例寫法可以對應到實際像素。

三、元件主體(LeftHeadGrid.js)

var LeftHeadGrid = function (config) {
    this.rowHeads     = config.rowHeads     != null ? config.rowHeads     : [];
    this.columnDatas  = config.columnDatas  != null ? config.columnDatas  : [];
    this.width        = config.width        != null ? config.width        : "";
    this.id           = config.id           != null ? config.id           : "TreGrid";
    this.perUnitWidth = config.perUnitWidth != null ? config.perUnitWidth : 10;
    this.innerWidth   = 0;
    this.innerLWidth  = 0;
    this.height       = 0;
    this.title        = config.title        != null ? config.title        : "";
    this.noDataStr    = config.noDataStr    != null ? config.noDataStr    : "no data";
}

四、產生左側表頭

LeftHeadGrid.prototype.createGrid = function () {
    var totalwidth = 0;
    var tableHtml = "<table>";

    for (var i = 0; i < this.rowHeads.length; i++) {
        var obj = this.rowHeads[i];
        var width = obj.width;
        totalwidth = totalwidth + parseInt(width);

        var rownameobj = obj.rowname;
        for (var j = 0; j < rownameobj.length; j++) {
            var nameobj = rownameobj[j];
            if (j == rownameobj.length - 1) {
                tableHtml += "<tr><td class='bluelast' width='" + width + "px'>"
                           + nameobj.name + "</td></tr>";
            } else {
                tableHtml += "<tr><td class='bluefirst' width='" + width + "px'>"
                           + nameobj.name + "</td></tr>";
            }
            this.height = this.height + 40;     // 每列固定 40px
        }
    }

    tableHtml += "</table>";
    var headHtml = "<div class='leftheadcss' style='width:" + totalwidth + "px;'>"
                 + tableHtml + "</div>";

    this.innerLWidth = totalwidth;
    this.innerWidth  = this.width - totalwidth - 5;    // 5px 留給邊框
    return headHtml;
}

用 bluelast/bluefirst 兩個 class 區分「最後一層」與「其他層」,是為了讓分隔線只畫在該畫的地方。

五、組裝整體結構

LeftHeadGrid.prototype.RenderTo = function (divId) {
    var headHtml = this.createGrid();

    var html = "<div id='outframe' class='outframecss' style='width:" + this.width + "px;'>"
             + headHtml
             + "<div id='dataframe' class='dataframecss' style='width:" + this.innerWidth + "px;'>"
             + "<div id='leftgriddataview' class='innerdivcss'></div>"
             + "</div>"
             + "</div>";

    // 標題獨立在上方
    html = "<div id='divtitle' class='grittitle'"
         + " style='width:" + this.width + "px;height:30px'><big>"
         + this.title + "</big></div>" + html;

    document.getElementById(divId).innerHTML = html;
    this.show();
}

結構是「外框 → 左側表頭 div + 右側資料 div → 資料捲動容器」。表頭固定是怎麼做到的? 靠的是:左側表頭放在獨立的 div 中,而右側資料放在自己的捲動容器裡。左右並排,只有右邊捲動,左邊自然就不動了。這比「用 position:fixed 硬固定」簡單可靠得多。

六、填入資料並自適應寬度

LeftHeadGrid.prototype.show = function () {
    if (this.columnDatas && this.columnDatas.length > 0) {
        var obj = this.columnDatas[0];
        var widthArr = obj.width;
        var rows = obj.rows;
        var totalWidth = 0;

        // 把比例寬度換算成像素
        for (var i = 0; i < widthArr.length; i++) {
            widthArr[i] = parseInt(widthArr[i]) * this.perUnitWidth;
            totalWidth = totalWidth + widthArr[i];
        }

        var tableHtml = "<table width='" + totalWidth + "'>";
        for (var i = 0; i < rows.length; i++) {
            var rowvalueArr = rows[i];
            tableHtml += "<tr>";
            for (var j = 0; j < rowvalueArr.length; j++) {
                tableHtml += "<td width='" + widthArr[j] + "px'>" + rowvalueArr[j] + "</td>";
            }
            tableHtml += "</tr>";
        }
        tableHtml += "</table>";

        // 若內容比容器窄,就縮小外框,讓表格置中而非靠左
        if (this.innerWidth > totalWidth) {
            document.getElementById("dataframe").style.width = parseInt(totalWidth) + "px";
            document.getElementById("divtitle").style.width =
                (parseInt(this.innerLWidth) + parseInt(totalWidth)) + "px";
            document.getElementById("outframe").style.width =
                (parseInt(this.innerLWidth) + parseInt(totalWidth) + 4) + "px";
        }

        document.getElementById("leftgriddataview").innerHTML = tableHtml;
    } else {
        document.getElementById("leftgriddataview").style.height = (this.height + 4) + "px";
        document.getElementById("leftgriddataview").innerHTML = this.noDataStr;
    }
}

那個 if (this.innerWidth > totalWidth) 就是「自適應置中」的實作:當實際內容比配置寬度窄時,把外框、標題、資料區的寬度全部縮到「表頭寬 + 內容寬」,這樣整體就會真正置中,而不是被一個過寬的外框撐得靠左。

七、資料的讀寫

// 更新資料
LeftHeadGrid.prototype.addData = function (data) {
    this.columnDatas = data;
    this.show();
}

// 讀取資料:回傳字串陣列,每個元素是以逗號分隔的一列
LeftHeadGrid.prototype.getData = function () {
    var rtnObj = new Array();
    if (this.columnDatas && this.columnDatas.length > 0) {
        var obj = this.columnDatas[0];
        var rows = obj.rows;
        for (var i = 0; i < rows.length; i++) {
            var rowvalueArr = rows[i];
            for (var j = 0; j < rowvalueArr.length; j++) {
                if (j == 0) {
                    rtnObj[i] = rowvalueArr[j];
                } else {
                    rtnObj[i] = rtnObj[i] + "," + rowvalueArr[j];
                }
            }
        }
    }
    return rtnObj;
}

// 讀取表頭
LeftHeadGrid.prototype.getHead = function () {
    var rtnObj = new Array();
    for (var i = 0; i < this.rowHeads.length; i++) {
        var obj = this.rowHeads[i];
        var rownameobj = obj.rowname;
        for (var j = 0; j < rownameobj.length; j++) {
            var nameobj = rownameobj[j];
            if (j == 0) {
                rtnObj[i] = nameobj.name;
            } else {
                rtnObj[i] = rtnObj[i] + "," + nameobj.name;
            }
        }
    }
    return rtnObj;
}

元件需要的樣式(LeftHeadGrid.css)大致是這樣:

.outframecss { position: relative; }
.leftheadcss { float: left; }
.dataframecss { float: left; overflow-y: auto; overflow-x: hidden; }
.innerdivcss  { }
.grittitle    { text-align: center; font-weight: bold; }
.bluefirst    { background: #e8f0fa; border: 1px solid #b8cce4; }
.bluelast     { background: #d5e3f5; border: 1px solid #b8cce4; font-weight: bold; }

八、這份設計的檢討

作為一個自製元件,它達成了當初的功能目標,但用今天的標準來看有幾個明顯可改進之處:

  1. id 硬編碼:RenderTo 內部直接寫死 "dataframe"、"divtitle"、"outframe" 等 id。頁面上若有兩個 LeftHeadGrid 實例,第二個會找不到元素而失效。應該把 id 加上 this.id 前綴,或用 class 加範圍查詢。
  2. 用 innerHTML 拼接 HTML 字串:資料值直接插入字串,若含 <、& 就會破壞結構,也有 XSS 風險。應改用 DOM API 建立節點並用 textContent 填入。
  3. width:[1,1] 這種間接的比例寫法增加了理解成本。直接用 CSS Grid 或 <colgroup> 就能自然處理欄寬比例。
  4. 「固定表頭」的實作方式綁死了結構:靠左右兩個獨立 div 並排,也就無法同時支援「上方表頭 + 左側表頭」的四向固定。CSS 的 position: sticky 可以優雅地同時處理兩個方向。
  5. 沒有無障礙標示:用 div 拼出來的表格,螢幕閱讀器無法辨識表頭與資料的關聯。這類元件應使用真正的 <table>、<th> 與 scope 屬性。

九、現代做法:sticky + 真正的表格語意

如果今天要實作同樣的需求,用 CSS 就夠了,不需要任何 JavaScript:

<table class="grid">
    <thead>
        <tr>
            <th scope="col">項目</th>
            <th scope="col">一月</th>
            <th scope="col">二月</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <th scope="row">日期</th>
            <td>10130501</td>
            <td>2</td>
        </tr>
        <tr>
            <th scope="row">數值</th>
            <td>101011</td>
            <td>3</td>
        </tr>
    </tbody>
</table>

<style>
.grid {
    border-collapse: separate;
    border-spacing: 0;
    width: 100%;
}
.grid th, .grid td {
    border: 1px solid #b8cce4;
    padding: 6px 10px;
    text-align: center;
}

/* 上方表頭固定 */
.grid thead th {
    position: sticky;
    top: 0;
    background: #d5e3f5;
    z-index: 2;
}

/* 左側表頭固定 */
.grid tbody th {
    position: sticky;
    left: 0;
    background: #e8f0fa;
    z-index: 1;
}

/* 左上角同時固定,z-index 要最高 */
.grid thead th:first-child { z-index: 3; }

/* 捲動容器 */
.grid-wrap {
    max-height: 400px;
    max-width: 800px;
    overflow: auto;
}
</style>

<div class="grid-wrap">
    <!-- 表格放在這裡 -->
</div>

用 position: sticky 搭配真正的 <table>,可以同時做到上方表頭固定、左側表頭固定、左上角也固定,三個方向一次解決,而且完全不需要 JavaScript。表格語意正確,螢幕閱讀器能正常朗讀,scope 屬性明確標示了表頭與資料的對應關係。

讀取資料也不需要自製 getData():

function readTable(table) {
    return Array.from(table.tBodies[0].rows).map(function (row) {
        return Array.from(row.cells).map(function (cell) {
            return cell.textContent.trim();       // 回傳真正的陣列,不必再 split 字串
        });
    });
}

回傳二維陣列而非「逗號分隔的字串」,呼叫端不必再處理「欄位值本身含逗號」的引號轉義問題——這正是自製 getData() 那種設計最脆弱的地方。

總結來說,這個自製元件在當時是合理且有效的選擇,而它教會我們的事情——組態物件化的 API 設計、表頭與資料分離的結構思路——今天仍然適用。只是實作層面,瀏覽器與 CSS 已經提供了更強大的原生能力。

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