mx.effects.SetStyleAction (Flex™ 2 リファレンスガイド)

パッケージ	mx.effects
	public class SetStyleAction
継承	SetStyleAction Effect EventDispatcher Object

SetStyleAction クラスでは、ビューステートを定義する SetStyle プロパティに対応したアクションエフェクトを定義します。SetStyleAction エフェクトをトランジションの定義範囲で使用することにより、SetStyle プロパティで定義されたビューステートの変化がトランジションで発生する時期を制御できます。

MXML シンタックス expanded

MXML シンタックスの非表示

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

 <mx:SetStyleAction プロパティ id="ID" style="" value="" />

例の表示

パブリックプロパティ

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

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

	プロパティ		定義
		className : String `"Fade"` など、エフェクトクラスの名前です。	Effect
		constructor : Object 特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。	Object
		customFilter : EffectTargetFilter エフェクトを再生するターゲットを特定するために、エフェクトによって使用されるタイプ EffectTargetFilter のカスタムフィルタオブジェクトを指定します。	Effect
		filter : String エフェクトのターゲットをフィルタリングするアルゴリズムを指定します。	Effect
		instanceClass : Class このエフェクトクラスのエフェクトインスタンスクラスを指定する Class 型のオブジェクトを表します。	Effect
		isPlaying : Boolean エフェクトのインスタンスのいずれかが現在再生中の場合に true、そうでない場合に false となる読み取り専用フラグです。	Effect
		name : String 変更されるスタイルプロパティの名前を表します。	SetStyleAction
		prototype : Object [static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。	Object
		relevantProperties : Array フィルタリング実行時に使用するプロパティ名の配列を表します。	Effect
		relevantStyles : Array このエフェクトによって変更されたスタイルプロパティを含みます。	SetStyleAction
		repeatCount : int = 1 エフェクトを繰り返す回数を表します。	Effect
		repeatDelay : int = 0 エフェクトを繰り返す前の待機時間を表します (ミリ秒単位)。	Effect
		startDelay : int = 0 エフェクトを開始する前の待機時間を表します (ミリ秒単位)。	Effect
		suspendBackgroundProcessing : Boolean = false `true` の場合、エフェクトの再生中にすべてのバックグラウンド処理をブロックします。	Effect
		target : Object このエフェクトが適用される UIComponent オブジェクトを表します。	Effect
		targets : Array エフェクトのターゲットである UIComponent オブジェクトの配列を表します。	Effect
		value : * スタイルプロパティの新しい値を表します。	SetStyleAction

パブリックメソッド

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

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

	メソッド		定義
		SetStyleAction(target:Object = null) コンストラクタ。	SetStyleAction
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	EventDispatcher
		captureStartValues():void エフェクトのターゲットにおいて関連するプロパティの現在値をキャプチャします。	Effect
		createInstance(target:Object = null):EffectInstance 1 つのエフェクトインスタンスを作成し、それを初期化します。	Effect
		createInstances(targets:Array = null):Array ターゲットオブジェクトの配列を取得し、各ターゲットで `createInstance()` メソッドを呼び出します。	Effect
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		end(effectInstance:EffectInstance = null):void 現在再生中のエフェクトをすべて中断し、直ちにエフェクトの終わりにジャンプします。	Effect
		getAffectedProperties():Array ストリングの配列を返します。各ストリングは、このエフェクトによって変更されるプロパティの名前です。	Effect
		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
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブ値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

Protectedメソッド

継承される Protected メソッドの表示

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

	イベント	一覧	定義
		effectEnd	エフェクトの再生停止時 (エフェクトの再生完了時、またはエフェクトが `end()` メソッドの呼び出しにより中断されたとき) に送出されます。	Effect
		effectStart	エフェクトの再生開始時に送出されます。	Effect

プロパティの詳細

name

プロパティ

public var name:String

変更されるスタイルプロパティの名前を表します。デフォルトでは、ビューステートを定義したもののうち SetStyle プロパティの定義からこの値が決定されます。

relevantStyles

プロパティ

relevantStyles:Array [read-write]

このエフェクトによって変更されたスタイルプロパティを含みます。この getter メソッドによって、スーパークラスメソッドがオーバーライドされます。

このクラスのサブクラスを作成してカスタムエフェクトを作成する場合は、このメソッドをオーバーライドして、サブクラスによって変更されたスタイルプロパティリストを含む配列を返す必要があります。

実装
public function get relevantStyles():Array
public function set relevantStyles(value:Array):void

value

プロパティ

public var value:*

スタイルプロパティの新しい値を表します。デフォルトでは、ビューステートを定義したもののうち SetStyle プロパティの定義からこの値が決定されます。

コンストラクタの詳細

SetStyleAction

()

コンストラクタ

public 関数 SetStyleAction(target:Object = null)

コンストラクタ。

パラメータ

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

例

TransitionExample

<?xml version="1.0" ?>
<!-- Simple example to demonstrate the Transition class. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">

    <!-- Define one view state, in addition to the base state.-->
    <mx:states>
        <mx:State name="Register">
            <mx:AddChild relativeTo="{loginForm}" position="lastChild">
                <mx:target>
                    <mx:FormItem id="confirm" label="Confirm:">
                        <mx:TextInput/>
                    </mx:FormItem>
                </mx:target>
            </mx:AddChild>
            <mx:SetProperty target="{loginPanel}" name="title" value="Register"/>
            <mx:SetProperty target="{loginButton}" name="label" value="Register"/>
            <mx:SetStyle target="{loginButton}" 
                name="color" value="blue"/>
            <mx:RemoveChild target="{registerLink}"/>
            <mx:AddChild relativeTo="{spacer1}" position="before">
                <mx:target>
                    <mx:LinkButton id="loginLink" label="Return to Login" click="currentState=''"/>
                </mx:target>
            </mx:AddChild>
        </mx:State>
    </mx:states>

    <mx:transitions>
        <!-- Define the transition from the base state to the Register state.-->
        <mx:Transition id="toRegister" fromState="*" toState="Register">
            <mx:Sequence targets="{[loginPanel, registerLink, confirm, loginLink, spacer1]}">
                <mx:RemoveChildAction/>
                <mx:SetPropertyAction target="{loginPanel}" name="title"/>
                <mx:SetPropertyAction target="{loginButton}" name="label"/>
                <mx:SetStyleAction target="{loginButton}" name="color"/>
                <mx:Resize target="{loginPanel}"/>
                <mx:AddChildAction/>
            </mx:Sequence>
        </mx:Transition>

        <!-- Define the transition from the Register state to the base state.-->
        <mx:Transition id="toDefault" fromState="Register" toState="*">
            <mx:Sequence targets="{[loginPanel, registerLink, 
                    confirm, loginLink, spacer1]}">
                <mx:RemoveChildAction/>
                <mx:SetPropertyAction target="{loginPanel}" name="title"/>
                <mx:SetPropertyAction  target="{loginButton}" name="label"/>
                <mx:SetStyleAction target="{loginButton}" name="color"/>
                <mx:Resize target="{loginPanel}"/>
                <mx:AddChildAction/>
            </mx:Sequence>
        </mx:Transition>
    </mx:transitions>

    <!-- Define a Panel container that defines the login form.-->
    <mx:Panel title="Login" id="loginPanel" 
        horizontalScrollPolicy="off" verticalScrollPolicy="off"
        paddingTop="10" paddingLeft="10" paddingRight="10" paddingBottom="10">
    
        <mx:Text width="100%" color="blue"
            text="Click the 'Need to Register?' link to change state. Click the 'Return to Login' link to return to the base state."/>

        <mx:Form id="loginForm" >
            <mx:FormItem label="Username:">
                <mx:TextInput/>
            </mx:FormItem>
            <mx:FormItem label="Password:">
                <mx:TextInput/>
            </mx:FormItem>
        </mx:Form>
        <mx:ControlBar>
            <mx:LinkButton id="registerLink"  label="Need to Register?"
                click="currentState='Register'"/>
            <mx:Spacer width="100%" id="spacer1"/>
            <mx:Button label="Login" id="loginButton"/>
        </mx:ControlBar>
    </mx:Panel>
</mx:Application>

Adobe^® Flex™ 2 リファレンスガイド		すべてのパッケージ \| すべてのクラス \| 言語エレメント \| 索引 \| 付録 \| 規則 \| フレーム内に表示フレームなしバージョン
Class SetStyleAction	プロパティ \| メソッド \| イベント \| 例