Adobe® Flash® Platform 用 ActionScript® 3.0 リファレンスガイド
ホーム  |  パッケージおよびクラスリストの非表示 |  パッケージ  |  クラス  |  新機能  |  索引  |  付録  |  英語で表示される理由
フィルター: サーバーからデータを取得しています...
サーバーからデータを取得しています...
org.osmf.traits 

LoadTrait  - AS3 OSMF

パッケージorg.osmf.traits
クラスpublic class LoadTrait
継承LoadTrait Inheritance MediaTraitBase Inheritance EventDispatcher Inheritance Object

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

LoadTrait は、表示前にロードする必要のあるメディアの特性インターフェイスを定義します。これは、より具体的な LoadTrait サブクラスの基本クラスとしても使用できます。

hasTrait(MediaTraitType.LOAD)true を返す場合は、MediaElement.getTrait(MediaTraitType.LOAD) メソッドを使用して、このタイプのオブジェクトを取得します。

関連する API エレメント



パブリックプロパティ
 プロパティ定義元
  bytesLoaded : Number
[読み取り専用] ロードされたデータのバイト数です。
LoadTrait
  bytesTotal : Number
[読み取り専用] ロードされるデータの合計サイズです(バイト単位)。
LoadTrait
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。
Object
  loadState : String
[読み取り専用] この特性のロード状態です。
LoadTrait
  resource : MediaResourceBase
[読み取り専用] この LoadTrait にロードされるメディアを表すリソースです。
LoadTrait
 InheritedtraitType : String
[読み取り専用] この特性の MediaTraitType です。
MediaTraitBase
パブリックメソッド
 メソッド定義元
  
コンストラクターです。
LoadTrait
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
EventDispatcher
 Inherited
イベントをイベントフローに送出します。
EventDispatcher
 Inherited
この特性が使用するすべてのリソースを破棄します。
MediaTraitBase
 Inherited
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
  
このメディアをこの LoadTrait にロードします。
LoadTrait
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのストリング表現を返します。
Object
  
この LoadTrait をアンロードします。
LoadTrait
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
 Inherited
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
プロテクトメソッド
 メソッド定義元
  
bytesLoaded プロパティが変更された直後に呼び出されます。
LoadTrait
  
bytesLoaded プロパティが変更される直前に呼び出されます。
LoadTrait
  
bytesTotal プロパティが変更された直後に呼び出されます。
LoadTrait
  
bytesTotal プロパティが変更される直前に呼び出されます。
LoadTrait
  
loadState プロパティが変更された直後に呼び出されます。
LoadTrait
  
loadState プロパティが変更される直前に呼び出されます。
LoadTrait
  
ロードされたデータのバイト数を設定します。
LoadTrait
  
ロードされるデータの合計サイズを設定します(バイト単位)。
LoadTrait
  
