Packageorg.apache.flex.effects
Classpublic class Wipe
InheritanceWipe Inheritance Tween Inheritance Effect Inheritance EventDispatcher Inheritance flash.events.EventDispatcher
Implements IDocument

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

The Fade effect animates a UI component's alpha or opacity.


Public Properties
 PropertyDefined By
 InheritedactiveTweens : Object
[static] The list of tweens that are currently playing.
Tween
 InheritedcurrentTime : Number = NaN
[static] Used by effects to get the current effect time tick.
Tween
  direction : String
The direction of the Wipe.
Wipe
 Inheritedduration : Number
Duration of the animation, in milliseconds.
Effect
 InheritedeasingFunction : Function
[write-only] Sets the easing function for the animation.
Tween
 InheritedendValue : Number
Final value of the animation.
Tween
 Inheritedlistener : Object
Object that is notified at each interval of the animation.
Tween
 InheritedstartValue : Number
Initial value of the animation.
Tween
  target : String
The target as the String id of a widget in an MXML Document.
Wipe
Public Methods
 MethodDefined By
  
Wipe(target:IUIBase = null)
Constructor.
Wipe
 Inherited
captureEndValues():void
Effect
 Inherited
captureStartValues():void
Effect
 Inherited
endTween():void
Interrupt the tween, jump immediately to the end of the tween, and invoke the onTweenEnd() callback function.
Tween
  
onTweenEnd(value:Number):void
Wipe
  
onTweenUpdate(value:Number):void
Wipe
 Inherited
pause():void
[override] Pauses the effect until you call the resume() method.
Tween
 Inherited
play():void
[override] Stops the tween, ending it without dispatching an event or calling the Tween's endFunction or onTweenEnd().
Tween
 Inherited
resume():void
[override] Resumes the effect after it has been paused by a call to the pause() method.
Tween
 Inherited
reverse():void
[override] Plays the effect in reverse, starting from the current position of the effect.
Tween
 Inherited
seek(playheadTime:Number):void
Advances the tween effect to the specified position.
Tween
  
setDocument(document:Object, id:String = null):void
Wipe
 Inherited
stop():void
[override] Stops the tween, ending it without dispatching an event or calling the Tween's endFunction or onTweenEnd().
Tween
Public Constants
 ConstantDefined By
 InheritedEFFECT_END : String = effectEnd
[static] The Effect.EFFECT_END constant defines the value of the event object's type property for a effectEnd event.
Effect
 InheritedEFFECT_START : String = effectStart
[static] The Effect.EFFECT_START constant defines the value of the event object's type property for a effectStart event.
Effect
 InheritedEFFECT_STOP : String = effectStop
[static] The Effect.EFFECT_STOP constant defines the value of the event object's type property for a effectStop event.
Effect
 InheritedTWEEN_END : String = tweenEnd
[static] The Tween.TWEEN_END constant defines the value of the event object's type property for a tweenEnd event.
Tween
 InheritedTWEEN_START : String = tweenStart
[static] The Tween.TWEEN_START constant defines the value of the event object's type property for a tweenStart event.
Tween
 InheritedTWEEN_UPDATE : String = tweenUpdate
[static] The Tween.TWEEN_UPDATE constant defines the value of the event object's type property for a tweenUpdate event.
Tween
Property Detail
directionproperty
public var direction:String

The direction of the Wipe. "up" means the top will be the last part to disappear. "down" will reveal from the top down.

targetproperty 
public var target:String

The target as the String id of a widget in an MXML Document.

Constructor Detail
Wipe()Constructor
public function Wipe(target:IUIBase = null)

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

Constructor.

Parameters
target:IUIBase (default = null) — Object ID or reference to an object that will have its x and/or y property animated.
Method Detail
onTweenEnd()method
public function onTweenEnd(value:Number):void

Parameters

value:Number

onTweenUpdate()method 
public function onTweenUpdate(value:Number):void

Parameters

value:Number

setDocument()method 
public function setDocument(document:Object, id:String = null):void

Parameters

document:Object
 
id:String (default = null)




The Apache Software Foundation

Mon Sep 5 2016, 07:19 AM -07:00