Adobe Flex 2 Language Reference - collected by Jimbob | Back to MY RESOURCES


Packagemx.effects.effectClasses
Classpublic class WipeUpInstance
InheritanceWipeUpInstance Inheritance MaskEffectInstance Inheritance EffectInstance Inheritance EventDispatcher Inheritance Object

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

See also

mx.effects.WipeUp


Public Properties
 PropertyDefined by
 InheritedclassName : String
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
Duration of the effect in milliseconds.
EffectInstance
 Inheritedeffect : 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
EffectInstance
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedrepeatCount : int
EffectInstance
 InheritedrepeatDelay : int
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
EffectInstance
 InheritedsuspendBackgroundProcessing : Boolean
EffectInstance
 Inheritedtarget : Object
EffectInstance
 InheritedtargetArea : Rectangle
The area where the mask is applied on the target.
MaskEffectInstance
 InheritedtriggerEvent : Event
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
  
Constructor.
WipeUpInstance
 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
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
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 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
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 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
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
startEffect():void
Plays the effect instance on the target after the startDelay period has elapsed.
EffectInstance
 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
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
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
Callback method that is called when the scaleX and scaleY properties of the mask should be updated by the effect.
MaskEffectInstance
Events
 EventSummaryDefined by
 Inherited Dispatched when Flash Player gains operating system focus and becomes active.EventDispatcher
 Inherited Dispatched when Flash Player loses operating system focus and is becoming inactive.EventDispatcher
Constructor detail
WipeUpInstance()constructor
public function WipeUpInstance(target:Object)

Constructor.

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





collected by Jimbob 2007.05