nsIWebProgressListener

メソッド概要

定数

遷移状態フラグ(State Transition Flags)

これらのフラグは、リクエストがロードされ、遷移しているさまざまな状態を表します。これらのフラグは排他的です。

リクエストが与えられる度、onStateChange() が呼び出されます。 STATE_START を伴って一回、STATE_TRANSFERRING フラグを伴ってゼロまたは数回、STATE_REDIRECTING と一回、最終的にSTATE_STOP を伴って一回、onStateChange() は呼び出されます。

状態種類フラグ(State Type Flags)

これらのフラグは、発生しているトランザクションの状態についての実態をより詳しく説明します。これらのフラグは排他的ではありません( onStateChange() イベントはこれらのフラグが組み合わさっていることを示すかもしれません。)

状態変更フラグ(State Modifier Flags)

これらのフラグは、発生しているトランザクションの状態についての実態をより詳しく説明します。これらのフラグは排他的ではありません( onStateChange() イベントはこれらのフラグが組み合わさっていることを示すかもしれません。)

セキュリティ状態フラグ(State Security Flags)

これらのフラグは onSecurityChange() が呼び出されることによって 報告されるセキュリティの状態について説明します。これらのフラグは排他的です。

セキュリティ強度フラグ(Security Strength Flags)

これらのフラグは、セキュリティの強度と、onSecurityChange() メソッドの呼び出しに伴う STATE_IS_SECURE について説明します。これらのフラグは排他的です。

これらのフラグは、データ転送のセキュリティについて厳密な詳細を提供することを意味しません。これらは代わりに、セキュリティ通知の色区分や、その他ユーザー向けの基本的なデータ転送のフィードバックなどのような、簡易的なインジケータで使用されることを意図しています。

アイデンティティ状態フラグ（State identity flags）

これらのフラグは、onSecurityChange() メソッドの呼び出しにおける、身元検証のレベルについて説明します。

ロケーション変更状態フラグ (Location Change flags)

メソッド

onLocationChange()

変更を監視されているウィンドウのロケーションが変更された際に呼び出されます。読み込みがリクエストされたときではなく、与えられたウィンドウにおいて読み込みが発生しようとしているの一度確認された際に呼び出されます。たとえば、ウィンドウに於いて開始した読み込みが、新しいサイトに向けてプログレスとステータスメッセージを送信していたとしても、新たなページが読み込まれていると私たちが確認するまでは、onLocationChange は呼び出されないでしょう。別の例として、ブラウザの中でドキュメントが読み込まれているのではなく、サードパーティのツールへとドキュメントが渡された場合、PDFやフラッシュの読み込みでは onLocationChange は呼び出されないでしょう。

void onLocationChange(
  in nsIWebProgress aWebProgress,
  in nsIRequest aRequest,
  in nsIURI aLocation
  [optional] in unsigned long aFlags
);

引数

aWebProgress

通知が発生した nsIWebProgress インスタンス。

aRequest

関連する nsIRequest 。いくつかの場合では、この値は null かもしれません。

aLocation

読み込まれているロケーションの URI 。

aFlags

オプション：この値は、ロケーションが変更された状況や理由について表します。 Optional from Gecko 10

onProgressChange()

aWebProgress に関連するリクエストのひとつの変更されたプログレスを通知します。（STATE_STOP と STATE_IS_WINDOW フラグを含む aStateFlags を伴って呼び出された onStateChange() に対応する） aWebProgress の全てのリクエストが完了したとき、プログレス全体はゼロへとリセットされます。

void onProgressChange(
  in nsIWebProgress aWebProgress,
  in nsIRequest aRequest,
  in long aCurSelfProgress,
  in long aMaxSelfProgress,
  in long aCurTotalProgress,
  in long aMaxTotalProgress
);

引数

aWebProgress

通知が発生した nsIWebProgress インスタンス。

aRequest

新しいプログレスを持つ nsIRequest 。

aCurSelfProgress

リクエストの現在のプログレス。

aMaxSelfProgress

リクエストの最大のプログレス。

aCurTotalProgress

aWebProgress に関連する全てのリクエストにおける、現在のプログレス。

aMaxTotalProgress

aWebProgress に関連する全てのリクエストにおける、全体のプログレス。

onSecurityChange()

セキュリティプログレスを通知します。このメソッドは （例えば HTTP -> HTTPS または HTTP, FOO -> HTTPS といった）セキュリティの遷移に応じて、およびドキュメントの読み込みの完了と共に呼び出されます。ネットワーク読み込みの間にエラーが発生した場合でも、同様に呼び出されます。

void onSecurityChange(
  in nsIWebProgress aWebProgress,
  in nsIRequest aRequest,
  in unsigned long aState
);

引数

aWebProgress

通知が発生した nsIWebProgress インスタンス。

aRequest

新しいセキュリティ状態の nsIRequest 。

aState

上述のセキュリティ状態フラグとセキュリティ強度フラグによって構成された値。将来的には未定義なビット列を受け取ることになるかもしれません。

onStateChange()

aWebProgress に関連するリクエストのいずれかの状態が変更されたことを通知します。

void onStateChange(
  in nsIWebProgress aWebProgress,
  in nsIRequest aRequest,
  in unsigned long aStateFlags,
  in nsresult aStatus
);

引数

aWebProgress

通知が発生した nsIWebProgress インスタンス。

aRequest

状態が変更した nsIRequest 。この引数は null である場合があります。

aStateFlags

新しい状態のフラグを表します。この値は、上述した遷移状態フラグのひとつと、状態種類フラグのひとつ、または複数によって構成されています。将来的には未定義なビット列を受け取ることになるかもしれません。

aStatus

状態の変更に関連するエラーステータスコードです。この引数は aStateFlag が STATE_STOP ビットを含まない限りは無視されます。ステータスコードは状態の変更に関連するリクエストの成功または失敗を示します。

註：HTTP 404 File Not Found エラーのようなサーバー側で発生したエラーに対しても、成功したとのコードを示すかもしれません。こうした場合において、リクエスト自体のエラー情報については、（HTTPリクエストについては nsIHttpChannel を参照するなど）拡張されたエラー情報を問い合わせるべきです。

onStatusChange()

リクエストのステータスが変更されたことを通知します。ステータスメッセージは、ブラウザのステータスバーなどといった、ユーザーへの表示を意図されています。

void onStatusChange(
  in nsIWebProgress aWebProgress,
  in nsIRequest aRequest,
  in nsresult aStatus,
  in wstring aMessage
);

引数

aWebProgress

通知が発火した　nsIWebProgress 。

aRequest

新たなステータスを持つ nsIRequest 。

aStatus

この値はエラーコードではありません。その代わり、現在のリクエストのステータスを示す数値になります。このインターフェースはステータスコードの設定が可能なようには定義されていません。

註：いくつかのステータス値は、nsITransport および nsISocketTransportで定義されています

aMessage

aStatus に対応するローカライズされたテキスト。

例

タブごとへの nsIWebProgressListener:

• gBrowser.mTabProgressListener による作成

gBrowser.mProgressListeners (上で述べたようにタブ毎の nsIWebProgressListener によって起動される):

• XULBrowserWindow.onStateChange (etc.)