← すべてのドキュメント

editor.collapse(bStart)

現在の選択範囲を 1 つの挿入位置（テキストが強調表示されていないキャレット）に折りたたみます。プログラムで選択した後や、範囲に対して動作するコマンドを実行した後に、範囲全体を強調表示したままにせず、選択していた部分の一方の端にキャレットを置きたい場合に使います。

構文

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

関連項目