mx.effects.WipeRight （Flex 3.2）

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

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

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

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

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

MXML のシンタックス expanded

MXML シンタックスを隠す

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

  <mx:WipeRight
    id="ID"
  />

例を表示

パブリックプロパティ

継承されるパブリックプロパティを隠す

継承されるパブリックプロパティを表示

	プロパティ		定義元
		className : String [読み取り専用] このエフェクトクラスの名前です。たとえば、"Fade" などがあります。	Effect
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。	Object
		createMaskFunction : Function エフェクトによってマスクが作成される際に呼び出される関数を表します。	MaskEffect
		customFilter : EffectTargetFilter エフェクトを再生するターゲットを特定するために、エフェクトによって使用されるタイプ EffectTargetFilter のカスタムフィルタオブジェクトを指定します。	Effect
		duration : Number エフェクトの継続時間を表します（ミリ秒単位）。	Effect
		effectTargetHost : IEffectTargetHost データエフェクトのターゲットリストコントロールにアクセスできるプロパティです。	Effect
		filter : String エフェクトのターゲットをフィルタリングするアルゴリズムを指定します。	Effect
		hideFocusRing : Boolean エフェクトの開始時にエフェクトがフォーカスリングを非表示にするかどうかを指定します。	Effect
		instanceClass : Class このエフェクトクラスのエフェクトインスタンスクラスを指定する Class 型のオブジェクトを表します。	Effect
		isPlaying : Boolean [読み取り専用] エフェクトのインスタンスのいずれかが現在再生中の場合に true、そうでない場合に false となる読み取り専用フラグです。	Effect
		moveEasingFunction : Function マスクを移動させるのに使用するイージング関数を表します。	MaskEffect
		perElementOffset : Number エフェクトの最初のターゲットの後に発生する、エフェクトターゲットの追加遅延（ミリ秒）です。	Effect
		prototype : Object [静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。	Object
		relevantProperties : Array フィルタリング実行時に使用するプロパティ名の配列を表します。	Effect
		relevantStyles : Array フィルタリング実行時に使用するスタイル名の配列を表します。	Effect
		repeatCount : int = 1 エフェクトを繰り返す回数を表します。	Effect
		repeatDelay : int = 0 エフェクトを繰り返す前の待機時間を表します（ミリ秒単位）。	Effect
		scaleEasingFunction : Function マスクの伸縮に使用するイージング関数を表します。	MaskEffect
		scaleXFrom : Number マスクの初期 scaleX を表します。	MaskEffect
		scaleXTo : Number マスクの終了 scaleX を表します。	MaskEffect
		scaleYFrom : Number マスクの初期 scaleY を表します。	MaskEffect
		scaleYTo : Number マスクの終了 scaleY を表します。	MaskEffect
		showTarget : Boolean ターゲットコンポーネントを可視にする場合は true に設定し、不可視にする場合は false に設定します。	MaskEffect
		startDelay : int = 0 エフェクトを開始する前の待機時間を表します（ミリ秒単位）。	Effect
		suspendBackgroundProcessing : Boolean = false true の場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。	Effect
		target : Object このエフェクトが適用される UIComponent オブジェクトを表します。	Effect
		targets : Array エフェクトのターゲットである UIComponent オブジェクトの配列を表します。	Effect
		triggerEvent : Event エフェクトがトリガされたときに EffectManager によってこの Effect に渡される Event オブジェクトです。EffectManager によってエフェクトが再生されていない場合は null です。	Effect
		xFrom : Number マスクの初期位置の x 座標を表します。	MaskEffect
		xTo : Number マスクの移動先の位置の x 座標を表します。	MaskEffect
		yFrom : Number マスクの初期位置の y 座標を表します。	MaskEffect
		yTo : Number マスクの移動先の位置の y 座標を表します。	MaskEffect

プロテクトプロパティ

継承されるプロテクトプロパティを隠す

継承されるプロテクトプロパティを表示

	プロパティ		定義元
		endValuesCaptured : Boolean = false エフェクトの終了値が既に決定されている場合は true を含むフラグ、エフェクトの実行時にエフェクトターゲットの現在のプロパティから終了値を取得する必要がある場合は false を含むフラグです。	Effect

パブリックメソッド

継承されるパブリックメソッドを隠す

継承されるパブリックメソッドを表示

	メソッド		定義元
		WipeRight(target:Object = null) コンストラクタです。	WipeRight
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	EventDispatcher
		captureEndValues():void エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャし、終了値として保存します。	Effect
		captureMoreStartValues(targets:Array):void ターゲットの追加セットの関連するプロパティの現在値をキャプチャします。この機能は、データ変更エフェクトを実行したときに Flex によって使用されます。	Effect
		captureStartValues():void エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャします。	Effect
		createInstance(target:Object = null):IEffectInstance 1 つのエフェクトインスタンスを作成し、それを初期化します。	Effect
		createInstances(targets:Array = null):Array ターゲットオブジェクトの配列を取得し、各ターゲットで createInstance() メソッドを呼び出します。	Effect
		deleteInstance(instance:IEffectInstance):void インスタンスからイベントリスナーを削除し、インスタンスのリストからインスタンスを削除します。	Effect
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		end(effectInstance:IEffectInstance = null):void 現在再生中のエフェクトをすべて中断し、直ちにエフェクトの終わりにジャンプします。	Effect
		getAffectedProperties():Array [override] このエフェクトによって変更されたコンポーネントプロパティを返します。	MaskEffect
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		pause():void resume() メソッドを呼び出すまで、エフェクトを一時停止します。	Effect
		play(targets:Array = null, playReversedFromEnd:Boolean = false):Array エフェクトの再生を開始します。	Effect
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	EventDispatcher
		resume():void pause() メソッドを呼び出し、エフェクトを一時停止した後、再開させます。	Effect
		reverse():void エフェクトが現在再生中の場合に、エフェクトの現在位置から開始して、逆順でエフェクトを再生します。	Effect
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		stop():void エフェクトターゲットを現在の状態にしたまま、エフェクトを停止します。	Effect
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

プロテクトメソッド

継承されるプロテクトメソッドを表示

	メソッド		定義元
		applyValueToTarget(target:Object, property:String, value:*, props:Object):void エフェクトインフラストラクチャによって内部的に使用されます。	Effect
		effectEndHandler(event:EffectEvent):void エフェクトインスタンスの再生終了時に呼び出されます。	Effect
		effectStartHandler(event:EffectEvent):void このメソッドは、エフェクトインスタンスの再生開始時に呼び出されます。	Effect
		filterInstance(propChanges:Array, target:Object):Boolean エフェクトインスタンスをフィルタリングするために必要なロジックを決定します。	Effect
		getValueFromTarget(target:Object, property:String):* ターゲットからプロパティの値を取得するために captureStartValues() メソッドによって呼び出されます。	Effect
		initInstance(instance:IEffectInstance):void エフェクトインスタンスにエフェクトのプロパティをコピーします。	Effect
		tweenEventHandler(event:TweenEvent):void TweenEffect から TweenEvent が送出されたときに呼び出されます。	MaskEffect

イベント

継承されるイベントを隠す

継承されるイベントを表示

	概要	定義元
activate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
deactivate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher
effectEnd	エフェクトの再生停止時（エフェクトの再生完了時、またはエフェクトが end() メソッドの呼び出しにより中断されたとき）に送出されます。	Effect
effectStart	エフェクトの再生開始時に送出されます。	Effect
tweenEnd	エフェクトの終了時に送出されます。	MaskEffect
tweenStart	エフェクトの開始時に送出されます。これは onMoveTweenUpdate() および onScaleTweenUpdate() メソッドの最初の呼び出しに対応します。	MaskEffect
tweenUpdate	エフェクトでターゲットが更新されるたびに送出されます。	MaskEffect

コンストラクタの詳細

WipeRight

()

コンストラクタ

public function WipeRight(target:Object = null)

コンストラクタです。

パラメータ

target:Object (default = null) — このエフェクトでアニメーション化するオブジェクトを表します。

例例の使用法

WipeRightExample.mxml

<?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>

現在のページ: http://livedocs.adobe.com/flex/3_jp/langref/mx/effects/WipeRight.html

Adobe® Flex™ 3.2 リファレンスガイド This Help system only	すべてのパッケージ \| すべてのクラス \| 言語エレメント \| 索引 \| 付録 \| 規則 \| フレームフレームなし
WipeRight	プロパティ \| メソッド \| イベント \| 例