XUL:browser

出典: MDC

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

ウェブドキュメントのビューを含むことが期待されているフレーム。ページの履歴を持っていることと現在表示するページを操作するための追加のメソッドを含んでいること以外は iframe に似ています。

browser の大半のプロパティとメソッドが使われることは稀で、chrome URL のみから呼び出すことができます。他の URL は表示されている文書を変更するために document と history オブジェクトを使う必要があるでしょう。

属性

autocompleteenabled, autocompletepopup, autoscroll, disablehistory, disablesecurity, homepage, showcaret, src, type

プロパティ

accessibleType, canGoBack, canGoForward, contentDocument, contentPrincipal, contentTitle, contentViewerEdit, contentViewerFile, contentWindow, currentURI, docShell, documentCharsetInfo, homePage, markupDocumentViewer, preferences, securityUI, sessionHistory, webBrowserFind, webNavigation, webProgress

メソッド

addProgressListener, goBack, goForward, goHome, gotoIndex, loadURI, loadURIWithFlags, reload, reloadWithFlags, removeProgressListener, stop

[編集] 例

<!-- groupbox の中に Mozilla のホームページを表示 -->
<groupbox flex="1">
  <caption label="Mozilla のホームページ"/>
  <browser type="content" src="http://www.mozilla.org" flex="1"/>
</groupbox>

[編集] 属性

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

autocompleteenabled

型: boolean

フィールドの自動補完を有効にするには true に設定してください。

autocompletepopup

型: popup 要素の id

popup 要素の id は、要素のための自動補完の候補を保持します。

autoscroll

型: boolean

この browser の自動スクロールを無効にするには false に設定します。この属性を true に設定するか省略した場合、自動スクロールが有効になるか、ユーザ設定の general.autoScroll に従います。

disablehistory

型: boolean

false の場合、すべての利用可能な候補のドロップダウンメニューを開く矢印ボタンが textbox の末尾に表示されます。デフォルト値は、ドロップダウンボタンが隠れている true です。

disablesecurity

型: boolean

この browser のセキュリティ UI を無効にするには、この属性を true に設定します。有効にするには、この属性を省略してください。

homepage

型: ホームページの URL

この属性は browser 要素のホームページを設定します。ユーザのブラウザホームページとは関係ありませんが、ホームページを保持する便利なプロパティになります。このホームページに切り替えるには goHome メソッドを使用します。

showcaret

型: boolean

コンテンツ領域に文字入力のキャレットを表示するかどうかを設定します。デフォルト値は false です。

src

型: URL

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

type

型: 下記の値のいずれか一つ

browser 内に読み込まれたドキュメントのアクセスを設定するための browser の形式。これが設定されていない場合、読み込まれたドキュメントは browser を含む window と同じアクセスを持ちます。

• content: コンテンツのためのブラウザ。browser 内に読み込まれたコンテンツは chrome より上位へのアクセスが許可されません。
• content-primary: コンテンツのための一次ブラウザ。browser 内に読み込まれたコンテンツは chrome より上位へのアクセスが許可されません。つまり、ウェブブラウザ内では、これはウェブページを表示する要素になります。一次コンテンツの 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 オブジェクトの種類を示す値。

canGoBack

型: boolean

セッション履歴で前のページに移動できるとき、このプロパティは true になり、Back ボタンが有効になります。このプロパティは読み取り専用です。

canGoForward

型: boolean

セッション履歴で次のページに移動できるとき、このプロパティは true になり、Forward ボタンが有効になります。このプロパティは読み取り専用です。

contentDocument

型: document

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

contentPrincipal

型: nsIPrincipal

この読み取り専用のプロパティは browser に読み込まれたコンテンツの、セキュリティ関係の情報を提供する主部を含みます。

contentTitle

型: string

この読み取り専用のプロパティは browser 内の document オブジェクトの title を含みます。

contentViewerEdit

型: nsIContentViewerEdit

この読み取り専用のプロパティは、document 上のクリップボード操作を扱う nsIContentViewerEdit を含みます。

contentViewerFile

型: nsIContentViewerFile

document の nsIContentViewerFile インタフェースへの参照。

contentWindow

型: window

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

currentURI

型: nsIURI

この読み取り専用のプロパティは現在読み込まれている URL を含みます。URL を変更するには loadURI メソッドを使用してください。

docShell

型: nsIDocShell

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

documentCharsetInfo

型: nsIDocumentCharsetInfo

