EffectEvent

Package	mx.events
Class	public class EffectEvent
Inheritance	EffectEvent Event Object

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:

effectStart
effectStop
effectRepeat
effectEnd
effectRepeat

More examples

Manually dispatching events
Handling effect events

Learn more

About Flex events

Related API Elements

mx.effects.Effect

Public Properties

	Property		Defined By
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented.	Event
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener.	Event
		effectInstance : IEffectInstance The effect instance object for the event.	EffectEvent
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

Public Methods

	Method		Defined By
		EffectEvent(eventType:String, bubbles:Boolean = false, cancelable:Boolean = false, effectInstance:IEffectInstance = null) Constructor.	EffectEvent
		clone():Event Duplicates an instance of an Event subclass.	Event
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns a string containing all the properties of the Event object.	Event
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

	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_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

effectInstance

property

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_END

Constant

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:

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.

Related API Elements

mx.effects.Effect

EFFECT_REPEAT

Constant

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:

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.

Related API Elements

mx.effects.Effect

EFFECT_START

Constant

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:

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.

Related API Elements

mx.effects.Effect

EFFECT_STOP

Constant

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:

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.

Related API Elements

mx.effects.Effect

EFFECT_UPDATE

Constant

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:

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.

Related API Elements

mx.effects.Effect

Legal Notices | Online Privacy Policy

EffectEvent - AS3 Flex

Classes x

effectInstance

EffectEvent

EFFECT_END

EFFECT_REPEAT

EFFECT_START

EFFECT_STOP

EFFECT_UPDATE