| パッケージ | mx.effects |
| クラス | public class EffectInstance |
| 継承 | EffectInstance  EventDispatcher Object |
| 実装 | IEffectInstance |
| サブクラス | ActionEffectInstance, AnimateInstance, CompositeEffectInstance, MaskEffectInstance, SoundEffectInstance, TweenEffectInstance |
| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトの開発時には、カスタムエフェクト用のインスタンスクラスを作成する必要があります。
さらに例を参照
関連する API エレメント
継承されるパブリックプロパティを隠す
継承されるパブリックプロパティを表示| プロパティ | 定義元 | ||
|---|---|---|---|
| className : String [読み取り専用]
このエフェクトクラスの名前です。たとえば、"FadeInstance" などがあります。 | EffectInstance | ||
 | constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | |
| duration : Number
エフェクトの持続時間を表します（ミリ秒単位）。 | EffectInstance | ||
| effect : IEffect
この IEffectInstance オブジェクトを作成した IEffect オブジェクトを表します。 | EffectInstance | ||
| effectTargetHost : mx.effects:IEffectTargetHost
データエフェクトのターゲットリストコントロールにアクセスできるプロパティです。 | EffectInstance | ||
| hideFocusRing : Boolean
エフェクトの開始時にエフェクトがフォーカス枠を非表示にするかどうかを指定します。 | EffectInstance | ||
| playheadTime : Number
エフェクトの現在の時間位置です。 | EffectInstance | ||
| propertyChanges : PropertyChanges
エフェクトのターゲットに関連するプロパティのセットに対して、開始値および終了値を含む PropertyChanges オブジェクトを指定します。 | EffectInstance | ||
| repeatCount : int
エフェクトを繰り返す回数を表します。 | EffectInstance | ||
| repeatDelay : int
エフェクトを繰り返す前の待機時間を表します（ミリ秒単位）。 | EffectInstance | ||
| startDelay : int
エフェクトを開始する前の待機時間を表します（ミリ秒単位）。 | EffectInstance | ||
| suspendBackgroundProcessing : Boolean
true の場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。 | EffectInstance | ||
| target : Object
このエフェクトが適用される UIComponent オブジェクトを表します。 | EffectInstance | ||
| triggerEvent : Event
エフェクトの再生をトリガーしたイベントを表します（存在する場合）。 | EffectInstance | ||
| メソッド | 定義元 | ||
|---|---|---|---|
EffectInstance(target:Object)
コンストラクターです。 | EffectInstance | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。 | EventDispatcher | |
|
イベントをイベントフローに送出します。 | EventDispatcher | |
現在再生中のエフェクトインスタンスを中断し、直ちにエフェクトの終わりにジャンプします。 | EffectInstance | ||
エフェクトの再生が完了すると、end() メソッドによって呼び出されます。 | EffectInstance | ||
繰り返されるエフェクトの各反復により再生が終了すると、呼び出されます。 | EffectInstance | ||
|
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 | EventDispatcher | |
|
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | |
このメソッドは、エフェクトが EffectManager によってトリガーされると呼び出されます。 | EffectInstance | ||
|
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | |
resume() メソッドを呼び出すまで、エフェクトを一時停止します。 | EffectInstance | ||
ターゲットでエフェクトインスタンスを再生します。 | EffectInstance | ||
|
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | |
|
EventDispatcher オブジェクトからリスナーを削除します。 | EventDispatcher | |
pause() メソッドを呼び出し、エフェクトを一時停止した後、再開させます。 | EffectInstance | ||
エフェクトの現在位置から開始して、逆順でエフェクトを再生します。 | EffectInstance | ||
|
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | |
startDelay 時間の経過後、ターゲットでエフェクトインスタンスを再生します。 | EffectInstance | ||
ターゲットを現在の状態にしたまま、エフェクトを停止します。 | EffectInstance | ||
|
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのプリミティブな値を返します。 | Object | |
|
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 | EventDispatcher | |
className | プロパティ |
duration | プロパティ |
effect | プロパティ |
effectTargetHost | プロパティ |
effectTargetHost:mx.effects:IEffectTargetHost| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
データエフェクトのターゲットリストコントロールにアクセスできるプロパティです。 このプロパティにより、エフェクトクラスのインスタンスは、エフェクトが再生されているリストコントロールと通信できます。
実装
public function get effectTargetHost():mx.effects:IEffectTargetHost public function set effectTargetHost(value:mx.effects:IEffectTargetHost):voidhideFocusRing | プロパティ |
hideFocusRing:Boolean| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトの開始時にエフェクトがフォーカス枠を非表示にするかどうかを指定します。エフェクトターゲットは、フォーカス枠を非表示にします。UIComponent クラスのサブクラスは、フォーカス枠を自動的に非表示にします。エフェクトターゲットが UIComponent クラスのサブクラスではない場合は、フォーカス枠を非表示にするための機能を追加する必要があります。
エフェクトの再生中にフォーカス枠を非表示にするには、このプロパティを true に設定します。
Effect のサブクラスのデフォルト値は false です。 MaskEffect のサブクラスのデフォルト値は true です。
実装
public function get hideFocusRing():Boolean public function set hideFocusRing(value:Boolean):voidplayCount | プロパティ |
protected var playCount:int = 0| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
インスタンスが再生された回数です。
playheadTime | プロパティ |
propertyChanges | プロパティ |
propertyChanges:PropertyChanges| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトのターゲットに関連するプロパティのセットに対して、開始値および終了値を含む PropertyChanges オブジェクトを指定します。 このプロパティは、このエフェクトインスタンスを作成したエフェクトで captureStartValues() メソッドが呼び出された場合にのみ設定されます。
propertyChanges プロパティは、トランジションの一部として使用されるエフェクトを作成する際に頻繁に使用されます。 captureStartValues() メソッドは、トランジションが開始されると、自動的に Flex から呼び出されます。 Effectinstance.play() メソッドのオーバーライドの範囲で、propertyChanges() メソッド内の情報を調べて、エフェクトの開始値および終了値を初期化できます。
実装
public function get propertyChanges():PropertyChanges public function set propertyChanges(value:PropertyChanges):voidさらに例を参照
repeatCount | プロパティ |
repeatDelay | プロパティ |
startDelay | プロパティ |
startDelay:int| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトを開始する前の待機時間を表します（ミリ秒単位）。 有効な値は 0 以上の整数です。 repeatCount プロパティの使用によりエフェクトが繰り返される場合は、エフェクトの初回再生時にのみ startDelay プロパティが適用されます。
実装
public function get startDelay():int public function set startDelay(value:int):voidsuspendBackgroundProcessing | プロパティ |
suspendBackgroundProcessing:Boolean| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
true の場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。 バックグラウンド処理では、測定、レイアウト、および、サーバーから受信した応答の処理が行われます。
実装
public function get suspendBackgroundProcessing():Boolean public function set suspendBackgroundProcessing(value:Boolean):voidtarget | プロパティ |
triggerEvent | プロパティ |
triggerEvent:Event| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトの再生をトリガーしたイベントを表します（存在する場合）。 このプロパティは、エフェクトが複数のトリガーイベントに割り当てられている場合に便利です。
エフェクトがイベントによってトリガーされるのでなく play() メソッドを呼び出すことによってプログラムで再生される場合、このプロパティは null となります。
実装
public function get triggerEvent():Event public function set triggerEvent(value:Event):voidEffectInstance | () | コンストラクター |
end | () | メソッド |
public function end():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
現在再生中のエフェクトインスタンスを中断し、直ちにエフェクトの終わりにジャンプします。 このメソッドは、Effect.end() メソッドの呼び出しにより、呼び出されます。 実装時に、finishEffect() メソッドが呼び出されます。
エフェクトの終了処理の一環としてこのメソッドが呼び出されると、エフェクトインスタンスにより effectEnd イベントが送出されます。
EffectInstance のサブクラスでは、このメソッドを任意でオーバーライドできます。オーバーライドの一部として、ロジックの後、つまりオーバーライドの終わりで super.end() メソッドを呼び出す必要があります。
さらに例を参照
finishEffect | () | メソッド |
public function finishEffect():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトの再生が完了すると、end() メソッドによって呼び出されます。 この関数によって、エフェクトターゲットの endEffect イベントが送出されます。
サブクラスでこのメソッドをオーバーライドする必要はありません。 エフェクトの使用時にこのメソッドを呼び出す必要はありません。ただし、エフェクトのサブクラスを作成する場合は、呼び出す必要があります。
finishRepeat | () | メソッド |
public function finishRepeat():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
繰り返されるエフェクトの各反復により再生が終了すると、呼び出されます。
サブクラスでこのメソッドをオーバーライドする必要はありません。 エフェクトの使用時にこのメソッドを呼び出す必要はありません。
initEffect | () | メソッド |
public function initEffect(event:Event):void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
このメソッドは、エフェクトが EffectManager によってトリガーされると、呼び出されます。 この基本クラスのバージョンによって、エフェクトをトリガーしたイベントが triggerEvent プロパティに保存されます。 各サブクラスによってこのメソッドがオーバーライドされます。
パラメーター
event:Event — エフェクトをトリガーするために送出されたイベントオブジェクトを表します。 たとえば、トリガーが mouseDownEffect の場合、イベントは MouseEvent となり、タイプは MouseEvent.MOUSEDOWN と同じになります。
|
pause | () | メソッド |
public function pause():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
resume() メソッドを呼び出すまで、エフェクトを一時停止します。
play | () | メソッド |
public function play():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
ターゲットでエフェクトインスタンスを再生します。 EffectInstance でエフェクトの再生を開始する場合は、代わりに startEffect() メソッドを呼び出します。
EffectInstance のサブクラスでは、このメソッドをオーバーライドする必要があります。 オーバーライドによって super.play() メソッドが必ず呼び出され、ターゲットから effectStart イベントが送出されます。
さらに例を参照
resume | () | メソッド |
public function resume():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
pause() メソッドを呼び出してエフェクトを一時停止した後、再開させます。
reverse | () | メソッド |
public function reverse():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
エフェクトの現在位置から開始して、逆順でエフェクトを再生します。
startEffect | () | メソッド |
public function startEffect():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
startDelay 時間の経過後、ターゲットでエフェクトインスタンスを再生します。 Effect クラスによって呼び出されます。 EffectInstance の開始時は、play() メソッドの代わりにこの関数を使用します。
stop | () | メソッド |
public function stop():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
ターゲットを現在の状態にしたまま、エフェクトを停止します。 このメソッドは、Effect.stop() メソッドの呼び出しにより、呼び出されます。 実装時に、finishEffect() メソッドが呼び出されます。
エフェクトの終了処理の一環としてこのメソッドが呼び出されると、エフェクトインスタンスにより effectEnd イベントが送出されます。
Tue Jun 12 2018, 10:34 AM Z