Package | mx.effects.effectClasses |
Class | public class IrisInstance |
Inheritance | IrisInstance MaskEffectInstance EffectInstance EventDispatcher Object |
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Related API Elements
Public Properties
Property | Defined By | ||
---|---|---|---|
className : String [read-only]
The name of the effect class, such as "FadeInstance". | EffectInstance | ||
constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | ||
createMaskFunction : Function
Function called when the effect creates the mask. | MaskEffectInstance | ||
duration : Number
The duration of the effect, in milliseconds. | EffectInstance | ||
effect : IEffect
The IEffect object that created this IEffectInstance object. | EffectInstance | ||
effectTargetHost : mx.effects:IEffectTargetHost
A property that lets you access the target
list-based control of a data effect. | EffectInstance | ||
hideFocusRing : Boolean
Determines whether the effect should hide
the focus ring when starting the effect. | EffectInstance | ||
moveEasingFunction : Function
Easing function to use for moving the mask. | MaskEffectInstance | ||
playheadTime : Number
Current time position of the effect. | EffectInstance | ||
propertyChanges : PropertyChanges
Specifies the PropertyChanges object containing
the start and end values for the set of properties
relevant to the effect's targets. | EffectInstance | ||
repeatCount : int
Number of times to repeat the effect. | EffectInstance | ||
repeatDelay : int
Amount of time, in milliseconds,
to wait before repeating the effect. | EffectInstance | ||
scaleEasingFunction : Function
Easing function to use for scaling the mask. | MaskEffectInstance | ||
scaleXFrom : Number
Initial scaleX for mask. | MaskEffectInstance | ||
scaleXTo : Number
Ending scaleX for mask. | MaskEffectInstance | ||
scaleYFrom : Number
Initial scaleY for mask. | MaskEffectInstance | ||
scaleYTo : Number
Ending scaleY for mask. | MaskEffectInstance | ||
showTarget : Boolean
Specifies that the target component is becoming visible,
false, or invisible, true. | MaskEffectInstance | ||
startDelay : int
Amount of time, in milliseconds,
to wait before starting the effect. | EffectInstance | ||
suspendBackgroundProcessing : Boolean
If true, blocks all background processing
while the effect is playing. | EffectInstance | ||
target : Object
The UIComponent object to which this effect is applied. | EffectInstance | ||
targetArea : Rectangle
The area where the mask is applied on the target. | MaskEffectInstance | ||
triggerEvent : Event
The event, if any, which triggered the playing of the effect. | EffectInstance | ||
xFrom : Number
Initial position's x coordinate for mask. | MaskEffectInstance | ||
xTo : Number
Destination position's x coordinate for mask. | MaskEffectInstance | ||
yFrom : Number
Initial position's y coordinate for mask. | MaskEffectInstance | ||
yTo : Number
Destination position's y coordinate for mask. | MaskEffectInstance |
Protected Properties
Property | Defined By | ||
---|---|---|---|
effectMask : 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 | ||
playCount : int = 0
Number of times that the instance has been played. | EffectInstance | ||
targetVisualBounds : Rectangle
The actual size of the effect target, including any drop shadows. | MaskEffectInstance |
Public Methods
Method | Defined By | ||
---|---|---|---|
IrisInstance(target:Object)
Constructor. | IrisInstance | ||
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 | ||
Dispatches an event into the event flow. | EventDispatcher | ||
Interrupts an effect instance that is currently playing,
and jumps immediately to the end of the effect. | EffectInstance | ||
Called by the end() method when the effect
finishes playing. | EffectInstance | ||
Called after each iteration of a repeated effect finishes playing. | EffectInstance | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | ||
Indicates whether an object has a specified property defined. | Object | ||
This method is called if the effect was triggered by the EffectManager. | EffectInstance | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
[override]
Pauses the effect until you call the resume() method. | MaskEffectInstance | ||
Plays the effect instance on the target. | EffectInstance | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Removes a listener from the EventDispatcher object. | EventDispatcher | ||
[override]
Resumes the effect after it has been paused
by a call to the pause() method. | MaskEffectInstance | ||
[override]
Plays the effect in reverse,
starting from the current position of the effect. | MaskEffectInstance | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Plays the effect instance on the target after the
startDelay period has elapsed. | EffectInstance | ||
Stops the effect, leaving the target in its current state. | EffectInstance | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
Returns the string representation of the specified object. | Object | ||
Returns the primitive value of the specified object. | Object | ||
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher |
Protected Methods
Method | Defined By | ||
---|---|---|---|
Creates the default mask for the effect. | MaskEffectInstance | ||
Initializes the move and scale
properties of the effect. | MaskEffectInstance | ||
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 | ||
Callback method that is called when the x and y position
of the mask should be updated by the effect. | MaskEffectInstance | ||
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 | ||
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 | ||
---|---|---|---|---|
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | |||
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher |
Thu Dec 4 2014, 05:50 PM -08:00