Language Version : | ActionScript 3.0 |
Runtime Versions : | 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.
Show MXML Syntax
Hide MXML Syntax 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"
/>
enabled:Boolean
Language Version : | ActionScript 3.0 |
Runtime Versions : | 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.
The default value is true
.
Implementation public function get enabled():Boolean
public function set enabled(value:Boolean):void
numRadioButtons:int
[read-only]
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The number of RadioButtons that belong to this RadioButtonGroup.
The default value is "0"
.
This property can be used as the source for data binding.
Implementation public function get numRadioButtons():int
selectedValue:Object
Language Version : | ActionScript 3.0 |
Runtime Versions : | 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.
The default value is null
.
This property can be used as the source for data binding.
Implementation public function get selectedValue():Object
public function set selectedValue(value:Object):void
selection:RadioButton
Language Version : | ActionScript 3.0 |
Runtime Versions : | 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.
The default value is null
.
This property can be used as the source for data binding.
Implementation public function get selection():RadioButton
public function set selection(value:RadioButton):void
public function RadioButtonGroup(document:IFlexDisplayObject = null)
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Constructor.
Parameters | document:IFlexDisplayObject (default = null ) — In simple cases where a class extends EventDispatcher,
the document parameter should not be used.
|
See also
flash.events.EventDispatcher
public function getRadioButtonAt(index:int):RadioButton
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Returns the RadioButton component at the specified index.
Parameters
| index:int — The 0-based index of the RadioButton in the
RadioButtonGroup.
|
Returns | RadioButton — The specified RadioButton component if index is between
0 and numRadioButtons - 1. Returns
null if the index is invalid.
|
See also
numRadioButtons
public function initialized(document:Object, id:String):void
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Implementation of the IMXMLObject.initialized()
method
to support deferred instantiation.
Parameters
| 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.
|
See also
Event Object Type: flash.events.Event
Event.type property = flash.events.Event.CHANGE
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Dispatched when the value of the selected RadioButton component in
this group changes.
Event Object Type: mx.events.ItemClickEvent
ItemClickEvent.type property = mx.events.ItemClickEvent.ITEM_CLICK
Language Version : | ActionScript 3.0 |
Runtime Versions : | 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. |
Event Object Type: mx.events.FlexEvent
FlexEvent.type property = mx.events.FlexEvent.VALUE_COMMIT
Language Version : | ActionScript 3.0 |
Runtime Versions : | 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. |
Mon Jul 9 2012, 07:18 PM -04:00