パッケージmx.preloaders
public class DownloadProgressBar
継承DownloadProgressBar Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
ImplementsIPreloaderDisplay

DownloadProgressBar クラスはダウンロードの進行状況を表示します。アプリケーションでダウンロードおよびロードを実行しているとき、ユーザーにフィードバックを提供するために Preloader コントロールで使用されます。

ダウンロードプログレスバーには、アプリケーションの 2 つの段階 (ダウンロード段階と初期化段階) に関する情報が表示されます。

<mx:Application> タグで、preloader プロパティを使用してサブクラスの名前を指定します。

DownloadProgressBar クラスのサブクラスを作成すると、カスタムダウンロードプログレスバーのコンポーネントを実装することができます。MXML コンポーネントとして実装すると、ロードに著しく時間がかかります。ダウンロードプログレスバーを MXML コンポーネントとして実装することは避けてください。

関連項目

mx.core.Application
mx.preloaders.IPreloaderDisplay
mx.preloaders.Preloader
カスタムプログレスバーの作成


パブリックプロパティ
 プロパティ定義
 InheritedaccessibilityProperties : AccessibilityProperties
この表示オブジェクトの現在のアクセシビリティオプションです。
DisplayObject
 Inheritedalpha : Number
指定されたオブジェクトのアルファ透明度値を示します。
DisplayObject
  backgroundAlpha : Number
backgroundImage プロパティで定義されている SWF ファイルまたはイメージのアルファレベル、または backgroundColor プロパティで定義されているカラーのアルファレベルです。
DownloadProgressBar
  backgroundColor : uint
ダウンロードプログレスバーの背景色です。
DownloadProgressBar
  backgroundImage : Object
プリローダーによって渡されるアプリケーションの背景イメージです。
DownloadProgressBar
  backgroundSize : String
backgroundImage で指定されているイメージを、元のサイズとは異なるサイズに拡大および縮小します。
DownloadProgressBar
 InheritedblendMode : String
使用するブレンドモードを指定する BlendMode クラスの値です。
DisplayObject
 InheritedbuttonMode : Boolean
このスプライトのボタンモードを指定します。
Sprite
 InheritedcacheAsBitmap : Boolean
true に設定されている場合、表示オブジェクトの内部ビットマップ表現が Flash Player にキャッシュされます。
DisplayObject
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
 InheritedcontextMenu : ContextMenu
このオブジェクトに関連付けられたコンテキストメニューを指定します。
InteractiveObject
 InheriteddoubleClickEnabled : Boolean
オブジェクトが doubleClick イベントを受け取るかどうかを指定します。
InteractiveObject
 InheriteddropTarget : DisplayObject
スプライトのドラッグ先またはスプライトがドロップされた先の表示オブジェクトを指定します。
Sprite
 Inheritedfilters : Array
表示オブジェクトに現在関連付けられている各フィルタオブジェクトが格納されているインデックス付きの配列です。
DisplayObject
 InheritedfocusRect : Object
このオブジェクトがフォーカス矩形を表示するかどうかを指定します。
InteractiveObject
 Inheritedgraphics : Graphics
ベクターの描画コマンドが発生するこのスプライトに属する Graphics オブジェクトを指定します。
Sprite
 Inheritedheight : Number
表示オブジェクトの高さを示します (ピクセル単位)。
DisplayObject
 InheritedhitArea : Sprite
スプライトのヒット領域となる別のスプライトを指定します。
Sprite
  initializingLabel : String
[static] 初期化段階でラベルとして表示するストリングです。
DownloadProgressBar
 InheritedloaderInfo : LoaderInfo
この表示オブジェクトが属するファイルのロード情報を含む LoaderInfo オブジェクトを返します。
DisplayObject
 Inheritedmask : DisplayObject
呼び出し元の表示オブジェクトは、指定された mask オブジェクトによってマスクされます。
DisplayObject
 InheritedmouseChildren : Boolean
オブジェクトの子に対してマウスが有効かどうかを調べます。
DisplayObjectContainer
 InheritedmouseEnabled : Boolean
このオブジェクトがマウスメッセージを受け取るかどうかを指定します。
InteractiveObject
 InheritedmouseX : Number
マウス位置の x 座標を示します (ピクセル単位)。
DisplayObject
 InheritedmouseY : Number