この LoadTrait のロード状態を設定します。
LoadTrait
イベント
 イベント 概要 定義元
 Inherited[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。EventDispatcher
  ロードされるデータの総バイト数が変更されたときに送出されます。LoadTrait
 Inherited[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。EventDispatcher
  LoadTrait の状態が変更されたときに送出されます。LoadTrait
プロパティの詳細

bytesLoaded

プロパティ
bytesLoaded:Number  [読み取り専用]

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

ロードされたデータのバイト数です。



実装
    public function get bytesLoaded():Number

bytesTotal

プロパティ 
bytesTotal:Number  [読み取り専用]

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

ロードされるデータの合計サイズです(バイト単位)。



実装
    public function get bytesTotal():Number

loadState

プロパティ 
loadState:String  [読み取り専用]

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

この特性のロード状態です。有効な値については、LoadState を参照してください。



実装
    public function get loadState():String

resource

プロパティ 
resource:MediaResourceBase  [読み取り専用]

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

この LoadTrait にロードされるメディアを表すリソースです。



実装
    public function get resource():MediaResourceBase
コンストラクターの詳細

LoadTrait

()コンストラクター
public function LoadTrait(loader:LoaderBase, resource:MediaResourceBase)

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

コンストラクターです。

パラメーター
loader:LoaderBase — この特性を所有するメディアエレメントのメディアをロードするために使用される LoaderBase インスタンスです。
 
resource:MediaResourceBase — ロードされるメディアリソースを表す MediaResourceBase インスタンスです。
メソッドの詳細

bytesLoadedChangeEnd

()メソッド
protected function bytesLoadedChangeEnd():void

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

bytesLoaded プロパティが変更された直後に呼び出されます。

bytesLoadedChangeStart

()メソッド 
protected function bytesLoadedChangeStart(newValue:Number):void

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

bytesLoaded プロパティが変更される直前に呼び出されます。

サブクラスでは、このメソッドをオーバーライドして、メディアに変更を通知できます。

パラメーター

newValue:Number — 新しい bytesLoaded 値です。

bytesTotalChangeEnd

()メソッド 
protected function bytesTotalChangeEnd():void

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

bytesTotal プロパティが変更された直後に呼び出されます。bytesTotalChange イベントが送出されます。

オーバーライドするサブクラスでは、このメソッドを呼び出して、bytesTotalChange イベントを送出する必要があります。

bytesTotalChangeStart

()メソッド 
protected function bytesTotalChangeStart(newValue:Number):void

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

bytesTotal プロパティが変更される直前に呼び出されます。

サブクラスでは、このメソッドをオーバーライドして、メディアに変更を通知できます。

パラメーター

newValue:Number — 新しい bytesTotal 値です。

load

()メソッド 
public function load():void

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

このメディアをこの LoadTrait にロードします。ロード状態を更新します。状態が変更されるたびに loadStateChange イベントが送出されます。

通常、メディアがロードしている間の状態は LOADING です。ロードが正常に完了すると READY になります。ロードを完了できない場合は LOAD_ERROR になります。

メソッドの呼び出し時に LoadState が LOADING または READY の場合は、エラーがスローされます。


例外
IllegalOperationError — この特性が自身をロードできない場合、または LoadState が LOADINGREADY の場合。

関連する API エレメント

loadStateChangeEnd

()メソッド 
protected function loadStateChangeEnd():void

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

loadState プロパティが変更された直後に呼び出されます。

loadStateChangeStart

()メソッド 
protected function loadStateChangeStart(newState:String):void

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

loadState プロパティが変更される直前に呼び出されます。

サブクラスでは、このメソッドをオーバーライドして、メディアに変更を通知できます。

パラメーター

newState:String — 新しい loadState 値です。

setBytesLoaded

()メソッド 
protected final function setBytesLoaded(value:Number):void

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

ロードされたデータのバイト数を設定します。

パラメーター

value:Number


例外
ArgumentError — 値が負、NaN、または bytesTotal より大きい場合。

setBytesTotal

()メソッド 
protected final function setBytesTotal(value:Number):void

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

ロードされるデータの合計サイズを設定します(バイト単位)。

パラメーター

value:Number


例外
ArgumentError — 値が負、または bytesLoaded より小さい場合。

setLoadState

()メソッド 
protected final function setLoadState(newState:String):void

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

この LoadTrait のロード状態を設定します。

パラメーター

newState:String

unload

()メソッド 
public function unload():void

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

この LoadTrait をアンロードします。ロード状態を更新します。状態が変更されるたびに loadStateChange イベントが送出されます。

通常、メディアがアンロードしている間の状態は UNLOADING です。アンロードが正常に完了すると UNINITIALIZED になります。アンロードを完了できない場合は LOAD_ERROR になります。

メソッドの呼び出し時に LoadState が READY でない場合は、エラーがスローされます。


例外
IllegalOperationError — この特性が自身をアンロードできない場合、または LoadState が READY でない場合。

関連する API エレメント

イベントの詳細

bytesTotalChange

イベント
イベントオブジェクトの型: org.osmf.events.LoadEvent
プロパティ LoadEvent.type = org.osmf.events.LoadEvent.BYTES_TOTAL_CHANGE

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

ロードされるデータの総バイト数が変更されたときに送出されます。

LoadEvent.BYTES_TOTAL_CHANGE 定数により、bytesTotalChange イベントのイベントオブジェクトの type プロパティ値が定義されます。

loadStateChange

イベント  
イベントオブジェクトの型: org.osmf.events.LoadEvent
プロパティ LoadEvent.type = org.osmf.events.LoadEvent.LOAD_STATE_CHANGE

言語バージョン: ActionScript 3.0
製品バージョン: OSMF 1.0
ランタイムバージョン: Flash Player 10, AIR 1.5

LoadTrait の状態が変更されたときに送出されます。

LoadEvent.LOAD_STATE_CHANGE 定数により、loadStateChange イベントのイベントオブジェクトの type プロパティ値が定義されます。




[ X ]英語で表示される理由
ActionScript 3.0 リファレンスガイドのコンテンツが英語で表示されます。

ActionScript 3.0 リファレンスガイドのすべての部分がすべての言語に翻訳されているわけではありません。言語エレメントが翻訳されていない場合、そのエレメントは英語で表示されます。例えば、ga.controls.HelpBox クラスはどの言語にも訳されていません。このため、リファレンスガイドの日本語バージョンでは、ga.controls.HelpBox クラスは英語で表示されます。