DIV CSS 佈局教程網

仿 iGoogle 的首頁模塊拖拽:布局、位置持久化與虛線預演
編輯:JavaScript綜合知識     

iGoogle 那種「首頁模塊可以隨意拖動排布,刷新後位置還在」的體驗,背後其實是幾個技術點的組合:多列布局、拖拽時的插入位置預演、以及用 Cookie 保存布局。這個示例把三者完整實現了一遍。

整體結構

頁面主體是一個三列表格,每列裡放若干 class="dragDiv" 的模塊,每個模塊有自己的標題欄(id="titleBarN")與內容區。拖拽的抓手就是標題欄。

通用工具層:Common 對象

示例首先封裝了一組跨瀏覽器工具函數,這部分很值得借鑑:

var Common = {
  // 兼容 IE 與 Firefox 地取得事件對象
  getEvent: function() {
    if (document.all) { return window.event; }
    func = getEvent.caller;
    while (func != null) {
      var arg0 = func.arguments[0];
      if (arg0) {
        if ((arg0.constructor == Event || arg0.constructor == MouseEvent) ||
            (typeof(arg0) == "object" && arg0.preventDefault && arg0.stopPropagation)) {
          return arg0;
        }
      }
      func = func.caller;
    }
    return null;
  },

  // 取得鼠標在文檔中的坐標,兼容 pageX/Y 與 clientX/Y + scroll 兩套模型
  getMousePos: function(ev) {
    if (!ev) { ev = this.getEvent(); }
    if (ev.pageX || ev.pageY) {
      return { x: ev.pageX, y: ev.pageY };
    }
    if (document.documentElement && document.documentElement.scrollTop) {
      return {
        x: ev.clientX + document.documentElement.scrollLeft - document.documentElement.clientLeft,
        y: ev.clientY + document.documentElement.scrollTop  - document.documentElement.clientTop
      };
    } else if (document.body) {
      return {
        x: ev.clientX + document.body.scrollLeft - document.body.clientLeft,
        y: ev.clientY + document.body.scrollTop  - document.body.clientTop
      };
    }
  },

  // 累加 offsetParent 得到元素在文檔中的絕對坐標
  getElementPos: function(el) {
    el = this.getItself(el);
    var _x = 0, _y = 0;
    do {
      _x += el.offsetLeft;
      _y += el.offsetTop;
    } while (el = el.offsetParent);
    return { x: _x, y: _y };
  },

  getItself: function(id) {
    return "string" == typeof id ? document.getElementById(id) : id;
  },

  getViewportSize: {
    w: (window.innerWidth) ? window.innerWidth
     : (document.documentElement && document.documentElement.clientWidth)
     ? document.documentElement.clientWidth
     : (document.body ? document.body.offsetWidth : 0),
    h: (window.innerHeight) ? window.innerHeight
     : (document.documentElement && document.documentElement.clientHeight)
     ? document.documentElement.clientHeight
     : (document.body ? document.body.offsetHeight : 0)
  },

  isIE: document.all ? true : false,

  firstChild: function(parentObj, tagName) {
    if (Common.isIE) { return parentObj.firstChild; }
    else {
      var arr = parentObj.getElementsByTagName(tagName);
      return arr[0];
    }
  },

  lastChild: function(parentObj, tagName) {
    if (Common.isIE) { return parentObj.lastChild; }
    else {
      var arr = parentObj.getElementsByTagName(tagName);
      return arr[arr.length - 1];
    }
  },

  setCookie: function(name, value) {
    document.cookie = name + "=" + value;
  },

  getCookie: function(name) {
    var arrCookie = document.cookie.split("; ");
    for (var i = 0; i < arrCookie.length; i++) {
      var arr = arrCookie[i].split("=");
      if (!arr[1]) { return ""; }
      if (arr[0] == name) { return arr[1]; }
    }
    return "";
  }
};

// 極簡的類工廠
var Class = {
  create: function() {
    return function() { this.init.apply(this, arguments); };
  }
};

拖拽對象:Drag

Drag 的構造函數接受三個參數:抓手元素、被拖動元素、可選配置(透明度與拖拽邊界)。

