← 全部文档

editor.collapse(bStart)

把当前选区折叠为单个插入点（没有高亮文本的光标）。在以编程方式选中内容，或某个命令作用于一个范围之后，如果希望把光标放在所选内容的某一端，而不是让整个范围保持高亮，就可以使用它。

语法

editor.collapse(bStart)

参数

bStart——布尔值。true 把选区折叠到起点，false 折叠到终点。省略时的行为与 false 相同（折叠到终点）。

返回值

无（undefined）。

行为说明

  • 已经折叠的选区保持不变。如果选区已经是光标，collapse() 会立即返回，不移动它。
  • 没有活动范围时先选中整个文档。如果根本没有选区范围（例如编辑器还没有获得过焦点），collapse() 会退而选中整个文档，因此调用之后仍然有一个明确的选区可供使用。
  • 它作用于实时选区，也就是用户看到的那个选区——不存在需要另外同步的光标。

用法示例

对整个文档执行一个命令，然后把光标放到末尾，以便继续在其后输入：

var editor1 = new RichTextEditor("#div_editor1");
editor1.setHTMLCode("<b>hello world</b>");
editor1.selectDoc();
editor1.execCommand("forecolor", "red");
editor1.collapse(false);   // caret lands after the colored text

改为折叠到起点，把光标放在选区之前：

editor1.selectDoc();
editor1.collapse(true);    // caret lands at the very beginning

相关内容