← すべてのドキュメント

editor.getReadOnly()

エディターが現在読み取り専用かどうかを返します。鍵のアイコンを表示する、「保存」ボタンを有効にするかどうかを決めるなど、独自の UI に編集状態を反映させるために使います。また、モードを切り替えるときの現在の値としても使います。

構文

editor.getReadOnly()

パラメーター

なし。

戻り値

ブール値。エディターが読み取り専用の場合は true、編集可能な場合は false。

動作に関する注意

  • 報告するのは現在のモードだけです。値は setReadOnly() を呼び出すと切り替わります。同期させる必要のある別のフラグはありません。
  • 常にブール値です。結果は実際の true／false なので、そのまま条件式に使えます。
  • 切り替えには setReadOnly と組み合わせます。現在の値を読み取ってその反対の値を渡すのが、標準的な切り替えのパターンです。

使用例

現在の値を使い、ボタンで読み取り専用モードを切り替えます。

var editor1 = new RichTextEditor("#div_editor1");
document.getElementById("btn_lock").onclick = function () {
    editor1.setReadOnly(!editor1.getReadOnly());
};

エディターが編集可能な場合だけ保存を許可します。

if (!editor1.getReadOnly()) {
    save(editor1.getHTMLCode());
}

関連項目