パッケージmx.effects
インターフェイスpublic interface IEffect extends IAbstractEffect , IEventDispatcher
実装者 Effect

IEffect インターフェイスは、すべての Flex エフェクトの基本インターフェイスを定義します。 EffectInstance インターフェイスは、エフェクトインスタンスのすべてのサブクラスについての基本インターフェイスを定義します。

関連項目

mx.effects.IEffectInstance

パブリックプロパティ
 プロパティ定義元
  className : String
[読み取り専用] このエフェクトクラスの名前です。たとえば、"Fade" などがあります。
IEffect
  customFilter : EffectTargetFilter
エフェクトを再生するターゲットを特定するために、エフェクトによって使用されるタイプ EffectTargetFilter のカスタムフィルタオブジェクトを指定します。
IEffect
  duration : Number
エフェクトの継続時間を表します（ミリ秒単位）。
IEffect
  effectTargetHost : IEffectTargetHost
データエフェクトのターゲットリストコントロールにアクセスできるプロパティです。
IEffect
  filter : String
エフェクトのターゲットをフィルタリングするアルゴリズムを指定します。
IEffect
  hideFocusRing : Boolean
エフェクトの開始時にエフェクトがフォーカスリングを非表示にするかどうかを指定します。
IEffect
  isPlaying : Boolean
[読み取り専用] エフェクトのインスタンスのいずれかが現在再生中の場合に true、そうでない場合に false となる読み取り専用フラグです。
IEffect
  perElementOffset : Number
エフェクトの最初のターゲットの後に発生する、エフェクトターゲットの追加遅延（ミリ秒）です。
IEffect
  relevantProperties : Array
フィルタリング実行時に使用するプロパティ名の配列を表します。
IEffect
  relevantStyles : Array
フィルタリング実行時に使用するスタイル名の配列を表します。
IEffect
  target : Object
このエフェクトが適用される UIComponent オブジェクトを表します。
IEffect
  targets : Array
エフェクトのターゲットである UIComponent オブジェクトの配列を表します。
IEffect
  triggerEvent : Event
エフェクトがトリガされたときに EffectManager によってこの Effect に渡される Event オブジェクトです。EffectManager によってエフェクトが再生されていない場合は null です。
IEffect
パブリックメソッド
 メソッド定義元
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
IEventDispatcher
  
captureEndValues():void
エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャし、終了値として保存します。
IEffect
  
captureMoreStartValues(targets:Array):void
ターゲットの追加セットの関連するプロパティの現在値をキャプチャします。この機能は、データ変更エフェクトを実行したときに Flex によって使用されます。
IEffect
  
captureStartValues():void
エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャします。
IEffect
  
createInstance(target:Object = null):IEffectInstance
1 つのエフェクトインスタンスを作成し、それを初期化します。
IEffect
  
createInstances(targets:Array = null):Array
ターゲットオブジェクトの配列を取得し、各ターゲットで createInstance() メソッドを呼び出します。
IEffect
  
deleteInstance(instance:IEffectInstance):void
インスタンスからイベントリスナーを削除し、インスタンスのリストからインスタンスを削除します。
IEffect
 Inherited
dispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。
IEventDispatcher
  
end(effectInstance:IEffectInstance = null):void
現在再生中のエフェクトをすべて中断し、直ちにエフェクトの終わりにジャンプします。
IEffect
  
getAffectedProperties():Array
ストリングの配列を返します。各ストリングは、このエフェクトによって変更されるプロパティの名前です。
IEffect
 Inherited
hasEventListener(type:String):Boolean
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
IEventDispatcher
  
pause():void
resume() メソッドを呼び出すまで、エフェクトを一時停止します。
IEffect
  
play(targets:Array = null, playReversedFromEnd:Boolean = false):Array
エフェクトの再生を開始します。
IEffect
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
IEventDispatcher
  
resume():void
pause() メソッドを呼び出し、エフェクトを一時停止した後、再開させます。
IEffect
  
reverse():void
エフェクトが現在再生中の場合に、エフェクトの現在位置から開始して、逆順でエフェクトを再生します。
IEffect
  
stop():void
エフェクトターゲットを現在の状態にしたまま、エフェクトを停止します。
IEffect
 Inherited
willTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
IEventDispatcher
プロパティの詳細
classNameプロパティ
className:String  [読み取り専用]

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

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



実装
    public function get className():String
customFilterプロパティ 
customFilter:EffectTargetFilter

エフェクトを再生するターゲットを特定するために、エフェクトによって使用されるタイプ EffectTargetFilter のカスタムフィルタオブジェクトを指定します。

ターゲットへのフィルタリングは、エフェクトの再生前に captureStartValues() を呼び出した場合にのみ実行されます。エフェクトがトランジションに含まれる場合に、captureStartValues() メソッドが自動的に Flex から呼び出されます。