マウス位置の y 座標を示します (ピクセル単位)。
DisplayObject
 Inheritedname : String
DisplayObject のインスタンス名を示します。
DisplayObject
 InheritednumChildren : int
このオブジェクトの子の数を返します。
DisplayObjectContainer
 InheritedopaqueBackground : Object
表示オブジェクトが特定の背景色で不透明であるかどうかを指定します。
DisplayObject
 Inheritedparent : DisplayObjectContainer
この表示オブジェクトを含む DisplayObjectContainer オブジェクトを示します。
DisplayObject
  preloader : Sprite
[write-only] Preloader クラスは、プリローダーからイベントをリッスンできるように、クラス自体への参照を表示クラスに渡します。
DownloadProgressBar
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
 Inheritedroot : DisplayObject
ロードされた SWF ファイル内の表示オブジェクトの場合、root プロパティはその SWF ファイルが表す表示リストのツリー構造部分の一番上にある表示オブジェクトとなります。
DisplayObject
 Inheritedrotation : Number
DisplayObject インスタンスの元の位置からの回転角を度単位で示します。
DisplayObject
 Inheritedscale9Grid : Rectangle
現在有効な拡大 / 縮小グリッドです。
DisplayObject
 InheritedscaleX : Number
基準点から適用されるオブジェクトの水平スケール (percentage) を示します。
DisplayObject
 InheritedscaleY : Number
オブジェクトの基準点から適用されるオブジェクトの垂直スケール (percentage) を示します。
DisplayObject
 InheritedscrollRect : Rectangle
表示オブジェクトのスクロール矩形の境界。
DisplayObject
 InheritedsoundTransform : SoundTransform
このスプライト内のサウンドを制御します。
Sprite
 Inheritedstage : Stage
表示オブジェクトのステージ。
DisplayObject
  stageHeight : Number
ステージの高さ。Preloader クラスによって渡されます。
DownloadProgressBar
  stageWidth : Number
ステージの幅。Preloader クラスによって渡されます。
DownloadProgressBar
 InheritedtabChildren : Boolean
オブジェクトの子に対してタブが有効かどうかを調べます。
DisplayObjectContainer
 InheritedtabEnabled : Boolean
このオブジェクトがタブ順序序に含まれるかどうかを指定します。
InteractiveObject
 InheritedtabIndex : int
SWF ファイル内のオブジェクトのタブ順を指定します。
InteractiveObject
 InheritedtextSnapshot : TextSnapshot
この DisplayObjectContainer インスタンスの TextSnapshot オブジェクトを返します。
DisplayObjectContainer
 Inheritedtransform : Transform
表示オブジェクトのマトリックス、カラー変換、ピクセル境界に関係するプロパティを持つオブジェクト。
DisplayObject
 InheriteduseHandCursor : Boolean
buttonMode プロパティが true に設定されたスプライト上にマウスが移動したときに、指差しハンドポインタ (ハンドカーソル) を表示するかどうかを示すブール値です。
Sprite
  visible : Boolean
ダウンンロードプログレスバーを表示するかどうかを指定します。
DownloadProgressBar
 Inheritedwidth : Number
表示オブジェクトの幅を示します (ピクセル単位)。
DisplayObject
 Inheritedx : Number
親 DisplayObjectContainer のローカル座標を基準にした DisplayObject インスタンスの x 座標を示します。
DisplayObject
 Inheritedy : Number
親 DisplayObjectContainer のローカル座標を基準にした DisplayObject インスタンスの y 座標を示します。
DisplayObject
Protectedプロパティ
 プロパティ定義
  barFrameRect : RoundedRectangle
[read-only] プログレスバーの境界線のサイズです。
DownloadProgressBar
  barRect : RoundedRectangle
[read-only] プログレスバーのサイズです。
DownloadProgressBar
  borderRect : RoundedRectangle
[read-only] 表示の境界線のサイズです。
DownloadProgressBar
  downloadingLabel : String
ダウンロード段階でラベルとして表示するストリングです。
DownloadProgressBar
  DOWNLOAD_PERCENTAGE : uint = 60
SWF ファイルが完全にダウンロードされたときに、ダウンロード段階がプログレスバーを占めるパーセント。
DownloadProgressBar
  label : String
プログレスバーがアクティブなときに表示されるテキストです。
DownloadProgressBar
  labelFormat : TextFormat
