Package | mx.events |
Class | public class EffectEvent |
Inheritance | EffectEvent flash.events.Event |
effectStart
effectEnd
See also
Property | Defined by | ||
---|---|---|---|
effectInstance : IEffectInstance
The effect instance object for the event.
| EffectEvent |
Method | Defined by | ||
---|---|---|---|
EffectEvent(eventType:String, bubbles:Boolean = false, cancelable:Boolean = false, effectInstance:IEffectInstance = null)
Constructor.
| EffectEvent |
Constant | Defined 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_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 |
effectInstance | property |
public var effectInstance:IEffectInstance
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.
EffectEvent | () | constructor |
public function EffectEvent(eventType:String, bubbles:Boolean = false, cancelable:Boolean = false, effectInstance:IEffectInstance = null)
Constructor.
ParameterseventType: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.
|
EFFECT_END | constant |
public static const EFFECT_END:String = "effectEnd"
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:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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 . |
effectInstance | The effect instance object for the event. |
target | The 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
EFFECT_START | constant |
public static const EFFECT_START:String = "effectStart"
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:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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 . |
effectInstance | The effect instance object for the event. |
target | The 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