Command API ¶

Contents

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'
});

doc ¶

document对象。

win ¶

window对象。

sel ¶

原生selection对象。

range ¶

KRange对象 ( Range API )

selection([forceReset])¶

根据当前选中状态，重新设置range。

参数:
- Boolean forceReset: 默认值为false，值为true时如果当前没有选中信息，自动选择文档的最后位置，
返回: KCmd

示例:

cmd.selection();

select()¶

选中range。

参数: 无
返回: KCmd

示例:

cmd.select();

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

bold()¶

粗体

参数: 无
返回: KCmd

italic()¶

斜体

参数: 无
返回: KCmd

underline()¶

下划线

参数: 无
返回: KCmd

strikethrough()¶

删除线

参数: 无
返回: KCmd

forecolor(val)¶

文字颜色

参数:
- string val: 颜色
返回: KCmd

hilitecolor(val)¶

文字背景

参数:
- string val: 颜色
返回: KCmd

fontsize(val)¶

文字大小

参数:
- string val: 文字大小
返回: KCmd

fontfamily(val)¶

字体

参数:
- string val: 字体
返回: KCmd

fontname(val)¶

字体， fontfamily(val) 的别名。

参数:
- string val: 字体
返回: KCmd

removeformat()¶

删除inline样式

参数: 无
返回: KCmd

inserthtml(val)¶

插入HTML

参数:
- string val: HTML
返回: KCmd

hr()¶

插入水平线

参数: 无
返回: KCmd

print()¶

弹出打印窗口

参数: 无
返回: KCmd

insertimage(url , title , width , height , border , align)¶

插入图片

参数:
- string url: 图片URL
- string title: 图片alt
- int width: 图片宽度
- int height: 图片高度
- int border: 图片边框
- string align: 对齐方式
返回: KCmd

createlink(url , target)¶

超级链接

参数:
- string url: URL
- string target: 打开方式
返回: KCmd

unlink()¶

取消超级链接

参数: 无
返回: KCmd

formatblock(val)¶

段落

参数:
- string val: 段落标签
返回: KCmd

selectall()¶

全选

参数: 无
返回: KCmd

justifyleft()¶

左对齐

参数: 无
返回: KCmd

justifycenter()¶

居中

参数: 无
返回: KCmd

justifyright()¶

右对齐

参数: 无
返回: KCmd

justifyfull()¶

两端对齐

参数: 无
返回: KCmd

insertorderedlist()¶

编号

参数: 无
返回: KCmd

insertunorderedlist()¶

项目符号

参数: 无
返回: KCmd

indent()¶

增加缩进

参数: 无
返回: KCmd

outdent()¶

减少缩进

参数: 无
返回: KCmd

subscript()¶

下标

参数: 无
返回: KCmd

superscript()¶

上标

参数: 无
返回: KCmd

cut()¶

剪切

参数: 无
返回: KCmd

copy()¶

复制

参数: 无
返回: KCmd

paste()¶

粘贴

参数: 无
返回: KCmd

Navigation

Navigation