gBrowser/メソッド - userChrome.js作成メモWiki

ローカルメソッドと思われる物（最初がアンダーバーで始まるもの）は書き出していない。

• tabbrowser - MDC Doc Center

gBrowser独自のメソッド

isFindBarInitialized(aTab)

getFindBar(aTab)

getStatusPanel()

updateWindowResizers()

ウィンドウ右下のリサイズグリップの表示フラグを各browserに設定する。

pinTab(aTab)

タブをピン留めする。aTabに"TabPinned"イベントが発行される。

unpinTab(aTab)

ピンのピン留めを解除する。aTabに"TabUnpinned"イベントが発行される。

previewTab(aTab, aCallback)

getBrowserAtIndex(aIndex)

タブインデックスからブラウザーオブジェクトを取得する。

getBrowserIndexForDocument(aDocument)

Documentオブジェクトをキーにして、それが所属するブラウザーオブジェクトのインデックスを返す。

getBrowserForDocument(aDocument)

Documentオブジェクトをキーにして、それが所属するブラウザーオブジェクトを返す。

_getTabForContentWindow(aWindow)

Windowオブジェクトをキーにして、そのウィンドウのタブを返す。

_getTabForBrowser(aBrowser)

ブラウザーオブジェクトをキーにして、そのタブを返す。

getNotificationBox(aBrowser)

getSidebarContainer(aBrowser)

getBrowserContainer(aBrowser)

getTabModalPromptBox(aBrowser)

mTabProgressListener(aTab, aBrowser, aStartsBlank)

setIcon(aTab, aURI)

getIcon(aTab)

shouldLoadFavIcon(aURI)

useDefaultIcon(aTab)

isFailedIcon(aURI)

getWindowTitleForBrowser(aBrowser)

updateTitlebar()

updateCurrentBrowser(aForceUpdate)

選択されたタブに従ってCurrentBrowserを切り替える関数。ユーザーがこの関数を直接使うような事は普通はしないだろう。
CurrentTabに"TabSelect"イベントが発行される。

_tabAttrModified(aTab)

aTabに"TabAttrModified"イベントを発行するためだけの関数。

setTabTitleLoading(aTab)

setTabTitle(aTab)

loadOneTab(aURI, aReferrerURI, aCharset, aPostData, aLoadInBackground, aAllowThirdPartyFixup)

タブを一つ開く。
引数が2個で、第2引数がそれ以降の引数＋αを内包したオブジェクトとなっている方式がFirefox3.6より導入された。引数3個以上は互換性維持のために残してあるだけ。
第2引数のオブジェクトは

{
  referrerURI          : null,     // nsIURIオブジェクト
  charset              : 'UTF-8',  // 'UTF-8' とか 'Shift_JIS' とか
  postData             : null,
  inBackground         : false,    // バックグラウンドで開く時true
  allowThirdPartyFixup : false,
  fromExternal         : false,
  relatedToCurrent     : false,    // カレントページの隣に開く時true
  isUTF8               : false,    // aURIがUTF8かどうか
} 

• loadOneTab - MDC Doc Center

loadTabs(aURIs, aLoadInBackground, aReplace)

複数のURLによる配列を渡して複数のタブを開く。

addTab(aURI, aReferrerURI, aCharset, aPostData, aOwner, aAllowThirdPartyFixup)

タブを一つバックグラウンドで開き、作成されたaTabを返す。aTabには"TabOpen"イベントが発行される。
引数が2個で、第2引数がそれ以降の引数＋αを内包したオブジェクトとなっている方式がFirefox3.6より導入された。引数3個以上は互換性維持のために残してあるだけ。
第2引数のオブジェクトは

{
  referrerURI          : null,     // nsIURIオブジェクト
  charset              : 'UTF-8',  // 'UTF-8' とか 'Shift_JIS' とか
  postData             : null,
  ownerTab             : null,     // 親タブ xul:tab
  allowThirdPartyFixup : false,
  fromExternal         : false,
  relatedToCurrent     : false,    // カレントページの隣に開く時true
  skipAnimation        : false,
  isUTF8               : false,    // aURIがUTF8かどうか
} 

• addTab - MDC Doc Center

warnAboutClosingTabs(aCloseTabs, aTab)

開いている複数のタブ全てを閉じようとする時に表示される警告ダイアログを出す。
第一引数の aCloseTabs には gBrowser.closingTabsEnum の3つの値のどれかを設定する。
閉じるタブ数が1個以下の時やダイアログ非表示設定の時は自動的に true が返る。それ以外はダイアログ結果によって true/false が返ってくる。

getTabsToTheEndFrom(aTab)

指定したタブより右のタブの配列を取得する。

removeTabsToTheEndFrom(aTab)

指定したタブより右のタブを閉じる。

removeAllTabsBut(aTab)

指定したタブ以外を削除する。

removeCurrentTab(aParams)

カレントタブを削除する。removeTab() に mCurrentTab を渡してるだけ。

removeTab(aTab, aParams)

タブを削除する。
第2引数のオブジェクトは

{
  animate : false,
  byMouse : false,  // タブをマウスクリックで削除の場合true。アニメーション処理が変わる（タブバー上にマウスがある限りタブの横幅が変わらない）
} 

swapNewTabWithBrowser(aNewTab, aBrowser)

swapBrowsersAndCloseOther(aOurTab, aOtherTab)

reloadAllTabs()

全てのタブをリロードする。

reloadTab(aTab)

タブをリロード。実体は aTab.linkedBrowser.reload() である。

addProgressListener(aListener)

removeProgressListener(aListener)

addTabsProgressListener(aListener)

removeTabsProgressListener(aListener)

getBrowserForTab(aTab)

タブからブラウザーオブジェクトを取得する。実体は aTab.linkedBrowser

showOnlyTheseTabs(aTab)

showTab(aTab)

aTabに"TabShow"イベントが発行される。

hideTab(aTab)

aTabに"TabHide"イベントが発行される。

selectTabAtIndex(aIndex, aEvent)

指定されたインデックスのタブを選択する。
aEvent はイベントキャンセル（preventDefault と stopPropagation）するために指定するだけ。

replaceTabWithWindow(aTab)

タブを新しいウィンドウとして切り離す。

moveTabTo(aTab, aIndex)

タブを指定したタブ配列インデックスに移動させる。

moveTabForward() / moveTabBackward()

カレントタブをタブ配列の一つ前/後ろへ移動させる。

moveTabToStart() / moveTabToEnd()

カレントタブをタブ配列の一番最初/最後へ移動させる。

moveTabOver(aEvent)

duplicateTab(aTab)

タブを複製する。複製されたタブはタブ配列の一番最後に追加される。

attachFormFill()

detachFormFill()

createTooltip(event)

handleEvent(aEvent)

receiveMessage(aMessage)

setStripVisibilityTo(aShow)

getStripVisibility()

mCurrentBrowser にそのままリダイレクトしているメソッド

goBack()

goForward()

reload()

reloadWithFlags(aFlags)

stop()

loadURI(aURI, aReferrerURI, aCharset)

loadURIWithFlags(aURI, aFlags, aReferrerURI, aCharset, aPostData)

goHome()

gotoIndex(aIndex)