DIV CSS 佈局教程網

為 jQuery 擴充文字區域游標操作:選取、插入、刪除、取值
編輯:JQuery特效代碼     

在 textarea 裡做「插入表情」「包住選取文字」「刪除前 n 個字」這類操作,是聊天室與編輯器很常遇到的需求。以下把這些行為包成六個 jQuery 擴充方法,一次搞定,並處理了 IE 與非 IE 的游標 API 差異。

一、提供的方法與用法

  • 取得游標位置:$(elem).iGetFieldPos()
  • 設定游標位置:$(elem).iSelectField(start)
  • 選取指定範圍內的文字:$(elem).iSelectField(start, end)
  • 選取指定的字串:$(elem).iSelectStr(str)
  • 在游標之後插入字串:$(elem).iAddField(str)
  • 刪除游標前面(-n)或後面(n)的 n 個字:$(elem).iDelField(n)

二、擴充程式碼

;(function($){
  /**
   * 文字區域游標操作(選、添、刪、取)的 jQuery 擴充
   */
  $.fn.extend({

    // 取得游標所在位置
    iGetFieldPos: function(){
      var field = this.get(0);
      if(document.selection){
        // IE:靠 selection 與 TextRange 反推位置
        $(this).focus();
        var sel = document.selection;
        var range = sel.createRange();
        var dupRange = range.duplicate();
        dupRange.moveToElementText(field);
        dupRange.setEndPoint('EndToEnd', range);
        field.selectionStart = dupRange.text.length - range.text.length;
        field.selectionEnd   = field.selectionStart + range.text.length;
      }
      return field.selectionStart;
    },

    // 選取指定範圍內字元,或單純設定游標位置
    // 從 start(含)選到 end(不含);不傳 end 即視為設定游標
    iSelectField: function(start, end){
      var field = this.get(0);
      if(arguments[1] == undefined){ end = start; }

      if(document.selection){
        // IE
        var range = field.createTextRange();
        range.moveEnd('character', -$(this).val().length);
        range.moveEnd('character', end);
        range.moveStart('character', start);
        range.select();
      } else {
        // 非 IE:標準 API
        field.setSelectionRange(start, end);
        $(this).focus();
      }
    },

    // 選取指定字串
    iSelectStr: function(str){
      var i = $(this).val().indexOf(str);
      i != -1 ? $(this).iSelectField(i, i + str.length) : false;
    },

    // 在游標之後插入字串
    iAddField: function(str){
      var field = this.get(0);
      var v = $(this).val();
      var len = v.length;

      if(document.selection){
        // IE
        $(this).focus();
        document.selection.createRange().text = str;
      } else {
        // 非 IE:以 slice 重組字串,再把游標移到插入內容之後
        var selPos = field.selectionStart;
        $(this).val(v.slice(0, field.selectionStart) + str + v.slice(field.selectionStart, len));
        this.iSelectField(selPos + str.length);
      }
    },

    // 刪除游標前面(-)或後面(+)的 n 個字
    iDelField: function(n){
      var field = this.get(0);
      var pos = $(this).iGetFieldPos();
      var v = $(this).val();
      // n > 0 刪後面,n < 0 刪前面
      $(this).val(n > 0 ? v.slice(0, pos - n) + v.slice(pos)
                         : v.slice(0, pos) + v.slice(pos - n));
      $(this).iSelectField(pos - (n < 0 ? 0 : n));
    }

  });
})(jQuery);

三、使用範例

// 取得游標位置
var pos = $('#msg').iGetFieldPos();

// 在游標處插入 BBCode,並把游標移到標記之後
$('#msg').iAddField('[b][/b]');

// 把游標前 3 個字刪掉
$('#msg').iDelField(-3);

// 選取畫面中出現的「你好」兩個字
$('#msg').iSelectStr('你好');

四、幾個實作要點

  • 跨瀏覽器的兩套 API:標準瀏覽器用 selectionStart/setSelectionRange();舊版 IE 則要透過 document.selection 與 TextRange 的 moveStart/moveEnd 反推位置。程式碼裡以 document.selection 是否存在來分流。
  • 插入後要重設游標:直接改 value 會讓游標跳到尾端,所以插入完成後必須再呼叫一次 iSelectField 把游標放回正確位置,使用者才能連續輸入。
  • 選取範圍是「左閉右開」:iSelectField(start, end) 選到 end 的前一個字元,這與 substring 的慣例一致,比較不容易出錯。
  • 現代替代方案:目前主流瀏覽器都支援標準 API,IE 分支實際上已可移除。另外若要處理「選取文字後插入」這類進階需求,也可用 document.execCommand('insertText')(雖已棄用但相容性仍佳),它能保留使用者的 undo 紀錄,體驗更好。
XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved