RadioButtonGroup

Paquete	mx.controls
Clase	public class RadioButtonGroup
Herencia	RadioButtonGroup EventDispatcher Object
Implementa	IMXMLObject

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 3

Versiones de motor de ejecución:

Flash Player 9, AIR 1.1

Desde Flex 4.0, Adobe recomienda la utilización de la clase spark.components.RadioButtonGroup como una alternativa a esta clase.

The RadioButtonGroup control defines a group of RadioButton controls that act as a single mutually exclusive control; therefore, a user can select only one RadioButton control at a time. While grouping RadioButton instances in a RadioButtonGroup is optional, a group lets you do things like set a single event handler on a group of buttons, rather than on each individual button.

The id property is required when you use the <mx:RadioButtonGroup> tag to define the name of the group.

Notice that the RadioButtonGroup control is a subclass of EventDispatcher, not UIComponent, and implements the IMXMLObject interface. All other Flex visual components are subclasses of UIComponent, which implements the IUIComponent interface. The RadioButtonGroup control has support built into the Flex compiler that allows you to use the RadioButtonGroup control as a child of a Flex container, even though it does not implement IUIComponent. All other container children must implement the IUIComponent interface.

Therefore, if you try to define a visual component as a subclass of EventDispatcher that implements the IMXMLObject interface, you will not be able to use it as the child of a container.

Sintaxis MXML expanded

Ocultar sintaxis 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"
  />

Ver los ejemplos

Más ejemplos

RadioButton control

Elementos de API relacionados

mx.controls.RadioButton

Propiedades públicas

Ocultar propiedades públicas heredadas

Mostrar propiedades públicas heredadas

	Propiedad		Definido por
		constructor : Object Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada.	Object
		enabled : Boolean Determines whether selection is allowed.	RadioButtonGroup
		labelPlacement : String Position of the RadioButton label relative to the RadioButton icon for each control in the group.	RadioButtonGroup
		numRadioButtons : int [solo lectura] The number of RadioButtons that belong to this RadioButtonGroup.	RadioButtonGroup
		selectedValue : Object The value of the value property of the selected RadioButton control in the group, if this has been set to be something other than null (the default value).	RadioButtonGroup
		selection : RadioButton Contains a reference to the currently selected RadioButton control in the group.	RadioButtonGroup

Métodos públicos

Ocultar métodos públicos heredados

Mostrar métodos públicos heredados

	Método		Definido por
		RadioButtonGroup(document:IFlexDisplayObject = null) Constructor.	RadioButtonGroup
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registra un objeto de detector de eventos con un objeto EventDispatcher, de modo que el detector reciba la notificación de un evento.	EventDispatcher
		dispatchEvent(event:Event):Boolean Distribuye un evento en el flujo del evento.	EventDispatcher
		getRadioButtonAt(index:int):RadioButton Returns the RadioButton control at the specified index.	RadioButtonGroup
		hasEventListener(type:String):Boolean Comprueba si el objeto EventDispatcher tiene detectores registrados para un tipo concreto de evento.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indica si un objeto tiene definida una propiedad especificada.	Object
		initialized(document:Object, id:String):void Implementation of the IMXMLObject.initialized() method to support deferred instantiation.	RadioButtonGroup
		isPrototypeOf(theClass:Object):Boolean Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro.	Object
		propertyIsEnumerable(name:String):Boolean Indica si existe la propiedad especificada y si es enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Elimina un detector del objeto EventDispatcher.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Establece la disponibilidad de una propiedad dinámica para operaciones de bucle.	Object
		toLocaleString():String Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional.	Object
		toString():String Devuelve la representación de cadena del objeto especificado.	Object
		valueOf():Object Devuelve el valor simple del objeto especificado.	Object
		willTrigger(type:String):Boolean Comprueba si hay registrado un detector de eventos con este objeto EventDispatcher o con cualquiera de sus ascendientes para el tipo de evento concreto.	EventDispatcher

Eventos

Haga clic para obtener más información sobre los eventos

Ocultar eventos heredados

Mostrar eventos heredados

	Resumen	Definido por
activate	[evento broadcast] Se distribuye cuando Flash Player o AIR pasan a estar activos.	EventDispatcher
change	Dispatched when the value of the selected RadioButton control in this group changes.	RadioButtonGroup
deactivate	[evento broadcast] Se distribuye cuando Flash Player o de AIR pasan a estar inactivos.	EventDispatcher
itemClick	Dispatched when a user selects a RadioButton control in the group.	RadioButtonGroup

Información sobre propiedades

enabled

propiedad

enabled:Boolean

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 3

Versiones de motor de ejecución:

Flash Player 9, AIR 1.1

Determines whether selection is allowed.

El valor predeterminado es true.

Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento enabledChanged .

Implementación
public function get enabled():Boolean
public function set enabled(value:Boolean):void

labelPlacement

propiedad

labelPlacement:String

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 3

Versiones de motor de ejecución:

Flash Player 9, AIR 1.1

Position of the RadioButton label relative to the RadioButton icon for each control in the group. You can override this setting for the individual controls.

