Command API¶
Contents
- Command API
- K.cmd(doc)
- doc
- win
- sel
- range
- selection([forceReset])
- select()
- wrap(val)
- split(isStart , map)
- remove(map)
- commonAncestor(tagName)
- state(commandName)
- val(commandName)
- bold()
- italic()
- underline()
- strikethrough()
- forecolor(val)
- hilitecolor(val)
- fontsize(val)
- fontfamily(val)
- fontname(val)
- removeformat()
- inserthtml(val)
- hr()
- print()
- insertimage(url , title , width , height , border , align)
- createlink(url , target)
- unlink()
- formatblock(val)
- selectall()
- justifyleft()
- justifycenter()
- justifyright()
- justifyfull()
- insertorderedlist()
- insertunorderedlist()
- indent()
- outdent()
- subscript()
- superscript()
- cut()
- copy()
- paste()
K.cmd(doc)¶
创建KCmd对象，KCmd用于操作可视化编辑区域的DOM。
- 参数:
- document doc: document或KRange ( Range API )
返回: KCmd
示例:
var cmd = K.cmd(document);
cmd.bold();
cmd.wrap('<span style="color:red;"></span>');
cmd.remove({
span : '*',
div : 'class,border'
});
selection([forceReset])¶
根据当前选中状态，重新设置range。
- 参数:
- Boolean forceReset: 默认值为false，值为true时如果当前没有选中信息，自动选择文档的最后位置，
返回: KCmd
示例:
cmd.selection();
wrap(val)¶
用指定element围住range。
- 参数:
- string|node val: DOM元素、HTML代码
返回: KCmd
示例:
cmd.wrap('<strong></strong>');
split(isStart , map)¶
根据map规则分割range的开始位置或结束位置。
- 参数:
- boolean isStart: true或false
- object map: 规则
返回: KCmd
示例:
cmd.split(true, {
span : '*',
div : 'class,border'
});
remove(map)¶
根据map规则删除range中的element或attribute。
- 参数:
- object map: 规则
返回: KCmd
示例:
cmd.remove({
span : '*',
div : 'class,border'
});
commonAncestor(tagName)¶
根据map规则取得range的共同祖先。
- 参数:
- string tagName: 规则
返回: KNode ( Node API )
示例:
var knode = cmd.commonAncestor('table');
state(commandName)¶
Determines whether the given command has been executed on the current selection.
- 参数:
- string commandName: 命令名
返回: boolean
Note
Reference: https://developer.mozilla.org/en/Midas
示例:
bool = cmd.state('bold');
val(commandName)¶
Determines the current value of the document, range, or current selection for the given command.
- 参数:
- string commandName: 命令名
返回: string
示例:
fontSize = cmd.val('fontsize');
Note
目前只支持以下命令: * fontfamily (fontname) * formatblock * forecolor * hilitecolor
insertimage(url , title , width , height , border , align)¶
插入图片
- 参数:
- string url: 图片URL
- string title: 图片alt
- int width: 图片宽度
- int height: 图片高度
- int border: 图片边框
- string align: 对齐方式
返回: KCmd