RadioButtonGroup

Package	mx.controls
Classe	public class RadioButtonGroup
Héritage	RadioButtonGroup EventDispatcher Object
Implémente	IMXMLObject

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

A partir de Flex 4.0, Adobe vous recommande d’utiliser la classe spark.components.RadioButtonGroup comme alternative à cette classe.

Le contrôle RadioButtonGroup définit un groupe de contrôles RadioButton agissant comme un contrôle unique mutuellement exclusif. De ce fait, l’utilisateur ne peut sélectionner qu’un seul contrôle RadioButton à la fois. Alors que le regroupement d’instances de RadioButton dans un composant RadioButtonGroup est facultatif, un groupe vous permet d’effectuer des choses comme définir un seul gestionnaire d’événement sur un groupe de boutons, plutôt que sur chaque bouton.

La propriété id est requise lorsque vous utilisez la balise <mx:RadioButtonGroup> pour définir le nom du groupe.

Notez que le contrôle RadioButtonGroup est une sous-classe du contrôle EventDispatcher, pas du contrôle UIComponent et qu’il implémente l’interface IMXMLObject. Tous les autres composants visuels de Flex sont des sous-classes du contrôle UIComponent, qui implémente l’interface IUIComponent. Le contrôle RadioButtonGroup est intégré au compilateur Flex, ce qui permet d’utiliser le contrôle RadioButtonGroup comme enfant d’un conteneur Flex, même s’il n’implémente pas l’interface IUIComponent. Tous les autres enfants du conteneur doivent implémenter l’interface IUIComponent.

Par conséquent, si vous essayez de définir un composant visuel comme sous-classe du contrôle EventDispatcher qui implémente l’interface IMXMLObject, vous ne pourrez pas l’utiliser comme enfant d’un conteneur.

Syntaxe MXML expanded

Masquer la syntaxe 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"
  />

Consulter les exemples

Eléments de l’API associés

mx.controls.RadioButton

Propriétés publiques

Masquer les propriétés publiques héritées

Afficher les propriétés publiques héritées

	Propriété		Défini par
		constructor : Object Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.	Object
		enabled : Boolean Détermine si la sélection est autorisée.	RadioButtonGroup
		labelPlacement : String Position de l’étiquette RadioButton par rapport à l’icône RadioButton de chaque contrôle du groupe.	RadioButtonGroup
		numRadioButtons : int [lecture seule] Nombre de contrôles RadioButton appartenant à ce contrôle RadioButtonGroup.	RadioButtonGroup
		selectedValue : Object Valeur de la propriété value du contrôle RadioButton sélectionné dans le groupe, si elle est différente de la valeur null (valeur par défaut).	RadioButtonGroup
		selection : RadioButton Contient une référence au contrôle RadioButton actuellement sélectionné dans le groupe.	RadioButtonGroup

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		RadioButtonGroup(document:IFlexDisplayObject = null) Constructeur.	RadioButtonGroup
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement.	EventDispatcher
		dispatchEvent(event:Event):Boolean Distribue un événement dans le flux d’événements.	EventDispatcher
		getRadioButtonAt(index:int):RadioButton Renvoie le contrôle RadioButton à l’index spécifié.	RadioButtonGroup
		hasEventListener(type:String):Boolean Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indique si la propriété spécifiée d’un objet est définie.	Object
		initialized(document:Object, id:String):void Implémentation de la méthode IMXMLObject.initialized() pour prendre en charge l’instanciation différée.	RadioButtonGroup
		isPrototypeOf(theClass:Object):Boolean Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre.	Object
		propertyIsEnumerable(name:String):Boolean Indique si la propriété spécifiée existe et est énumérable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Supprime un écouteur de l’objet EventDispatcher.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.	Object
		toLocaleString():String Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.	Object
		toString():String Renvoie la représentation sous forme de chaîne de l’objet spécifié.	Object
		valueOf():Object Renvoie la valeur primitive de l’objet spécifié.	Object
		willTrigger(type:String):Boolean Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié.	EventDispatcher

Evénements

Cliquez pour plus d’informations sur les événements

Masquer les événements hérités

Afficher les événements hérités

	Synthèse	Défini par
