RichTextEditor のメソッド

Name: RichTextEditor
Price: 129 USD
Author: Richscripts Inc.

RichTextEditor では、次のメソッドを使用できます。

メソッド	説明
`duplicateCurrentBlock()`	新しいソースのコアビルドのみ（リリースされたすべてのバンドルにあるわけではありません）：選択範囲にあるブロックを複製し、キャレットを複製先に置きます。一意の ID とレビューの識別情報は複製されません。読み取り専用／コメントのみのコンテンツ、サポートされていない行の結合、提案モードでは、この操作は拒否されます。true が返っても、安全のために何もしなかったことを意味する場合があり、コンテンツが複製された証拠にはなりません。古いランタイムで使う前に、typeof editor.duplicateCurrentBlock を確認してください。
`recordUndo()`	現在の文書を記録し、その元に戻す単位を確定します。独自に DOM を編集した後に呼び出すと、その変更を「元に戻す」で取り消せるようになります。
`makePanelResizable(panel, opts)`	core 2.6.11 以降。サイドパネルの要素に、ドラッグでき、キーボード（ArrowLeft / ArrowRight / Home / End）でも操作できるサイズ変更用の端を追加します。opts：最小幅と最大幅（px、既定値は 240 / 720）、スクリーンリーダー用のラベル。panelresized イベントを発生させます。ハンドルの要素を返します。パネルがない場合やすでにサイズ変更可能な場合は null を返します。
`setListStart(n)`	選択範囲にある番号付きリストの開始番号を設定します（0 も指定できます）。番号付きリストが選択されていない場合や n が無効な場合は false を返します。
`continueListNumbering()`	選択した番号付きリストの番号を、直前の番号付きリストから続けます。適切なリストが見つからない場合は false を返します。
`toggleTableCaption()`	選択した表のキャプションを追加または削除し、元に戻す単位を記録します。表が選択されていない場合は false を返します。
`execCommand(cmd,value)`	現在の選択範囲、または指定した範囲に対してコマンドを実行します。
`attachEvent(name,handler)`	イベントハンドラーを登録します。エディターが読み込まれて動作し始めた後に操作できます。
`detachEvent(name,handler)`	イベントから EventHandler を削除します。
`getHTMLCode()`	RichTextEditor のコンテンツを HTML として取得します。
`setHTMLCode(html)`	RichTextEditor のコンテンツを設定します。
`getReadOnly()`	クライアント側でエディターの状態が読み取り専用かどうかを示す値を返します。
`setReadOnly(bReadOnly)`	読み取り専用モードを有効または無効にします。
`isCommandEnabled(cmd)`	指定したコマンドが有効かどうかを取得します。
`isCommandActive(cmd)`	このコマンドを現在実行できるかどうかを確認します。
`focus()`	エディターのコンテンツウィンドウへのフォーカスの設定を試みます。
`setContentCssText(text)`	編集領域で使われるインラインの CSS テキストを設定します。
`insertRootParagraph(tagname)`	エディターの末尾に新しい段落を挿入します。
`insertByTagName(tagName)`	タグ名を指定して要素を挿入します。
`surroundByTagName(tagName)`	選択範囲のコンテンツを取得して要素の中に入れ、その新しい要素を挿入します。
`insertElement(element)`	要素を挿入します。この要素は editor.document で作成したものでなければなりません。
`surroundElement(element)`	editor.document を使って要素を作成し、選択範囲のコンテンツをその要素の中に入れてから、その新しい要素を挿入します。
`insertText(text)`	指定したプレーンテキストをエディターの文書に挿入します。
`insertHTML(text)`	指定した HTML をエディターの文書内の範囲に挿入します。何かが選択されている場合、選択範囲は新しい HTML とテキストに置き換えられます。
`selectControl(element)`	コントロールを選択します。
`selectDoc(bStart)`	文書を選択します。bStart はブール値で、true では選択範囲を先頭に、false では末尾に移動します。省略した場合の既定値は false です。
`collapse(bStart)`	現在の選択範囲を 1 点に折りたたみます。bStart はブール値で、true では Range を先頭に、false では末尾に折りたたみます。省略した場合の既定値は false です。
`delete()`	選択範囲を削除します。
`commitBookmark()`	元に戻す記録のためのブックマークを作成します。
`clearHistory()`	元に戻す／やり直しの記録をすべて消去します。
`notifySelectionChange()`	コンテンツの変更をエディターに通知します。
`htmlEncode(text)`	文字列を HTML エンコードされた文字列に変換します。
`htmlDecode(html)`	HTTP で送信するために HTML エンコードされた文字列を、デコードされた文字列に変換します。
`getSelection()`	editor.selection オブジェクトを返します。
`getDocument()`	editor.document オブジェクトを返します。
`getEditable()`	編集領域のルート要素を返します。
`ensureStyleSheetLive(doc,element,id,csstext)`	独自の <style> 要素を追加した直後に呼び出します。通常は何もしません。厳格な Content-Security-Policy によって要素が空にされた場合にだけ動作し、同じ CSS を CSSOM を通じて再挿入して、ルールが黙って捨てられずに適用されるようにします。<style> 要素を主な経路として維持することで、カスケード内での位置が保たれます。
`injectStyleSheet(doc,id,csstext)`	<style> 要素を使わずに、指定した文書にスタイルシートを追加するので、厳格な style-src の下でも機能します。維持すべき要素がない場合に使ってください。要素がある場合は ensureStyleSheetLive() を使うことをお勧めします。こちらのルールは、文書内のすべてのスタイルシートの後に並ぶ adopted stylesheet に入るからです。同じ id で異なる CSS を指定して再度呼び出すと、既存のシートが更新されます。
`getPlainText()`	editor.document.body.innerText オブジェクトを返します。
`getJSON()`	構造化コンテンツブリッジが読み込まれている場合に使用できます。現在のエディターのコンテンツについて、意味構造を持つ JSON の文書モデルを返します。
`setJSON(documentModel)`	構造化コンテンツブリッジが読み込まれている場合に使用できます。構造化 JSON の文書モデルからエディターを復元します。
`getSelectedControl()`	選択されているコントロールのオブジェクトを返します。
`getSelectionElement()`	選択されている要素のオブジェクトを返します。
`getSelectedText()`	選択されているプレーンテキストを返します。
`createToolbarButton(cmd)`	既定のスタイルでツールバーにボタンを作成します。詳しくはプラグインの例を参照してください。
`createToolbarDropDown(cmd)`	既定のスタイルでツールバーにドロップダウンを作成します。詳しくはプラグインの例を参照してください。
`createDialog(title,className)`	既定のスタイルでダイアログを作成します。詳しくはプラグインの例を参照してください。
`closeCurrentPopup()`	すべてのポップアップ／ドロップダウン／メニュー／ダイアログを閉じようとします。
`setImageForCommand(element,cmdname)`	cmdname に対応する画像（svg または png）を要素に追加します。
`destroy()`	エディターを破棄し、そのリスナーと DOM を解放します。SPA でアンマウントするときに呼び出してください。prepareDestroy() は別名です。
`getHTML() / setHTML(html)`	getHTMLCode() と setHTMLCode() の別名です。
`bindDocumentEvent(type, handler, capture)`	core 2.6.10 以降。編集用の文書でイベント（keydown、input など）を待ち受けます。getDocument().addEventListener の代わりに使ってください。編集用のフレームが新しい文書を取得したときに、エディターがリスナーを付け直します（documentreplaced イベントを参照してください）。
`bindEditableEvent(type, handler, capture)`	core 2.6.10 以降。同じことを、編集可能な body（getEditable()）に対して行います。
`runInSavedView(fn)`	core 2.6.10 以降。編集領域が、保存される内容とまったく同じものを表示している状態で fn を実行し（差し込みフィールドのサンプルなどのプラグインのプレビューは、この呼び出しの間オフになります）、fn の結果を返します。計算済みのスタイルやレイアウトを読み取る必要があるエクスポートに使ってください。
`cancelUploads(reason)`	実行中のすべてのアップロードをキャンセルし、キャンセルした数を返します。ハンドラーが abort 関数を返している場合はそれを呼び出し、遅れて届いた結果は無視します。destroy() もアップロードをキャンセルします。文書から削除された画像の結果は破棄されますが、削除しただけでネットワーク通信がすぐに中止されるとは限りません。
`getPendingUploadCount()`	実行中のアップロードの数。
`uploadEmbeddedImages(callback)`	base64 の data: URL としてコンテンツにすでに埋め込まれている画像（setHTMLCode で設定したもの、ページから貼り付けたもの、下書きから復元したもの）を file_upload_handler 経由でアップロードし、各 src を返された URL に置き換えます。コールバックは { uploaded, failed, skipped, errors } を受け取ります。http(s) の画像はそのままです。ハンドラーが設定されていない場合は何も変わりません。
`getText() / setText(text)`	getPlainText() と setPlainText() の別名です。
`setPlainText(text)`	文書をプレーンテキストに置き換えます。改行ごとに個別のブロックになります。
`formatChanged(formats, callback)`	書式やコマンドの状態の変化を購読し、カスタムのツールバーがポーリングせずにアクティブな状態を追跡できるようにします。TinyMCE の formatChanged() と同じもので、組み込みのツールバーと同じ更新処理で動くため、購読側の状態がずれることはありません。editor.formatter.formatChanged としても使えます。
`getSelectedHTML()`	現在の選択範囲を HTML 文字列として返します。
`getStatistics()`	エディターのコンテンツの統計（単語数、文字数などの数）を返します。
`showWordCount()`	単語数のダイアログを開きます。
`showShortcuts()`	キーボードショートカットの一覧を開きます（Cmd/Ctrl + /）。
`toMarkdown()`	現在のコンテンツを CommonMark として返します。
`fromMarkdown(md, opts)`	CommonMark を解析してコンテンツを置き換えます。
`exportPdf(options)`	文書をベクター形式のタグ付き PDF としてエクスポートします。
`printPreview()`	現在の文書の印刷プレビューを開きます。
`insertImageByUrl(url, alt)`	URL を指定して、キャレットの位置に画像を挿入します。省略可能な alt で代替テキストを設定します（core 2.6.5 以降）。指定しない場合、alt 属性は書き出されません。
`openFindDialog()`	検索と置換のダイアログを開きます。
`findHighlight(query, options)`	ダイアログを開かずに、検索語に一致するすべての箇所を強調表示します。
`clearFindHighlights()`	findHighlight() で追加した強調表示を削除します。
`markAllOccurrencesOfSelection()`	現在の選択範囲と同じ文字列をすべて強調表示します。
`toggleReadingMode(state) / isReadingMode()`	集中して読める閲覧表示のオン／オフを切り替え、その状態を返します。
`setCommentsOnly(bVal) / getCommentsOnly()`	編集をコメントだけに制限し、そのモードが有効かどうかを返します。
`applyMathMarkup() / renderMath()`	TeX をエディターの数式マークアップに変換し、ページに KaTeX または MathJax がある場合はそれを描画します。
`setPreviewCssText(text)`	プレビューモードで使われるインラインの CSS を設定します。
`getLangText(key)`	現在の言語のローカライズされた UI 文字列を検索します。
`fireEvent(name, ...args)`	プログラムからイベントフックを呼び出します。
`autoSave`	config.autoSave が設定されている場合に存在します。ユーザーの入力に合わせて、自分のサーバーに保存します。trigger() はすぐに保存し、retryNow() は失敗した保存をただちに再試行し、hasUnsavedChanges() は保存がまだ残っているかどうかを返し、isDirty() はコンテンツを最後に保存したバージョンと比較し、lastSavedAt() はタイムスタンプを返します。失敗した保存は、待ち時間を倍にしながら、またブラウザーがオンラインに戻ったときに再試行され、失敗したスナップショットが再送されます。autosaved と autosavefailed のイベントが、それぞれの結果を通知します。代わりにブラウザー側の下書きを使う場合は、localDraft オプションを参照してください。