[read-only] ラベルの TextField コンポーネントの TextFormat オブジェクトです。
DownloadProgressBar
  labelRect : Rectangle
[read-only] ラベルの TextField コンポーネントのサイズです。
DownloadProgressBar
  MINIMUM_DISPLAY_TIME : uint = 0
表示を可視にするまでの最小ミリ秒数。
DownloadProgressBar
  percentFormat : TextFormat
[read-only] パーセントを表示するための TextField コンポーネントの TextFormat です。
DownloadProgressBar
  percentRect : Rectangle
[read-only] パーセントを表示するための TextField コンポーネントのサイズです。
DownloadProgressBar
  showLabel : Boolean
ラベルを表示するか (true)、または表示しないか (false) を制御します。
DownloadProgressBar
  showPercentage : Boolean
パーセンテージを表示するか (true)、または表示しないか (false) を制御します。
DownloadProgressBar
パブリック Methods
 メソッド定義
  
コンストラクタ
DownloadProgressBar
 Inherited
この DisplayObjectContainer インスタンスに子 DisplayObject インスタンスを追加します。
DisplayObjectContainer
 Inherited
この DisplayObjectContainer インスタンスに子 DisplayObject インスタンスを追加します。
DisplayObjectContainer
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
リスナーがイベントの通知を受け取るように、イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録します。
EventDispatcher
 Inherited
特定の point ポイントを指定して呼び出した DisplayObjectContainer.getObjectsUnderPoint() メソッドから返されたリストに、セキュリティ上の制約のために省略される表示オブジェクトがあるかどうかを示します。
DisplayObjectContainer
 Inherited
指定された表示オブジェクトが、DisplayObjectContainer インスタンスの子であるか、インスタンス自体であるかを指定します。
DisplayObjectContainer
 Inherited
イベントをイベントフローに送出します。
EventDispatcher
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
targetCoordinateSpace オブジェクトの座標系を基準にして、表示オブジェクトの領域を定義する矩形を返します。
DisplayObject
 Inherited
指定のインデックス位置にある子表示オブジェクトインスタンスを返します。
DisplayObjectContainer
 Inherited
指定された名前に一致する子表示オブジェクトを返します。
DisplayObjectContainer
 Inherited
child DisplayObject インスタンスのインデックス位置を返します。
DisplayObjectContainer
 Inherited
指定されたポイントの下にあり、この DisplayObjectContainer インスタンスの子 (または孫など) であるオブジェクトの配列を返します。
DisplayObjectContainer
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
シェイプ上の線を除き、targetCoordinateSpace パラメータによって定義された座標系に基づいて、表示オブジェクトの境界を定義する矩形を返します。
DisplayObject
 Inherited
point オブジェクトをステージ (グローバル) 座標から表示オブジェクトの (ローカル) 座標に変換します。
DisplayObject
 Inherited
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 Inherited
指定されたプロパティがオブジェクトに定義されているかどうかを示します。
Object
 Inherited
表示オブジェクトを評価して、obj 表示オブジェクトと重複または交差するかどうかを調べます。
DisplayObject
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
表示オブジェクトを評価して、x および y パラメータで指定されたポイントと重複または交差するかどうかを調べます。
DisplayObject
  
ダウンロードプログレスバーが Preloader の子として追加されると、Preloader によって呼び出されます。
DownloadProgressBar
 Inherited
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
point オブジェクトを表示オブジェクトの (ローカル) 座標からステージ (グローバル) 座標に変換します。
DisplayObject
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
DisplayObjectContainer インスタンスの子リストから指定の child DisplayObject インスタンスを削除します。
DisplayObjectContainer
 Inherited
DisplayObjectContainer の子リストの指定された index 位置から子 DisplayObject を削除します。
DisplayObjectContainer
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
 Inherited
表示オブジェクトコンテナの既存の子の位置を変更します。
DisplayObjectContainer
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
指定されたスプライトをユーザーがドラッグできるようにします。
Sprite
 Inherited
startDrag() メソッドを終了します。
Sprite
 Inherited
指定された 2 つの子オブジェクトの z 順序 (重ね順) を入れ替えます。
DisplayObjectContainer
 Inherited
swapChildrenAt(index1:int, index2:int):void
子リスト内の指定されたインデックス位置に該当する 2 つの子オブジェクトの z 順序 (重ね順) を入れ替えます。
DisplayObjectContainer
 Inherited
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
 Inherited
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
Protected Methods
 メソッド定義
  