単純なフィルタリングには、filter プロパティを使用します。 customFilter プロパティが null 以外の場合、filter プロパティは無視されます。

デフォルト値 : null.



実装
    public function get customFilter():EffectTargetFilter
    public function set customFilter(value:EffectTargetFilter):void

関連項目

mx.effects.EffectTargetFilter
durationプロパティ 
duration:Number

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

Parallel エフェクトまたは Sequence エフェクトでは、duration プロパティによって各エフェクトの継続時間が設定されます。 例えば、Sequence エフェクトの duration プロパティが 3000 に設定されている場合、Sequence の各エフェクトの再生時間は 3000 ミリ秒となります。

繰り返されるエフェクトの場合、duration プロパティによって、エフェクトの 1 つあたりのインスタンスの継続時間が指定されます。 したがって、エフェクトで duration プロパティが 2000 に設定され、repeatCount プロパティが 3 に設定されている場合、エフェクトの総再生時間は 6000 ミリ秒（6 秒）となります。

デフォルト値 : 500.



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

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



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

エフェクトのターゲットをフィルタリングするアルゴリズムを指定します。 値が null の場合、フィルタリングは指定されません。

ターゲットへのフィルタリングは、エフェクトの再生前に captureStartValues() を呼び出した場合にのみ実行されます。エフェクトがトランジションに含まれる場合、またはリストコントロールのデータエフェクトに含まれる場合に、captureStartValues() メソッドが自動的に Flex から呼び出されます。

単純なフィルタリングには、このプロパティを使用します。 複雑なフィルタリングには、customFilter プロパティを使用します。 customFilter プロパティに null 以外の値が含まれている場合、このプロパティは無視されます。

filter プロパティについては、次の値を使用できます。

デフォルト値 : null.



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

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

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

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



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

エフェクトのインスタンスのいずれかが現在再生中の場合に true、そうでない場合に false となる読み取り専用フラグです。



実装
    public function get isPlaying():Boolean
perElementOffsetプロパティ 
perElementOffset:Number

エフェクトの最初のターゲットの後に発生する、エフェクトターゲットの追加遅延（ミリ秒）です。 この値は、startDelay プロパティの値に加算されます。



実装
    public function get perElementOffset():Number
    public function set perElementOffset(value:Number):void
relevantPropertiesプロパティ 
relevantProperties:Array

フィルタリング実行時に使用するプロパティ名の配列を表します。 このプロパティは内部的に使用され、エフェクトユーザーは設定する必要がありません。

デフォルト値は、getAffectedProperties() メソッドで返される配列と等しくなります。



実装
    public function get relevantProperties():Array
    public function set relevantProperties(value:Array):void
relevantStylesプロパティ 
relevantStyles:Array

フィルタリング実行時に使用するスタイル名の配列を表します。 このプロパティは内部的に使用され、エフェクトユーザーは設定する必要がありません。

デフォルト値は、getAffectedProperties() メソッドで返される配列と等しくなります。



実装
    public function get relevantStyles():Array
    public function set relevantStyles(value:Array):void
targetプロパティ 
target:Object

このエフェクトが適用される UIComponent オブジェクトを表します。 エフェクトトリガによってエフェクトがトリガされると、target プロパティはエフェクトをトリガするオブジェクトとなるように自動的に設定されます。



実装
    public function get target():Object
    public function set target(value:Object):void
targetsプロパティ 
targets:Array

エフェクトのターゲットである UIComponent オブジェクトの配列を表します。 エフェクトの再生時、各ターゲットのエフェクトがパラレル処理で実行されます。 target プロパティを設定すると、この配列中のすべてのオブジェクトが置換されます。 targets プロパティが設定されていると、target プロパティによってこの配列の最初の項目が返されます。



実装
    public function get targets():Array
    public function set targets(value:Array):void
triggerEventプロパティ 
triggerEvent:Event

エフェクトがトリガされたときに EffectManager によってこの Effect に渡される Event オブジェクトです。EffectManager によってエフェクトが再生されていない場合は null です。



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

エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャし、終了値として保存します。

エフェクトがデータ変更エフェクトに含まれる場合に、captureEndValues() メソッドが自動的に Flex から呼び出されます。

captureMoreStartValues()メソッド 
public function captureMoreStartValues(targets:Array):void

ターゲットの追加セットの関連するプロパティの現在値をキャプチャします。

この機能は、データ変更エフェクトを実行したときに Flex によって使用されます。

パラメータ

targets:Array — 値がキャプチャされるターゲットの配列を表します。

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

エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャします。 エフェクトがトランジションに含まれる場合に、captureStartValues() メソッドが自動的に Flex から呼び出されます。

