Packagemx.effects.effectClasses
Classpublic class WipeLeftInstance
InheritanceWipeLeftInstance Inheritance MaskEffectInstance Inheritance EffectInstance Inheritance flash.events.EventDispatcher

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

See also

mx.effects.WipeLeft


Public Properties
 PropertyDefined by
 InheritedclassName : String
The name of the effect class, such as "FadeInstance".
EffectInstance
 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 : 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 position in time 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
 InheritedtargetVisualBounds : Rectangle
The actual size of the effect target, including any drop shadows.
MaskEffectInstance
Public Methods
 MethodDefined by
  
WipeLeftInstance(target:Object)
Constructor.
WipeLeftInstance
 Inherited
end():void
Interrupts an effect instance that is currently playing, and jumps immediately to the end of the effect.
EffectInstance
 Inherited
finishEffect():void
Called by the end() method when the effect finishes playing.
EffectInstance
 Inherited
finishRepeat():void
Called after each iteration of a repeated effect finishes playing.
EffectInstance
 Inherited
initEffect(event:Event):void
This method is called if the effect was triggered by the EffectManager.
EffectInstance
 Inherited
pause():void
Pauses the effect until you call the resume() method.
MaskEffectInstance
 Inherited
play():void
Plays the effect instance on the target.
EffectInstance
 Inherited
resume():void
Resumes the effect after it has been paused by a call to the pause() method.
MaskEffectInstance
 Inherited
reverse():void
Plays the effect in reverse, starting from the current position of the effect.
MaskEffectInstance
 Inherited
startEffect():void
Plays the effect instance on the target after the startDelay period has elapsed.
EffectInstance
 Inherited
stop():void
Stops the effect, leaving the target in its current state.
EffectInstance
Protected Methods
 MethodDefined by
 Inherited
defaultCreateMask(targ:Object, bounds:Rectangle):Shape
Creates the default mask for the effect.
MaskEffectInstance
 Inherited
Initializes the move and scale properties of the effect.
MaskEffectInstance
 Inherited
onMoveTweenEnd(value:Object):void
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
onMoveTweenUpdate(value:Object):void
Callback method that is called when the x and y position of the mask should be updated by the effect.
MaskEffectInstance
 Inherited
onScaleTweenEnd(value:Object):void
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
onScaleTweenUpdate(value:Object):void
Callback method that is called when the scaleX and scaleY properties of the mask should be updated by the effect.
MaskEffectInstance
Constructor detail
WipeLeftInstance()constructor
public function WipeLeftInstance(target:Object)

Constructor.

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