center(width:Number, height:Number):void
渡されたサイズに基づいて、ダウンロードプログレスバーをセンタリングします。
DownloadProgressBar
  
Event.COMPLETE イベントのイベントリスナーです。
DownloadProgressBar
  
表示のサブコンポーネントを作成します。
DownloadProgressBar
  
ロードされたアプリケーションのパーセント値を返します。
DownloadProgressBar
  
FlexEvent.INIT_PROGRESS イベントのイベントリスナーです。
DownloadProgressBar
  
ProgressEvent.PROGRESS イベントのイベントリスナーです。
DownloadProgressBar
  
RSLEvent.RSL_COMPLETE イベントのイベントリスナーです。
DownloadProgressBar
  
RSLEvent.RSL_ERROR イベントのイベントリスナーです。
DownloadProgressBar
  
RSLEvent.RSL_PROGRESS イベントのイベントリスナーです。
DownloadProgressBar
  
setProgress(completed:Number, total:Number):void
ダウンロードプログレスバーの表示を現在のダウンロード情報で更新します。
DownloadProgressBar
  
ダウンロード中にダウンロードプログレスバーを表示するかどうかを決めるアルゴリズムを定義します。
DownloadProgressBar
  
showDisplayForInit(elapsedTime:int, count:int):Boolean
ダウンロードプログレスバーが現在、表示されていないことを前提として、初期化段階時にダウンロードプログレスバーを表示するかどうかを決めるアルゴリズムを定義します。
DownloadProgressBar
イベント
 イベント一覧定義
 Inherited Flash Player がオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。EventDispatcher
 Inherited 表示オブジェクトが表示リストに追加されたときに送出されます。DisplayObject
 Inherited 表示オブジェクトが、直接、または表示オブジェクトを含むサブツリーの追加により、ステージ上の表示リストに追加されたときに送出されます。DisplayObject
 Inherited ユーザーが同じ InteractiveObject 上でポインティングデバイスのメインボタンを押して離すと送出されます。InteractiveObject
 Inherited Flash Player がオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。EventDispatcher
 Inherited オブジェクトの doubleClickEnabled フラグが true に設定されている場合には、ユーザーが同じ InteractiveObject 上でポインティングデバイスのメインボタンを 2 回続けてすばやく押して離すと送出されます。InteractiveObject
 Inherited 再生ヘッドが新しいフレームに入るときに送出されます。DisplayObject
 Inherited 表示オブジェクトがフォーカスを取得した後に送出されます。InteractiveObject
 Inherited 表示オブジェクトがフォーカスを失った後に送出されます。InteractiveObject
 Inherited ユーザーがキーを押したときに送出されます。InteractiveObject
 Inherited ユーザーがキーボード操作によってフォーカスを変更しようとすると送出されます。InteractiveObject
 Inherited ユーザーがキーを離したときに送出されます。InteractiveObject
 Inherited Flash Player ウィンドウの InteractiveObject インスタンスの上で、ユーザーがポインティングデバイスのボタンを押したときに送出されます。InteractiveObject
 Inherited ユーザーがポインティングデバイスでフォーカスを変更しようとすると送出されます。InteractiveObject
 Inherited InteractiveObject の上で、ユーザーがポインティングデバイスを移動させたときに送出されます。InteractiveObject
 Inherited ユーザーが InteractiveObject インスタンスからポインティングデバイスを離したときに送出されます。InteractiveObject
 Inherited ユーザーが Flash Player ウィンドウの InteractiveObject インスタンスに、ポインティングデバイスを合わせたときに送出されます。InteractiveObject
 Inherited ユーザーが Flash Player ウィンドウの InteractiveObject インスタンスの上でポインティングデバイスのボタンを離したときに送出されます。InteractiveObject
 Inherited Flash Player ウィンドウの InteractiveObject インスタンスの上で、マウスホイールを回転させたときに送出されます。InteractiveObject
 Inherited 表示オブジェクトが表示リストから削除されようとしているときに送出されます。DisplayObject
 Inherited 表示オブジェクトが、直接、または表示オブジェクトを含むサブツリーの削除により、表示リストから削除されようとしているときに送出されます。DisplayObject
 Inherited 表示リストが更新およびレンダリングされようとしているときに送出されます。DisplayObject
 Inherited ユーザーが InteractiveObject インスタンスからポインティングデバイスを離したときに送出されます。InteractiveObject
 Inherited ユーザーが InteractiveObject インスタンスにポインティングデバイスを合わせたときに送出されます。InteractiveObject
 Inherited オブジェクトの tabChildren フラグの値が変更されたときに送出されます。InteractiveObject
 Inherited オブジェクトの tabEnabled フラグが変更されたときに送出されます。InteractiveObject
 Inherited オブジェクトの tabIndex プロパティの値が変更されたときに送出されます。InteractiveObject