この読み取り専用のプロパティは document の nsIDocumentCharsetInfo オブジェクトを含みます。このオブジェクトは document の表示に使用される文字セットを扱うために使用します。

homePage

型: ホームページ URL の string

このプロパティはユーザのホームページ設定の値を保持します。

markupDocumentViewer

型: nsIMarkupDocumentViewer

この読み取り専用のプロパティは、document を描画する nsIMarkupDocumentViewer を含みます。

preferences

型: nsIPrefService

この読み取り専用のプロパティは、ユーザ設定の取得と設定を行う nsIPref オブジェクトを含みます。

securityUI

型: nsISecureBrowserUI

この読み取り専用のプロパティは、読み込まれた document のセキュリティレベルを決定するオブジェクトを含みます。

sessionHistory

型: nsISHistory

この読み取り専用のプロパティは、セッション履歴を保持する nsISHistory オブジェクトを含みます。

webBrowserFind

型: nsIWebBrowserFind

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

webNavigation

型: nsIWebNavigation

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

webProgress

型: nsIWebProgress

この読み取り専用のプロパティは、document 読み込みの進捗をモニターする nsIWebProgress オブジェクトを含みます。

[編集] メソッド

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

addProgressListener( listener )

戻り値の型: 戻り値なし

読み込まれた document をモニターする進捗リスナーを browser に追加します。進捗リスナーは nsIWebProgressListener インタフェースを実装しなければなりません。

goBack()

戻り値の型: 戻り値なし

履歴内のページを一つ戻ります。

goForward()

戻り値の型: 戻り値なし

履歴内のページを一つ進みます。

goHome()

戻り値の型: 戻り値なし

ユーザのホームページを browser に読み込みます。

gotoIndex( index )

戻り値の型: 戻り値なし

与えられた index を持つ履歴内のページへ移動します。先へ進むには正の整数、前へ戻るには負の整数を使用します。

loadURI( uri, referrer, charset )

戻り値の型: 戻り値なし

与えられた referrer と charset で URL を document に読み込みます。

loadURIWithFlags( uri, flags, referrer, charset, postData )

戻り値の型: 戻り値なし

引数に指定した読み込みフラグ(flags) および与えられたリファラ(referrer)、文字セット(charset)、POST データで URL を document に読み込みます。reloadWithFlags メソッドで許可されたフラグに加え、次のフラグも有効です。

• LOAD_FLAGS_IS_REFRESH: このフラグは、meta タグの refresh や redirect によって URL が読み込まれたときに使用されます。
• LOAD_FLAGS_IS_LINK: このフラグは、ユーザがリンクをクリックして URL が読み込まれたときに使用されます。これに応じて HTTP Referer ヘッダが設定されます。
• LOAD_FLAGS_BYPASS_HISTORY: URL をセッション履歴に追加しません。
• LOAD_FLAGS_REPLACE_HISTORY: セッション履歴内の現在の URL を新しいものと置き換えます。このフラグはリダイレクトに使用されます。

(referrer および postData 引数の詳細は nsIWebNavigation.loadURI() をご覧ください。)

reload()

戻り値の型: 戻り値なし

browser 内の document を再度読み込みます。

reloadWithFlags( flags )

戻り値の型: 戻り値なし

browser 内の document を与えられた読み込みフラグ(flags) で再度読み込みます。下記のフラグが使用されます。これらはすべて webNavigation プロパティ (または nsIWebNavigation インタフェース) の定数です。記号( | ) を使用してフラグを組み合わせることができます。

• LOAD_FLAGS_NONE: 特別なフラグなし。document は普通に読み込まれます。
• LOAD_FLAGS_BYPASS_CACHE: ページを再度読み込みます。ページがキャッシュ内にあっても無視されます。このフラグは reload ボタンが Shift キーを押しながら押下されたときに使用されます。
• LOAD_FLAGS_BYPASS_PROXY: プロクシサーバを無視してページを再度読み込みます。
• LOAD_FLAGS_CHARSET_CHANGE: このフラグは、文字セットが変更されたため document を再度読み込む必要がある場合に使用されます。

removeProgressListener( listener )

戻り値の型: 戻り値なし

進捗リスナーを browser から削除します。

stop()

戻り値の型: 戻り値なし

中止ボタンの押下と同じです。このメソッドは現在の document の読み込みを中止します。

[編集] 関連項目

インタフェース

nsIAccessibleProvider