xhEditor用法

xhEditor是一個基於jQuery開發的簡單迷你並且高效的在線可視化HTML編輯器，而且兼容很多瀏覽器，所以就選它了，具體使用如下：

1 、下載xhEditor 最新版本

下載地址：http://xheditor.com/download

2 、解壓壓縮文件 【demo 文件夾中可以查看各種形式的配置實例】，將其中的jquery- 1.4.2.min.js 、xheditor-zh-cn.min.js 【這里暫時使用中文版】以及 xheditor_emot、xheditor_plugins 和xheditor_skin 三個文件夾拷貝到項目的相應目錄。

3 、在相應html 文件的head 標簽結束之前添加： 
<script src="jquery-1.4.2.min.js"  type="text/javascript"></script>
<script src="xheditor-zh-cn.min.js"  type="text/javascript"></script>

4 、調用方法
　　方法1 

　　在textarea 上添加屬性： class="xheditor {skin:'default'}" ，前面主參數也可以是xheditor-mini 和xheditor-simple ，分別加載迷你和簡單工具欄，后面詳細參數可以省略。

　　方法2 【推薦使用】

　　在您的頁面初始JS 代碼里加上： $(“#helpInfo”).xheditor();

<script type="text/javascript">
  $(document).ready(function(){
    //初始化xhEditor編輯器插件
    $("#helpInfo").xheditor({
     　　tools:'simple',
     　　skin:'default',
     　　upMultiple:true,
     　　upImgUrl: '{editorRoot}/upload.jsp',
     　　upImgExt: "jpg,jpeg,gif,bmp,png",
     　　onUpload:insertUpload
    });
    //xbhEditor編輯器圖片上傳回調函數
    function insertUpload(msg) {
     　　var _msg = msg.toString();
     　　var _picture_name = _msg.substring(_msg.lastIndexOf("/")+1);
     　　var _picture_path = Substring(_msg);
     　　var _str = "<input type='checkbox' name='_pictures' value='"+_picture_path+"' checked='checked' onclick='return false'/><label>"+_picture_name+"</label><br/>";
     　　$("#helpInfo").append(_msg);
     　　//$("#uploadList").append(_str);
    }
    //處理服務器返回到回調函數的字符串內容,格式是JSON的數據格式.
    function Substring(s){
     　　return s.substring(s.substring(0,s.lastIndexOf("/")).lastIndexOf("/"),s.length);
    }
   });
  </script>

 

5、初始化參數列表

 

初始化參數示例代碼：

$('#elm1').xheditor({tools:'full',skin:'default',showBlocktag:true,internalScript:false,internalStyle:false,width:300,height:200,loadCSS:'http://xheditor.com/test.css',fullscreen:true,sourceMode:true,forcePtag:true,upImgUrl:"upload.php",upImgExt:"jpg,jpeg,gif,png"});

初始化參數列表：

1. tools：自定義工具按鈕

   參數值：full(完全),mfull(多行完全),simple(簡單),mini(迷你)
   或者自定義字符串，例如：'Cut,Copy,Paste,Pastetext,|,Source,Fullscreen,About'
   
   完整按鈕表：
   |：分隔符
   /：強制換行
   Cut：剪切
   Copy：復制
   Paste：粘貼
   Pastetext：文本粘貼
   Blocktag：段落標簽
   Fontface：字體
   FontSize：字體大小
   Bold：粗體
   Italic：斜體
   Underline：下划線
   Strikethrough：中划線
   FontColor：字體顏色
   BackColor：字體背景色
   SelectAll：全選
   Removeformat：刪除文字格式
   Align：對齊
   List：列表
   Outdent：減少縮進
   Indent：增加縮進
   Link：超鏈接
   Unlink：刪除鏈接
   Anchor：錨點
   Img：圖片
   Flash：Flash動畫
   Media：Windows media player視頻
   Hr：插入水平線
   Emot：表情
   Table：表格
   Source：切換源代碼模式
   Preview：預覽當前代碼
   Print：打印
   Fullscreen：切換全屏模式
   About：關於xhEditor

2. skin：皮膚風格選擇

   參數值：default(默認風格),o2007blue(Office 2007 藍色),o2007silver(Office 2007 銀色),vista(Vista),nostyle(NoStyle)

3. layerShadow：陰影的深度(按鈕面板和模式窗口的背景陰影)

   參數值：0(不顯示陰影),大於0的數值(顯示陰影並設置陰影的深度)

4. clickCancelDialog：點擊任意位置取消按鈕面板功能

   參數值：默認true(開啟點擊取消功能),false(關閉點擊取消功能，必需要點擊“取消”按鈕才能關閉按鈕面板)

5. showBlocktag：顯示段落標簽

   參數值：true(顯示段落標簽),false(不顯示)

6. linkTag：樣式鏈接link標簽保留狀態

   參數值：true(保留樣式鏈接link標簽),false(清理樣式鏈接link標簽)

7. internalScript：內部JS代碼保留狀態

   參數值：true(保留內部JS代碼),false(清理內部JS代碼)

8. inlineScript：內聯JS代碼保留狀態

   參數值：true(保留內聯JS代碼),false(清理內聯JS代碼)

9. internalStyle：內部樣式保留狀態

   參數值：true(保留內部樣式),false(清理內部樣式)

10. inlineStyle：內聯樣式保留狀態

    參數值：true(保留內聯樣式),false(清理內聯樣式)

11. width：編輯器寬度

    參數值：不帶單位的數字，例：300

12. height：編輯器高度

    參數值：不帶單位的數字，例：100

13. background：編輯器背景

    參數值：字符串，例：url(test.gif) no-repeat，設置編輯器背景，格式同CSS同名參數一致。建議直接設置textarea的css背景
    備注：v1.1.1新添加

14. loadCSS：加載樣式

    參數值：URL地址、URL數組以及直接內部樣式，例如：'1.css'、['1.css','2.css']、'<style>body{font-size:20px;}</style>'<br />備注：1.0.0 RC3新添加加載內部樣式功能

15. fullscreen：默認全屏顯示

    參數值：true(全屏大小),false(標准大小)

16. sourceMode：默認源代碼模式

    參數值：true(源代碼模式),false(編輯模式)

17. forcePtag：強制P標簽

    參數值：true(強制使用P標簽),false(不強制),默認true

18. cleanPaste：是否清理粘貼的HTML代碼

    參數：0(不做任何清理),1(簡單清理Word),2(深入清理Word),3(強制轉文本),默認為1簡單清理Word
    說明：若網站應用需要保留更多的Word樣式效果，請設置此值為1，不過產生的HTML代碼體積會大大增大
    備注：1.1.4版本中新變更，原為wordDeepClean和forcePasteText兩個參數

19. disableContextmenu：禁用編輯區的右鍵菜單

    參數值：true(禁用右鍵菜單),false(不禁用),默認false
    備注：v1.1.0新添加

20. editorRoot：編輯器JS文件所在的根路徑

    參數值：編輯器所在的根路徑，用在某些特殊情況下定位編輯器的根路徑，默認為空，讀取默認的編輯器根路徑
    備注：v1.1.0新添加

21. shortcuts：自定義鍵盤快捷方式

    參數：快捷鍵對應事件代碼的對象數組
    示例：{'ctrl+enter':function(){$('#frmTest').submit();}}
    備注：1.0.0 beta2新添加

22. urlBase：相對URL地址的基地址

    參數：字符串的URL地址，用以解決前后台不在同一路徑的資源定位問題
    備注：1.1.0新添加

23. urlType：本地URL地址強制轉換方式選擇

    參數：abs(絕對路徑),root(根路徑),rel(相對路徑)
    備注：1.0.0 beta2新添加,v1.1.0版中名字由localUrl變更為urlType

24. emotPath：修改表情圖片的URL根路徑

    參數：字符串的URL地址，默認為空，指向編輯器路徑下的默認表情
    備注：1.1.0新添加

25. emotMark：是否在表情img標簽上標注emot屬性

    參數：true(標注),false(不標注),默認為false
    說明：若使用了ubb插件，請設置此屬性為true
    備注：1.0.0 beta2新添加

26. emots：添加自定義表情

    參數：可定義多個JSON對象數組，示例如下：{qq:{name:'QQ',count:55,width:25,height:25,line:11},msn:{name:'MSN',count:40,width:22,height:22,line:8}}
            name：表情分組名
            count：表情數量
            list：表情列表，例：{test1:'表情1',test2:'表情2'}，鍵名代表文件名，擴展名必需為gif，鍵值代表alt信息
            width：單個表情區域寬度，必需大於或等於表情最大寬度
            height：單表情區域高度，必需大於或等於表情最大高度
            line：單行顯示表情數量
            說明：count和list必需選其中一個值，注意count模式插入表情img的alt為空
    備注：1.0.0 beta2新添加

27. hoverExecDelay：懸停自動執行延遲的時間

    參數：數值(單位毫秒)，默認為100，設置為-1關閉此功能
    備注：1.0.0 rc2新添加

28. defLinkText：超鏈接的默認文字

    參數值：字符串(默認值：“點擊打開鏈接”)
    說明：只在不選擇任何內容的情況下才會用到這個參數值

29. modalWidth：showModal彈出窗口的默認寬度

    參數值：數值，默認為350
    說明：彈出窗口的默認寬度

30. modalHeight：showModal彈出窗口的默認高度

    參數值：數值，默認為220
    說明：彈出窗口的默認高度

31. modalTitle：showModal彈出窗口是否顯示上方的標題欄

    參數值：true(顯示),false(不顯示)
    說明：控制彈出窗口是否顯示上方的標題欄，默認為顯示，若需要顯示一個更定制個性化的iframe窗口，可通過此參數隱藏上方的標題欄

32. upBtnText：上傳按鈕的文字

    參數值：任意字符串,默認值：“上傳”
    備注：1.0.0 beta2新添加

33. html5Upload：是否開啟HTML5上傳支持

    參數值：true(允許),false(不允許),默認為true允許
    說明：本功能需要瀏覽器支持HTML5上傳
    備注：1.0.0 Final新添加

34. upMultiple：允許一次上傳多少個文件

    參數值：大於0的數值,默認：99,設置為1關閉多文件上傳
    說明：本功能需要瀏覽器支持HTML5上傳
    備注：1.0.0 RC3新添加

35. upLinkUrl：超鏈接文件上傳接收URL

    參數值：接收用戶上傳的服務器端程序URL，默認留空為禁用超鏈接上傳功能，具體使用方法請參考demo8演示文件
    注：可使用內置變量：{editorRoot}，代表當前編輯器的根路徑，例：{editorRoot}upload.php

36. upLinkExt：超鏈接上傳前限制本地文件擴展名

    參數值：超鏈接上傳前限制的文件擴展名列表，默認為：zip,rar,txt，建議與服務端擴展名檢查列表一致

37. upImgUrl：圖片文件上傳接收URL

    參數值：接收用戶上傳的服務器端程序URL，默認留空為禁用上傳功能，具體使用方法請參考demo8演示文件
    注：可使用內置變量：{editorRoot}，代表當前編輯器的根路徑，例：{editorRoot}upload.php

38. upImgExt：圖片上傳前限制本地文件擴展名

    參數值：圖片上傳前限制的文件擴展名列表，默認為：jpg,jpeg,gif,png，建議與服務端擴展名檢查列表一致

39. upFlashUrl：動畫文件上傳接收URL

    參數值：接收用戶上傳的服務器端程序URL，默認留空為禁用上傳功能，具體使用方法請參考demo8演示文件
    注：可使用內置變量：{editorRoot}，代表當前編輯器的根路徑，例：{editorRoot}upload.php

40. upFlashExt：動畫上傳前限制本地文件擴展名

    參數值：動畫上傳前限制的文件擴展名列表，默認為：swf，建議與服務端擴展名檢查列表一致

41. upMediaUrl：視頻文件上傳接收URL

    參數值：接收用戶上傳的服務器端程序URL，默認留空為禁用上傳功能，具體使用方法請參考demo8演示文件
    注：可使用內置變量：{editorRoot}，代表當前編輯器的根路徑，例：{editorRoot}upload.php

42. upMediaExt：視頻上傳前限制本地文件擴展名

    參數值：視頻上傳前限制的文件擴展名列表，默認為：avi，建議與服務端擴展名檢查列表一致

43. onUpload：文件上傳成功回調函數

    參數值：成功后需要執行的函數
    說明：這個函數執行時返回的值為上傳程序返回的msg變量，可能為字符串或者數組，若為字符串則直接代表url，若是數組，則必需包含一個url的變量，其它可由可開發者自定義
    備注：1.0.0 beta2新添加

44. plugins：自定義按鈕之插件擴展

    插件對象的屬性解釋：
    c：樣式表名稱
    t：插件名字(鼠標在按鈕上方時顯示)
    s：快捷方式，例："ctrl+enter"
    h：是否鼠標懸停直接執行,1:直接執行(省略當前值代表不直接執行)
    e：按鈕點擊后需要執行的代碼(省略執行代碼，則把當前的插件名作為參數，調用瀏覽器的execCommand函數)
    
    特別說明：
    如果您希望樣式表存儲在系統自帶的模板目錄ui.css中，請將插件對象的樣式名留空，則會自動按照插件名來調用相應的樣式，例如：xhEdtBtnCut、xhEdtBtnCopy，其中的Cut和Copy是插件名
    
    具體調用方法請參考演示文件夾中的demo9

45. submitID：觸發表單提交的按鈕ID值

    參數值：表單提交按鈕的ID值，默認在form表單上綁定submit以同步結果
    說明：通過本參數，在非標准submit提交環境下，比如AJAX提交，可以由用戶點擊提交按鈕以觸發編輯器最新值的同步
    備注：v1.1.7新添加

46. onPaste：剪切板粘貼回調函數

    參數值：用戶粘貼后需要執行的函數
    說明：此函數用來過濾用戶粘貼的代碼，若返回false禁用粘貼
    備注：v1.1.8新添加

47. localUrlTest：非本站域名測試正則表達式

    參數值：正則表達式
    說明：本參數用來測試某些組件中測試URL是否屬於本站域名
    備注：v1.1.8新添加

48. remoteImgSaveUrl：遠程圖片抓取接收程序URL

    參數值：字符串(若不設置不開啟此功能)
    說明：當localUrlTest測試為false時，會將圖片URL發往當前參數指定的服務器端上傳接收程序，抓取成功后將本地URL返回並替換
    備注：v1.1.8新添加

49. readTip：無障礙讀屏提示

參數值：字符串(默認為空)
說明：無障礙讀屏軟件提示文字，可用來為殘疾人士提示快捷鍵等信息
備注：v1.1.9新添加

官網：http://xheditor.com

原文：http://kms.lenovots.com/kb/article.php?id=13203