| Package | mx.effects |
| Class | public class WipeDown |
| Inheritance | WipeDown MaskEffect Effect flash.events.EventDispatcher |
| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
![]() | Starting with Flex 4.0, Apache recommends that you use the spark.effects.Wipe class as an alternative to this class.
The direction-specific Wipe effects in Flex 3 have been replaced by a more generic
Wipe effect that takes a generic direction. To get similar behavior from the new
Wipe effect, set the |
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.
Hide MXML SyntaxThe <mx:WipeDown> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<mx:WipeDown
id="ID"
/>
See also
| Method | Defined By | ||
|---|---|---|---|
WipeDown(target:Object = null)
Constructor. | WipeDown | ||
![]() | captureEndValues():void
Captures the current values of the relevant properties
on the effect's targets and saves them as end values. | Effect | |
![]() | captureMoreStartValues(targets:Array):void
Captures the current values of the relevant properties
of an additional set of targets
Flex uses this function when a data change
effect is run.
| Effect | |
![]() | 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 | |
![]() | deleteInstance(instance:IEffectInstance):void
Removes event listeners from an instance
and removes it from the list of instances. | Effect | |
![]() | end(effectInstance:IEffectInstance = null):void
Interrupts an effect that is currently playing,
and jumps immediately to the end of the effect. | Effect | |
![]() | getAffectedProperties():Array [override]
Returns the component properties modified by this effect. | MaskEffect | |
![]() | 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 | |
![]() | 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 | |
![]() | stop():void
Stops the effect, leaving the effect targets in their current state. | Effect | |
| WipeDown | () | Constructor |
public function WipeDown(target:Object = null)| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Constructor.
Parameterstarget:Object (default = null) — The Object to animate with this effect.
|
<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!-- Simple example to demonstrate the WipeDown effect. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:s="library://ns.adobe.com/flex/spark"
xmlns:mx="library://ns.adobe.com/flex/mx">
<fx:Declarations>
<mx:WipeDown id="wipeOut" duration="1000"/>
<mx:WipeDown id="wipeIn" duration="1000"/>
</fx:Declarations>
<s:Panel title="WipeDown Effect Example" width="95%" height="95%" >
<s:VGroup left="20" right="20" top="20" bottom="20">
<s:Label width="100%" color="blue"
text="Use the WipeDown effect to show or hide the text and image."/>
<mx:Label text="Product1"
fontSize="14"
visible="{cb1.selected}"
hideEffect="{wipeOut}" showEffect="{wipeIn}"/>
<mx:Image source="@Embed(source='assets/Product1.png')"
visible="{cb1.selected}"
hideEffect="{wipeOut}" showEffect="{wipeIn}"/>
<s:CheckBox id="cb1" label="visible" selected="true"/>
</s:VGroup>
</s:Panel>
</s:Application>