XHEditor文本編輯器使用文檔

為了同時支持Firefox和IE，我們常常用document.getElementById(id)方法來取得HTML對象。但是getElementById方法只能取得單個對象，而對于CheckBox數組則無能為力。
1. 下載xhEditor最新版本。下載地址：http://xheditor.com/download

2. 解壓zip文件，將其中的xheditor.js以及xheditor_emot和xheditor_skin兩個文件夾上傳到網站相應目錄

3. 在相應html文件的head標簽結束之前添加

<script type="text/javascript" src="http://static.xxx.com/js/xheditor.js"></script>
4. 調用方法有兩種：

方法1：在textarea上添加屬性： class="xheditor"(設置為xheditor-mini和xheditor-simple，分別默認加載迷你和簡單工具欄)方法2：在您的頁面初始JS代碼里加上： $('#elm1').xheditor(true);例如：$({$('#elm1').xheditor(true);});相應的隱藏編輯的代碼為：$('#elm1').xheditor(false);
初始化參數說明
初始化示例代碼：

$('#elm1').xheditor(true,{tools:'full',skin:'default',showBlocktag:true,readonly:false,internalScript:false,internalStyle:false,width:300,height:200,loadCSS:'http://vevb.com/test.css',fullscreen:true,sourceMode:true,forcePtag:true,upImgUrl:"upload.php",upImgExt:"jpg,jpeg,gif,png",keepValue:true,plugins:{}});
tools：自定義工具按鈕

參數值：full(完全),simple(簡單),mini(迷你)或者自定義字符串，例如：'GStart,Cut,Copy,Paste,Pastetext,GEnd,Separator,GStart,Source,Preview,Fullscreen,About,GEnd'完整按鈕表：GStart：組開始GEnd：組結束Separator：分隔符Cut：剪切Copy：復制Paste：粘貼Pastetext：文本粘貼Blocktag：段落標簽Fontface：字體FontSize：字體大小Bold：粗體Italic：斜體Underline：下劃線Strikethrough：中劃線FontColor：字體顏色BackColor：字體背景色Removeformat：刪除文字格式Align：對齊List：列表Outdent：減少縮進Indent：增加縮進Link：超鏈接Unlink：刪除鏈接Img：圖片Flash：Flash動畫Media：Windows media player視頻Emot：表情Table：表格Source：切換源代碼模式Preview：切換預覽模式Fullscreen：切換全屏模式About：關于xhEditor
skin：皮膚風格選擇

參數值：default(默認風格),o2007blue(Office 2007 藍色),o2007silver(Office 2007 銀色)
showBlocktag:顯示段落標簽

參數值：true(顯示段落標簽),false(不顯示)
internalScript：內部JS代碼保留狀態

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

參數值：true(保留內聯JS代碼),false(清理內聯JS代碼)
internalStyle：內部樣式保留狀態

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

參數值：true(保留內聯樣式),false(清理內聯樣式)
width：編輯器寬度

參數值：不帶單位的數字，例：300
height：編輯器高度

參數值：不帶單位的數字，例：100
loadCSS：加載樣式

參數值：樣式表網址，例如：'http://www.49028c.com/css/global.css'
fullscreen：默認全屏顯示

參數值：true(全屏大小),false(標準大小)
readonly：默認只讀模式

參數值：true(只讀模式),false(可編輯模式)
sourceMode:默認源代碼模式

參數值：true(源代碼模式),false(編輯模式)
forcePtag:強制P標簽

參數值：true(強制使用P標簽),false(不強制)
keepValue:自動保存src和href屬性值

參數值：true(保存),false(不保存)說明：在IE等瀏覽器下使用編輯器，插入的圖片和鏈接地址都會被瀏覽器自動轉為絕對地址，比如輸入：a.gif，自動會轉為：http://test.com/a.gif
modalWidth:showModal彈出窗口的默認寬度

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

參數值：數值，默認為220說明：彈出窗口的默認高度
modalTitle：showModal彈出窗口是否顯示上方的標題欄

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

參數值：接收用戶上傳的服務器端程序URL，默認留空為禁用超鏈接上傳功能，具體使用方法請參考demo8演示文件
upLinkExt:超鏈接上傳前限制本地文件擴展名

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

參數值：接收用戶上傳的服務器端程序URL，默認留空為禁用上傳功能，具體使用方法請參考demo8演示文件
upImgExt:圖片上傳前限制本地文件擴展名

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

參數值：接收用戶上傳的服務器端程序URL，默認留空為禁用上傳功能，具體使用方法請參考demo8演示文件
upFlashExt:動畫上傳前限制本地文件擴展名

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

參數值：接收用戶上傳的服務器端程序URL，默認留空為禁用上傳功能，具體使用方法請參考demo8演示文件
upMediaExt:視頻上傳前限制本地文件擴展名

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