プロパティの詳細
backgroundAlphaプロパティ
backgroundAlpha:Number  [read-write]

backgroundImage プロパティで定義されている SWF ファイルまたはイメージのアルファレベル、または backgroundColor プロパティで定義されているカラーのアルファレベルです。有効な値の範囲は 0 から 1.0 です。

backgroundColor または backgroundImage のいずれか一方を設定できますが、両方を設定することはできません。

デフォルト値1.0.

実装
    public function get backgroundAlpha():Number
    public function set backgroundAlpha(value:Number):void
backgroundColorプロパティ 
backgroundColor:uint  [read-write]

ダウンロードプログレスバーの背景色です。backgroundColor または backgroundImage のいずれか一方を設定できますが、両方を設定することはできません。

実装
    public function get backgroundColor():uint
    public function set backgroundColor(value:uint):void
backgroundImageプロパティ 
backgroundImage:Object  [read-write]

プリローダーによって渡されるアプリケーションの背景イメージです。backgroundColor または backgroundImage のいずれか一方を設定できますが、両方を設定することはできません。

値が null の場合、"未設定" であることを意味します。このスタイルと backgroundColor スタイルの両方が未定義である場合、コンポーネントは透明な背景を持ちます。

プリローダーは埋め込みイメージを表示しません。実行時にロードされたイメージのみを使用できます。

デフォルト値ヌル (null).

実装
    public function get backgroundImage():Object
    public function set backgroundImage(value:Object):void
backgroundSizeプロパティ 
backgroundSize:String  [read-write]

backgroundImage で指定されているイメージを、元のサイズとは異なるサイズに拡大および縮小します。"100%" に設定すると、コンポーネント全体に収まるサイズにイメージを伸縮します。パーセント値で指定する場合は、パーセント記号 (%) 付きで指定する必要があります。"auto" の値で、イメージの元のサイズを維持します。

デフォルト値&quot;auto&quot;.

実装
    public function get backgroundSize():String
    public function set backgroundSize(value:String):void
barFrameRectプロパティ 
barFrameRect:RoundedRectangle  [read-only]

プログレスバーの境界線のサイズです。これは、読み取り専用のプロパティです。変更が必要な場合は、オーバーライドします。

実装
    protected function get barFrameRect():RoundedRectangle
barRectプロパティ 
barRect:RoundedRectangle  [read-only]

プログレスバーのサイズです。これは、読み取り専用のプロパティです。変更が必要な場合は、オーバーライドします。

実装
    protected function get barRect():RoundedRectangle
borderRectプロパティ 
borderRect:RoundedRectangle  [read-only]

表示の境界線のサイズです。これは、読み取り専用のプロパティです。変更が必要な場合は、オーバーライドします。

実装
    protected function get borderRect():RoundedRectangle
downloadingLabelプロパティ 
downloadingLabel:String  [read-write]

ダウンロード段階でラベルとして表示するストリングです。

デフォルト値&quot;Loading&quot;.

実装
    protected function get downloadingLabel():String
    protected function set downloadingLabel(value:String):void
DOWNLOAD_PERCENTAGEプロパティ 
protected var DOWNLOAD_PERCENTAGE:uint = 60

SWF ファイルが完全にダウンロードされたときに、ダウンロード段階がプログレスバーを占めるパーセント。プログレスバーの残りの部分は、初期化段階が占めます。この値の範囲は 0 から 100 です。

デフォルト値60.

initializingLabelプロパティ 
initializingLabel:String  [read-write]

初期化段階でラベルとして表示するストリングです。

デフォルト値&quot;Initializing&quot;.

実装
    public static function get initializingLabel():String
    public function set initializingLabel(value:String):void
labelプロパティ 
label:String  [read-write]

