パッケージmx.effects
public class WipeRight
継承WipeRight Inheritance MaskEffect Inheritance Effect Inheritance EventDispatcher Inheritance Object

WipeRight クラスは、バーの右方向へのワイプエフェクトを定義します。エフェクト適用前または適用後のコンポーネントの状態は不可視にする必要があります。

このエフェクトは、通常、showEffect トリガおよび hideEffect トリガとあわせて使用します。コンポーネントの visible プロパティが false から true に変化してコンポーネントが可視状態になるときに、showEffect トリガが発生します。コンポーネントの visible プロパティが true から false に変化してコンポーネントが不可視状態になるときに、hideEffect トリガが発生します。

このエフェクトには MaskEffect.show プロパティの設定が継承されます。値が true に設定されている場合、コンポーネントは可視になります。値が false に設定されている場合、コンポーネントは不可視になります。デフォルト値は true です。

このエフェクトを showEffect または hideEffect トリガで使用するよう指定した場合、show プロパティが Flex により有効になります。コンポーネントが不可視の場合は true に、可視の場合は false に設定されます。

MXML シンタックスexpandedMXML シンタックスの非表示

<mx:WipeRight> タグはスーパークラスのすべてのタグ属性を継承し、次のタグを追加します。

 <mx:WipeRight id="ID" /> 

例の表示

関連項目

mx.effects.effectClasses.WipeRightInstance


パブリックプロパティ
 プロパティ定義
 InheritedclassName : String
"Fade" など、エフェクトクラスの名前です。
Effect
 Inheritedconstructor : Object
特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
 InheritedcreateMaskFunction : Function
エフェクトによってマスクが作成される際に呼び出される関数を表します。
MaskEffect
 InheritedcustomFilter : EffectTargetFilter
エフェクトを再生するターゲットを特定するために、エフェクトによって使用されるタイプ EffectTargetFilter のカスタムフィルタオブジェクトを指定します。
Effect
 Inheritedduration : Number
エフェクトの継続時間を表します (ミリ秒単位)。
Effect
 Inheritedfilter : String
エフェクトのターゲットをフィルタリングするアルゴリズムを指定します。
Effect
 InheritedinstanceClass : Class
このエフェクトクラスのエフェクトインスタンスクラスを指定する Class 型のオブジェクトを表します。
Effect
 InheritedisPlaying : Boolean
エフェクトのインスタンスのいずれかが現在再生中の場合に true、そうでない場合に false となる読み取り専用フラグです。
Effect
 InheritedmoveEasingFunction : Function
マスクを移動させるのに使用するイージング関数を表します。
MaskEffect
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
 InheritedrelevantProperties : Array
フィルタリング実行時に使用するプロパティ名の配列を表します。
Effect
 InheritedrelevantStyles : Array
フィルタリング実行時に使用するスタイル名の配列を表します。
Effect
 InheritedrepeatCount : int = 1
エフェクトを繰り返す回数を表します。
Effect
 InheritedrepeatDelay : int = 0
エフェクトを繰り返す前の待機時間を表します (ミリ秒単位)。
Effect
 InheritedscaleEasingFunction : Function
マスクを伸縮させるのに使用するイージング関数を表します。
MaskEffect
 InheritedscaleXFrom : Number
マスクの初期 scaleX を表します。
MaskEffect
 InheritedscaleXTo : Number
マスクの終了 scaleX を表します。
MaskEffect
 InheritedscaleYFrom : Number
マスクの初期 scaleY を表します。
MaskEffect
 InheritedscaleYTo : Number
マスクの終了 scaleY を表します。
MaskEffect
 InheritedshowTarget : Boolean
ターゲットコンポーネントを見えるようにする場合は true に設定し、見えなくなるようにする場合は false に設定します。
MaskEffect
 InheritedstartDelay : int = 0
エフェクトを開始する前の待機時間を表します (ミリ秒単位)。
Effect
 InheritedsuspendBackgroundProcessing : Boolean = false
true の場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。
Effect
 Inheritedtarget : Object
このエフェクトが適用される UIComponent オブジェクトを表します。
Effect
 Inheritedtargets : Array
エフェクトのターゲットである UIComponent オブジェクトの配列を表します。
Effect
 InheritedxFrom : Number
マスクの初期位置の x 座標を表します。
MaskEffect
 InheritedxTo : Number