var Drag = Class.create();
Drag.prototype = {
  init: function(titleBar, dragDiv, Options) {
    titleBar = Common.getItself(titleBar);
    dragDiv  = Common.getItself(dragDiv);

    this.dragArea = { maxLeft: -9999, maxRight: 9999, maxTop: -9999, maxBottom: 9999 };

    if (Options) {
      // 拖動時的透明度,默認 60
      this.opacity = Options.opacity
        ? (isNaN(parseInt(Options.opacity)) ? 100 : parseInt(Options.opacity))
        : 60;
      if (Options.area) {
        if (Options.area.left   && !isNaN(parseInt(Options.area.left)))   { this.dragArea.maxLeft   = Options.area.left; }
        if (Options.area.right  && !isNaN(parseInt(Options.area.right)))  { this.dragArea.maxRight  = Options.area.right; }
        if (Options.area.top    && !isNaN(parseInt(Options.area.top)))    { this.dragArea.maxTop    = Options.area.top; }
        if (Options.area.bottom && !isNaN(parseInt(Options.area.bottom))) { this.dragArea.maxBottom = Options.area.bottom; }
      }
    }

    this.moveable = false;
    this.dragArray = [];

    var dragObj = this;
    var dragTbl = document.getElementById("dragTable");

    titleBar.onmousedown = function(e) {
      var ev = e || window.event || Common.getEvent();

      // 只允許左鍵拖拽(IE 左鍵為 1,Firefox 為 0)
      if (Common.isIE && ev.button == 1 || !Common.isIE && ev.button == 0) {
      } else { return false; }

      // 找到被拖元素當前所在的列
      var tmpColId;
      for (c = 0; c < dragTbl.rows[0].cells.length; c++) {
        for (k = 0; k < dragTbl.rows[0].cells[c].getElementsByTagName("DIV").length; k++) {
          if (dragDiv.id == dragTbl.rows[0].cells[c].getElementsByTagName("DIV")[k].id) {
            tmpColId = c; break;
          }
        }
      }

      // 記錄該列首末元素的位置,用於處理「拖到列外又回到原列頭尾」的特殊情況
      var tmpPosFirstChild = Common.getElementPos(Common.firstChild(dragTbl.rows[0].cells[tmpColId], "DIV"));
      var tmpPosLastChild  = Common.getElementPos(Common.lastChild(dragTbl.rows[0].cells[tmpColId], "DIV"));
      var tmpObj = {
        colId: tmpColId,
        firstChildUp: tmpPosFirstChild.y,
        lastChildDown: tmpPosLastChild.y
                   + Common.lastChild(dragTbl.rows[0].cells[tmpColId], "DIV").offsetHeight
      };

      // 保存當前所有可拖拽容器的位置,供碰撞檢測使用
      dragObj.dragArray = dragObj.RegDragsPos();

      // 插入虛線框作為「將要插入的位置」預演
      var dashedElement = document.createElement("div");
      dashedElement.style.cssText = dragDiv.style.cssText;
      dashedElement.style.border = " dashed 2px #aaa ";
      dashedElement.style.marginBottom = "6px";
      // 減去 border 寬度,使虛線框尺寸與原元素一致
      dashedElement.style.width  = dragDiv.offsetWidth  - 2 * parseInt(dashedElement.style.borderWidth) + "px";
      dashedElement.style.height = dragDiv.offsetHeight - 2 * parseInt(dashedElement.style.borderWidth) + "px";
      dashedElement.style.position = "relative";

      if (dragDiv.nextSibling) {
        dragDiv.parentNode.insertBefore(dashedElement, dragDiv.nextSibling);
      } else {
        dragDiv.parentNode.appendChild(dashedElement);
      }

      // 拖動時改為 absolute 脫離文檔流
      dragDiv.style.width = dragDiv.offsetWidth + "px";
      dragDiv.style.position = "absolute";

      dragObj.moveable = true;
      dragDiv.style.zIndex = dragObj.GetZindex() + 1;

      var downPos = Common.getMousePos(ev);
      dragObj.tmpX = downPos.x - dragDiv.offsetLeft;
      dragObj.tmpY = downPos.y - dragDiv.offsetTop;

      if (Common.isIE) { dragDiv.setCapture(); }
      else             { window.captureEvents(Event.mousemove); }

      dragObj.SetOpacity(dragDiv, dragObj.opacity);

      // Firefox 下防止拖動時誤拖圖片
      if (ev.preventDefault) { ev.preventDefault(); ev.stopPropagation(); }

      document.onmousemove = function(e) {
        if (!dragObj.moveable) return;
        var ev = e || window.event || Common.getEvent();
        if (document.all) { ev.returnValue = false; }

        var movePos = Common.getMousePos(ev);
        dragDiv.style.left = Math.max(Math.min(movePos.x - dragObj.tmpX, dragObj.dragArea.maxRight), dragObj.dragArea.maxLeft) + "px";
        dragDiv.style.top  = Math.max(Math.min(movePos.y - dragObj.tmpY, dragObj.dragArea.maxBottom), dragObj.dragArea.maxTop) + "px";

        // 碰撞檢測:鼠標落在哪個同層元素的上/下半區,虛線框就移到它前面/後面
        var targetDiv = null;
        for (var k = 0; k < dragObj.dragArray.length; k++) {
          if (dragDiv == dragObj.dragArray[k]) { continue; }

          if (movePos.x > dragObj.dragArray[k].PosLeft
           && movePos.x < dragObj.dragArray[k].PosLeft + dragObj.dragArray[k].PosWidth
           && movePos.y > dragObj.dragArray[k].PosTop
           && movePos.y < dragObj.dragArray[k].PosTop  + dragObj.dragArray[k].PosHeight) {

            targetDiv = document.getElementById(dragObj.dragArray[k].DragId);

            if (movePos.y < dragObj.dragArray[k].PosTop + dragObj.dragArray[k].PosHeight / 2) {
              // 插到目標前面
              dashedElement.style.width = targetDiv.offsetWidth - 2 * parseInt(dashedElement.style.borderWidth) + "px";
              targetDiv.parentNode.insertBefore(dashedElement, targetDiv);
            } else {
              // 插到目標後面
              dashedElement.style.width = targetDiv.offsetWidth - 2 * parseInt(dashedElement.style.borderWidth) + "px";
              if (targetDiv.nextSibling) {
                targetDiv.parentNode.insertBefore(dashedElement, targetDiv.nextSibling);
              } else {
                targetDiv.parentNode.appendChild(dashedElement);
              }
            }
          }
        }

        // 跨列移動:判斷鼠標落在哪一列,處理空列與列的首尾插入
        for (j = 0; j < dragTbl.rows[0].cells.length; j++) {
          var startLeft = Common.getElementPos(dragTbl.rows[0].cells[j]).x;
          if (movePos.x > startLeft && movePos.x < startLeft + dragTbl.rows[0].cells[j].offsetWidth) {

            if (dragTbl.rows[0].cells[j].getElementsByTagName("div").length == 0) {
              // 空列:直接放入
              dashedElement.style.width = dragTbl.rows[0].cells[j].offsetWidth - 2 * parseInt(dashedElement.style.borderWidth) + "px";
              dragTbl.rows[0].cells[j].appendChild(dashedElement);
            } else {
              var posFirstChild = Common.getElementPos(Common.firstChild(dragTbl.rows[0].cells[j], "DIV"));
              var posLastChild  = Common.getElementPos(Common.lastChild(dragTbl.rows[0].cells[j], "DIV"));

              var tmpUp, tmpDown;
              if (tmpObj.colId == j) {          // 回到原列時用先前記錄的值
                tmpUp = tmpObj.firstChildUp;
                tmpDown = tmpObj.lastChildDown;
              } else {
                tmpUp = posFirstChild.y;
                tmpDown = posLastChild.y
                        + Common.lastChild(dragTbl.rows[0].cells[j], "DIV").offsetHeight;
              }

              if (movePos.y < tmpUp) {
                // 插到該列最上面
                dashedElement.style.width = Common.firstChild(dragTbl.rows[0].cells[j], "DIV").offsetWidth - 2 * parseInt(dashedElement.style.borderWidth) + "px";
                dragTbl.rows[0].cells[j].insertBefore(dashedElement, Common.firstChild(dragTbl.rows[0].cells[j], "DIV"));
              } else if (movePos.y > tmpDown) {
                // 插到該列最下面
                dashedElement.style.width = Common.lastChild(dragTbl.rows[0].cells[j], "DIV").offsetWidth - 2 * parseInt(dashedElement.style.borderWidth) + "px";
                dragTbl.rows[0].cells[j].appendChild(dashedElement);
              }
            }
          }
        }
      };

      document.onmouseup = function() {
        if (dragObj.moveable) {
          if (Common.isIE) { dragDiv.releaseCapture(); }
          else             { window.releaseEvents(dragDiv.mousemove); }

          dragObj.SetOpacity(dragDiv, 100);
          dragObj.moveable = false;
          dragObj.tmpX = 0;
          dragObj.tmpY = 0;

          // 必須寫在這個 if 內
          dragDiv.style.left = "";
          dragDiv.style.top  = "";

          dragDiv.style.width = "";
          dragDiv.style.position = "";

          // 把元素真正放到虛線框所在的位置
          dashedElement.parentNode.insertBefore(dragDiv, dashedElement);
          dashedElement.parentNode.removeChild(dashedElement);
        }
      };
    };
  },

  SetOpacity: function(dragDiv, n) {
    if (Common.isIE) { dragDiv.filters.alpha.opacity = n; }
    else             { dragDiv.style.opacity = n / 100; }
  },

  GetZindex: function() {
    var maxZindex = 0;
    var divs = document.getElementsByTagName("div");
    for (z = 0; z < divs.length; z++) {
      maxZindex = Math.max(maxZindex, divs[z].style.zIndex);
    }
    return maxZindex;
  },

  // 收集所有可拖拽元素的當前位置與尺寸
  RegDragsPos: function() {
    var arrDragDivs = new Array();
    var dragTbl = document.getElementById("dragTable");
    var tmpDiv, tmpPos;
    for (i = 0; i < dragTbl.getElementsByTagName("div").length; i++) {
      tmpDiv = dragTbl.getElementsByTagName("div")[i];
      if (tmpDiv.className == "dragDiv") {
        tmpPos = Common.getElementPos(tmpDiv);
        arrDragDivs.push({
          DragId: tmpDiv.id, PosLeft: tmpPos.x, PosTop: tmpPos.y,
          PosWidth: tmpDiv.offsetWidth, PosHeight: tmpDiv.offsetHeight
        });
      }
    }
    return arrDragDivs;
  }
};

