パッケージmx.effects
クラスpublic class Effect
継承Effect Inheritance EventDispatcher Inheritance Object
実装 IEffect
サブクラス AddChildAction, AddItemAction, CompositeEffect, MaskEffect, RemoveChildAction, RemoveItemAction, SetPropertyAction, SetStyleAction, SoundEffect, TweenEffect, UnconstrainItemAction

Effect クラスはすべての Flex エフェクトの基本的な機能を定義する抽象基本クラスです。 Effect クラスはすべてのエフェクトの基本ファクトリクラスを定義します。 EffectInstance クラスはエフェクトインスタンスのすべてのサブクラスについての基本クラスを定義します。

アプリケーションで Effect クラス自体のインスタンスを作成することはありません。 その代わり、Fade、WipeLeft などのいずれかのサブクラスのインスタンスを作成します。

MXML のシンタックスexpandedMXML シンタックスを隠す

The Effect class defines the following properties, which all of its subclasses inherit:

  <mx:tagname
    Properties
    customFilter=""
    duration="500"
    filter=""
    hideFocusRing="false"
    perElementOffset="0"
    repeatCount="1"
    repeatDelay="0"
    startDelay="0"
    suspendBackgroundProcessing="false|true"
    target="effect target"
    targets="array of effect targets"
     
    Events
    effectEnd="No default"
    efectStart="No default"
  />

例を表示

関連項目

mx.effects.EffectInstance
About behaviors
About behaviors
Applying behaviors in MXML
Applying behaviors in MXML
Applying behaviors in ActionScript
Working with effects
Working with effects
Working with effects
Application coding
About creating a custom effect
About creating a custom effect
About creating a custom effect
Writing an effect for a transition
Defining a custom effect trigger
Using effects with charts

パブリックプロパティ
 プロパティ定義元
  className : String
[読み取り専用] このエフェクトクラスの名前です。たとえば、"Fade" などがあります。
Effect
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  customFilter : EffectTargetFilter
エフェクトを再生するターゲットを特定するために、エフェクトによって使用されるタイプ EffectTargetFilter のカスタムフィルタオブジェクトを指定します。
Effect
  duration : Number
エフェクトの継続時間を表します（ミリ秒単位）。
Effect
  effectTargetHost : IEffectTargetHost
データエフェクトのターゲットリストコントロールにアクセスできるプロパティです。
Effect
  filter : String
エフェクトのターゲットをフィルタリングするアルゴリズムを指定します。
Effect
  hideFocusRing : Boolean
エフェクトの開始時にエフェクトがフォーカスリングを非表示にするかどうかを指定します。
Effect
  instanceClass : Class
このエフェクトクラスのエフェクトインスタンスクラスを指定する Class 型のオブジェクトを表します。
Effect
  isPlaying : Boolean
[読み取り専用] エフェクトのインスタンスのいずれかが現在再生中の場合に true、そうでない場合に false となる読み取り専用フラグです。
Effect
  perElementOffset : Number
エフェクトの最初のターゲットの後に発生する、エフェクトターゲットの追加遅延（ミリ秒）です。
Effect
 Inheritedprototype : Object
