RadioButtonGroup

パッケージ	spark.components
クラス	public class RadioButtonGroup
継承	RadioButtonGroup EventDispatcher Object
実装	IMXMLObject

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

RadioButtonGroup コンポーネントは、1 つの相互排他的コンポーネントとして機能する RadioButton コンポーネントのグループを定義します。RadioButton コンポーネントは一度に 1 つしか選択できません。<s:RadioButtonGroup> タグを使用してグループの名前を定義する場合は、id プロパティを指定する必要があります。このグループに追加された <s:RadioButton> コンポーネントには、このグループ名が割り当てられます。

RadioButtonGroup コンポーネントは UIComponent ではなく EventDispatcher のサブクラスであり、IMXMLObject インターフェイスを実装します。他のすべての Flex のビジュアルコンポーネントは、IVisualElement インターフェイスを実装します。RadioButtonGroup コンポーネントの宣言は IVisualElement に割り当てられないので、<Declarations> タグ内に含める必要があります。

List や DataGrid などのリストベースのコンポーネントでこのコンポーネントを使用するには、アイテムレンダラーを作成します。アイテムレンダラーの作成について詳しくは、「Custom Spark item renderers」を参照してください。

MXML シンタックス expanded

MXML シンタックスを隠す

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

  <s:RadioButtonGroup
    Properties
    enabled="true"
    selectedValue="null"
    selection="null"
 
    Events
    change="No default"
    itemClick="No default"
    valueCommit="No default"
  />

例を表示

さらに例を参照

RadioButton control

関連する API エレメント

spark.components.RadioButton

パブリックプロパティ

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

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

	プロパティ		定義元
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		enabled : Boolean 選択が可能かどうかを判別します。	RadioButtonGroup
		numRadioButtons : int [読み取り専用] この RadioButtonGroup に属する RadioButton の数です。	RadioButtonGroup
		selectedValue : Object グループ内で選択されている RadioButton コンポーネントの value プロパティが設定されている場合は、value プロパティです。設定されていない場合は、選択した RadioButton の label プロパティです。	RadioButtonGroup
		selection : RadioButton グループ内で現在選択されている RadioButton コンポーネントへの参照を格納します。	RadioButtonGroup

パブリックメソッド

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

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

	メソッド		定義元
		RadioButtonGroup(document:IFlexDisplayObject = null) コンストラクターです。	RadioButtonGroup
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	EventDispatcher
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		getRadioButtonAt(index:int):RadioButton 指定されたインデックス位置にある RadioButton コンポーネントを返します。	RadioButtonGroup
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean オブジェクトに指定されたプロパティが定義されているかどうかを示します。	Object
		initialized(document:Object, id:String):void 遅延インスタンス化をサポートする IMXMLObject.initialized() メソッドの実装です。	RadioButtonGroup
		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
