DIV CSS 佈局教程網

JS Range 完整指南:文字選取、跨瀏覽器處理與應用
編輯:關於JavaScript     

本文围绕「區域範圍物件(Range objects)」這個概念展開。它能讓你選取HTML文件的任意部分,並對這些選取的內容做各種處理。其中,最常見的 Range 就是使用者用滑鼠選中的文字(user selection)。

文章有相當篇幅在說明如何把使用者的選取轉換為 W3C Range 或 Microsoft Text Range 物件。

一、什麼是 Range

簡單說,Range 就是HTML文件中任意一段內容。它的起點與終點位置可以任意指定,甚至可以兩點相同(形成空 Range)。最常見的 Range 是使用者文字選取範圍——當使用者在頁面上選了一段文字,你就可以把這個選取轉為 Range。當然,你也可以直接用程式定義 Range。

看個例子:

2011-04-12 負責調查切爾諾貝利核事故對人與環境造成影響的俄科學家亞布羅科夫博士指出,
因福島核電站使用的燃料較切爾諾貝利核電站多,且有反應堆使用了含有高毒性的钚的燃料,
因此"福島核電站事故可能會比切爾諾貝利帶來更嚴重的後果"。

假設粗體那部分是使用者選中的,這段文字就可以轉換成 Range 物件。透過 Range 物件,你能找到起點與終點,也能刪除、複製這些內容,或用其他文字甚至HTML片段替換它。

上面是最簡單的例子,因為只包含文字。實際上 Range 也可以包含HTML程式碼:

<time>2011-04-12</time>
<p>據日本廣播協會電視台12日報道,日本經濟產業省原子能安全保安院決定將福島第一核電站核洩漏事故等級提高至7級。這使日本核洩漏事故等級與蘇聯切爾諾貝利核電站核洩漏事故等級相同。</p>
<p>負責調查切爾諾貝利核事故對人與環境造成影響的俄科學家亞布羅科夫博士指出,因福島核電站使用的燃料較切爾諾貝利核電站多,且有反應堆使用了含有高毒性的钚的燃料,因此"福島核電站事故可能會比切爾諾貝利帶來更嚴重的後果"。</p>

此時 Range 物件被建立且包含HTML,但問題來了:選取的內容正好跨過了標籤邊界。若純粹照選取範圍截取,會得到:

洩漏事故等級與蘇聯切爾諾貝利核電站核洩漏事故等級相同。</p> <p>負責調查切爾諾貝

這段HTML顯然是無效的——有閉合標籤卻沒有對應的開啟標籤。所幸所有瀏覽器都會自動調整HTML片段使其有效,變成:

<p>洩漏事故等級與蘇聯切爾諾貝利核電站核洩漏事故等級相同。</p>
<p>負責調查切爾諾貝</p>

也就是說,瀏覽器會自動補上必要數量的標籤讓 Range 保持有效。因此你複製或移動 Range 時,得到的HTML內容一定是合法的。

二、三種 Range 物件與瀏覽器相容性

在真正動手寫JavaScript之前,得先知道相容性的全貌。麻煩的是歷史上存在過三種類似 Range 的物件,且都有必要理解。

支援   不支援   部分支援

1. W3C Range

這是唯一的官方標準,把 Range 視為包含DOM的文件片段。在IE6/7中完全不支援,Firefox 2、Safari 1.3、Opera 9 則大致支援,主要方法包含:

  • cloneContents():用法如 docFrag = rangeObject.cloneContents(),把 Range 內容克隆到文件片段並回傳。Safari 下有個問題:若選取範圍為空,會回傳 null 而非空文件片段,可用 docFrag = rangeObject.cloneContents() || document.createDocumentFragment() 修復。
  • deleteContents():永久刪除 Range 內容,無回傳值。
  • extractContents():用法如 docFrag = rangeObject.extractContents(),從DOM樹上剪切 Range 並回傳文件片段,該片段可貼回頁面。
  • startContainer / endContainer:選取內容起始與結束處的容器節點,通常是文字節點。
  • startOffset / endOffset:起訖位置在容器中的偏移。Opera 在選取內容為空時會回傳 0。
  • cloneRange()、collapse()、collapsed、commonAncestorContainer、compareBoundaryPoints()、insertNode()、selectNode()、selectNodeContents()、setEnd()、setStart() 等。

2. Mozilla Selection

