RadioButtonGroup

Package	spark.components
Classe	public class RadioButtonGroup
Héritage	RadioButtonGroup EventDispatcher Object
Implémente	IMXMLObject

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Le composant RadioButtonGroup définit un groupe de composants RadioButton agissant comme un composant unique mutuellement exclusif. De ce fait, l’utilisateur ne peut sélectionner qu’un seul composant RadioButton à la fois. La propriété id est requise lorsque vous utilisez la balise <s:RadioButtonGroup> pour définir le nom du groupe. Tout composant <s:RadioButton> ajouté à ce groupe portera ce nom de groupe.

Notez que le contrôle RadioButtonGroup est une sous-classe du composant EventDispatcher, pas du contrôle UIComponent, et qu’il implémente l’interface IMXMLObject. Toutes les autres composants visuels Flex implémentent l’interface IVisualElement. La déclaration du composant RadioButtonGroup doit être contenue dans la balise <déclarations> puisqu’elle n’est pas attribuable à IVisualElement.

Pour utiliser ce composant d’un composant à base de listes (par exemple List ou DataGrid) créez une option de rendu d’élément. Pour plus d’informations sur la création d’une option de rendu d’élément, consultez la section Options personnalisées de rendu d’élément Spark.

Syntaxe MXML expanded

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

Consulter les exemples

Eléments de l’API associés

spark.components.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
		numRadioButtons : int [lecture seule] Nombre de contrôles RadioButton appartenant à ce contrôle RadioButtonGroup.	RadioButtonGroup
		selectedValue : Object Propriété value du composant RadioButton sélectionné dans le groupe, s’il a été défini, dans le cas contraire, propriété label du composant RadioButton sélectionnée.	RadioButtonGroup
		selection : RadioButton Contient une référence au composant 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 composant 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 composant 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 composant RadioButton dans le groupe.	RadioButtonGroup
valueCommit	Distribué lorsque les valeurs sont modifiées soit par programmation, soit par interaction de l’utilisateur.	RadioButtonGroup

Détails de la propriété

enabled

propriété

enabled:Boolean

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Détermine si la sélection est autorisée. La valeur renvoyée reflète uniquement la valeur explicitement définie sur le composant RadioButtonGroup et ne reflète pas les valeurs explicitement définies sur les différents composants RadioButton.

La valeur par défaut est true.

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

numRadioButtons

propriété

numRadioButtons:int [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

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

La valeur par défaut est "0".

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 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Propriété valeur du composant RadioButton sélectionné dans le groupe, s’il a été défini, dans le cas contraire, propriété label du composant 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 premier composant 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 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Contient une référence au composant RadioButton actuellement sélectionné dans le groupe. Vous pouvez accéder à cette propriété uniquement en langage ActionScript. Elle ne peut pas être définie en langage MXML. Le fait de définir cette propriété sur null désélectionne le composant RadioButton actuellement sélectionné. Un événement change n’est pas distribué.

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 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

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 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Renvoie le composant RadioButton à l’index spécifié.

Paramètres

index:int — Index en base 0 du composant RadioButton dans le composant RadioButtonGroup.

Valeur renvoyée

RadioButton — Composant RadioButton spécifié si l’index est compris entre 0 et numRadioButtons - 1. Renvoie null si l’index n’est pas valide.

Eléments de l’API associés

numRadioButtons

initialized

()

méthode

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

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

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 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Distribué lorsque la valeur du composant 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 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Distribué lorsqu’un utilisateur sélectionne un composant RadioButton dans le groupe. Vous pouvez également définir un gestionnaire pour chaque composant RadioButton. Cet événement est distribué uniquement lorsque l’utilisateur actionne les boutons radio à l’aide de la souris.

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`.

valueCommit

Evénement

Type d’objet d’événement: mx.events.FlexEvent
propriété FlexEvent.type = mx.events.FlexEvent.VALUE_COMMIT

Version du langage:

ActionScript 3.0

Version du produit:

Flex 4

Versions du moteur d’exécution:

Flash Player 10, AIR 1.5

Distribué lorsque les valeurs sont modifiées soit par programmation, soit par interaction de l’utilisateur.

Puisqu’une modification de programmation déclenche cet événement, assurez-vous que les gestionnaires d’événements valueCommit ne modifient pas une valeur qui entraîne un autre événement valueCommit. Par exemple, ne modifiez pas la propriété selectedValue ou sélection d’un gestionnaire d’événements valueCommit.

La constante FlexEvent.VALUE_COMMIT définit la valeur de la propriété type de l’objet d’événement d’un événement valueCommit.

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`.
`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"?>
<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>

Informations juridiques | Politique de confidentialité en ligne

RadioButtonGroup - AS3 Flex

Packagesx

Eléments du langage

Annexes

Package spark.components

enabled

numRadioButtons

selectedValue

selection