RadioButtonGroup

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

Flex 4.0 以降では、このクラスの代わりとして spark.components.RadioButtonGroup クラスを使用することをお勧めします。

RadioButtonGroup コントロールは、1 つの相互排他的コントロールとして機能する RadioButton コントロールのグループを定義します。RadioButton コントロールは一度に 1 つしか選択できません。 RadioButton インスタンスを RadioButtonGroup にグループ化することはオプションですが、グループ化を行うと、例えば、単一のイベントハンドラーを個々のボタンではなく、ボタングループで設定できます。

id プロパティが必要です（<mx:RadioButtonGroup> タグを使用してグループの名前を定義する場合）。

RadioButtonGroup コントロールは UIComponent ではなく EventDispatcher のサブクラスであり、IMXMLObject インターフェイスを実装します。他のすべての Flex のビジュアルコンポーネントは UIComponent のサブクラスであり、IUIComponent インターフェイスを実装します。Flex コンパイラーには RadioButtonGroup コントロールのサポートが組み込まれているため、RadioButtonGroup コントロールを Flex コンテナの子として使用できます。ただし、IUIComponent は実装されません。他のすべてのコンテナの子では、IUIComponent インターフェイスを実装する必要があります。

そのため、ビジュアルコンポーネントを、IMXMLObject インターフェイスを実装する EventDispatcher のサブクラスとして定義しようとしても、それをコンテナの子として使用することはできません。

MXML シンタックス expanded

MXML シンタックスを隠す

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

  <mx:RadioButtonGroup
    Properties
    enabled="true|false"
    id="No default"
    labelPlacement="right|left|top|bottom"
 
    Events
    change="No default"
    itemClick="No default"
  />

例を表示

さらに例を参照

RadioButton control

関連する API エレメント

mx.controls.RadioButton

パブリックプロパティ

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

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

	プロパティ		定義元
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。	Object
		enabled : Boolean 選択が可能かどうかを判別します。	RadioButtonGroup
		labelPlacement : String グループ内の各コントロールの RadioButton アイコンを基準にした RadioButton ラベルの位置です。	RadioButtonGroup
		numRadioButtons : int [読み取り専用] この RadioButtonGroup に属する RadioButton の数です。	RadioButtonGroup
		selectedValue : Object null（デフォルト値）以外の値が設定されている場合、グループから選択された RadioButton コントロールの value プロパティの値です。	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

プロパティの詳細

enabled

プロパティ

enabled:Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

選択が可能かどうかを判別します。

デフォルト値： true。

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

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

labelPlacement

プロパティ

labelPlacement:String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

グループ内の各コントロールの RadioButton アイコンを基準にした RadioButton ラベルの位置です。この設定はコントロールごとにオーバーライドできます。

MXML で使用できる値は "right"、"left"、"bottom" および "top" です。

ActionScript では、このプロパティを設定するために、ButtonLabelPlacement.RIGHT、ButtonLabelPlacement.LEFT、ButtonLabelPlacement.BOTTOM および ButtonLabelPlacement.TOP の各定数を使用します。

デフォルト値： "right"。

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

実装
public function get labelPlacement():String
public function set labelPlacement(value:String):void

numRadioButtons

プロパティ

numRadioButtons:int [読み取り専用]

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

デフォルト値： "undefined"。

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

実装
public function get numRadioButtons():int

selectedValue

プロパティ

selectedValue:Object

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

グループから選択された RadioButton コントロールの value プロパティの値です（null（デフォルト値）以外の値が設定されている場合）。それ以外の場合は、selectedValueが、選択された 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 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

グループ内で現在選択されている 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 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

コンストラクターです。

パラメーター

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

getRadioButtonAt

()

メソッド

public function getRadioButtonAt(index:int):RadioButton

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

パラメーター

index:int — RadioButtonGroup コントロール内の RadioButton のインデックスです。最初のコントロールのインデックスは 0 です。

戻り値

RadioButton — 指定された RadioButton コントロールです。

initialized

()

メソッド

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

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

パラメーター

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

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

change

イベント

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

このグループ内で選択された 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 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ユーザーがグループ内の RadioButton コントロールを選択したときに送出されます。各 RadioButton コントロールについてハンドラーを設定することもできます。

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

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

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

例この例の使用方法

RadioButtonGroupExample.mxml

<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate Halo RadioButtonGroup control. -->
<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;
        
            // Event handler function to display the selected button
            // in a Halo Alert control.
            private function handleCard(evt:ItemClickEvent):void {
                switch (evt.currentTarget.selectedValue) {
                    case "AmEx":
                        Alert.show("You selected American Express");
                        break;
                    case "MC":
                        Alert.show("You selected MasterCard");
                        break;
                    case "Visa":
                        Alert.show("You selected Visa");
                        break;
                }
            }
        ]]>
    </fx:Script>

    <fx:Declarations>
        <mx:RadioButtonGroup id="cardtype" itemClick="handleCard(event);"/>
    </fx:Declarations>

    <s:Panel title="Halo RadioButtonGroup Control Example"
            width="75%" height="75%" 
            horizontalCenter="0" verticalCenter="0">
        <s:VGroup left="10" right="10" top="10" bottom="10">
            <s:Label width="100%" color="blue" 
                    text="Select a type of credit card."/>

            <mx:RadioButton groupName="cardtype" id="americanExpress" value="AmEx" 
                    label="American Express" width="150" />
            <mx:RadioButton groupName="cardtype" id="masterCard" value="MC" 
                    label="MasterCard" width="150" />
            <mx:RadioButton groupName="cardtype" id="visa" value="Visa" 
                    label="Visa" width="150" />
        </s:VGroup>
    </s:Panel>

</s:Application>

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

RadioButtonGroup - AS3 Flex

クラス x

enabled

labelPlacement

numRadioButtons

selectedValue

selection