這個物件的存在主要是為了向後相容 Netscape 4,它同樣基於DOM樹,概念上與 W3C Range 相似。除了IE之外的所有瀏覽器都支援它。主要成員包含:

  • anchorNode / anchorOffset:用法如 userSelection.anchorNode,定義選取的起始位置,通常是文字節點。Opera 在選取為空時回傳 0。
  • focusNode / focusOffset:用法如 userSelection.focusNode,定義選取的結束位置。
  • getRangeAt():用法如 rangeObject = userSelection.getRangeAt(0),作用是把 Mozilla Selection 轉換為 W3C Range。索引通常從0開始。
  • addRange()、collapseToEnd()、collapseToStart()、rangeCount、removeAllRanges()、removeRange()、selectAllChildren()、isCollapsed 等。

3. Microsoft Text Range

這就與前兩者差別很大了——它是基於字串的,而非基於DOM節點。事實上,Text Range 包含的字串很難直接跳變成DOM節點。只有IE支援它,主要成員包含:

  • text:用法如 string = userSelection.text,回傳 Text Range 的文字內容,相當於 innerText,可讀可寫。
  • htmlText:用法如 htmlString = userSelection.htmlText,回傳 HTML 內容,相當於 innerHTML,唯讀。
  • pasteHTML():貼上HTML時,若目標是文字節點,該節點會自動分隔。
  • boundingHeight、boundingLeft、boundingTop、boundingWidth、offsetLeft、offsetTop:位置與尺寸資訊。
  • collapse()、compareEndPoints()、duplicate()、expand()、findText()、move()、moveEnd()、moveStart()、moveToElementText()、moveToPoint()、parentElement()、scrollIntoView()、select() 等。

總結對照

物件IE 6/7Firefox 2Safari 1.3Opera 9基礎
W3C Range不支援支援支援支援DOM 文件片段,官方標準
Mozilla Selection不支援支援部分支援支援DOM 樹,為相容 Netscape 4 而生
Microsoft Text Range支援不支援不支援部分支援字串為基礎

老實說,Mozilla Selection 有點像是打醬油的角色,它存在的意義主要是向後相容 Netscape 4。它唯一的閃光點是能直接把使用者選的任何內容變成完整的 Range 物件;但諷刺的是,除了IE之外的瀏覽器都支援它。

三、取得使用者選取的內容

var userSelection;
if (window.getSelection) {          // 現代瀏覽器
    userSelection = window.getSelection();
} else if (document.selection) {    // IE瀏覽器
    userSelection = document.selection.createRange();
}

由於相容性問題,IE吃IE的包子,其他瀏覽器吃Mozilla的饅頭。在Mozilla、Safari、Opera下,userSelection 是個 Selection 物件;在IE下則是 Text Range 物件。這個差異會影響後續所有腳本——IE的 Text Range 與 Mozilla Selection、W3C Range 完全不同,你需要分別為IE和其他瀏覽器寫兩套程式碼。

這裡有個順序上必須注意的地方:window.getSelection 要放在前面。原因在于Opera同時支援兩種物件——若用 window.getSelection() 讀取,Opera會建立 Selection 物件;若用 document.selection,則會建立 Text Range 物件。由於Opera對 Mozilla Selection 與 W3C Range 的支持相當好,對 Microsoft Text Range 卻差強人意,所以顯然該優先走標準路線。

四、讀取選取的文字內容

此時 userSelection 要麼是 Mozilla Selection,要麼是 Microsoft Text Range。Mozilla Selection 可以直接轉字串:

alert(userSelection);
// 洩漏事故等級與蘇聯切爾諾貝利核電站核洩漏事故等級相同。負責調查切爾諾貝

雖然它不是字串型別,但現代瀏覽器仍會自動呼叫 toString 輸出內容。而IE的 Text Range 則需要用 userSelection.text。要寫出通用程式碼:

var selectedText = userSelection;
if (userSelection.text) {
    selectedText = userSelection.text;
}

現在 selectedText 就包含了使用者選取的文字。

五、從 Selection 建立 Range 物件

在IE下 userSelection 是 Text Range,在現代瀏覽器下則是 Selection 物件。要建立一個內容相同的 Range:

var getRangeObject = function (selectionObject) {
    if (selectionObject.getRangeAt)
        return selectionObject.getRangeAt(0);
    else { // 較舊版本的 Safari
        var range = document.createRange();
        range.setStart(selectionObject.anchorNode, selectionObject.anchorOffset);
        range.setEnd(selectionObject.focusNode, selectionObject.focusOffset);
        return range;
    }
}
var rangeObject = getRangeObject(userSelection);

理想情況下,透過 Selection 的 getRangeAt() 就能取得 W3C Range。這個方法回傳指定索引的 Range,JavaScript中第一個 Range 的索引值是0。

用程式手動建立 Range

Safari 1.3 不支援 getRangeAt(),因此若要相容該版本就得手動建立:

var range = document.createRange();

