Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
WipeRight

Package | mx.effects
Class | public class WipeRight
Inheritance | WipeRight 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 `direction` parameter appropriately.

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.

MXML Syntax Show MXML Syntax
Hide MXML Syntax

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

      <mx:WipeRight
        id="ID"
      />

View the examples

See also

mx.effects.effectClasses.WipeRightInstance

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | className : String [read-only] The name of the effect class, such as "Fade". | Effect
|  | 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
|  | effectTargetHost : IEffectTargetHost A property that lets you access the target list-based control of a data effect. | Effect
|  | filter : String Specifies an algorithm for filtering targets for an effect. | Effect
|  | hideFocusRing : Boolean Determines whether the effect should hide the focus ring when starting the effect. | Effect
|  | instanceClass : Class An object of type Class that specifies the effect instance class class for this effect class. | Effect
|  | isPlaying : Boolean [read-only] 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
|  | perElementOffset : Number Additional delay, in milliseconds, for effect targets after the first target of the effect. | Effect
|  | playheadTime : Number Current time position of the effect. | Effect
|  | 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 object to which this effect is applied. | Effect
|  | targets : Array An Array of objects that are targets for the effect. | Effect
|  | triggerEvent : Event The Event object passed to this Effect by the EffectManager when an effect is triggered, or null if the effect is not being played by the EffectManager. | 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

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | applyTransitionEndProperties : Boolean This flag controls whether the effect, when run in a transition, automatically applies the property values according to the end state, as opposed to leaving values as set by the effect itself. | Effect
|  | endValuesCaptured : Boolean = false A flag containing true if the end values of an effect have already been determined, or false if they should be acquired from the current properties of the effect targets when the effect runs. | Effect

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | WipeRight(target:Object = null) Constructor. | WipeRight
|  | 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

Protected Methods
Show 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
|  | effectStopHandler(event:EffectEvent):void Called when an effect instance has stopped by a call to the stop() method. | Effect
|  | filterInstance(propChanges:Array, target: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

| Event | Summary | Defined By
--- | --- | --- | ---
|  | effectEnd | Dispatched when one of the effect's instances finishes playing, either when the instance finishes playing or when the effect is interrupted by a call to the end() method. | Effect
|  | effectStart | Dispatched when the effect starts playing. | Effect
|  | effectStop | Dispatched when the effect has been stopped, which only occurs when the effect is interrupted by a call to the stop() method. | 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

WipeRight | () | Constructor

`public function WipeRight(target:Object = null)`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Parameters

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

Examples
WipeRightExample.mxml

    <?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 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="Product1.png"
                    fontSize="14"
                    visible="{cb1.selected}"
                    hideEffect="{wipeOut}" showEffect="{wipeIn}"/>

                <mx:Image source="@Embed(source='assets/Product1.png.png')"
                    visible="{cb1.selected}"
                    hideEffect="{wipeOut}" showEffect="{wipeIn}"/>

                <s:CheckBox id="cb1" label="visible" selected="true"/>
            </s:VGroup>

        </s:Panel>
    </s:Application>

Sun Mar 5 2017, 03:42 PM +11:00