State

パッケージ	mx.states
クラス	public class State
継承	State EventDispatcher Object

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

State クラスにより、コンポーネントの特定のビューである、ビューステートが定義されます。例えば、製品サムネールには、最小限の情報だけを表示する基本ビューステートと、追加情報を含む詳細ビューステートの 2 つのビューステートを定義できます。 overrides プロパティは、基本ビューステートに対して追加または削除する子クラスのセット、ビューステートが有効な場合に設定するプロパティ、スタイルおよびイベントハンドラーを指定します。

State クラスは、Flex コンポーネントの states プロパティで使用します。 states プロパティは、アプリケーションまたはカスタムコントロールのルートにのみ指定できます。子コントロールには指定できません。

ビューステートを有効にするには、コンポーネントの currentState プロパティを設定します。

MXML シンタックス expanded

MXML シンタックスを隠す

The <mx:State> tag has the following attributes:

  <mx:State
  Properties
  basedOn="null"
  name="null"
  overrides="null"
  />

デフォルトの MXML プロパティoverrides

パブリックプロパティ

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

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

	プロパティ		定義元
		basedOn : String このビューステートが基礎とするビューステートの名前。このビューステートが指定されたビューステートに基づいていない場合は、null になります。	State
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		name : String ビューステートの名前です。	State
		overrides : Array IOverride インターフェイスを実装するオブジェクトの配列としての、ビューステートのオーバーライドです。	State
		stateGroups : Array このビューステートが属しているステートグループを示すストリングの配列です。	State

パブリックメソッド

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

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

	メソッド		定義元
		State(properties:Object = null) コンストラクターです。	State
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	EventDispatcher
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		toLocaleString():String ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

イベント

イベントの詳細についてはここをクリックしてください

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

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

	概要	定義元
activate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
deactivate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher
enterState	ビューステートに移行した後に送出されます。	State
exitState	ビューステートが終了する直前に送出されます。	State

プロパティの詳細

basedOn

プロパティ

public var basedOn:String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

このビューステートが基礎とするビューステートの名前。このビューステートが指定されたビューステートに基づいていない場合は、null になります。この値が null の場合、ビューステートは、State クラスを使用しないでコンポーネントに定義するプロパティ、スタイル、イベントハンドラーおよび子で構成されるルートステートに基づきます。

デフォルト値： null。

name

プロパティ

public var name:String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ビューステートの名前です。 State 名は特定のコンポーネントに対して一意である必要があります。このプロパティは設定する必要があります。

overrides

プロパティ

public var overrides:Array

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

IOverride インターフェイスを実装するオブジェクトの配列としての、ビューステートのオーバーライドです。これらのオーバーライドは、このビューステートに移行すると順番に適用され、ビューステートが終了すると逆の順序で削除されます。

次の Flex クラスで IOverride インターフェイスを実装して、ビューステート特性を定義します。

AddChild
RemoveChild
SetEventHandler
SetProperty
SetStyle

overrides プロパティは、State クラスのデフォルトプロパティです。 MXML タグのシンタックスを使用してオーバーライドを定義する場合は、<mx:overrides> タグとその子 <mx:Array> タグを省略できます。

stateGroups

プロパティ

public var stateGroups:Array

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

このビューステートが属しているステートグループを示すストリングの配列です。

コンストラクターの詳細

()

コンストラクター

public function State(properties:Object = null)

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

コンストラクターです。

パラメーター

properties:Object (default = null) — この State のプロパティ設定を含むオブジェクトです。

イベントの詳細

enterState

イベント

イベントオブジェクトの型: mx.events.FlexEvent
プロパティ FlexEvent.type = mx.events.FlexEvent.ENTER_STATE

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ビューステートに移行した後に送出されます。

FlexEvent.ENTER_STATE 定数により、イベントオブジェクトの type プロパティ値が enterState イベント用に定義されます。

このイベントが送出されるのは、1 つ以上の関連するリスナーが、送出するオブジェクトに関連付けられている場合に限られます。

イベントオブジェクトの各プロパティには次の値が設定されています。

プロパティ	値
`bubbles`	false
`cancelable`	false
`currentTarget`	イベント処理を行うイベントリスナーの定義用オブジェクトを表します。例えば、イベントリスナーの登録に `myButton.addEventListener()` を使用すると、myButton の値は `currentTarget` となります。
`target`	イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、`currentTarget` プロパティを使用してください。

exitState

イベント

イベントオブジェクトの型: mx.events.FlexEvent
プロパティ FlexEvent.type = mx.events.FlexEvent.EXIT_STATE

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ビューステートが終了する直前に送出されます。このイベントは、デフォルトのビューステートへの変更が削除される前に送出されます。

FlexEvent.EXIT_STATE 定数により、イベントオブジェクトの type プロパティ値が exitState イベント用に定義されます。

このイベントが送出されるのは、1 つ以上の関連するリスナーが、送出するオブジェクトに関連付けられている場合に限られます。

イベントオブジェクトの各プロパティには次の値が設定されています。

プロパティ	値
`bubbles`	false
`cancelable`	false
`currentTarget`	イベント処理を行うイベントリスナーの定義用オブジェクトを表します。例えば、イベントリスナーの登録に `myButton.addEventListener()` を使用すると、myButton の値は `currentTarget` となります。
`target`	イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、`currentTarget` プロパティを使用してください。

法律上の注意 | プライバシーポリシー

State - AS3 Flex

クラス x

basedOn

name

overrides

stateGroups

State

enterState

exitState