RadioButtonGroup

Pacote	spark.components
Classe	public class RadioButtonGroup
Herança	RadioButtonGroup EventDispatcher Object
Implementações	IMXMLObject

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

Flash Player 10, AIR 1.5

The RadioButtonGroup component defines a group of RadioButton components that act as a single mutually exclusive component; therefore, a user can select only one RadioButton component at a time. The id property is required when you use the <s:RadioButtonGroup> tag to define the group name. Any <s:RadioButton> component added to this group will have this group name.

Notice that the RadioButtonGroup component is a subclass of EventDispatcher, not UIComponent, and implements the IMXMLObject interface. All other Flex visual components implement the IVisualElement interface. The RadioButtonGroup component declaration must be contained within the <Declarations> tag since it is not assignable to IVisualElement.

To use this component in a list-based component, such as a List or DataGrid, create an item renderer. For information about creating an item renderer, see Custom Spark item renderers.

Sintaxe MXML expanded

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

Veja os exemplos

Mais exemplos

RadioButton control

Elementos da API relacionados

spark.components.RadioButton

Propriedades públicas

Ocultar propriedades públicas herdadas

Mostrar propriedades públicas herdadas

	Propriedade		Definido por
		constructor : Object Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto.	Object
		enabled : Boolean Determines whether selection is allowed.	RadioButtonGroup
		numRadioButtons : int [somente leitura] The number of RadioButtons that belong to this RadioButtonGroup.	RadioButtonGroup
		selectedValue : Object The value property of the selected RadioButton component in the group, if it has been set, otherwise, the label property of the selected RadioButton.	RadioButtonGroup
		selection : RadioButton Contains a reference to the currently selected RadioButton component in the group.	RadioButtonGroup

Métodos públicos

Ocultar métodos públicos herdados

Mostrar métodos públicos herdados

	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 um objeto de ouvinte de evento em um objeto EventDispatcher, de forma que o ouvinte receba a notificação de um evento.	EventDispatcher
		dispatchEvent(event:Event):Boolean Envia um evento para o fluxo de eventos.	EventDispatcher
		getRadioButtonAt(index:int):RadioButton Returns the RadioButton component at the specified index.	RadioButtonGroup
		hasEventListener(type:String):Boolean Verifica se o objeto EventDispatcher tem ouvintes registrados para um tipo específico de evento.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indica se um objeto tem uma propriedade especificada definida.	Object
		initialized(document:Object, id:String):void Implementation of the IMXMLObject.initialized() method to support deferred instantiation.	RadioButtonGroup
		isPrototypeOf(theClass:Object):Boolean Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro.	Object
		propertyIsEnumerable(name:String):Boolean Indica se a propriedade especificada existe e é enumerável.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Remove um ouvinte do objeto EventDispatcher.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Define a disponibilidade de uma propriedade dinâmica para operações de repetição.	Object
		toLocaleString():String Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade.	Object
		toString():String Retorna a representação de string do objeto especificado.	Object
		valueOf():Object Retorna o valor primitivo do objeto especificado.	Object
		willTrigger(type:String):Boolean Verifica se um ouvinte de evento está registrado nesse objeto EventDispatcher ou em qualquer um de seus ancestrais para o tipo de evento especificado.	EventDispatcher

Eventos

Clique para obter mais informações sobre eventos

Ocultar eventos herdados

Mostrar eventos herdados

	Resumo	Definido por