demos目錄中的upload.php僅為演示代碼，若您使用的是其它的服務器腳本語言，請自行對初始化參數中的upLinkUrl、upImgUrl、upFlashUrl和upMediaUrl進行修改，并開發相應服務器上傳接收程序。若您希望在自己的項目中實際使用，請自行修改代碼或者重新開發，開發過程中請注意上傳文件的格式及大小限制，注意服務器安全問題。上傳接收程序開發規范：1,上傳文件域名字為：upload2,返回結構必需為json，并且結構如下：{"err":"","msg":"200906030521128703.gif"}若上傳出現錯誤，請將錯誤內容保存在err變量中；若上傳成功，請將服務器上的絕對或者相對地址保存在msg變量中。編輯器若發現返回的err變量不為空，則彈出窗口顯示返回的錯誤內容。上傳管理方案建議：1,在編輯器初始化時在upload.php后面跟上一個服務器生成的絕對唯一的跟蹤值，例如：upload.php?infoid=1213121212,在服務器接收程序中以這個跟蹤值保存到數據庫中，同時也可以限制單個跟蹤值下總上傳文件數或者總文件大小，否則就是一個可以上傳無限個文件的漏洞了3,最終當前表單提交時，再根據編輯器提交的HTML內容和數據庫中上傳內容進行比較，刪除所有沒有使用的上傳文件4,定期由服務器腳本刪除上傳數據庫中沒提交的文件記錄，這樣就能防止別人將您的網站作為免費相冊空間了
plugins:自定義按鈕之插件擴展

插件對象的屬性解釋：c：樣式表名稱　t：插件名字(鼠標在按鈕上方時顯示)　s：快捷方式　e：按鈕點擊后需要執行的代碼特別說明：如果您希望樣式表存儲在系統自帶的模板目錄ui.css中，請將插件對象的樣式名留空，則會自動按照插件名來調用相應的樣式，例如：xhEdtBtnCut、xhEdtBtnCopy，其中的Cut和Copy是插件名具體調用方法請參考演示文件夾中的demo9
JS接口說明
JS接口示例代碼：

var editor=$('#elm1').xheditor(true,{tools:'full',skin:'default',internalScript:false,internalStyle:false,width:300,height:200,loadCSS:'http://vevb.com/test.css',fullscreen:true,beforeSetSource:ubb2html,beforeGetSource:html2ubb,focus:focusAction,blur:blurAction})[0].xheditor;editor.focus();editor.setSource('str')sHtml=editor.getSource()editor.appendHTML('aaa')editor.pasteHTML('aaa')editor.pasteText('str')sHtml=editor.formatXHTML('aaa')editor.toggleSource()editor.togglePreview()editor.toggleFullscreen()editor.toggleReadonly()alert(editor.settings.upImgExt);editor.settings.upImgExt='txt,doc';
focus：使編輯器獲得焦點

無參數
setSource：設置編輯器源代碼

參數1：要設置的源代碼內容，例：'aaa'
getSource：返回編輯器格式后的源代碼

無參數
appendHTML：粘貼HTML內容到編輯器結尾處

參數1：要粘貼的HTML代碼，例：'uuu'注：0.9.5版添加
pasteHTML：粘貼HTML內容到編輯器當前光標處

參數1：要粘貼的HTML代碼，例：'uuu'
pasteText：粘貼文本到編輯器當前光標處

參數1：要粘貼的文本，例：'這里的內容完全原樣顯示aaa'
formatXHTML：格式化XHTML代碼

參數1：需要格式化的HTML代碼，例：'aaa'，返回'aaa'
toggleSource：在源代碼模式和編輯模式之間切換

參數1：空(切換),true(顯示源代碼模式),false(顯示編輯模式)
togglePreview：在預覽模式和編輯模式之間切換

參數1：空(切換),true(顯示預覽模式),false(顯示編輯模式)
toggleFullscreen：在全屏模式和標準大小之間切換

參數1：空(切換),true(顯示全屏模式),false(顯示標準模式)
toggleReadonly：在只讀模式和可編輯模式之間切換

參數1：空(切換),true(切換為只讀模式),false(切換為可編輯模式)
settings：獲取或者修改編輯器內部參數

internalScript:是否清除內部代碼inlineScript:是否清除內聯代碼internalStyle:是否清除內部樣式inlineStyle:是否清除內聯樣式forcePtag:強制使用P標簽keepValue:保持屬性值upLinkUrl:超鏈接上傳接口地址upLinkExt:超鏈接本地上傳擴展限制upImgUrl:圖片上傳接口地址upImgExt:圖片本地上傳擴展限制upFlashUrl:動畫上傳接口地址upFlashExt:動畫本地上傳擴展限制upMediaUrl:視頻上傳接口地址upMediaExt:視頻本地上傳擴展限制beforeSetSource:在設置源代碼到編輯器前調用此函數beforeGetSource:從編輯器返回源代碼前調用此函數focus:編輯器獲得焦點時回調此函數blur:編輯器失去焦點時回調此函數注：修改有效變量僅限以上，其它的變量都僅在編輯器初始化時使用
編輯器初始化回調函數列表：

beforeSetSource和beforeGetSource是編輯器回調函數，分別在設置源代碼和取回源代碼之前調用，詳細使用方法可參考UBB代碼演示頁面focus和blur是編輯器聚焦和失去焦點時的回調函數