← すべてのドキュメント

editor.getEditable(bFocus)

編集可能なルート要素、つまりユーザーが入力するコンテンツを実際に保持している、エディターの iframe 内の body を返します。子要素を読み取る、サイズを測る、クエリの対象を編集中のコンテンツだけに絞るなど、コンテナー要素そのものが必要な場合に使います。

構文

editor.getEditable(bFocus)

パラメーター

bFocus — 省略可能なブール値。true の場合、要素を返す前にエディターにフォーカスします。フォーカスを変えずに要素を取得するには、省略する（または falsy な値を渡す）ようにします。

戻り値

編集可能な body 要素。

動作に関する注意

  • ドキュメントではなく要素です。これは body 要素を返します。getDocument() はそれを囲む Document を返します。どちらも編集用の iframe の中にあります。
  • フォーカスのオプションは利便性のためのものです。これから選択範囲を設定したり編集を始めたりする場合、true を渡せば、別途 focus() を呼び出す手間が省けます。
  • 対象を限定するには、これに対してクエリを実行します。返された要素に対する querySelector は、編集中のコンテンツだけを対象とし、周囲のページの UI を参照することはありません。

使用例

編集中のコンテンツの最初の段落を読み取ります。

var editor1 = new RichTextEditor("#div_editor1");
var body = editor1.getEditable();
var firstPara = body.querySelector("p");

選択範囲を設定する前に、1 回の呼び出しでエディターにフォーカスし、編集可能な要素を取得します。

var body = editor1.getEditable(true);   // focuses, then returns the element

関連項目