プログレスバーがアクティブなときに表示されるテキストです。Preloader クラスは、プログレスバーを表示する前にこの値を設定します。サブクラスにこのプロパティを実装するのは、オプションです。

デフォルト値&quot;&quot;.

実装
    protected function get label():String
    protected function set label(value:String):void
labelFormatプロパティ 
labelFormat:TextFormat  [read-only]

ラベルの TextField コンポーネントの TextFormat オブジェクトです。これは、読み取り専用のプロパティです。変更が必要な場合は、オーバーライドします。

実装
    protected function get labelFormat():TextFormat
labelRectプロパティ 
labelRect:Rectangle  [read-only]

ラベルの TextField コンポーネントのサイズです。これは、読み取り専用のプロパティです。変更が必要な場合は、オーバーライドします。

実装
    protected function get labelRect():Rectangle
MINIMUM_DISPLAY_TIMEプロパティ 
protected var MINIMUM_DISPLAY_TIME:uint = 0

表示を可視にするまでの最小ミリ秒数。アプリケーションのダウンロードと初期化にかかる時間が最小ミリ秒数に指定された値より小さい場合、Flex はこの指定された時間が経過するまで一時停止してから、complete イベントを送出します。

デフォルト値0.

percentFormatプロパティ 
percentFormat:TextFormat  [read-only]

パーセントを表示するための TextField コンポーネントの TextFormat です。これは、読み取り専用のプロパティです。変更が必要な場合は、オーバーライドします。

実装
    protected function get percentFormat():TextFormat
percentRectプロパティ 
percentRect:Rectangle  [read-only]

パーセントを表示するための TextField コンポーネントのサイズです。これは、読み取り専用のプロパティです。変更が必要な場合は、オーバーライドします。

実装
    protected function get percentRect():Rectangle
preloaderプロパティ 
preloader:Sprite  [write-only]

Preloader クラスは、プリローダーからイベントをリッスンできるように、クラス自体への参照を表示クラスに渡します。

実装
    public function set preloader(value:Sprite):void
showLabelプロパティ 
showLabel:Boolean  [read-write]

ラベルを表示するか (true)、または表示しないか (false) を制御します。

デフォルト値true.

実装
    protected function get showLabel():Boolean
    protected function set showLabel(value:Boolean):void
showPercentageプロパティ 
showPercentage:Boolean  [read-write]

パーセンテージを表示するか (true)、または表示しないか (false) を制御します。

デフォルト値true.

実装
    protected function get showPercentage():Boolean
    protected function set showPercentage(value:Boolean):void
stageHeightプロパティ 
stageHeight:Number  [read-write]

ステージの高さ。Preloader クラスによって渡されます。

実装
    public function get stageHeight():Number
    public function set stageHeight(value:Number):void
stageWidthプロパティ 
stageWidth:Number  [read-write]

ステージの幅。Preloader クラスによって渡されます。

実装
    public function get stageWidth():Number
    public function set stageWidth(value:Number):void
visibleプロパティ 
visible:Boolean  [read-write]

ダウンンロードプログレスバーを表示するかどうかを指定します。

Preloader コントロールがプログレスバーを表示することを判断すると、この値はtrue に設定されます。Preloader コントロールはプログレスバーを非表示にすることを判断すると、この値は false に設定されます。

DownloadProgressBar クラスのサブクラスでこのプロパティを変更してはなりません。その代わりに、setter メソッドをオーバーライドして、Preloader がこのプロパティをいつ変更したかを認識し、必要な措置を講じるようにすることができます。

デフォルト値false.

実装
    public function get visible():Boolean
    public function set visible(value:Boolean):void
コンストラクタの詳細
DownloadProgressBar()コンストラクタ
public 関数 DownloadProgressBar()

コンストラクタ

メソッドの詳細
center()メソッド
protected function center(width:Number, height:Number):void

渡されたサイズに基づいて、ダウンロードプログレスバーをセンタリングします。

パラメータ
width:Number — ダウンロードプログレスバーをセンタリングする領域の幅。
 
height:Number — ダウンロードプログレスバーをセンタリングする領域の高さ。
completeHandler()メソッド 
protected function completeHandler(event:Event):void

Event.COMPLETE イベントのイベントリスナーです。デフォルトの実装では、何も行われません。

