mx.effects.WipeDown (Flex™ 2 Language Reference

Package	mx.effects
Class	public class WipeDown
Inheritance	WipeDown MaskEffect Effect EventDispatcher Object

The WipeDown class defines a bar wipe down effect. The before or after state of the component must be invisible.

You often use this effect with the showEffect and hideEffect triggers. The showEffect trigger occurs when a component becomes visible by changing its visible property from false to true. The hideEffect trigger occurs when the component becomes invisible by changing its visible property from true to false.

This effect inherits the MaskEffect.show property. If you set the value to true, the component appears. If you set the value to false, the component disappears. The default value is true.

If you specify this effect for a showEffect or hideEffect trigger, Flex sets the show property for you, either to true if the component becomes invisible, or false if the component becomes visible.

MXML Syntax expanded

Hide MXML Syntax

The <mx:WipeDown> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

  <mx:WipeDown
    id="ID"
  />

View the examples.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined by
		className : String The name of the effect class, such as `"Fade"`.	Effect
		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.	MaskEffect
		customFilter : EffectTargetFilter Specifies a custom filter object, of type EffectTargetFilter, used by the effect to determine the targets on which to play the effect.	Effect
		duration : Number Duration of the effect in milliseconds.	Effect
		filter : String Specifies an algorithm for filtering targets for an effect.	Effect
		instanceClass : Class An object of type Class that specifies the effect instance class class for this effect class.	Effect
		isPlaying : Boolean A read-only flag which is true if any instances of the effect are currently playing, and false if none are.	Effect
		moveEasingFunction : Function Easing function to use for moving the mask.	MaskEffect
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		relevantProperties : Array An Array of property names to use when performing filtering.	Effect
		relevantStyles : Array An Array of style names to use when performing filtering.	Effect
		repeatCount : int = 1 Number of times to repeat the effect.	Effect
		repeatDelay : int = 0 Amount of time, in milliseconds, to wait before repeating the effect.	Effect
		scaleEasingFunction : Function Easing function to use for scaling the mask.	MaskEffect
		scaleXFrom : Number Initial scaleX for mask.	MaskEffect
		scaleXTo : Number Ending scaleX for mask.	MaskEffect
		scaleYFrom : Number Initial scaleY for mask.	MaskEffect
		scaleYTo : Number Ending scaleY for mask.	MaskEffect
		showTarget : Boolean Specifies that the target component is becoming visible, `true`, or invisible, `false`.	MaskEffect
		startDelay : int = 0 Amount of time, in milliseconds, to wait before starting the effect.	Effect
		suspendBackgroundProcessing : Boolean = false If `true`, blocks all background processing while the effect is playing.	Effect
		target : Object The UIComponent object to which this effect is applied.	Effect
		targets : Array An Array of UIComponent objects that are targets for the effect.	Effect
		xFrom : Number Initial position's x coordinate for mask.	MaskEffect
		xTo : Number Destination position's x coordinate for mask.	MaskEffect
		yFrom : Number Initial position's y coordinate for mask.	MaskEffect
		yTo : Number Destination position's y coordinate for mask.	MaskEffect

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		WipeDown(target:Object = null) Constructor.	WipeDown
		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
		captureStartValues():void Captures the current values of the relevant properties on the effect's targets.	Effect
		createInstance(target:Object = null):IEffectInstance Creates a single effect instance and initializes it.	Effect
		createInstances(targets:Array = null):Array Takes an Array of target objects and invokes the `createInstance()` method on each target.	Effect
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		end(effectInstance:IEffectInstance = null):void Interrupts an effect that is currently playing, and jumps immediately to the end of the effect.	Effect
		getAffectedProperties():Array Returns the component properties modified by this effect.	MaskEffect
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		pause():void Pauses the effect until you call the `resume()` method.	Effect
		play(targets:Array = null, playReversedFromEnd:Boolean = false):Array Begins playing the effect.	Effect
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		resume():void Resumes the effect after it has been paused by a call to the `pause()` method.	Effect
		reverse():void Plays the effect in reverse, if the effect is currently playing, starting from the current position of the effect.	Effect
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined by
		applyValueToTarget(target:Object, property:String, value:*, props:Object):void Used internally by the Effect infrastructure.	Effect
		effectEndHandler(event:EffectEvent):void Called when an effect instance has finished playing.	Effect
		effectStartHandler(event:EffectEvent):void This method is called when the effect instance starts playing.	Effect
		filterInstance(propChanges:Array, targ:Object):Boolean Determines the logic for filtering out an effect instance.	Effect
		getValueFromTarget(target:Object, property:String):* Called by the `captureStartValues()` method to get the value of a property from the target.	Effect
		initInstance(instance:IEffectInstance):void Copies properties of the effect to the effect instance.	Effect
		tweenEventHandler(event:TweenEvent):void Called when the TweenEffect dispatches a TweenEvent.	MaskEffect

Events

Hide Inherited Events

Show Inherited Events

	Summary	Defined by
activate	Dispatched when Flash Player gains operating system focus and becomes active.	EventDispatcher
deactivate	Dispatched when Flash Player loses operating system focus and is becoming inactive.	EventDispatcher
effectEnd	Dispatched when the effect finishes playing, either when the effect finishes playing or when the effect has been interrupted by a call to the `end()` method.	Effect
effectStart	Dispatched when the effect starts playing.	Effect
tweenEnd	Dispatched when the effect ends.	MaskEffect
tweenStart	Dispatched when the effect starts, which corresponds to the first call to the `onMoveTweenUpdate()` and `onScaleTweenUpdate()` methods.	MaskEffect
tweenUpdate	Dispatched every time the effect updates the target.	MaskEffect

Constructor detail

WipeDown

()

constructor

public function WipeDown(target:Object = null)

Constructor.

Parameters

target:Object (default = null) — The Object to animate with this effect.

Examples

WipeDownExample

<?xml version="1.0"?>
<!-- Simple example to demonstrate the WipeDown effect. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">

    <mx:WipeDown id="wipeOut" duration="1000"/>
    <mx:WipeDown id="wipeIn" duration="1000"/>

    <mx:Panel title="WipeDown Effect Example" width="95%" height="95%" 
        paddingTop="5" paddingLeft="10" paddingRight="10" paddingBottom="5">

        <mx:Text width="100%" color="blue" 
            text="Use the WipeDown effect to show or hide the text and image."/>

        <mx:Label text="Nokia 9930"  
            fontSize="14"
            visible="{cb1.selected}"
            hideEffect="{wipeOut}" showEffect="{wipeIn}"/>
            
        <mx:Image source="@Embed(source='assets/Nokia_6630.png')" 
            visible="{cb1.selected}"
            hideEffect="{wipeOut}" showEffect="{wipeIn}"/>
            
        <mx:CheckBox id="cb1" label="visible" selected="true"/>

    </mx:Panel>
</mx:Application>

Adobe^® Flex™ 2 Language Reference	All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Frames No Frames
Class WipeDown	Properties \| Methods \| Events \| Examples