位置持久化:Cookie 存布局

頁面加載時讀取 Cookie,按記錄的順序把元素重新 append 到對應列;卸載時反向收集當前的排列並寫回:

window.onload = function() {
  var dragTbl = document.getElementById("dragTable");

  // 恢復上次的布局
  if (Common.getCookie("configArr")) {
    var configArr = eval("(" + Common.getCookie("configArr") + ")");
    for (i = 0; i < dragTbl.rows[0].cells.length; i++) {
      for (j = 0; j < configArr[i].length; j++) {
        dragTbl.rows[0].cells[i].appendChild(document.getElementById(configArr[i][j]));
      }
    }
  }

  new Drag("titleBar1", "dragDiv1");
  new Drag("titleBar2", "dragDiv2");
  new Drag("titleBar3", "dragDiv3");
  new Drag("titleBar4", "dragDiv4");
  new Drag("titleBar5", "dragDiv5");
};

window.onunload = function() {
  var dragTbl = document.getElementById("dragTable");
  var configArr = "";
  for (i = 0; i < dragTbl.rows[0].cells.length; i++) {
    var tmpStr = "";
    for (j = 0; j < dragTbl.rows[0].cells[i].getElementsByTagName("DIV").length; j++) {
      tmpStr += (tmpStr == "" ? "" : ",") + "'"
              + dragTbl.rows[0].cells[i].getElementsByTagName("DIV")[j].id + "'";
    }
    configArr += (configArr == "" ? "" : ",") + "[" + tmpStr + "]";
  }
  // 最終格式形如:[['dragDiv3','dragDiv5'],['dragDiv4','dragDiv1'],['dragDiv2']]
  Common.setCookie("configArr", "[" + configArr + "]");
};

