| パッケージ | mx.effects |
| public class EffectInstance | |
| 継承 | EffectInstance  EventDispatcher Object |
| Subclasses | ActionEffectInstance, CompositeEffectInstance, MaskEffectInstance, SoundEffectInstance, TweenEffectInstance |
エフェクトの開発時には、カスタムエフェクト用のインスタンスクラスを作成する必要があります。
関連項目
| プロパティ | 定義 | ||
|---|---|---|---|
| className : String
[read-only]
このエフェクトクラスの名前です。たとえば、
"FadeInstance" などがあります。 | EffectInstance | ||
 | constructor : Object
特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
| Object | |
| duration : Number
エフェクトの継続時間を表します (ミリ秒単位)。
| EffectInstance | ||
| effect : Effect
この EffectInstance オブジェクトを作成した Effect オブジェクトを表します。
| EffectInstance | ||
| playheadTime : Number
[read-only]
エフェクト再生中の現在位置を表します。
| EffectInstance | ||
| propertyChanges : PropertyChanges
エフェクトのターゲットに関連するプロパティのセットに対して、開始値および終了値を含む PropertyChanges オブジェクトを指定します。
| EffectInstance | ||
| prototype : Object
[static]
クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
| Object | |
| repeatCount : int = 1
エフェクトを繰り返す回数を表します。
| EffectInstance | ||
| repeatDelay : int = 0
エフェクトを繰り返す前の待機時間を表します (ミリ秒単位)。
| EffectInstance | ||
| startDelay : int = 0
エフェクトを開始する前の待機時間を表します (ミリ秒単位)。
| EffectInstance | ||
suspendBackgroundProcessing : Boolean = falsetrue の場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。 | 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 | |
| dispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。
| EventDispatcher | |
| end():void
現在再生中のエフェクトインスタンスを中断し、直ちにエフェクトの終わりにジャンプします。
| EffectInstance | ||
| finishEffect():void
エフェクトの再生が完了すると、
end() メソッドによって呼び出されます。 | EffectInstance | ||
| finishRepeat():void
繰り返されるエフェクトの各反復により再生が終了すると、呼び出されます。
| EffectInstance | ||
| hasEventListener(type:String):Boolean
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
| EventDispatcher | |
| hasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
| Object | |
| initEffect(event:Event):void
このメソッドは、エフェクトが EffectManager によってトリガされると、呼び出されます。
| EffectInstance | ||
| isPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
| Object | |
pause():void
resume() メソッドを呼び出すまで、エフェクトを一時停止します。 | EffectInstance | ||
| play():void
ターゲットでエフェクトインスタンスを再生します。
| EffectInstance | ||
| propertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙可能かどうかを示します。
| Object | |
| removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
| EventDispatcher | |
resume():void
pause() メソッドを呼び出し、エフェクトを一時停止した後、再開させます。 | EffectInstance | ||
| reverse():void
エフェクトの現在位置から開始して、逆順でエフェクトを再生します。
| EffectInstance | ||
| setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
| Object | |
startEffect():void
startDelay 時間の経過後、ターゲットでエフェクトインスタンスを再生します。 | EffectInstance | ||
| toString():String
指定されたオブジェクトのストリング表現を返します。
| Object | |
| valueOf():Object
指定されたオブジェクトのプリミティブ値を返します。
| Object | |
| willTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
| EventDispatcher | |
| className | プロパティ |
継承されるパブリックプロパティの非表示
継承されるパブリックプロパティの表示className:String [read-only]
このエフェクトクラスの名前です。たとえば、"FadeInstance" などがあります。
これは短い形式または無修飾の名前で、パッケージ名は含まれません。修飾名が必要な場合は、flash.utils パッケージに含まれる getQualifiedClassName() メソッドを使用します。
public function get className():String
| duration | プロパティ |
duration:Number [read-write]エフェクトの継続時間を表します (ミリ秒単位)。
デフォルト値500.
public function get duration():Number
public function set duration(value:Number):void
| effect | プロパティ |
public var effect:Effectこの EffectInstance オブジェクトを作成した Effect オブジェクトを表します。
| playheadTime | プロパティ |
playheadTime:Number [read-only]
エフェクト再生中の現在位置を表します。このプロパティの値の範囲は、0 から実際の継続時間 (startDelay、repeatCount、および repeatDelay プロパティ値を含む) です。
public function get playheadTime():Number
| propertyChanges | プロパティ |
public var propertyChanges:PropertyChanges
エフェクトのターゲットに関連するプロパティのセットに対して、開始値および終了値を含む PropertyChanges オブジェクトを指定します。このプロパティは、このエフェクトインスタンスを作成したエフェクトで captureStartValues() メソッドが呼び出された場合にのみ設定されます。
propertyChanges プロパティは、トランジションの一部として使用されるエフェクトを作成する際に頻繁に使用されます。captureStartValues() メソッドは、トランジションが開始されると、自動的に Flex から呼び出されます。Effectinstance.play() メソッドのオーバーライドの範囲で、propertyChanges() メソッド内の情報を調べて、エフェクトの開始値および終了値を初期化できます。
関連項目
| repeatCount | プロパティ |
| repeatDelay | プロパティ |
| startDelay | プロパティ |
public var startDelay:int = 0
エフェクトを開始する前の待機時間を表します (ミリ秒単位)。有効な値は 0 以上の整数です。repeatCount プロパティを使用することによってエフェクトが繰り返される場合は、エフェクトの初回再生時にのみ startDelay プロパティが適用されます。
デフォルト値0.
| suspendBackgroundProcessing | プロパティ |
public var suspendBackgroundProcessing:Boolean = false
true の場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。バックグラウンド処理では、測定、レイアウト、および、サーバーから受信した応答の処理が行われます。
デフォルト値false.
関連項目
| target | プロパティ |
| triggerEvent | プロパティ |
public var triggerEvent:Eventエフェクトの再生をトリガしたイベントを表します (存在する場合)。このプロパティは、エフェクトが複数のトリガイベントに割り当てられている場合に便利です。
エフェクトがイベントによってトリガされるのでなく play() メソッドを呼び出すことによってプログラムで再生される場合、このプロパティは null となります。
| EffectInstance | () | コンストラクタ |
public 関数 EffectInstance(target:Object)コンストラクタ。
パラメータtarget:Object — このエフェクトでアニメーション化する UIComponent オブジェクトを表します。
|
| end | () | メソッド |
public function end():void
現在再生中のエフェクトインスタンスを中断し、直ちにエフェクトの終わりにジャンプします。このメソッドは、Effect.end() メソッドの呼び出しにより、呼び出されます。実装時に、finishEffect() メソッドが呼び出されます。
エフェクトの終了処理の一環としてこのメソッドが呼び出されると、エフェクトインスタンスにより effectEnd イベントが送出されます。
EffectInstance のサブクラスでは、このメソッドを任意でオーバーライドできます。オーバーライドの一環として、ロジック後、オーバーライドの終わりから super.end() メソッドを呼び出す必要があります。
関連項目
| finishEffect | () | メソッド |
public function finishEffect():void
エフェクトの再生が完了すると、end() メソッドによって呼び出されます。この関数によって、エフェクトターゲットの endEffect イベントが送出されます。
サブクラスでこのメソッドをオーバーライドする必要はありません。エフェクトの使用時にこのメソッドを呼び出す必要はありません。ただし、エフェクトのサブクラスを作成する場合は、呼び出す必要があります。
関連項目
| finishRepeat | () | メソッド |
public function finishRepeat():void繰り返されるエフェクトの各反復により再生が終了すると、呼び出されます。
サブクラスでこのメソッドをオーバーライドする必要はありません。エフェクトの使用時にこのメソッドを呼び出す必要はありません。
| initEffect | () | メソッド |
public function initEffect(event:Event):void
このメソッドは、エフェクトが EffectManager によってトリガされると、呼び出されます。この基本クラスのバージョンによって、エフェクトをトリガしたイベントが triggerEvent プロパティに保存されます。各サブクラスによってこのメソッドがオーバーライドされます。
event:Event — エフェクトをトリガするために送出されたイベントオブジェクトを表します。たとえば、トリガが mouseDownEffect の場合、イベントは MouseEvent となり、タイプは MouseEvent.MOUSEDOWN と同じになります。
|
| pause | () | メソッド |
public function pause():void
resume() メソッドを呼び出すまで、エフェクトを一時停止します。
| play | () | メソッド |
public function play():void
ターゲットでエフェクトインスタンスを再生します。EffectInstance でエフェクトの再生を開始する場合は、代わりに startEffect() メソッドを呼び出します。
EffectInstance のサブクラスでは、このメソッドをオーバーライドする必要があります。オーバーライドによって super.play() メソッドが必ず呼び出され、ターゲットから effectStart イベントが送出されます。
関連項目
| resume | () | メソッド |
public function resume():void
pause() メソッドを呼び出し、エフェクトを一時停止した後、再開させます。
| reverse | () | メソッド |
public function reverse():voidエフェクトの現在位置から開始して、逆順でエフェクトを再生します。
| startEffect | () | メソッド |
public function startEffect():void
startDelay 時間の経過後、ターゲットでエフェクトインスタンスを再生します。Effect クラスによって呼び出されます。EffectInstance の開始時は、play() メソッドの代わりにこの関数を使用します。