エフェクトの開始値および終了値を把握するためにエフェクトが必要とされる場合は、この関数を使用します。 この関数を正しく使用するには、次の手順に従います。

  1. captureStartValues() メソッドを呼び出します。エフェクトはエフェクトの開始値をキャプチャします。
  2. 子の追加または削除、プロパティの変更、位置の変更、またはサイズの変更など、エフェクトターゲットを変更します。
  3. play() メソッドを呼び出します。エフェクトは終了値をキャプチャします。 この関数によって、このエフェクトで作成されたエフェクトインスタンスごとの EffectInstance.propertyChanges プロパティが作成されます。 エフェクト開発者は、propertyChanges プロパティを使用して、そのエフェクトの開始値および終了値を取得できます。

createInstance()メソッド 
public function createInstance(target:Object = null):IEffectInstance

1 つのエフェクトインスタンスを作成し、それを初期化します。 play() メソッドの代わりにこのメソッドを使用して、エフェクトインスタンスの再生前にエフェクトインスタンスのプロパティを操作します。

エフェクトインスタンスは、instanceClass プロパティで指定された型で作成されます。 次に、initInstance() メソッドを使用して初期化されます。インスタンスが EffectManager によって作成されている場合 (エフェクトがエフェクトトリガによってトリガされる場合)、エフェクトは EffectInstance.initEffect() メソッドの呼び出しによりさらに初期化されます。

createInstance() メソッドが呼び出されると、エフェクトは再生されません。返されたエフェクトインスタンスで startEffect() メソッドを呼び出す必要があります。

この関数は、Effect.play() メソッドによって自動的に呼び出されます。

パラメータ

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

戻り値
IEffectInstance — エフェクトのエフェクトインスタンスオブジェクトを表します。
createInstances()メソッド 
public function createInstances(targets:Array = null):Array

ターゲットオブジェクトの配列を取得し、各ターゲットで createInstance() メソッドを呼び出します。

パラメータ

targets:Array (default = null) — このエフェクトでアニメーション化するオブジェクトの配列を表します。

戻り値
Array — ターゲットごとに 1 つで、かつエフェクト用でもあるエフェクトインスタンスオブジェクトの配列を表します。
deleteInstance()メソッド 
public function deleteInstance(instance:IEffectInstance):void

インスタンスからイベントリスナーを削除し、インスタンスのリストからインスタンスを削除します。

パラメータ

instance:IEffectInstance

end()メソッド 
public function end(effectInstance:IEffectInstance = null):void

現在再生中のエフェクトをすべて中断し、直ちにエフェクトの終わりにジャンプします。 このメソッドが呼び出されると、EffectInstance.end() メソッドも呼び出されます。

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

エフェクトインスタンスを引数として渡すと、そのインスタンスは中断されます。 引数が渡されないと、そのときエフェクトから生成されたすべてのエフェクトインスタンスが中断されます。

パラメータ

effectInstance:IEffectInstance (default = null) — 終了する EffectInstance を表します。

関連項目

mx.effects.EffectInstance.end()
getAffectedProperties()メソッド 
public function getAffectedProperties():Array

ストリングの配列を返します。各ストリングは、このエフェクトによって変更されるプロパティの名前です。 例えば、Move エフェクトは "x" と "y" から成る配列を返します。

Effect のサブクラスはすべてこのメソッドを実装する必要があります。 このメソッドは、2 つのエフェクトが同時に同一オブジェクトの同一プロパティをアニメーション化しないように EffectManager で使用されます。

戻り値
Array — このエフェクトで変更されたプロパティの名前を指定するストリングの配列を表します。
pause()メソッド 
public function pause():void

resume() メソッドを呼び出すまで、エフェクトを一時停止します。

play()メソッド 
public function play(targets:Array = null, playReversedFromEnd:Boolean = false):Array

エフェクトの再生を開始します。 通常は end() メソッドを呼び出してから play() メソッドを呼び出します。これは、エフェクトの以前のインスタンスを確実に終了させてから新しいインスタンスを開始するためです。

すべてのサブクラスではこのメソッドを実装する必要があります。

パラメータ

targets:Array (default = null) — このエフェクトを再生するターゲットオブジェクトの配列を表します。 このパラメータを指定した場合、エフェクトの targets プロパティは使用されません。
 
playReversedFromEnd:Boolean (default = false) — true の場合、エフェクトを逆順に再生します。

戻り値
Array — ターゲットごとに 1 つで、かつエフェクト用でもある EffectInstance オブジェクトの配列を表します。
resume()メソッド 
public function resume():void

pause() メソッドを呼び出し、エフェクトを一時停止した後、再開させます。

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

エフェクトが現在再生中の場合に、エフェクトの現在位置から開始して、逆順でエフェクトを再生します。

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

エフェクトターゲットを現在の状態にしたまま、エフェクトを停止します。 pause() メソッドの呼び出しと異なり、resume() メソッドを stop() メソッドの後に呼び出すことはできません。ただし、play() メソッドを呼び出してエフェクトを再開できます。

エフェクトの終了処理の一環としてこのメソッドが呼び出されると、エフェクトインスタンスにより 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/IEffect.html