マスクの移動先の位置の x 座標を表します。
MaskEffect
 InheritedyFrom : Number
マスクの初期位置の y 座標を表します。
MaskEffect
 InheritedyTo : Number
マスクの移動先の位置の y 座標を表します。
MaskEffect
パブリックメソッド
 メソッド定義
  WipeRight(target:Object = null)
コンストラクタ。
WipeRight
 InheritedaddEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
EventDispatcher
 InheritedcaptureStartValues():void
エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャします。
Effect
 InheritedcreateInstance(target:Object = null):EffectInstance
1 つのエフェクトインスタンスを作成し、それを初期化します。
Effect
 InheritedcreateInstances(targets:Array = null):Array
ターゲットオブジェクトの配列を取得し、各ターゲットで createInstance() メソッドを呼び出します。
Effect
 InheriteddispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。
EventDispatcher
 Inheritedend(effectInstance:EffectInstance = null):void
現在再生中のエフェクトをすべて中断し、直ちにエフェクトの終わりにジャンプします。
Effect
 InheritedgetAffectedProperties():Array
このエフェクトによって変更されたコンポーネントプロパティを返します。
MaskEffect
 InheritedhasEventListener(type:String):Boolean
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 InheritedhasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 InheritedisPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inheritedpause():void
resume() メソッドを呼び出すまで、エフェクトを一時停止します。
Effect
 Inheritedplay(targets:Array = null, playReversedFromEnd:Boolean = false):Array
エフェクトの再生を開始します。
Effect
 InheritedpropertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙可能かどうかを示します。
Object
 InheritedremoveEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
 Inheritedresume():void
pause() メソッドを呼び出し、エフェクトを一時停止した後、再開させます。
Effect
 Inheritedreverse():void
エフェクトが現在再生中の場合に、エフェクトの現在位置から開始して、逆順でエフェクトを再生します。
Effect
 InheritedsetPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 InheritedtoString():String
指定されたオブジェクトのストリング表現を返します。
Object
 InheritedvalueOf():Object
指定されたオブジェクトのプリミティブ値を返します。
Object
 InheritedwillTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
Protectedメソッド
 メソッド定義
 InheritedapplyValueToTarget(target:Object, property:String, value:*, props:Object):void
エフェクトインフラストラクチャによって内部的に使用されます。
Effect
 InheritedeffectEndHandler(event:EffectEvent):void
エフェクトインスタンスの再生終了時に呼び出されます。
Effect
 InheritedeffectStartHandler(event:EffectEvent):void
このメソッドは、エフェクトインスタンスの再生開始時に呼び出されます。
Effect
 InheritedfilterInstance(propChanges:Array, targ:Object):Boolean
エフェクトインスタンスのフィルタリングに必要なロジックを決定します。
Effect
 InheritedgetValueFromTarget(target:Object, property:String):*
ターゲットからプロパティの値を取得するために captureStartValues() によって呼び出されます。
Effect
 InheritedinitInstance(instance:EffectInstance):void
エフェクトインスタンスにエフェクトのプロパティをコピーします。
Effect
 InheritedtweenEventHandler(event:TweenEvent):void
TweenEffect から TweenEvent が送出されたときに呼び出されます。
MaskEffect
イベント
 イベント一覧定義
 InheritedeffectEnd エフェクトの再生停止時 (エフェクトの再生完了時、またはエフェクトが end() メソッドの呼び出しにより中断されたとき) に送出されます。Effect
 InheritedeffectStart エフェクトの再生開始時に送出されます。Effect
 InheritedtweenEnd エフェクトの終了時に送出されます。MaskEffect
 InheritedtweenStart エフェクトの開始時に送出されます。これは onMoveTweenUpdate() および onScaleTweenUpdate() メソッドの最初の呼び出しに対応します。MaskEffect
 InheritedtweenUpdate エフェクトでターゲットが更新されるたびに送出されます。MaskEffect
コンストラクタの詳細
WipeRight()コンストラクタ
public 関数 WipeRight(target:Object = null)

コンストラクタ。

パラメータ
target:Object (default = null) — このエフェクトでアニメーション化するオブジェクトを表します。
WipeRightExample
<?xml version="1.0"?>
<!-- Simple example to demonstrate the WipeRight effect. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">

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

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

        <mx:Text 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}"/>
            
        <mx:CheckBox id="cb1" label="visible" selected="true"/>

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