activate	[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active.	EventDispatcher
change	Distribué lorsque la valeur du contrôle RadioButton sélectionné dans ce groupe change.	RadioButtonGroup
deactivate	[Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive.	EventDispatcher
itemClick	Distribué lorsqu’un utilisateur sélectionne un contrôle RadioButton dans le groupe.	RadioButtonGroup

Détails de la propriété

enabled

propriété

enabled:Boolean

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Détermine si la sélection est autorisée.

La valeur par défaut est true.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement enabledChanged .

Implémentation
public function get enabled():Boolean
public function set enabled(value:Boolean):void

labelPlacement

propriété

labelPlacement:String

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Position de l’étiquette RadioButton par rapport à l’icône RadioButton de chaque contrôle du groupe. Vous pouvez remplacer ce paramètre pour chaque contrôle.

Les valeurs possibles dans MXML sont "right", "left", "bottom" et "top".

Dans ActionScript, vous utilisez les constantes suivantes pour définir cette propriété : ButtonLabelPlacement.RIGHT, ButtonLabelPlacement.LEFT, ButtonLabelPlacement.BOTTOM et ButtonLabelPlacement.TOP.

La valeur par défaut est "right".

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement labelPlacementChanged .

Implémentation
public function get labelPlacement():String
public function set labelPlacement(value:String):void

numRadioButtons

propriété

numRadioButtons:int [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Nombre de contrôles RadioButton appartenant à ce contrôle RadioButtonGroup.

La valeur par défaut est "undefined".

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement numRadioButtonsChanged .

Implémentation
public function get numRadioButtons():int

selectedValue

propriété

selectedValue:Object

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Valeur de la propriété value du contrôle RadioButton sélectionné dans le groupe, si elle est différente de la valeur null (valeur par défaut). Sinon, selectedValue est la valeur de la propriété label du contrôle RadioButton sélectionné. Si aucun contrôle RadioButton n’est sélectionné, cette propriété a la valeur null.

Si vous définissez selectedValue, Flex sélectionne le contrôle RadioButton dont la propriété value ou label correspond à cette valeur.

La valeur par défaut est null.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement valueCommit .

Implémentation
public function get selectedValue():Object
public function set selectedValue(value:Object):void

selection

propriété

selection:RadioButton

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Contient une référence au contrôle RadioButton actuellement sélectionné dans le groupe. Vous pouvez accéder à la propriété dans ActionScript uniquement ; elle ne peut pas être définie dans MXML. Définir cette propriété sur null a pour effet de désélectionner le contrôle RadioButton actuellement sélectionné.

La valeur par défaut est null.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement valueCommit .

Implémentation
public function get selection():RadioButton
public function set selection(value:RadioButton):void

Détails du constructeur

()

Constructeur

public function RadioButtonGroup(document:IFlexDisplayObject = null)

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Constructeur.

Paramètres

document:IFlexDisplayObject (default = null) — Dans les cas simples où une classe étend la classe EventDispatcher, le paramètre document ne doit pas être utilisé.

Eléments de l’API associés

flash.events.EventDispatcher

Détails de la méthode

getRadioButtonAt

()

méthode

public function getRadioButtonAt(index:int):RadioButton

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Renvoie le contrôle RadioButton à l’index spécifié.

Paramètres

index:int — Index du contrôle RadioButton dans le contrôle RadioButtonGroup, l’index du premier contrôle étant 0.

Valeur renvoyée

RadioButton — Contrôle RadioButton spécifié.

initialized

()

méthode

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

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Implémentation de la méthode IMXMLObject.initialized() permettant de prendre en charge l’instanciation différée.

Paramètres

	`document:Object` — Document MXML ayant créé cet objet.

	`id:String` — Identificateur utilisé par le document pour faire référence à cet objet. Si l’objet est une propriété profonde dans le document, la valeur `id` est null.

Eléments de l’API associés

mx.core.IMXMLObject

Détails de l’événement

change

Evénement

Type d’objet d’événement: flash.events.Event
propriété Event.type = flash.events.Event.CHANGE

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Distribué lorsque la valeur du contrôle RadioButton sélectionné dans ce groupe change.

La constante Event.CHANGE définit la valeur de la propriété type de l’objet d’événement change.

Les propriétés de cet événement sont les suivantes :

Propriété	Valeur
`bubbles`	`true`
`cancelable`	`false` ; il n’existe aucun comportement par défaut à annuler.
`currentTarget`	L’objet qui traite activement l’objet Event avec un écouteur d’événements.
`target`	Objet dont la valeur a été modifiée. La propriété `target` ne correspond pas toujours à l’objet de la liste d’affichage qui est associé à l’écouteur d’événement. Utilisez la propriété `currentTarget` pour accéder à l’objet de la liste d’affichage qui traite actuellement l’événement.

itemClick

Evénement

Type d’objet d’événement: mx.events.ItemClickEvent
propriété ItemClickEvent.type = mx.events.ItemClickEvent.ITEM_CLICK

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Distribué lorsqu’un utilisateur sélectionne un contrôle RadioButton dans le groupe. Vous pouvez également définir un gestionnaire pour chaque contrôle RadioButton.

La constante ItemClickEvent.ITEM_CLICK définit la valeur de la propriété type de l’objet d’événement d’un événement itemClick.

Les valeurs des propriétés de l’objet d’événement sont les suivantes :

Propriété	Valeur
`bubbles`	false
`cancelable`	false
`currentTarget`	Objet définissant l’écouteur d’événement qui traite l’événement. Par exemple, si vous utilisez `myButton.addEventListener()` pour enregistrer un écouteur d’événement, myButton est la valeur de `currentTarget`.
`index`	Index de l’élément de navigation sur lequel l’utilisateur a cliqué.
`item`	Elément correspondant à l’élément de navigation sur lequel l’utilisateur a cliqué dans le fournisseur de données.
`label`	Libellé de l’élément de navigation sur lequel l’utilisateur a cliqué.
`relatedObject`	Objet enfant qui a généré l’événement.
`target`	Objet qui a distribué l’événement (il ne s’agit pas toujours de l’objet qui écoute l’événement). Pour accéder systématiquement à l’objet qui écoute l’événement, utilisez la propriété `currentTarget`.

Exemples Comment utiliser cet exemple

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>

Informations juridiques | Politique de confidentialité en ligne

RadioButtonGroup - AS3 Flex

Packagesx

Eléments du langage

Annexes

Package mx.controls

enabled

labelPlacement

numRadioButtons

selectedValue

selection