Valid values in MXML are "right", "left", "bottom", and "top".

In ActionScript, you use the following constants to set this property: ButtonLabelPlacement.RIGHT, ButtonLabelPlacement.LEFT, ButtonLabelPlacement.BOTTOM, and ButtonLabelPlacement.TOP.

El valor predeterminado es "right".

Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento labelPlacementChanged .

Implementación
public function get labelPlacement():String
public function set labelPlacement(value:String):void

numRadioButtons

propiedad

numRadioButtons:int [solo lectura]

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 3

Versiones de motor de ejecución:

Flash Player 9, AIR 1.1

The number of RadioButtons that belong to this RadioButtonGroup.

El valor predeterminado es "undefined".

Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento numRadioButtonsChanged .

Implementación
public function get numRadioButtons():int

selectedValue

propiedad

selectedValue:Object

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 3

Versiones de motor de ejecución:

Flash Player 9, AIR 1.1

The value of the value property of the selected RadioButton control in the group, if this has been set to be something other than null (the default value). Otherwise, selectedValue is the value of the label property of the selected RadioButton. If no RadioButton is selected, this property is null.

If you set selectedValue, Flex selects the RadioButton control whose value or label property matches this value.

El valor predeterminado es null.

Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento valueCommit .

Implementación
public function get selectedValue():Object
public function set selectedValue(value:Object):void

selection

propiedad

selection:RadioButton

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 3

Versiones de motor de ejecución:

Flash Player 9, AIR 1.1

Contains a reference to the currently selected RadioButton control in the group. You can access the property in ActionScript only; it is not settable in MXML. Setting this property to null deselects the currently selected RadioButton control.

El valor predeterminado es null.

Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento valueCommit .

Implementación
public function get selection():RadioButton
public function set selection(value:RadioButton):void

Información sobre constructores

()

Información sobre

public function RadioButtonGroup(document:IFlexDisplayObject = null)

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 3

Versiones de motor de ejecución:

Flash Player 9, AIR 1.1

Constructor.

Parámetros

document:IFlexDisplayObject (default = null) — In simple cases where a class extends EventDispatcher, the document parameter should not be used.

Elementos de API relacionados

flash.events.EventDispatcher

Información sobre métodos

getRadioButtonAt

()

método

public function getRadioButtonAt(index:int):RadioButton

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 3

Versiones de motor de ejecución:

Flash Player 9, AIR 1.1

Returns the RadioButton control at the specified index.

Parámetros

index:int — The index of the RadioButton control in the RadioButtonGroup control, where the index of the first control is 0.

Valor devuelto

RadioButton — The specified RadioButton control.

initialized

()

método

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

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 3

Versiones de motor de ejecución:

Flash Player 9, AIR 1.1

Implementation of the IMXMLObject.initialized() method to support deferred instantiation.

Parámetros

	`document:Object` — The MXML document that created this object.

	`id:String` — The identifier used by document to refer to this object. If the object is a deep property on document, `id` is null.

Elementos de API relacionados

mx.core.IMXMLObject

Información sobre eventos

change

Evento

Tipo de objeto de evento: flash.events.Event
propiedad Event.type = flash.events.Event.CHANGE

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 3

Versiones de motor de ejecución:

Flash Player 9, AIR 1.1

Dispatched when the value of the selected RadioButton control in this group changes.

La constante Event.CHANGE define el valor de la propiedad type de un objeto de evento change.

Este evento tiene las propiedades siguientes:

Propiedad	Valor
`bubbles`	`true`
`cancelable`	`false`; no hay ningún comportamiento predeterminado que cancelar.
`currentTarget`	Objeto que procesa de forma activa el objeto de evento con un detector de eventos.
`target`	Objeto al que se ha modificado su valor. El objeto `target` no siempre es el objeto de la lista de visualización que registró el detector de eventos. Utilice la propiedad `currentTarget` para acceder al objeto de la lista de visualización que está procesando el evento actualmente.

itemClick

Evento

Tipo de objeto de evento: mx.events.ItemClickEvent
propiedad ItemClickEvent.type = mx.events.ItemClickEvent.ITEM_CLICK

Versión del lenguaje:

ActionScript 3.0

Versión de producto:

Flex 3

Versiones de motor de ejecución:

Flash Player 9, AIR 1.1

Dispatched when a user selects a RadioButton control in the group. You can also set a handler for individual RadioButton controls.

The ItemClickEvent.ITEM_CLICK constant defines the value of the type property of the event object for an itemClick event.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`index`	The index of the navigation item that was clicked.
`item`	The item in the data provider of the navigation item that was clicked.
`label`	The label of the navigation item that was clicked.
`relatedObject`	The child object that generated the event.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

Ejemplos Cómo utilizar este ejemplo

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>

Avisos legales | Política de privacidad en línea

RadioButtonGroup - AS3 Flex

Paquetesx

Elementos del lenguaje

Apéndices

Paquete mx.controls

enabled

labelPlacement

numRadioButtons

selectedValue

selection