Package | mx.effects |
Class | public class WipeRight |
Inheritance | WipeRight MaskEffect Effect EventDispatcher Object |
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Starting with Flex 4.0, Adobe 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 |
The WipeRight class defines a wipe right 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.
The <mx:WipeRight>
tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<mx:WipeRight id="ID" />
Learn more
Related API Elements
Method | Defined By | ||
---|---|---|---|
Constructor. | WipeRight | ||
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 | ||
Captures the current values of the relevant properties
on the effect's targets and saves them as end values. | Effect | ||
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 | ||
Captures the current values of the relevant properties
on the effect's targets. | Effect | ||
Creates a single effect instance and initializes it. | Effect | ||
Takes an Array of target objects and invokes the
createInstance() method on each target. | Effect | ||
Removes event listeners from an instance
and removes it from the list of instances. | Effect | ||
Dispatches an event into the event flow. | EventDispatcher | ||
Interrupts an effect that is currently playing,
and jumps immediately to the end of the effect. | Effect | ||
[override]
Returns the component properties modified by this effect. | MaskEffect | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | ||
Indicates whether an object has a specified property defined. | Object | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Pauses the effect until you call the resume() method. | Effect | ||
Begins playing the effect. | Effect | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Removes a listener from the EventDispatcher object. | EventDispatcher | ||
Resumes the effect after it has been paused
by a call to the pause() method. | Effect | ||
Plays the effect in reverse, if the effect is currently playing,
starting from the current position of the effect. | Effect | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Stops the effect, leaving the effect targets in their current state. | Effect | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
Returns the string representation of the specified object. | Object | ||
Returns the primitive value of the specified object. | Object | ||
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher |
WipeRight | () | Constructor |
<?xml version="1.0"?> <!-- Simple example to demonstrate the WipeRight 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:WipeRight id="wipeOut" duration="1000"/> <mx:WipeRight id="wipeIn" duration="1000"/> </fx:Declarations> <s:Panel title="WipeRight 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 WipeRight 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}"/> <s:CheckBox id="cb1" label="visible" selected="true"/> </s:VGroup> </s:Panel> </s:Application>
Thu Dec 6 2018, 01:12 PM -08:00