change	このグループ内で選択された RadioButton コンポーネントの値が変化したときに送出されます。	RadioButtonGroup
deactivate	[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher
itemClick	ユーザーがグループ内の RadioButton コンポーネントを選択したときに送出されます。	RadioButtonGroup
valueCommit	プログラムまたはユーザー操作のいずれかによって、値が変更されたときに送出されます。	RadioButtonGroup

プロパティの詳細

enabled

プロパティ

enabled:Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

選択が可能かどうかを判別します。返される値は RadioButtonGroup で明示的に設定された値のみを反映し、個々の RadioButton で明示的に設定された値を反映しないことに注意してください。

デフォルト値： true。

実装
public function get enabled():Boolean
public function set enabled(value:Boolean):void

numRadioButtons

プロパティ

numRadioButtons:int [読み取り専用]

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

この RadioButtonGroup に属する RadioButton の数です。

デフォルト値： "0"。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 numRadioButtonsChanged イベントが送出されます。

実装
public function get numRadioButtons():int

selectedValue

プロパティ

selectedValue:Object

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

グループ内で選択されている RadioButton コンポーネントの value プロパティが設定されている場合は、value プロパティです。設定されていない場合は、選択した RadioButton の label プロパティです。RadioButton が選択されていない場合、このプロパティは null です。

selectedValue を設定すると、value プロパティまたは label プロパティがこの値に一致する最初の RadioButton コンポーネントが選択されます。

デフォルト値： null。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 valueCommit イベントが送出されます。

実装
public function get selectedValue():Object
public function set selectedValue(value:Object):void

selection

プロパティ

selection:RadioButton

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

グループ内で現在選択されている RadioButton コンポーネントへの参照を格納します。このプロパティには ActionScript からのみアクセスできます。MXML で設定することはできません。このプロパティを null に設定すると、現在選択されている RadioButton コンポーネントの選択が解除されます。変更イベントは送出されません。

デフォルト値： null。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 valueCommit イベントが送出されます。

実装
public function get selection():RadioButton
public function set selection(value:RadioButton):void

コンストラクターの詳細

()

コンストラクター

public function RadioButtonGroup(document:IFlexDisplayObject = null)

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

コンストラクターです。

パラメーター

document:IFlexDisplayObject (default = null) — クラスが単純に EventDispatcher を継承する場合は、document パラメーターを使用しないでください。

関連する API エレメント

flash.events.EventDispatcher

メソッドの詳細

getRadioButtonAt

()

メソッド

public function getRadioButtonAt(index:int):RadioButton

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

指定されたインデックス位置にある RadioButton コンポーネントを返します。

パラメーター

index:int — RadioButtonGroup 内にある RadioButton の 0 から始まるインデックスです。

戻り値

RadioButton — インデックスが 0 ～ numRadioButtons - 1 の範囲内にある場合は、指定した RadioButton コンポーネントです。インデックスが無効の場合、null を返します。

関連する API エレメント

numRadioButtons

initialized

()

メソッド

public function initialized(document:Object, id:String):void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

遅延インスタンス化をサポートする IMXMLObject.initialized() メソッドの実装です。

パラメーター

	`document:Object` — このオブジェクトを作成した MXML ドキュメントです。

	`id:String` — ドキュメントがこのオブジェクトを参照するために使用する識別子です。オブジェクトがドキュメントの deep プロパティである場合、`id` は null になります。

関連する API エレメント

mx.core.IMXMLObject

イベントの詳細

change

イベント

イベントオブジェクトの型: flash.events.Event
プロパティ Event.type = flash.events.Event.CHANGE

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

このグループ内で選択された RadioButton コンポーネントの値が変化したときに送出されます。

Event.CHANGE 定数は、type プロパティ（change イベントオブジェクト）の値を定義します。

このイベントには、次のプロパティがあります。

プロパティ	値
`bubbles`	`true`
`cancelable`	`false` は、キャンセルするデフォルトの動作がないことを示します。
`currentTarget`	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
`target`	値が変更されたオブジェクトです。`target` は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、`currentTarget` プロパティを使用します。

itemClick

イベント

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

ユーザーがグループ内の RadioButton コンポーネントを選択したときに送出されます。各 RadioButton コンポーネントについてハンドラーを設定することもできます。ユーザーがマウスでラジオボタンを操作した場合にのみ、このイベントが送出されます。

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

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

プロパティ	値
`bubbles`	false
`cancelable`	false
`currentTarget`	イベント処理を行うイベントリスナーの定義用オブジェクトを表します。例えば、イベントリスナーの登録に `myButton.addEventListener()` を使用すると、myButton の値は `currentTarget` となります。
`index`	クリックされたナビゲーションアイテムのインデックスです。
`item`	クリックされたナビゲーションアイテムのデータプロバイダー内のアイテムです。
`label`	クリックされたナビゲーションアイテムのラベルです。
`relatedObject`	イベントを生成した子オブジェクトです。
`target`	イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、`currentTarget` プロパティを使用してください。

valueCommit

イベント

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 4

ランタイムバージョン:

Flash Player 10, AIR 1.5

プログラムまたはユーザー操作のいずれかによって、値が変更されたときに送出されます。

このイベントはプログラムによる変更によってトリガーされるため、valueCommit イベントハンドラーが値を変更し、別の valueCommit イベントを起動することがないようにする必要があります。例えば、valueCommit イベントハンドラーの selectedValue プロパティや selection プロパティは変更しないでください。

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

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

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

例この例の使用方法

RadioButtonGroupExample.mxml

<?xml version="1.0" encoding="utf-8"?>
<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:Script>
        <![CDATA[   
            
            import mx.controls.Alert;
            import mx.events.ItemClickEvent;
            
            private function handlePayment(event:ItemClickEvent):void {
                if (event.currentTarget.selectedValue == "check") {
                    Alert.show("You opted to pay by check."); 
                } else if (event.currentTarget.selectedValue == "credit") {
                    Alert.show("You opted to pay by credit card.");
                }
            }
        ]]>
    </fx:Script>
    
    <fx:Declarations>
        <s:RadioButtonGroup id="paymentType" itemClick="handlePayment(event);"/>
    </fx:Declarations>
    <s:VGroup paddingLeft="10" paddingTop="10">
        <s:RadioButton groupName="paymentType" 
                       id="payCheck" 
                       value="check" 
                       label="Pay by check" 
                       width="150"/>
        <s:RadioButton groupName="paymentType" 
                       id="payCredit" 
                       value="credit" 
                       label="Pay by credit card" 
                       width="150"/>
    </s:VGroup>
</s:Application>

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

RadioButtonGroup - AS3 Flex

クラス x

enabled

numRadioButtons

selectedValue

selection