kindeditor API ,kindeditor應用手冊,kindeditor函數
變量
獨一的全局變量,也是法度的定名空間。
數據類型:Object
編輯器的版本信息。
數據類型:String
編輯器的中文信息。
數據類型:Object
kindeditor.js的路徑。
數據類型:String
編輯器的HTML頁面路徑。
數據類型:String
注:3.4版本已放棄。
瀏覽器類型和版本,分別爲KE.browser.VERSION、KE.browser.IE、KE.browser.WEBKIT、 KE.browser.GECKO、KE.browser.OPERA。
數據類型:Object
注:3.4之前版本直接返回字符串,分別爲"IE"、"WEBKIT"、"GECKO"、"OPERA"。
編輯器的初始化屬性和其它設備。
數據類型:Object
一個編輯器的變量集,包含全部編輯器屬性,此外還包含如下變量,常常用KE.g[id]來默示。
例如:KE.g["content_1"].iframeDoc默示id爲"content_1"的編輯器的iframe document對象。
數據類型:Object
首要變量:
- container: 編輯器的外部element對象。
- iframe: 編輯區域的iframe對象。
- iframeWin: 編輯區域的iframe window對象。
- iframeDoc: 編輯區域的iframe document對象。
- keSel: 當前選中信息的KE.ion對象。
- keRange: 當前選中信息的KE.range對象。
- sel: 當前選中信息的瀏覽器原生ion對象。
- range: 當前選中信息的瀏覽器原生range對象。
- layoutDiv: 編輯器彈出層的div對象。3.4版本已放棄。
- hideDiv: 編輯器彈出層的parent div對象。
- dialog: 彈出窗口的iframe對象。3.4版本已放棄。
- yesButton: 彈出窗口的判定按鈕input對象。
- noButton: 彈出窗口的做廢按鈕input對象。
- previewButton: 彈出窗口的預覽按鈕input對象。
- maskDiv: 彈出窗口時灰色遮罩層的div對象。
- undoStack: undo/redo的undo記錄。
- redoStack: undo/redo的redo記錄。
定義編輯器的插件。
數據類型:Object
函數
取得element對象,doc.getElementById的別號。
參數:
id:String,element的id
doc:Object,element地點document對象,是可選參數,默認值爲document。
返回值:
Object,element對象
建立element對象,doc.createElement的別號。
參數:
name:String,element的tag name
doc:Object,element地點document對象,是可選參數,默認值爲document。
返回值:
Object,element對象
- 3. KE.event.add(el, event, listener)
添加一個事務。
參數:
el:Object,要添加事務的element對象
event:String,事務名稱,可設置"click","change","mousedown"等。
listener:Function,事務處理懲罰回調函數。
返回值:無
- 4. KE.event.remove(el, event, listener)
刪除已添加的一個事務。
參數:
el:Object,要添加事務的element對象
event:String,事務名稱,可設置"click","change","mousedown"等。
listener:Function,事務處理懲罰回調函數。
返回值:無
- 5. KE.event.input(el, func)
添加一個編輯器輸入事務。
參數:
el:Object,要添加事務的element對象
func:Function,編輯器輸入內容時調用這個函數。
返回值:無
- 6. KE.event.ctrl(el, key, func)
添加一個Ctrl+[?]事務。
參數:
el:Object,要添加事務的element對象
key:String,Ctrl組合鍵的字母,支撐A到Z。
func:Function,按下Ctrl+[?]時調用這個函數。
返回值:無
添加一個document的DOMContentLoaded事務。
參數:
func:Function,DOM加載完成後調用這個函數。
返回值:無
遍歷一個object。
參數:
obj:Object,要遍歷的object
func:Function,輪迴時調用這個函數,參數爲object的key和value。
返回值:無
- 9. KE.eachNode(node, func)
遍歷一個node。
參數:
node:Object,要遍歷的parent node
func:Function,輪迴時調用這個函數,參數爲node。
返回值:無
- 10. KE.format.getHtml(html, htmlTags)
把HTML轉換成XHTML,當指定htmlTags參數時,遵照htmlTags規矩過濾HTML標籤。
參數:
html:String,HTML文本
htmlTags:Object,過濾規矩,可選參數。
返回值:
String,XHTML文本
- 11. KE.util.getDocumentElement()
取得document element對象。
參數:無
返回值:
Object,element對象
- 12. KE.util.getDocumentWidth()
取合適前頁面的寬度。
參數:無
返回值:
Int,document寬度
- 13. KE.util.getDocumentHeight()
取合適前頁面的高度。
參數:無
返回值:
Int,document高度
- 14. KE.util.loadStyle(path)
在當前頁面加載一個CSS文件。
參數:
path:String,CSS文件的URL路徑
返回值:無
- 15. KE.util.inArray(str, arr)
判定一個字符串是否在一個數組裏。
參數:
str:String
arr:Array
返回值:
Boolean,返回true默示在數組裏,返回false默示不在數組裏。
刪除字符串兩邊的空格字符。
參數:
str:String
返回值:String
- 17. KE.util.getJsKey(key)
把HTML style裏的CSS名轉換成JavaScript屬性名。例如:KE.util.getJsKey("font-size")會返回"fontSize"。
參數:
key:String
返回值:String
轉換HTML裏的特別字符。
參數:
html:String,HTML文本
返回值:String
- 19. KE.util.getElementPos(el)
取得指定element的座標。
參數:
el:Object,element對象
返回值:Object
- 20. KE.util.getCoords(ev)
取得鼠標座標。
參數:
ev:Object,event對象
返回值:Object
- 21. KE.util.setOpacity(el, opacity)
設置element的透明度。
參數:
el:Object,element對象
opacity:Int,透明度,可設置0到100的數字。
返回值:無
- 22. KE.util.getIframeDoc(iframe)
取得iframe document對象。
參數:
iframe:Object,iframe對象
返回值:Object
- 23. KE.util.rgbToHex(str)
把RGB格局的色彩轉換成16進制的色彩。
參數:
str:String,RGB色彩標識表記標幟
返回值:String
- 24. KE.util.createRange(doc)
建立指定document的range。
參數:
doc:Object,document對象
返回值:Object,range對象
- 25. KE.util.getFullHtml(id, tagLineMode)
取得編輯器iframe的初始化HTML文本。
參數:
id:String,編輯器的ID
tagLineMode:Boolean,true時顯示模塊標籤的輪廓。
返回值:String
取得編輯器的HTML內容。
參數:
id:String,編輯器的ID
返回值:String
- 27. KE.util.getSrcData(id)
取得編輯器的原生HTML內容,也就是innerHTML直接返回的HTML。
參數:
id:String,編輯器的ID
返回值:String
- 28. KE.util.getPureData(id)
取得編輯器的純文本內容,不包含HTML標籤。3.4版本開端包含img和embed標籤。
參數:
id:String,編輯器的ID
返回值:String
把編輯器的內容設置到原TEXTAREA控件裏。
參數:
id:String,編輯器的ID
返回值:無
把核心移到編輯器裏。
參數:
id:String,編輯器的ID
返回值:無
把當前選中信息設置到KE.g[id].sel,KE.g[id].range,KE.g[id].keSel,KE.g[id].keRange裏。
參數:
id:String,編輯器的ID
返回值:無
從頭選中range,僅在IE有效。
參數:
id:String,編輯器的ID
返回值:無
按下回車鍵時生成BR標籤,僅在IE有效。
參數:
id:String,編輯器的ID
返回值:無
注:3.4版本已放棄。
- 34. KE.util.execCommand(id, cmd, value)
履行瀏覽器自帶的號令,具體請參考瀏覽器API裏的document.execCommand。
參數:
id:String,編輯器的ID
cmd:String,瀏覽器execCommand裏的cmd參數
value:String,瀏覽器execCommand裏的value參數
返回值:無
- 35. KE.util.Html(id, html)
把HTML內容插入到編輯區域裏的光標處。
參數:
id:String,編輯器的ID
html:String,HTML內容
返回值:無
注:履行本函數以前必須先履行過 KE.util.ion(id),由於要先設置KE.g[id].sel和KE.g[id].range。
建立編輯器。
參數:
id:String,編輯器的ID
mode:Int,可選參數,指定1時在body下面建立編輯器,0或未指按時在TEXTAREA前面建立編輯器。
返回值:無
移除編輯器。
參數:
id:String,編輯器的ID
mode:Int,可選參數,指定1時移除在body下面的編輯器,0或未指按時移除在TEXTAREA前面的編輯器。
返回值:無
設置編輯器的初始化參數。
參數:
config:Object,編輯器屬性的哈希數組,具體請參考編輯器屬性
返回值:無
初始化並建立編輯器。履行本函數時先調用KE.init設置初始化參數,而後在DOM加載完成後履行KE.create。
參數:
config:Object,編輯器屬性的哈希數組,具體請參考編輯器屬性
返回值:無
類
KindEditor的ion類,取得或設置選中項目組的range。
參數:
win:Object,window對象
oc:Object,document對象
成員變量:
- sel:Object,瀏覽器原生ion對象
- range:Object,當前ion的瀏覽器原生range對象
- keRange:Object,當前ion的KindEditor range對象,請參考KE.range。
辦法:
- addRange(keRange):設置當前ion。
- focus():從頭選中、僅在IE有效。
KindEditor的range類,爲各瀏覽器供給同一的range接口。
參數:
doc:Object,document對象
成員變量:
- startNode:Object,開端節點
- startPos:Int,開端節點的地位
- endNode:Object,中止節點
- endPos:Int,中止節點的地位
辦法:
- getParentElement():返回包含range的parent element。
- getNodeList():返回range裏的node list。
- comparePoints(how, range):鬥勁2個keRange的地位,how能夠設置"START_TO_START", "START_TO_END", "END_TO_START","END_TO_END"。
- setStart(node, pos):設置range的開端節點和地位。
- setEnd(node, pos):設置range的中止節點和地位。
- Node(node):把node設置到range,開端節點和中止節點都是node。
- extractContents():提取range的內容。
- cloneContents():複製range的內容。
- getText():取得range的純文本內容。
KindEditor的號令類,相似execCommand。
參數:
id:String,編輯器的ID
成員變量:
- doc:Object,編輯器的iframe document對象
- keSel:Int,KindEditor ion對象
- keRange:Object,當前ion的KindEditor range對象
辦法:
- wrap(tagName, attributes):用指定標籤包當前選中文本,今朝只支撐inline tag。tagName爲標籤名,attributes爲該標籤屬性數組。
- remove(tags):在當前選中文本中,清除指定的標籤和屬性。tags爲你要刪除的標籤和屬性。
歡迎關注本站公眾號,獲取更多信息