パッケージmx.effects
インターフェイスpublic interface IEffectInstance
実装者 EffectInstance

IEffectInstance インターフェイスはターゲットで再生されるエフェクトのインスタンスを表します。 各ターゲットには個別のエフェクトインスタンスが関連付けられています。 エフェクトインスタンスは一時的に有効になるインスタンスです。 インスタンスはエフェクトがターゲットで再生される場合に作成され、再生が終了するとそのインスタンスは破棄されます。 ターゲットで複数のエフェクトが同時に再生されている場合（例えば、Parallel エフェクト）は、エフェクトごとに別々のエフェクトインスタンスが作成されます。

エフェクトの開発時には、カスタムエフェクト用のインスタンスクラスを作成する必要があります。

関連項目

mx.effects.Effect

パブリックプロパティ
 プロパティ定義元
  className : String
[読み取り専用] このエフェクトクラスの名前です。たとえば、"FadeInstance" などがあります。
IEffectInstance
  duration : Number
エフェクトの持続時間を表します（ミリ秒単位）。
IEffectInstance
  effect : IEffect
この IEffectInstance オブジェクトを作成した IEffect オブジェクトを表します。
IEffectInstance
  effectTargetHost : IEffectTargetHost
データエフェクトのターゲットリストコントロールにアクセスできるプロパティです。
IEffectInstance
  hideFocusRing : Boolean
エフェクトの開始時にエフェクトがフォーカスリングを非表示にするかどうかを指定します。
IEffectInstance
  playheadTime : Number
[読み取り専用] エフェクト再生中の現在位置を表します。
IEffectInstance
  propertyChanges : PropertyChanges
エフェクトのターゲットに関連するプロパティのセットに対して、開始値および終了値を含む PropertyChanges オブジェクトを指定します。
IEffectInstance
  repeatCount : int
エフェクトを繰り返す回数を表します。
IEffectInstance
  repeatDelay : int
エフェクトを繰り返す前の待機時間を表します（ミリ秒単位）。
IEffectInstance
  startDelay : int
エフェクトを開始する前の待機時間を表します（ミリ秒単位）。
IEffectInstance
  suspendBackgroundProcessing : Boolean
true の場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。
IEffectInstance
  target : Object
このエフェクトが適用される UIComponent オブジェクトを表します。
IEffectInstance
  triggerEvent : Event
エフェクトの再生をトリガしたイベントを表します（存在する場合）。
IEffectInstance
パブリックメソッド
 メソッド定義元
  
end():void
現在再生中のエフェクトインスタンスを中断し、直ちにエフェクトの終わりにジャンプします。
IEffectInstance
  
finishEffect():void
エフェクトの再生が完了すると、end() メソッドによって呼び出されます。
IEffectInstance
  
finishRepeat():void
繰り返されるエフェクトの各反復により再生が終了すると、呼び出されます。
IEffectInstance
  
initEffect(event:Event):void
このメソッドは、エフェクトが EffectManager によってトリガされると呼び出されます。
IEffectInstance
  
pause():void
resume() メソッドを呼び出すまで、エフェクトを一時停止します。
IEffectInstance
  
play():void
ターゲットでエフェクトインスタンスを再生します。
IEffectInstance
  
resume():void
pause() メソッドを呼び出し、エフェクトを一時停止した後、再開させます。
IEffectInstance
  
reverse():void
エフェクトの現在位置から開始して、逆順でエフェクトを再生します。
IEffectInstance
  
startEffect():void
startDelay 時間の経過後、ターゲットでエフェクトインスタンスを再生します。
IEffectInstance
  
stop():void
ターゲットを現在の状態にしたまま、エフェクトを停止します。
IEffectInstance
プロパティの詳細
classNameプロパティ
className:String  [読み取り専用]

このエフェクトクラスの名前です。たとえば、"FadeInstance" などがあります。

これは短い形式または無修飾の名前で、パッケージ名は含まれません。 修飾名が必要な場合は、flash.utils パッケージに含まれる getQualifiedClassName() メソッドを使用します。



実装
    public function get className():String
durationプロパティ 
duration:Number

エフェクトの持続時間を表します（ミリ秒単位）。

デフォルト値 : 500.



実装
    public function get duration():Number
    public function set duration(value:Number):void
effectプロパティ 
effect:IEffect

この IEffectInstance オブジェクトを作成した IEffect オブジェクトを表します。



実装
    public function get effect():IEffect
    public function set effect(value:IEffect):void
effectTargetHostプロパティ 
effectTargetHost:IEffectTargetHost

データエフェクトのターゲットリストコントロールにアクセスできるプロパティです。 このプロパティにより、エフェクトクラスのインスタンスは、エフェクトが再生されているリストコントロールと通信できます。



実装
    public function get effectTargetHost():IEffectTargetHost
    public function set effectTargetHost(value:IEffectTargetHost):void
hideFocusRingプロパティ 
hideFocusRing:Boolean

エフェクトの開始時にエフェクトがフォーカスリングを非表示にするかどうかを指定します。 エフェクトターゲットは、フォーカスリングを非表示にします。 UIComponent クラスのサブクラスは、フォーカスリングを自動的に非表示にします。 エフェクトターゲットが UIComponent クラスのサブクラスではない場合は、フォーカスリングを非表示にするための機能を追加する必要があります。

エフェクトの再生中にフォーカスリングを非表示にするには、このプロパティを true に設定します。

