Skip to main content

Visit Mozilla.org

XUL:editor

出典: MDC

« XUL リファレンス HOME    [ 例 | 属性 | プロパティ | メソッド | 関連項目 ]

編集可能なドキュメントが含まれるフレーム。editor ドキュメントを作成するには、editortype 属性の値を html に設定します。Mozilla は HTML editor と plaintext editor の二通りの editor を提供しています。editor は編集ユーザインタフェースを提供しないため、あなた自身がそれを備えることになります。しかし、テキスト編集および画像のサイズ変更、table の行とセルの編集は可能です。editor に editortype 属性を設定しないときは、makeEditable メソッドを使用して編集を有効にしなければなりません。

editor に読み込ませる document を指定するには src 属性を使用します。しかし、src 属性をはじめから XUL ファイル内の editor タグに指定しておくと問題が起こるため、次のいずれかのようにしてください:

  1. 外側の window が読み込まれた後、editor 上に src 属性を設定する。例えば onload ハンドラ内など。また、ファイルダイアログからユーザが選択したものを src 属性に設定するかもしれません。この場合は editor 上に editortype 属性を設定してください。
  2. editor に読み込まれた document を編集可能にするために makeEditable メソッドを呼び出す。
  3. editor に読み込まれた document の design モードを有効にする。

新しいドキュメントを編集するには、about:blank に src 属性を設定します。

editor の多くの機能へアクセスするには、あなたのアプリケーションが拡張機能や chrome の一部でなければなりません。Web サーバからの URL を通して読み込まれる XUL アプリケーションは、editor のほとんどの機能へアクセスすることができません。

Gecko の埋め込みリッチテキストエディタについての詳しい情報は、Rich text editing および Midas ページを参照してください。

属性
editortype, src, type
プロパティ
accessibleType, commandManager, contentDocument, contentWindow, docShell, editingSession, editortype, webBrowserFind, webNavigation
メソッド
getEditor, getHTMLEditor, makeEditable

[編集] 例

この例は、読み込まれた HTML ドキュメントの designMode プロパティを設定して editor を編集可能にする方法です: 

<script language="javascript">
function initEditor(){
    // この関数は editor をセットアップするために呼び出される
    var editor = document.getElementById("myEditor");
    editor.contentDocument.designMode = 'on'
}
</script>
<editor id="myEditor" editortype="html" src="about:blank" flex="1" type="content-primary"/>

一度編集可能になると、document は特別な書式設定を持ち、document.execCommand メソッドを使用して他の HTML 片をそこに追加することができます: 

    var editor = document.getElementById("myEditor");

    // 現在の選択範囲をボールド体に切り替える
    editor.contentDocument.execCommand("bold", false, null);

詳しい command 文字列は Midas の概要をご覧ください。

[編集] 属性

XUL 要素からの継承
align, allowevents, allownegativeassertions, class, coalesceduplicatearcs, collapsed, container, containment, context, contextmenu, datasources, dir, empty, equalsize, flags, flex, height, hidden, id, insertafter, insertbefore, left, maxheight, maxwidth, menu, minheight, minwidth, mousethrough, observes, ordinal, orient, pack, persist, popup, position, preference-editable, querytype, ref, removeelement, sortDirection, sortResource, sortResource2, statustext, style, template, tooltip, tooltiptext, top, uri, wait-cursor, width

editortype
型: 下記の値のいずれか一つ
使用する editor の種類。この値は、editor 内の document の content type に依存して優先されます。
  • html: HTML エディタ。
  • text: テキストのみのエディタ。

src
型: URL
要素内に表示するコンテンツの URL。

type
型: string
文字列を content-primary に設定すると、この editor はページの最初のコンテンツになります。最初のコンテンツを持つ window は、window.content を使用して、より便利に検索することができます。

[編集] プロパティ

XUL 要素からの継承
align, allowEvents, boxObject, builder, className, collapsed, contextMenu, controllers, currentItem, database, datasources, dir, flex, height, hidden, id, left, listBoxObject, maxHeight, maxWidth, menu, minHeight, minWidth, observes, ordinal, orient, pack, persist, ref, resource, statusText, style, tooltip, tooltipText, top, value, width

DOM 要素からの継承
attributes, childNodes, cloneNode, firstChild, lastChild, localName, namespaceURI, nextSibling, nodeName, nodeType, nodeValue, ownerDocument, parentNode, prefix, previousSibling, tagName

accessibleType
型: integer
要素の accessibility オブジェクトの種類を示す値。

commandManager
型: nsICommandManager
command manager は editor 上の操作を扱います。

contentDocument
型: document
この読み取り専用のプロパティは要素内の document オブジェクトを含みます。

contentWindow
型: window
この読み取り専用のプロパティは要素内の window オブジェクトを含みます。

docShell
型: nsIDocShell
この読み取り専用のプロパティは document の nsIDocShell オブジェクトを含みます。

editingSession
型: nsIEditingSession
editor の初期化に使用される editing session。通常、これを使用する必要はありません。

editortype
型: 下記の値のいずれか一つ
使用する editor の種類。この値は、editor 内の document の content type に依存して優先されます。
  • html: HTML エディタ。
  • text: テキストのみのエディタ。

webBrowserFind
型: nsIWebBrowserFind
この読み取り専用のプロパティは、document 内のテキストの検索に使用することができる nsIWebBrowserFind オブジェクトを含みます。

webNavigation
型: nsIWebNavigation
この読み取り専用のプロパティは document の nsIWebNavigation オブジェクトを含みます。このメソッドのほとんどは、goBack や goForward のように要素自身から直接呼び出せます。また、reloadWithFlags および loadURIWithFlags によって使用される読み込み定数を含みます。

[編集] メソッド

getEditor( window )
戻り値の型: nsIEditor
document を操作するための多くのメソッドを含む、editor のための編集インタフェースを返します。引数として editor の contentWindow を渡してください。

getHTMLEditor( window )
戻り値の型: nsIHTMLEditor
HTML document を操作するためのメソッドを含む、editor のための HTML 編集インタフェースを返します。引数として editor の contentWindow を渡してください。

makeEditable( editortype, waitForLoad )
戻り値の型: 戻り値なし
この関数は editor による編集を有効にします。editortype として text または html を指定してください。

XUL 要素からの継承
blur, click, doCommand, focus, getElementsByAttribute

DOM 要素からの継承
addEventListener, appendChild, dispatchEvent, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, hasAttribute, hasAttributeNS, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, removeEventListener, replaceChild, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS

[編集] 関連項目

インタフェース
nsIAccessibleProvider
"http://developer.mozilla.org/ja/docs/XUL:editor" より作成