tabbrowser

この要素は Web ドキュメントの読み込み専用表示の一式を保持するために使用されます。これは browser 要素に似ていますが、複数のドキュメントをそれぞれ区切られたタブで表示できます。

属性

autocompleteenabled, autocompletepopup, autoscroll, contentcontextmenu, contenttooltip, handleCtrlPageUpDown, onbookmarkgroup, onnewtab, tabmodalPromptShowing

プロパティ

browsers, canGoBack, canGoForward, contentDocument, contentTitle, contentViewerEdit, contentViewerFile, contentWindow, currentURI, docShell, documentCharsetInfo, homePage, markupDocumentViewer, securityUI, selectedBrowser, selectedTab, sessionHistory, tabContainer, tabs, visibleTabs, webBrowserFind, webNavigation, webProgress

メソッド

addProgressListener, addTab, addTabsProgressListener,appendGroup, getBrowserAtIndex, getBrowserIndexForDocument, getBrowserForDocument, getBrowserForTab, getIcon, getNotificationBox, getTabModalPromptBox, goBack, goBackGroup, goForward, goForwardGroup, goHome, gotoIndex, loadGroup, loadOneTab, loadTabs, loadURI, loadURIWithFlags, moveTabTo, pinTab, reload, reloadAllTabs, reloadTab, reloadWithFlags, removeAllTabsBut, removeCurrentTab, removeProgressListener, removeTab, removeTabsProgressListener,replaceGroup, selectTabAtIndex, setIcon, showOnlyTheseTabs, stop, unpinTab

属性

プロパティ

メソッド

addProgressListener( listener )

戻り値の型: 戻り値無し

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

addTab( URL, referrerURI, charset, postData, owner, allowThirdPartyFixup )

戻り値の型: tab 要素

指定した URL のページを読み込む新しいタブを開きます。残りの引数は任意です。必要に応じてタブバーが表示されます。

例は Code snippets:Tabbed browser をご覧ください。

文字列から postData を準備するには Preprocessing POST Data をご覧ください。

addTabsProgressListener( listener )

Return type: no return value

Add a progress listener to the browser which will monitor loaded documents in all tabs in the tabbed browser. The progress listener should be based on the nsIWebProgressListener interface with an additional "browser" argument as the first argument of every method, which is the browser (not <tabbrowser> = gBrowser) where the event occurred. See Listening to events on all tabs for details.

appendGroup( group )

戻り値の型: 戻り値無し

※ Firefox では使用不可

いくつかの新しいタブを既存のタブの次に追加します。引数は、タブに読み込む各ドキュメントオブジェクトの配列です。オブジェクトはスクリプトで定義され、読み込むページの URL の URI プロパティを含みます。 referrerURI プロパティは、リファラページを設定するために任意で使用されます。

getBrowserAtIndex( index )

型: browser 要素

指定した tab index (index) の位置の browser を返します。

getBrowserIndexForDocument( document )

戻り値の型: 整数型

指定した document の browser の index を返します。

getBrowserForDocument( document )

型: browser 要素

指定した document の browser を返します。

getBrowserForTab( tab )

型: browser 要素

指定した tab 要素の browser を返します。

getIcon( aTab )

戻り値: string

指定タブのファビコンの URL を返します。 aTab（第二引数）が null の場合は、現在のタブのアイコンが返されます。アイコンのセット方法については setIcon のページを参照して下さい。

getNotificationBox( browser )

型: notificationbox 要素

指定した browser 要素の notificationbox を返します。

getTabModalPromptBox( browser )

Return type: object

Returns an object that manages tab-modal prompts for the specified browser. Returns a promptBox object representing the new prompt.

goBack()

戻り値の型: 戻り値無し

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

goBackGroup()

Firefox では使用不可

戻り値の型: 戻り値無し

前のタブグループへ戻ります。

goForward()

戻り値の型: 戻り値無し

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

goForwardGroup()

Firefox では使用不可

戻り値の型: 戻り値無し

次のタブグループへ進みます。

goHome()

戻り値の型: 戻り値無し

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

gotoIndex( index )

戻り値の型: 戻り値無し

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

loadGroup( group )

Not in Firefox

戻り値の型: 最初の tab

ページのグループを複数のタブに読み込みます。これらは browser.tabs.loadGroup 設定の状態によって、それぞれ追加、または置き換えられます。引数は、タブに読み込む各ドキュメントオブジェクトの配列です。オブジェクトはスクリプトで定義され、読み込むページの URL の URI プロパティを含みます。referrerURI プロパティは、リファラページを設定するために任意で使用されます。この関数は最初に読み込まれたタブへの参照を返します。

