Packagemx.events
Classpublic class EffectEvent
InheritanceEffectEvent Inheritance flash.events.Event

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Represents event objects that are specific to Flex effects. Flex effects dispatch the following types of events:

See also

mx.effects.Effect

Public Properties
 PropertyDefined By
  effectInstance : IEffectInstance
The effect instance object for the event.
EffectEvent
Public Methods
 MethodDefined By
  
EffectEvent(eventType:String, bubbles:Boolean = false, cancelable:Boolean = false, effectInstance:IEffectInstance = null)
Constructor.
EffectEvent
Public Constants
 ConstantDefined By
  EFFECT_END : String = effectEnd
[static] The EffectEvent.EFFECT_END constant defines the value of the type property of the event object for an effectEnd event.
EffectEvent
  EFFECT_REPEAT : String = effectRepeat
[static] The EffectEvent.EFFECT_REPEAT constant defines the value of the type property of the event object for an effectRepeat event.
EffectEvent
  EFFECT_START : String = effectStart
[static] The EffectEvent.EFFECT_START constant defines the value of the type property of the event object for an effectStart event.
EffectEvent
  EFFECT_STOP : String = effectStop
[static] The EffectEvent.EFFECT_STOP constant defines the value of the type property of the event object for an effectStop event.
EffectEvent
  EFFECT_UPDATE : String = effectUpdate
[static] The EffectEvent.EFFECT_UPDATE constant defines the value of the type property of the event object for an effectUpdate event.
EffectEvent
Property Detail
effectInstanceproperty
public var effectInstance:IEffectInstance

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The effect instance object for the event. You can use this property to access the properties of the effect instance object from within your event listener.

Constructor Detail
EffectEvent()Constructor
public function EffectEvent(eventType:String, bubbles:Boolean = false, cancelable:Boolean = false, effectInstance:IEffectInstance = null)

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Constructor.

Parameters
eventType:String — The event type; indicates the action that caused the event.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Specifies whether the behavior associated with the event can be prevented.
 
effectInstance:IEffectInstance (default = null) — The effect instance that triggered the event.
Constant Detail
EFFECT_ENDConstant
public static const EFFECT_END:String = effectEnd

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The EffectEvent.EFFECT_END constant defines the value of the type property of the event object for an effectEnd event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
effectInstanceThe effect instance object for the event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

See also

mx.effects.Effect
EFFECT_REPEATConstant 
public static const EFFECT_REPEAT:String = effectRepeat

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The EffectEvent.EFFECT_REPEAT constant defines the value of the type property of the event object for an effectRepeat event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
effectInstanceThe effect instance object for the event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

See also

mx.effects.Effect
EFFECT_STARTConstant 
public static const EFFECT_START:String = effectStart

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The EffectEvent.EFFECT_START constant defines the value of the type property of the event object for an effectStart event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
effectInstanceThe effect instance object for the event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

See also

mx.effects.Effect
EFFECT_STOPConstant 
public static const EFFECT_STOP:String = effectStop

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The EffectEvent.EFFECT_STOP constant defines the value of the type property of the event object for an effectStop event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
effectInstanceThe effect instance object for the event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

See also

mx.effects.Effect
EFFECT_UPDATEConstant 
public static const EFFECT_UPDATE:String = effectUpdate

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The EffectEvent.EFFECT_UPDATE constant defines the value of the type property of the event object for an effectUpdate event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
effectInstanceThe effect instance object for the event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

See also

mx.effects.Effect




Mon Dec 24 2012, 01:18 PM +11:00