activate	[transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR ganha o foco do sistema operacional e está se tornando inativo.	EventDispatcher
change	Dispatched when the value of the selected RadioButton component in this group changes.	RadioButtonGroup
deactivate	[transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR perde o foco do sistema operacional e está se tornando inativo.	EventDispatcher
itemClick	Dispatched when a user selects a RadioButton component in the group.	RadioButtonGroup
valueCommit	Dispatched when values are changed programmatically or by user interaction.	RadioButtonGroup

Detalhes da propriedade

enabled

propriedade

enabled:Boolean

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

Flash Player 10, AIR 1.5

Determines whether selection is allowed. Note that the value returned only reflects the value that was explicitly set on the RadioButtonGroup and does not reflect any values explicitly set on the individual RadioButtons.

O valor padrão é true.

Implementação
public function get enabled():Boolean
public function set enabled(value:Boolean):void

numRadioButtons

propriedade

numRadioButtons:int [somente leitura]

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

Flash Player 10, AIR 1.5

The number of RadioButtons that belong to this RadioButtonGroup.

O valor padrão é "0".

Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento numRadioButtonsChanged .

Implementação
public function get numRadioButtons():int

selectedValue

propriedade

selectedValue:Object

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

Flash Player 10, AIR 1.5

The value property of the selected RadioButton component in the group, if it has been set, otherwise, the label property of the selected RadioButton. If no RadioButton is selected, this property is null.

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

O valor padrão é null.

Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento valueCommit .

Implementação
public function get selectedValue():Object
public function set selectedValue(value:Object):void

selection

propriedade

selection:RadioButton

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

Flash Player 10, AIR 1.5

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

O valor padrão é null.

Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento valueCommit .

Implementação
public function get selection():RadioButton
public function set selection(value:RadioButton):void

Detalhes do construtor

()

Construtor

public function RadioButtonGroup(document:IFlexDisplayObject = null)

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

Flash Player 10, AIR 1.5

Constructor.

Parâmetros

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

Elementos da API relacionados

flash.events.EventDispatcher

Detalhes do método

getRadioButtonAt

()

método

public function getRadioButtonAt(index:int):RadioButton

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

Flash Player 10, AIR 1.5

Returns the RadioButton component at the specified index.

Parâmetros

index:int — The 0-based index of the RadioButton in the RadioButtonGroup.

Retorna

RadioButton — The specified RadioButton component if index is between 0 and numRadioButtons - 1. Returns null if the index is invalid.

Elementos da API relacionados

numRadioButtons

initialized

()

método

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

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

Flash Player 10, AIR 1.5

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 da API relacionados

mx.core.IMXMLObject

Detalhe do evento

change

Evento

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

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

Flash Player 10, AIR 1.5

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

A constante Event.CHANGE define o valor da propriedade type de um objeto de evento change.

Esse evento tem as seguintes propriedades:

Propriedade	Valor
`bubbles`	`true`
`cancelable`	`false`; não há comportamento padrão a ser cancelado.
`currentTarget`	O objeto que está processando ativamente o objeto Event com um ouvinte de evento.
`target`	O objeto que tem seus respectivos valores modificados. `target` não é sempre o objeto na lista de exibição que registrou o ouvinte de evento. Use a propriedade `currentTarget` para acessar o objeto na lista de exibição que está processando o evento no momento.

itemClick

Evento

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

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

Flash Player 10, AIR 1.5

Dispatched when a user selects a RadioButton component in the group. You can also set a handler for individual RadioButton components. This event is dispatched only when the user interacts with the radio buttons by using the mouse.

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.

valueCommit

Evento

Tipo do objeto de evento: mx.events.FlexEvent
propriedade FlexEvent.type = mx.events.FlexEvent.VALUE_COMMIT

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 4

Versões de runtime:

Flash Player 10, AIR 1.5

Dispatched when values are changed programmatically or by user interaction.

Because a programmatic change triggers this event, make sure that any valueCommit event handler does not change a value that causes another valueCommit event. For example, do not change theselectedValue property or selection property in a valueCommit event handler.

The FlexEvent.VALUE_COMMIT constant defines the value of the type property of the event object for a valueCommit 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`.
`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.

Exemplos Como usar este exemplo

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>

Aspectos jurídicos | Política de privacidade on-line

RadioButtonGroup - AS3 Flex

Classes x

enabled

numRadioButtons

selectedValue

selection