形式 1: loadOneTab( URL, referrerURI, charset, postData, loadInBackground, allowThirdPartyFixup )

形式 2: loadOneTab( URL, { referrerURI: ..., charset: ..., postData: ..., inBackground: ..., allowThirdPartyFixup: ..., relatedToCurrent: ... })

戻り値の型: tab 要素

指定した URL のページを読み込む新しいタブを開きます。残りの引数は任意です。このメソッドは addTab と同じ動作をしますが、loadInBackground 引数で新しいタブを前面と背面のどちらに開くかを選ぶことができます。また、owner タブは自動的に指定されるため、owner 引数はありません。

inBackground

true の場合、タブはバックグラウンドでロードされます。 false の場合はタブは新たに選択したタブになります。 引数が null かまたは無指定の場合、このパラメータは browser.tabs.loadInBackground の設定に追従します。

Firefox 3.6 における注記

このメソッドの 2 つ目の形式は Firefox 3.6 で追加されたものです。 relatedToCurrent パラメータが追加されており、パラメータは任意の順序で、名前によって指定することができます。

loadTabs( uris, loadInBackground, replace )

戻り値の型: 戻り値無し

uris 配列で指定された URI のセットをタブに読み込みます。loadInBackground が true の場合、これらのタブは背面に読み込まれます。replace が true の場合、タブを追加する代わりに、現在表示されているタブが指定した URI に置き換えられます。

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() をご覧ください。)

moveTabTo(tab, index)

Return type: tab element

Tries to moves an existing tab to a given index.

pinTab( tabElement )

戻り値の型 : 戻り値無し

指定 tab 要素を app タブにピン留めします。

reload()

戻り値の型: 戻り値無し

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

reloadAllTabs()

戻り値の型: 戻り値無し

すべてのタブのコンテンツを再読み込みします。

reloadTab( tab )

戻り値の型: 戻り値無し

指定タブのコンテンツを再読み込みします。

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 を再度読み込む必要がある場合に使用されます。

removeAllTabsBut( tabElement )

戻り値の型: 戻り値なし

指定したタブを除くすべてのタブパネルを削除します。タブページが 1 つしか表示されていない場合、このメソッドは何もしません。

removeCurrentTab()

戻り値の型: tab 要素

現在表示されているタブページを削除します。 タブが 1 つのみ表示されている場合、このメソッドは何もしません。

removeProgressListener( listener )

戻り値の型: 戻り値なし

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

removeTab( tabElement )

戻り値の型: 戻り値なし

与えられた tab 要素に対応する特定のタブ化されたページを削除します。 If only one tab is displayed, this method does nothing (unless the preference browser.tabs.closeWindowWithLastTab is true, in which case the window containing the tab is closed). If browser.tabs.autoHide is true, the row of tabs will collapse if only one tab remains.

removeTabsProgressListener( listener )

Return type: no return value

Removes a progress listener to the browser which has been monitoring all tabs. The progress listener should implement the nsIWebProgressListener interface.

replaceGroup( group )

Firefox では使用不可

戻り値の型: セッション履歴オブジェクトの配列

既存のタブを新しいセットで置き換えます。置き換え前のタブの方が多い場合は、余りのタブは削除されません。先に既存のタブを削除して完全に置き換えるには removeTab メソッドを使用してください。引数は読み込む各ドキュメントオブジェクトの配列です。オブジェクトはスクリプトで定義され、読み込むページの URL の URI プロパティを含みます。referrerURI プロパティは、リファラページを設定するために任意で使用されます。このメソッドは、削除されたタブのセッション履歴オブジェクトの配列を返します。

selectTabAtIndex( index, event )

戻り値の型: 戻り値無し

引数 index で指定した位置のタブを選択します。index には負の値も指定可能です。引数 event が指定されている場合は、デフォルトのイベント処理は行われなくなり、イベントの伝播も発生しません。

setIcon( aTab, aURI )

戻り値の型: 戻り値無し

第一引数 (aTab) に指定したタブのファビコンを、第二引数 (aURI) に指定した URI の画像に設定します。現在のアイコンの取得方法については getIcon のページを参照して下さい。

showOnlyTheseTabs( aTabs )

戻り値の型 : 戻り値無し

aTabs 配列内のすべてのタブを表示、他のすべてのタブを非表示にします。

stop()

戻り値の型: 戻り値無し

中止ボタンの押下と同じです。現在の document の読み込みを中止します。

unpinTab( tabElement )

Return type: no return value

Unpins the specified tab element, making it no longer an app tab.

関連項目

• Code snippets:Tabbed browser