RadioButtonGroup

包	spark.components
类	public class RadioButtonGroup
继承	RadioButtonGroup EventDispatcher Object
实现	IMXMLObject

语言版本:

ActionScript 3.0

产品版本:

Flex 4

运行时版本:

Flash Player 10, AIR 1.5

RadioButtonGroup 组件定义一组 RadioButton 组件，这些组件相互排斥；因此，用户每次只能选择一个 RadioButton 组件。使用 <s:RadioButtonGroup> 标签定义组名称时，需要使用 id 属性。添加到该组中的任何 <s:RadioButton> 组件都将拥有此组名称。

注意，RadioButtonGroup 组件是 EventDispatcher 的子类，而不是 UIComponent 的子类，并实现 IMXMLObject 接口。所有其它 Flex 可视组件实现 IVisualElement 接口。RadioButtonGroup 组件声明必须包含在 <Declarations> 标签内，因为不可以将该组件声明指定给 IVisualElement。

要在基于列表的组件（如 List 或 DataGrid）中使用此组件，请创建项呈示器。有关创建项呈示器的信息，请参阅自定义 Spark 项呈示器。

MXML 语法

隐藏 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"
  />

查看示例

相关 API 元素

spark.components.RadioButton

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		enabled : Boolean 确定是否允许选择。	RadioButtonGroup
		numRadioButtons : int [只读] 属于此 RadioButtonGroup 的 RadioButton 数。	RadioButtonGroup
		selectedValue : Object 组中所选 RadioButton 组件的 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 属性（如果未设置），否则为所选 RadioButton 组件的 label 属性。如果未选择任何 RadioButton，则此属性为 null。

如果设置了 selectedValue，则 Flex 会选择 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 组件的选择。不调度 change 事件。

默认值为 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 的从零开始的索引。

RadioButton — 当索引位于 0 和 numRadioButtons 之间时，指定的 RadioButton 组件为 1。如果索引无效，则返回 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` — 文档用来引用此对象的标识符。如果此对象是文档上的深层属性，则 `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 常量定义 change 事件对象的 type 属性值。

此事件具有以下属性：

属性	值
`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 常量可为 itemClick 事件定义事件对象的 type 属性值。

事件对象的属性有下列值：

属性	值
`bubbles`	false
`cancelable`	false
`currentTarget`	用于定义处理该事件的事件侦听器的对象。例如，如果您使用 `myButton.addEventListener()` 注册某个事件侦听器，则 myButton 为 `currentTarget` 的值。
`index`	单击的导航项目的索引。
`item`	单击的导航项目在数据提供程序中的项目。
`label`	单击的导航项目的标签。
`relatedObject`	生成事件的子对象。
`target`	调度该事件的 Object；它不一定是侦听该事件的 Object。使用 `currentTarget` 属性始终可以访问侦听事件的 Object。

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 常量可为 valueCommit 事件定义事件对象的 type 属性值。

事件对象的属性有下列值：

属性	值
`bubbles`	false
`cancelable`	false
`currentTarget`	用于定义处理该事件的事件侦听器的对象。例如，如果您使用 `myButton.addEventListener()` 注册某个事件侦听器，则 myButton 为 `currentTarget` 的值。
`target`	调度该事件的 Object；它不一定是侦听该事件的 Object。使用 `currentTarget` 属性始终可以访问侦听事件的 Object。

示例如何使用本示例

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

语言元素

附录

包 spark.components

enabled

numRadioButtons

selectedValue

selection