這行建立一個空 Range,接著需要用 setStart() 與 setEnd() 定義起訖點。這兩個方法都需要兩個參數:

  1. Range 起訖所在的 DOM 節點
  2. Range 起訖的文字偏移量(選取文字第一個與最後一個字元在文字節點中的位置)

這兩個參數分別對應 startContainer/startOffset 與 endContainer/endOffset。

舉個例子,假設有以下結構:

<p>男人,即使到了50歲,也千萬不要碰超過26歲還沒有結婚的女人。...</p>
<p>婚姻市場未來的變化將會是很有趣的問題...</p>

<ol>
    <li>為什麼是26這個準確的數字?</li>
    <li>找罵帖</li>
    <li>言論是對的,在100年前,lz穿越了而已。</li>
</ol>

此處 Range 開始於第二個 <p> 節點,結束於第一個 <li> 節點。若 <p> 處的文字偏移是8、<li> 處是5,則:

var startP = [the p node];
var endLi = [the second li node];
range.setStart(startP, 8);
range.setEnd(endLi, 5);

但實務上你幾乎不可能準確知道使用者選取文字的起始位置,所以這種硬寫偏移值的方式限制很大。好在 Range 物件有四個屬性可以用來定義起訖點,對應 Selection 的命名:

range.setStart(selectionObject.anchorNode, selectionObject.anchorOffset);
range.setEnd(selectionObject.focusNode, selectionObject.focusOffset);

Safari 的歷史包袱可以放下了

如果只是為了相容低版本的Safari而特地用程式建立 Range,其實沒什麼必要。Safari 老早就支援 getRangeAt() 了,Chrome 也是如此。因此在當前環境下,把 Selection 轉成 Range 直接這樣寫即可:

var userSelection, rangeObject;
if (window.getSelection) {
    // 現代瀏覽器
    userSelection = window.getSelection();
} else if (document.selection) {
    // IE瀏覽器(考量到 Opera,應放在後面)
    userSelection = document.selection.createRange();
}

// Range 物件
rangeObject = userSelection;
if (userSelection.getRangeAt) {
    // 現代瀏覽器
    rangeObject = userSelection.getRangeAt(0);
}

六、rangy:一個跨瀏覽器的 Range & Selection 函式庫

專案網址:https://code.google.com/p/rangy/

rangy 曾更新到 1.1 版,作者也補上了幾個展示API、方法與屬性的範例頁面。不過由於範例數量偏少,仍不太容易看出實際用法,以下舉兩個簡單例子。

範例一:取得使用者選取的文字

var sel = rangy.getSelection();
alert(sel.toString());

範例二:為選取的文字加上背景

選中頁面上的一段文字後讓它失去焦點,文字後面就會出現背景圖:

<script type="text/javascript" src="https://www.zhangxinxu.com/study/201104/rangy/rangy-core.js"></script>
<script type="text/javascript" src="https://www.zhangxinxu.com/study/201104/rangy/rangy-cssclassapplier.js"></script>
<script>
var cssApplier;
window.onload = function () {
    rangy.init();
    cssApplier = rangy.createCssClassApplier("selectClass", true);
    document.body.onmouseup = function () {
        cssApplier.toggleSelection();
    };
};
</script>

值得一提的是,這個外掛未壓縮時達115K,就實際專案的效益來看體積偏大,導入前值得評估。

七、實際應用:微博插入話題

先前折騰過「在文字框游標處插入文字並選中」的功能,當時參考的是新浪微博的範例。不過舊版實作有幾個明顯不足:

  1. 選中的普通文字無法作為話題插入
  2. 話題只能插在文字框最後,而非游標所在位置
  3. 預設的話題文字可以重複插入

藉這個機會正好把功能補齊。大致效果如下:

完整程式碼因篇幅因素不在此列出,可在展示頁面中查看完整的 CSS/HTML/JS。JS部分做了半封裝處理,有興趣的話可以在外面包一層函式使其外掛化。

八、結語

老實說,直到現在我對 Range 相關知識仍是半生不熟,所以本文比較接近翻譯性質的整理,並非建立在深入理解之上再淺顯剖析,有些地方讀起來想必不夠順暢。

文中展示的相容性表格數據都是多年前、還是 Safari 1.3 時代的資料,實用價值已大打折扣。可以補充的是,先前現代瀏覽器不支援的個別屬性,如今多半早已支援。

文章難免有表述不準確之處,歡迎指正,也歡迎回報相關腳本的問題。

參考資料

  1. Introduction to Range
  2. W3C DOM Compatibility – Range
  3. rangy – A cross-browser JavaScript range and selection library
  4. Reveal a Background Image upon Text Selection
XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved