mx.effects.EffectInstance (Flex™ 2 リファレンスガイド)

	プロパティ	定義
		className : String [read-only] このエフェクトクラスの名前です。たとえば、`"FadeInstance"` などがあります。	EffectInstance
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。	Object
		duration : Number エフェクトの継続時間を表します (ミリ秒単位)。	EffectInstance
		effect : Effect	EffectInstance
		playheadTime : Number [read-only] エフェクト再生中の現在位置を表します。	EffectInstance
		propertyChanges : PropertyChanges	EffectInstance
		prototype : Object [static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。	Object
		repeatCount : int	EffectInstance
		repeatDelay : int	EffectInstance
		startDelay : int	EffectInstance
		suspendBackgroundProcessing : Boolean	EffectInstance
		target : Object	EffectInstance
		triggerEvent : Event	EffectInstance

パブリック Methods

	メソッド		定義
		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

	イベント	一覧	定義
		activate	Flash Player がオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
		deactivate	Flash Player がオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	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

プロパティ

effect:Effect  [read-write]実装
    public function get effect():Effect
    public function set effect(value:Effect):void

playheadTime

プロパティ

playheadTime:Number [read-only]

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

実装
public function get playheadTime():Number

propertyChanges

プロパティ

propertyChanges:PropertyChanges  [read-write]実装
    public function get propertyChanges():PropertyChanges
    public function set propertyChanges(value:PropertyChanges):void

関連項目

propertyChanges プロパティの使用

repeatCount

プロパティ

repeatCount:int  [read-write]実装
    public function get repeatCount():int
    public function set repeatCount(value:int):void

repeatDelay

プロパティ

repeatDelay:int  [read-write]実装
    public function get repeatDelay():int
    public function set repeatDelay(value:int):void

startDelay

プロパティ

startDelay:int  [read-write]実装
    public function get startDelay():int
    public function set startDelay(value:int):void

suspendBackgroundProcessing

プロパティ

suspendBackgroundProcessing:Boolean  [read-write]実装
    public function get suspendBackgroundProcessing():Boolean
    public function set suspendBackgroundProcessing(value:Boolean):void

target

プロパティ

target:Object  [read-write]実装
    public function get target():Object
    public function set target(value:Object):void

triggerEvent

プロパティ

triggerEvent:Event  [read-write]実装
    public function get triggerEvent():Event
    public function set triggerEvent(value:Event):void

コンストラクタの詳細

EffectInstance

()

コンストラクタ

public 関数 EffectInstance(target:Object)

コンストラクタです。

パラメータ

target:Object — このエフェクトでアニメーション化する UIComponent オブジェクトを表します。

メソッドの詳細

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

Adobe^® Flex™ 2 リファレンスガイド		すべてのパッケージ \| すべてのクラス \| \| 索引 \| 付録 \| 規則 \| フレーム内に表示フレームなしバージョン
Class EffectInstance	プロパティ \| メソッド \| イベント

パッケージ	mx.effects
	public class EffectInstance
継承	EffectInstance EventDispatcher Object
Subclasses	ActionEffectInstance, CompositeEffectInstance, MaskEffectInstance, SoundEffectInstance, TweenEffectInstance