[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
  relevantProperties : Array
フィルタリング実行時に使用するプロパティ名の配列を表します。
Effect
  relevantStyles : Array
フィルタリング実行時に使用するスタイル名の配列を表します。
Effect
  repeatCount : int = 1
エフェクトを繰り返す回数を表します。
Effect
  repeatDelay : int = 0
エフェクトを繰り返す前の待機時間を表します（ミリ秒単位）。
Effect
  startDelay : int = 0
エフェクトを開始する前の待機時間を表します（ミリ秒単位）。
Effect
  suspendBackgroundProcessing : Boolean = false
true の場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。
Effect
  target : Object
このエフェクトが適用される UIComponent オブジェクトを表します。
Effect
  targets : Array
エフェクトのターゲットである UIComponent オブジェクトの配列を表します。
Effect
  triggerEvent : Event
エフェクトがトリガされたときに EffectManager によってこの Effect に渡される Event オブジェクトです。EffectManager によってエフェクトが再生されていない場合は null です。
Effect
プロテクトプロパティ
 プロパティ定義元
  endValuesCaptured : Boolean = false
エフェクトの終了値が既に決定されている場合は true を含むフラグ、エフェクトの実行時にエフェクトターゲットの現在のプロパティから終了値を取得する必要がある場合は false を含むフラグです。
Effect
パブリックメソッド
 メソッド定義元
  
Effect(target:Object = null)
コンストラクタです。
Effect
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
EventDispatcher
  
captureEndValues():void
エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャし、終了値として保存します。
Effect
  
captureMoreStartValues(targets:Array):void
ターゲットの追加セットの関連するプロパティの現在値をキャプチャします。この機能は、データ変更エフェクトを実行したときに Flex によって使用されます。
Effect
  
captureStartValues():void
エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャします。
Effect
  
createInstance(target:Object = null):IEffectInstance
1 つのエフェクトインスタンスを作成し、それを初期化します。
Effect
  
createInstances(targets:Array = null):Array
ターゲットオブジェクトの配列を取得し、各ターゲットで createInstance() メソッドを呼び出します。
Effect
  
deleteInstance(instance:IEffectInstance):void
インスタンスからイベントリスナーを削除し、インスタンスのリストからインスタンスを削除します。
Effect
 Inherited
dispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。
EventDispatcher
  
end(effectInstance:IEffectInstance = null):void
現在再生中のエフェクトをすべて中断し、直ちにエフェクトの終わりにジャンプします。
Effect
  
getAffectedProperties():Array
ストリングの配列を返します。各ストリングは、このエフェクトによって変更されるプロパティの名前です。
Effect
 Inherited
hasEventListener(type:String):Boolean
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
  
pause():void
resume() メソッドを呼び出すまで、エフェクトを一時停止します。
Effect
  
play(targets:Array = null, playReversedFromEnd:Boolean = false):Array
エフェクトの再生を開始します。
Effect
 Inherited
propertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
  
resume():void
pause() メソッドを呼び出し、エフェクトを一時停止した後、再開させます。
Effect
  
reverse():void
エフェクトが現在再生中の場合に、エフェクトの現在位置から開始して、逆順でエフェクトを再生します。
Effect
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
  
stop():void
エフェクトターゲットを現在の状態にしたまま、エフェクトを停止します。
Effect
 Inherited
toString():String
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
valueOf():Object
指定されたオブジェクトのプリミティブな値を返します。
Object
 Inherited
willTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
プロテクトメソッド
 メソッド定義元
  
applyValueToTarget(target:Object, property:String, value:*, props:Object):void
エフェクトインフラストラクチャによって内部的に使用されます。
Effect
  
effectEndHandler(event:EffectEvent):void
エフェクトインスタンスの再生終了時に呼び出されます。
Effect
  
effectStartHandler(event:EffectEvent):void
このメソッドは、エフェクトインスタンスの再生開始時に呼び出されます。
Effect
  
filterInstance(propChanges:Array, target:Object):Boolean
エフェクトインスタンスをフィルタリングするために必要なロジックを決定します。
Effect
  
getValueFromTarget(target:Object, property:String):*
ターゲットからプロパティの値を取得するために captureStartValues() メソッドによって呼び出されます。
Effect
  
initInstance(instance:IEffectInstance):void
エフェクトインスタンスにエフェクトのプロパティをコピーします。
Effect
イベント
 イベント 概要 定義元
 Inherited
activate
[ブロードキャスト イベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。EventDispatcher
 Inherited
deactivate
[ブロードキャスト イベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。EventDispatcher
  
effectEnd
エフェクトの再生停止時（エフェクトの再生完了時、またはエフェクトが end() メソッドの呼び出しにより中断されたとき）に送出されます。Effect
  
effectStart
エフェクトの再生開始時に送出されます。Effect
プロパティの詳細
classNameプロパティ
className:String  [読み取り専用]

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

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



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

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

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

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



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

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

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

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



実装
    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
endValuesCapturedプロパティ 
protected var endValuesCaptured:Boolean = false

エフェクトの終了値が既に決定されている場合は true を含むフラグ、エフェクトの実行時にエフェクトターゲットの現在のプロパティから終了値を取得する必要がある場合は false を含むフラグです。 このプロパティがデータエフェクトで必要なのは、データエフェクト（DefaultListEffect や DefaultTileListEffect など）を設定する順序が通常のエフェクトよりも複雑なためです。

デフォルト値 : false.

filterプロパティ 
filter:String

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

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

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

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



実装
    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
instanceClassプロパティ 
public var instanceClass:Class

このエフェクトクラスのエフェクトインスタンスクラスを指定する Class 型のオブジェクトを表します。

Effect クラスのすべてのサブクラスによって、コンストラクタ内のこのプロパティが必ず設定されます。

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
repeatCountプロパティ 
public var repeatCount:int = 1

エフェクトを繰り返す回数を表します。 有効な値は 0 以上の整数です。 値が 1 の場合、エフェクトが 1 度再生されます。 値 0 を設定すると、end() メソッドを呼び出して停止するまで、エフェクトは無制限に再生されます。

デフォルト値 : 1.

repeatDelayプロパティ 
public var repeatDelay:int = 0

エフェクトを繰り返す前の待機時間を表します（ミリ秒単位）。 有効な値は 0 以上の整数です。

デフォルト値 : 0.

startDelayプロパティ 
public var startDelay:int = 0

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

デフォルト値 : 0.

suspendBackgroundProcessingプロパティ 
public var suspendBackgroundProcessing:Boolean = false

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

ほとんどの場合、このプロパティを true に設定することをお勧めします。true に設定すると、アプリケーションのパフォーマンスが向上するためです。 ただし、次のいずれかが成り立つ場合はプロパティを false に設定してください。

デフォルト値 : false.

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
コンストラクタの詳細
Effect()コンストラクタ
public function Effect(target:Object = null)

コンストラクタです。

通常、エフェクトの開始は次の 3 つの手順から成るプロセスです。

パラメータ
target:Object (default = null) — このエフェクトでアニメーション化するオブジェクトを表します。
メソッドの詳細
applyValueToTarget()メソッド
protected function applyValueToTarget(target:Object, property:String, value:*, props:Object):void

エフェクトインフラストラクチャによって内部的に使用されます。 captureStartValues() が呼び出されているときに Flex が play() メソッドを呼び出す場合、この関数を使用してターゲットを開始状態に戻します。デフォルトのビヘイビアでは、getValueFromTarget() メソッドを使用してキャプチャした値を、ターゲットのプロパティに直接的に設定します。次に実際の使用例を示します。 

      
      target[property] = value;

キャプチャした値を異なる方法で適用する必要がある場合のみ、このメソッドをオーバーライドしてください。 ターゲットのスタイルプロパティは別のメカニズムで設定されます。 キャプチャし、適用するスタイルを指定するには、relevantStyles プロパティを使用します。

パラメータ

target:Object — エフェクトターゲットを表します。
 
property:String — ターゲットプロパティを表します。
 
value:* — プロパティの値です。
 
props:Object — オブジェクトの配列です。各配列にはエフェクトが監視しているプロパティの start および end オブジェクトが含まれます。

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

effectEndHandler()メソッド 
protected function effectEndHandler(event:EffectEvent):void

エフェクトインスタンスの再生終了時に呼び出されます。 このメソッドをオーバーライドする場合、必ずスーパーメソッドを呼び出すようにしてください。

パラメータ

event:EffectEvent — EffectEvent 型のイベントオブジェクトを表します。

effectStartHandler()メソッド 
protected function effectStartHandler(event:EffectEvent):void

このメソッドは、エフェクトインスタンスの再生開始時に呼び出されます。 このメソッドをオーバーライドする場合、必ずスーパーメソッドを呼び出すようにしてください。

パラメータ

event:EffectEvent — EffectEvent 型のイベントオブジェクトを表します。

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

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

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

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

パラメータ

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

filterInstance()メソッド 
protected function filterInstance(propChanges:Array, target:Object):Boolean

エフェクトインスタンスをフィルタリングするために必要なロジックを決定します。 このメソッドは、CompositeEffect クラスによってオーバーライドされます。

パラメータ

propChanges:Array — エフェクトによって変更されるプロパティを表します。
 
target:Object — エフェクトターゲットを表します。

戻り値
Boolean — エフェクトインスタンスを再生する必要がある場合は、true を返します。
getAffectedProperties()メソッド 
public function getAffectedProperties():Array

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

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

戻り値
Array — このエフェクトで変更されたプロパティの名前を指定するストリングの配列を表します。

関連項目

About creating a custom effect
getValueFromTarget()メソッド 
protected function getValueFromTarget(target:Object, property:String):*

ターゲットからプロパティの値を取得するために captureStartValues() メソッドによって呼び出されます。この関数は、エフェクトフレームワークによってのみ内部的に呼び出されます。 デフォルトのビヘイビアでは、target[property] だけを返します。エフェクトの開発時に異なるビヘイビアが必要な場合は、この関数をオーバーライドできます。

パラメータ

target:Object — エフェクトターゲットを表します。
 
property:String — ターゲットプロパティを表します。

戻り値
* — ターゲットプロパティの値です。
initInstance()メソッド 
protected function initInstance(instance:IEffectInstance):void

エフェクトインスタンスにエフェクトのプロパティをコピーします。

Flex は Effect.createInstance() メソッドからこのメソッドを呼び出します。ユーザーが呼び出す必要はありません。

カスタムエフェクトを作成する際は、このメソッドをオーバーライドして、Effect クラスからエフェクトインスタンスクラスにプロパティをコピーします。 オーバーライド時は、super.initInstance() () を呼び出す必要があります。

パラメータ

instance:IEffectInstance — 初期化するエフェクトインスタンスを表します。

関連項目

About creating a custom effect
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 イベントが送出されます。

マスクエフェクトの場合、エフェクトを停止してもマスクは自動的に削除されません。 最初のマスクを削除せずに、同じターゲット上でマスクエフェクトをさらに実行すると、予期しない結果が生じる可能性があります。

イベントの詳細
effectEnd イベント
イベントオブジェクトの型: mx.events.EffectEvent
プロパティ EffectEvent.type = mx.events.EffectEvent.EFFECT_END

エフェクトの再生停止時 (エフェクトの再生完了時、またはエフェクトが end() メソッドの呼び出しにより中断されたとき) に送出されます。

EffectEvent.EFFECT_END 定数は type プロパティ（effectEnd イベント用イベントオブジェクトのプロパティ）の値を定義します。

イベントオブジェクトの各プロパティには次の値が設定されています。

プロパティ値
bubblesfalse
cancelablefalse
currentTargetイベント処理を行うイベントリスナーの定義用オブジェクトを表します。 例えば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は myButton となります。
effectInstanceイベントのエフェクトインスタンスオブジェクトを表します。
targetイベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトにアクセスするには、currentTarget プロパティを使用します。
effectStart イベント  
イベントオブジェクトの型: mx.events.EffectEvent
プロパティ EffectEvent.type = mx.events.EffectEvent.EFFECT_START

エフェクトの再生開始時に送出されます。

EffectEvent.EFFECT_START 定数は type プロパティ（effectStart イベント用イベントオブジェクトのプロパティ）の値を定義します。

イベントオブジェクトの各プロパティには次の値が設定されています。

プロパティ値
bubblesfalse
cancelablefalse
currentTargetイベント処理を行うイベントリスナーの定義用オブジェクトを表します。 例えば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は myButton となります。
effectInstanceイベントのエフェクトインスタンスオブジェクトを表します。
targetイベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトにアクセスするには、currentTarget プロパティを使用します。
例 例の使用法
SimpleEffectExample.mxml
<?xml version="1.0"?>
<!-- Simple example to demonstrate the Effect class. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">

    <mx:Script>
        <![CDATA[

            import mx.controls.Alert;

            // Event handler for the effectEnd event.            
            private function endEffectHandler():void {
                Alert.show("Effect Ended!");
            }

            // Event handler for the reset button.            
            private function resetHandler():void {
                expand.end(); 
                img.width=30; 
                img.height=60; 
                button1.enabled=true;
            }
        ]]>
    </mx:Script>


    <mx:Resize id="expand" target="{img}" widthTo="100" heightTo="200" 
        duration="10000" effectEnd="endEffectHandler();"/>

    <mx:Panel title="Resize Effect Example" width="100%" height="100%" 
        paddingTop="10" paddingLeft="10" paddingRight="10" paddingBottom="10">

        <mx:Text width="100%" color="blue" 
            text="Use the Button controls to control the Resize effect."/>

        <mx:Image id="img" width="30" height="60"
            source="@Embed(source='assets/Nokia_6630.png')"/>
     
        <mx:ControlBar>
            <mx:Button id="button1" label="Start" click="expand.play(); button1.enabled=false;"/>
            <mx:Button label="Pause" click="expand.pause();"/>
            <mx:Button label="Resume" click="expand.resume();"/>
            <mx:Button label="Reverse" click="expand.reverse();"/>
            <mx:Button label="End" click="expand.end();"/>
            <mx:Button label="Reset" click="resetHandler();"/>
        </mx:ControlBar>
        
    </mx:Panel>
</mx:Application>



© 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/Effect.html