パラメータ
event:Event — イベントオブジェクト。
createChildren()メソッド 
protected function createChildren():void

表示のサブコンポーネントを作成します。

getPercentLoaded()メソッド 
protected function getPercentLoaded(loaded:Number, total:Number):Number

ロードされたアプリケーションのパーセント値を返します。

パラメータ
loaded:Number — ダウンロードされたアプリケーションの SWF ファイルのバイト数です。
 
total:Number — アプリケーションの SWF ファイルのサイズ (バイト単位) です。

戻り値
Number — ロードされたアプリケーションのパーセント値です。
initialize()メソッド 
public function initialize():void

ダウンロードプログレスバーが Preloader の子として追加されると、Preloader によって呼び出されます。これが、ダウンロードプログレスバー設定の開始点となります。

initProgressHandler()メソッド 
protected function initProgressHandler(event:Event):void

FlexEvent.INIT_PROGRESS イベントのイベントリスナーです。この実装により、イベントが送出されるたびにプログレスバーが更新され、ラベルのテキストが変更されます。

パラメータ
event:Event — イベントオブジェクト。
progressHandler()メソッド 
protected function progressHandler(event:ProgressEvent):void

ProgressEvent.PROGRESS イベントのイベントリスナーです。この実装により、ダウンロードされたバイトのパーセントでプログレスバーが更新されます。

パラメータ
event:ProgressEvent — イベントオブジェクト。
rslCompleteHandler()メソッド 
protected function rslCompleteHandler(event:RSLEvent):void

RSLEvent.RSL_COMPLETE イベントのイベントリスナーです。

パラメータ
event:RSLEvent — イベントオブジェクト。
rslErrorHandler()メソッド 
protected function rslErrorHandler(event:RSLEvent):void

RSLEvent.RSL_ERROR イベントのイベントリスナーです。このイベントリスナーは、RSL のダウンロード時に検出されたすべてのエラーを処理します。

パラメータ
event:RSLEvent — イベントオブジェクト。
rslProgressHandler()メソッド 
protected function rslProgressHandler(event:RSLEvent):void

RSLEvent.RSL_PROGRESS イベントのイベントリスナーです。デフォルトの実装では、何も行われません。

パラメータ
event:RSLEvent — イベントオブジェクト。
setProgress()メソッド 
protected function setProgress(completed:Number, total:Number):void

ダウンロードプログレスバーの表示を現在のダウンロード情報で更新します。一般的な実装では、ロードされた値が合計値で除算されて、パーセンテージが表示されます。このメソッドを実装しなかった場合、何らかのアニメーションを表示するプログレスバーを作成し、ダウンロードが進行中であることをユーザーに通知する必要があります。

setProgress() メソッドは、アプリケーションのダウンロード元がリモートサーバーで、アプリケーションがブラウザのキャッシュに存在しない場合にのみ呼び出されます。

パラメータ
completed:Number — ダウンロードされたアプリケーションの SWF ファイルのバイト数です。
 
total:Number — アプリケーションの SWF ファイルのサイズ (バイト単位) です。
showDisplayForDownloading()メソッド 
protected function showDisplayForDownloading(elapsedTime:int, event:ProgressEvent):Boolean

ダウンロード中にダウンロードプログレスバーを表示するかどうかを決めるアルゴリズムを定義します。

パラメータ
elapsedTime:int — ダウンロード段階が開始してから経過したミリ秒数。
 
event:ProgressEventbytesLoaded プロパティおよび bytesTotal プロパティの入った ProgressEvent オブジェクトです。

戻り値
Boolean — 戻り値が true の場合、ダウンロードプログレスバーが表示されます。デフォルト動作では、700 ミリ秒を超える時間が経過し、Flex が SWF ファイルのバイト数の半分以下をダウンロードすると、ダウンロードプログレスバーが表示されます。
showDisplayForInit()メソッド 
protected function showDisplayForInit(elapsedTime:int, count:int):Boolean

ダウンロードプログレスバーが現在、表示されていないことを前提として、初期化段階時にダウンロードプログレスバーを表示するかどうかを決めるアルゴリズムを定義します。

パラメータ
elapsedTime:int — ダウンロード段階が開始してから経過したミリ秒数。
 
count:int — アプリケーションからの initProgress イベントを受け取った回数です。

戻り値
Booleantrue の場合、ダウンロードプログレスバーが表示されます。