ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.effects.effectClasses 

IrisInstance  - AS3 Flex

Packagemx.effects.effectClasses
Classpublic class IrisInstance
InheritanceIrisInstance Inheritance MaskEffectInstance Inheritance EffectInstance Inheritance EventDispatcher Inheritance Object

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

The IrisInstance class implements the instance class for the Iris effect. Flex creates an instance of this class when it plays an Iris effect; you do not create one yourself.

Related API Elements



Public Properties
 PropertyDefined By
 InheritedclassName : String
[read-only] The name of the effect class, such as "FadeInstance".
EffectInstance
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcreateMaskFunction : Function
Function called when the effect creates the mask.
MaskEffectInstance
 Inheritedduration : Number
The duration of the effect, in milliseconds.
EffectInstance
 Inheritedeffect : IEffect
The IEffect object that created this IEffectInstance object.
EffectInstance
 InheritedeffectTargetHost : mx.effects:IEffectTargetHost
A property that lets you access the target list-based control of a data effect.
EffectInstance
 InheritedhideFocusRing : Boolean
Determines whether the effect should hide the focus ring when starting the effect.
EffectInstance
 InheritedmoveEasingFunction : Function
Easing function to use for moving the mask.
MaskEffectInstance
 InheritedplayheadTime : Number
Current time position of the effect.
EffectInstance
 InheritedpropertyChanges : PropertyChanges
Specifies the PropertyChanges object containing the start and end values for the set of properties relevant to the effect's targets.
EffectInstance
 InheritedrepeatCount : int
Number of times to repeat the effect.
EffectInstance
 InheritedrepeatDelay : int
Amount of time, in milliseconds, to wait before repeating the effect.
EffectInstance
 InheritedscaleEasingFunction : Function
Easing function to use for scaling the mask.
MaskEffectInstance
 InheritedscaleXFrom : Number
Initial scaleX for mask.
MaskEffectInstance
 InheritedscaleXTo : Number
Ending scaleX for mask.
MaskEffectInstance
 InheritedscaleYFrom : Number
Initial scaleY for mask.
MaskEffectInstance
 InheritedscaleYTo : Number
Ending scaleY for mask.
MaskEffectInstance
 InheritedshowTarget : Boolean
Specifies that the target component is becoming visible, false, or invisible, true.
MaskEffectInstance
 InheritedstartDelay : int
Amount of time, in milliseconds, to wait before starting the effect.
EffectInstance
 InheritedsuspendBackgroundProcessing : Boolean
If true, blocks all background processing while the effect is playing.
EffectInstance
 Inheritedtarget : Object
The UIComponent object to which this effect is applied.
EffectInstance
 InheritedtargetArea : Rectangle
The area where the mask is applied on the target.
MaskEffectInstance
 InheritedtriggerEvent : Event
The event, if any, which triggered the playing of the effect.
EffectInstance
 InheritedxFrom : Number
Initial position's x coordinate for mask.
MaskEffectInstance
 InheritedxTo : Number
Destination position's x coordinate for mask.
MaskEffectInstance
 InheritedyFrom : Number
Initial position's y coordinate for mask.
MaskEffectInstance
 InheritedyTo : Number
Destination position's y coordinate for mask.
MaskEffectInstance
Protected Properties
 PropertyDefined By
 InheritedeffectMask : Shape
Contains the effect mask, either the default mask created by the defaultCreateMask() method, or the one specified by the function passed to the createMaskFunction property.
MaskEffectInstance
 InheritedplayCount : int = 0
Number of times that the instance has been played.
EffectInstance
 InheritedtargetVisualBounds : Rectangle
The actual size of the effect target, including any drop shadows.
MaskEffectInstance
Public Methods
 MethodDefined By
  
Constructor.
IrisInstance
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 Inherited
Interrupts an effect instance that is currently playing, and jumps immediately to the end of the effect.
EffectInstance
 Inherited
Called by the end() method when the effect finishes playing.
EffectInstance
 Inherited
Called after each iteration of a repeated effect finishes playing.
EffectInstance
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
This method is called if the effect was triggered by the EffectManager.
EffectInstance
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
[override] Pauses the effect until you call the resume() method.
MaskEffectInstance
 Inherited
Plays the effect instance on the target.
EffectInstance
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
[override] Resumes the effect after it has been paused by a call to the pause() method.
MaskEffectInstance
 Inherited
[override] Plays the effect in reverse, starting from the current position of the effect.
MaskEffectInstance
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Plays the effect instance on the target after the startDelay period has elapsed.
EffectInstance
 Inherited
Stops the effect, leaving the target in its current state.
EffectInstance
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
 Inherited
Creates the default mask for the effect.
MaskEffectInstance
 Inherited
Initializes the move and scale properties of the effect.
MaskEffectInstance
 Inherited
Callback method that is called when the x and y position of the mask should be updated by the effect for the last time.
MaskEffectInstance
 Inherited
Callback method that is called when the x and y position of the mask should be updated by the effect.
MaskEffectInstance
 Inherited
Callback method that is called when the scaleX and scaleY properties of the mask should be updated by the effect for the last time.
MaskEffectInstance
 Inherited
Callback method that is called when the scaleX and scaleY properties of the mask should be updated by the effect.
MaskEffectInstance
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
Constructor Detail

IrisInstance

()Constructor
public function IrisInstance(target:Object)

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

Constructor.

Parameters
target:Object — The Object to animate with this effect.