Effect のサブクラスのデフォルト値は false です。 MaskEffect のサブクラスのデフォルト値は true です。



実装
    public function get hideFocusRing():Boolean
    public function set hideFocusRing(value:Boolean):void
playheadTimeプロパティ 
playheadTime:Number  [読み取り専用]

エフェクト再生中の現在位置を表します。 このプロパティの値の範囲は、0 から実際の継続時間（startDelay、repeatCount、および repeatDelay プロパティ値を含む）です。



実装
    public function get playheadTime():Number
propertyChangesプロパティ 
propertyChanges:PropertyChanges

エフェクトのターゲットに関連するプロパティのセットに対して、開始値および終了値を含む PropertyChanges オブジェクトを指定します。 このプロパティは、このエフェクトインスタンスを作成したエフェクトで captureStartValues() メソッドが呼び出された場合にのみ設定されます。

propertyChanges プロパティは、トランジションの一部として使用されるエフェクトを作成する際に頻繁に使用されます。 captureStartValues() メソッドは、トランジションが開始されると、自動的に Flex から呼び出されます。Effectinstance.play() メソッドのオーバーライドの範囲で、propertyChanges() メソッド内の情報を調べて、エフェクトの開始値および終了値を初期化できます。



実装
    public function get propertyChanges():PropertyChanges
    public function set propertyChanges(value:PropertyChanges):void

関連項目

mx.effects.effectClasses.PropertyChanges
repeatCountプロパティ 
repeatCount:int

エフェクトを繰り返す回数を表します。 有効な値は 0 以上の整数です。

デフォルト値 : 1.



実装
    public function get repeatCount():int
    public function set repeatCount(value:int):void

関連項目

mx.effects.Effect.repeatCount
repeatDelayプロパティ 
repeatDelay:int

エフェクトを繰り返す前の待機時間を表します（ミリ秒単位）。

デフォルト値 : 0.



実装
    public function get repeatDelay():int
    public function set repeatDelay(value:int):void

関連項目

mx.effects.Effect.repeatDelay
startDelayプロパティ 
startDelay:int

エフェクトを開始する前の待機時間を表します（ミリ秒単位）。 有効な値は 0 以上の整数です。repeatCount プロパティを使用してエフェクトが繰り返される場合、startDelay プロパティは、エフェクトの初回再生時にのみ適用されます。

デフォルト値 : 0.



実装
    public function get startDelay():int
    public function set startDelay(value:int):void
suspendBackgroundProcessingプロパティ 
suspendBackgroundProcessing:Boolean

true の場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。 バックグラウンド処理では、測定、レイアウト、および、サーバーから受信した応答の処理が行われます。

デフォルト値 : false.



実装
    public function get suspendBackgroundProcessing():Boolean
    public function set suspendBackgroundProcessing(value:Boolean):void

関連項目

mx.effects.Effect.suspendBackgroundProcessing
targetプロパティ 
target:Object

このエフェクトが適用される UIComponent オブジェクトを表します。



実装
    public function get target():Object
    public function set target(value:Object):void

関連項目

mx.effects.Effect.target
triggerEventプロパティ 
triggerEvent:Event

エフェクトの再生をトリガしたイベントを表します（存在する場合）。 このプロパティは、エフェクトが複数のトリガイベントに割り当てられている場合に便利です。

エフェクトがイベントによってトリガされるのでなく play() メソッドを呼び出すことによってプログラムで再生される場合、このプロパティは null となります。



実装
    public function get triggerEvent():Event
    public function set triggerEvent(value:Event):void
メソッドの詳細
end()メソッド
public function end():void

現在再生中のエフェクトインスタンスを中断し、直ちにエフェクトの終わりにジャンプします。 このメソッドは、Effect.end() メソッドの呼び出しにより、呼び出されます。実装時に、finishEffect() メソッドが呼び出されます。

エフェクトの終了処理の一環としてこのメソッドが呼び出されると、エフェクトインスタンスにより effectEnd イベントが送出されます。

EffectInstance のサブクラスでは、このメソッドを任意でオーバーライドできます。オーバーライドの一部として、ロジックの後、つまりオーバーライドの終わりで super.end() メソッドを呼び出す必要があります。

関連項目

mx.effects.Effect.end()
finishEffect()メソッド 
public function finishEffect():void

エフェクトの再生が完了すると、end() メソッドによって呼び出されます。この関数によって、エフェクトターゲットの endEffect イベントが送出されます。

サブクラスでこのメソッドをオーバーライドする必要はありません。 エフェクトの使用時にこのメソッドを呼び出す必要はありません。ただし、エフェクトのサブクラスを作成する場合は、呼び出す必要があります。

関連項目

mx.events.EffectEvent
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() メソッドの代わりにこの関数を使用します。

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

ターゲットを現在の状態にしたまま、エフェクトを停止します。 このメソッドは、Effect.stop() メソッドの呼び出しにより、呼び出されます。実装時に、finishEffect() メソッドが呼び出されます。

エフェクトの終了処理の一環としてこのメソッドが呼び出されると、エフェクトインスタンスにより effectEnd イベントが送出されます。




© 2009 Adobe Systems Incorporated. All rights reserved.
Thu Mar 19 2009, 08:51 PM -07:00
 

 

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flex/3_jp/langref/mx/effects/IEffectInstance.html