幾個值得學習的設計要點

虛線框預演是這個組件的精華。拖拽過程中並不真的移動 DOM,而是移動一個虛線佔位符,鼠標位置決定它插在哪裡;只在 mouseup 時才把真實元素放到佔位符位置。這樣做的好處是:DOM 不會被頻繁重排、拖拽期間布局穩定、用戶還能預先看到落點。這比「拖著元素到處跑,鬆手後再吸附」的體驗好得多。

碰撞檢測用「上半區/下半區」判斷前後。鼠標落在目標元素的上半部就插到它前面,落在下半部就插到後面,這是所有列表排序組件的通用判定法。

脫離文檔流是拖拽的前提。被拖元素改為 position:absolute 後才不會參與布局計算,鬆手後再還原樣式重新插入。

特殊的「回到原列頭尾」處理。因為拖動開始時元素已脫離文檔流,原列的首末元素發生了變化,若不提前記錄,拖回原列的最上方或最下方時會判斷失敗。示例用 tmpObj 快照解決了這個邊界情況,是個很細緻的考慮。

需要修正的地方

· 迴圈變量洩漏與未使用。document.onmousemove 內部有 if (dragDiv == dragObj.dragArray[i]),但迴圈變量是 k 而非 i,這是一個明確的 bug,會導致自身元素被納入碰撞檢測。上面引述時保留了原樣,實用時應改為 k。

· 用 eval 解析 Cookie。用 JSON.parse() 替代,既安全又更快;寫入時也應相應改用 JSON.stringify()。

· window.onunload 不可靠。該事件在移動端與部分現代瀏覽器中觸發時機並不確定。應改為在每次 mouseup 完成排序後立即保存,而非等到頁面卸載。

· Cookie 容量有限。每個域名通常只有 4KB 左右,模塊一多就會超限。此類布局數據更適合放 localStorage。

· Common.getEvent() 依賴 arguments.callee 與 caller,在嚴格模式下已禁用。現代寫法直接從事件回調的參數取 event 即可,根本不需要這套追溯。

· 用 table 做多列布局。現在應改用 Flexbox 或 Grid,配合 HTML5 的拖放 API(draggable 屬性 + dragstart/dragover/drop 事件)或成熟的排序庫(如 SortableJS),能省下絕大部分手工計算。

儘管實現年代久遠,這份代碼把「自定義分頁布局 + 拖拽排序 + 位置持久化」的完整鏈路走通了,其中虛線預演、碰撞檢測、脫流與還原的配合思路,放到今天用現代 API 重寫時依然適用。

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