Google Git
Sign in
apache / flex-site / trunk / . / content / asdoc / mx / controls / RadioButtonGroup.html
blob: beb0a896474b1cc6b7bf30a9792c957639762344 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!-- saved from url=(0014)about:internet --><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><link rel="stylesheet" href="../../style.css" type="text/css" media="screen"><link rel="stylesheet" href="../../print.css" type="text/css" media="print"><link rel="stylesheet" href="../../override.css" type="text/css"><meta name="keywords" content="RadioButtonGroup,mx.controls.RadioButtonGroup,BOTTOM,BOTTOM,BYTES,CANCEL,CENTER,COLUMN_AXIS,COMPUTER,COMPUTER,COMPUTER,COMPUTER,DIRECTORIES_FIRST,DIRECTORIES_ONLY,EVENT,FILES_AND_DIRECTORIES,FILES_FIRST,FILES_ONLY,HEADER_ICON_PART,HEADER_TEXT_PART,KILOBYTES,LEFT,LEFT,LEFT,MANUAL,NO,NONMODAL,OK,OLAP_DIMENSION,OLAP_HIERARCHY,OLAP_LEVEL,OLAP_MEMBER,POLLED,RIGHT,RIGHT,RIGHT,ROW_AXIS,SLICER_AXIS,TOP,TOP,YES,alignToolTip,allowDisjointSelection,allowMultipleSelection,anchorColumnIndex,arrowButtonStyleFilters,autoBandWidthDetection,autoLoad,autoPlay,autoRepeat,autoRewind,autoStop,automationDelegate,automationEnabled,automationName,automationOwner,automationParent,automationTabularData,automationValue,automationVisible,backHistory,backHistory,boldToolTip,border,borderMetrics,borderMetrics,bufferTime,bulletToolTip,buttonFlags,buttonHeight,buttonWidth,bytesLoaded,bytesLoaded,bytesTotal,bytesTotal,calendarLayoutStyleFilters,canNavigateBack,canNavigateBack,canNavigateDown,canNavigateDown,canNavigateForward,canNavigateForward,canNavigateUp,canNavigateUp,cancelLabel,caretColumnIndex,cellSelectionTweens,childAllowsParent,closeOnActivity,collection,colorField,colorPickerToolTip,columns,columns,condenseWhite,condenseWhite,condenseWhite,content,contentHeight,contentHeight,contentWidth,contentWidth,conversion,creationDateColumn,cuePointManager,cuePointManagerClass,cuePoints,data,data,data,data,data,data,data,data,data,data,dataDescriptor,dataDescriptor,dataDescriptor,dataDescriptor,dataDescriptor,dataProvider,dataProvider,dataProvider,dataProvider,dataProvider,dataProvider,dataProvider,dataProvider,dataProvider,dateFormatString,dayNames,dayNames,defaultButtonFlag,defaultCellString,defaultLinkProtocol,direction,directory,directory,directory,directory,disabledDays,disabledDays,disabledRanges,disabledRanges,displayAsPassword,displayAsPassword,displayDisclosureIcon,displayItemsExpanded,displayedMonth,displayedMonth,displayedYear,displayedYear,domWindow,downArrowStyleFilters,dragMoveEnabled,draggableColumns,draggableColumns,dropDownStyleFilters,dropdown,dropdown,dropdownFactory,dropdownFactory,dropdownWidth,editable,editable,editable,editable,editable,editable,editedItemPosition,editedItemPosition,editedItemPosition,editedItemRenderer,editedItemRenderer,editedItemRenderer,editorDataField,editorHeightOffset,editorUsesEnterKey,editorWidthOffset,editorXOffset,editorYOffset,emphasized,enableIME,enableIME,enableIME,enableIME,enableIME,enableIME,enableIME,enabled,enabledField,enumerationMode,enumerationMode,enumerationMode,extensions,extensions,extensions,filterFunction,filterFunction,filterFunction,firstDayOfWeek,firstDayOfWeek,firstVisibleItem,firstVisibleItem,fontContext,fontContext,fontContext,fontContext,fontFamilyToolTip,fontSizeToolTip,formatString,forwardHistory,forwardHistory,group,groupIconFunction,groupItemRenderer,groupLabelFunction,groupName,groupRowHeight,groupedColumns,hasRoot,hasRoot,hasRoot,hasRoot,headerInfoInitialized,headerRendererProviders,hierarchicalCollectionView,highlightColumnIndex,historyLength,historyPosition,horizontalScrollPolicy,horizontalScrollPosition,horizontalScrollPosition,horizontalScrollPosition,horizontalScrollPosition,horizontalScrollPosition,htmlHost,htmlLoader,htmlLoaderFactory,htmlText,htmlText,htmlText,htmlText,htmlText,iconClass,iconField,iconField,iconField,iconFunction,icons,idleTimeout,imeMode,imeMode,imeMode,imeMode,imeMode,imeMode,imeMode,imeMode,indent,indeterminate,initialized,inputFieldStyleFilters,isKeyPressed,italicToolTip,itemEditor,itemEditorInstance,itemEditorInstance,itemEditorInstance,itemIcons,itemIcons,itemRenderer,itemRendererProviders,iterator,keyEquivalentField,keyEquivalentFunction,keyEquivalentModifiersFunction,label,label,labelField,labelField,labelField,labelField,labelField,labelField,labelFunction,labelFunction,labelFunction,labelFunction,labelFunction,labelFunction,labelPlacement,labelPlacement,labelPlacement,labelPlacement,length,length,linkToolTip,listData,listData,listData,listData,listData,listData,listData,listData,listData,listData,live,loadForCompatibility,loaded,loaderContext,location,lockedColumnCount,lockedRowCount,lookAheadDuration,maintainAspectRatio,maintainAspectRatio,maxChars,maxChars,maxChars,maxHorizontalScrollPosition,maxWidth,maxYear,maxYear,maximum,maximum,measuringObjects,menuBarItemRenderer,menuBarItemStyleFilters,menuBarItems,menus,metadata,minColumnWidth,minColumnWidth,minYear,minYear,minimum,minimum,mnemonicIndexField,mnemonicIndexFunction,mode,modificationDateColumn,monthNames,monthNames,monthSymbol,monthSymbol,movieClip,nameColumn,nameCompareFunction,nameCompareFunction,nameCompareFunction,nativeMenu,nestLevel,nextMonthStyleFilters,nextValue,nextYearStyleFilters,noLabel,numAutomationChildren,numRadioButtons,okLabel,openAlways,openItems,openPaths,orderedHeadersList,paintsDefaultBackground,parentAllowsChild,parentDrawsFocus,parentDrawsFocus,parentMenu,parseFunction,pdfCapability,percentComplete,percentLoaded,playheadTime,playheadUpdateInterval,playing,popUp,popUp,prevMonthStyleFilters,prevYearStyleFilters,previousValue,processedDescriptors,progressInterval,prompt,rendererDescriptionMap,rendererIsEditor,rendererProviders,resizableColumns,resizableColumns,restrict,restrict,restrict,rowCount,runtimeApplicationDomain,scaleContent,selectable,selectable,selectable,selectableRange,selectableRange,selected,selectedCells,selectedColor,selectedColumnIndex,selectedDate,selectedDate,selectedField,selectedIndex,selectedIndex,selectedIndex,selectedIndex,selectedIndex,selectedIndex,selectedIndex,selectedItem,selectedItem,selectedLabel,selectedPath,selectedPath,selectedPath,selectedPaths,selectedPaths,selectedPaths,selectedRanges,selectedValue,selection,selection,selectionActivePosition,selectionAnchorPosition,selectionBeginIndex,selectionBeginIndex,selectionEndIndex,selectionEndIndex,showBusyCursor,showControlBar,showExtensions,showExtensions,showExtensions,showHidden,showHidden,showHidden,showIcons,showIcons,showIcons,showIcons,showInAutomationHierarchy,showRoot,showRoot,showRoot,showRoot,showRoot,showTextField,showToday,showToday,showToolTips,sizeColumn,sizeDisplayMode,smoothBitmapContent,sortExpertMode,sortableColumns,sortableColumns,source,source,source,state,stateResponsive,stepSize,stickyHighlighting,styleFunction,styleSheet,styleSheet,swatchStyleFilters,swfBridge,text,text,text,text,text,text,text,textField,textField,textField,textField,textField,textHeight,textHeight,textHeight,textInput,textInputStyleFilters,textWidth,textWidth,textWidth,toggle,toggleOnClick,toolTipField,totalTime,treeColumn,treeColumnIndex,truncateToFit,trustContent,tween,typeColumn,underlineToolTip,upArrowStyleFilters,updateCompletePendingFlag,userAgent,value,value,value,value,verticalScrollPolicy,verticalScrollPosition,videoHeight,videoWidth,visibleCellRenderers,volume,wordWrap,yearNavigationEnabled,yearNavigationEnabled,yearSymbol,yearSymbol,yesLabel,absoluteToDisplayColumnIndex,absoluteToVisibleColumnIndex,absoluteToVisibleIndices,addCellSelectionData,addSortField,adjustListContent,applyCellSelectionEffect,applyUserStylesForItemRenderer,atLeastOneProperty,attachCamera,calculatePreferredSizeFromData,calculatePreferredSizeFromData,cancelLoad,clear,clear,clear,clearCellSelectionData,clearIndicators,clearSelectedCells,clearSeparators,clearSeparators,clickHandler,clickHandler,close,close,close,close,close,closeSubdirectory,colNumToIndex,collapseAll,collectionChangeHandler,commitProperties,createAutomationIDPart,createAutomationIDPartWithRequiredProperties,createBorder,createBorder,createHeaderSeparators,createItemEditor,createItemEditor,createItemEditor,createItemRenderer,createMenu,createNavItem,dateToString,destroyItemEditor,destroyItemEditor,destroyItemEditor,display,displayToAbsoluteColumnIndex,downArrowButton_buttonDownHandler,dragCompleteHandler,dragCompleteHandler,dragDropHandler,dragDropHandler,drawColumnBackground,drawColumnBackground,drawHeaderBackground,drawHeaderBackground,drawHorizontalLine,drawHorizontalLine,drawLinesAndColumnBackgrounds,drawLinesAndColumnBackgrounds,drawLinesAndColumnGraphics,drawRowBackground,drawRowBackground,drawRowBackground,drawSeparators,drawSeparators,drawVerticalLine,drawVerticalLine,drawVerticalLine,endEdit,expandAll,expandChildrenOf,expandChildrenOf,expandItem,expandItem,findHeaderRenderer,findHeaderRenderer,findIndex,findIndex,findIndex,findItem,findItem,findItem,findRenderer,findSortField,finishKeySelection,getAutomationChildAt,getAutomationChildren,getCellRendererInfo,getFieldSortInfo,getFormattedCellValue,getHistoryAt,getIndent,getLineMetrics,getLineMetrics,getLineMetrics,getMenuAt,getParentItem,getParentItem,getRadioButtonAt,getSeparator,getVisibleApplicationRect,gotoAndPlay,gotoAndStop,gotoFirstFrameAndStop,hide,hiliteSelectedNavItem,historyBack,historyForward,historyGo,indexToColNum,initListData,initListData,initialized,invalidateProperties,isCellItemHighlighted,isCellItemSelected,isColumnFullyVisible,isDataEditable,isDraggingAllowed,isItemEditable,isItemEditable,isItemOpen,isItemOpen,itemToIcon,itemToKeyEquivalent,itemToKeyEquivalentModifiers,itemToLabel,itemToLabel,itemToLabel,itemToLabel,itemToMnemonicIndex,itemToUID,layoutChrome,layoutEditor,load,load,makeListData,makeListData,makeListData,measure,measure,measure,measure,menuClickHandler,mouseDownHandler,mouseUpHandler,moveFocusToHeader,moveIndicators,navigateBack,navigateBack,navigateDown,navigateDown,navigateForward,navigateForward,navigateTo,navigateTo,navigateUp,navigateUp,nextFrame,nextScene,open,open,open,open,openSubdirectory,parseLabelToMnemonicIndex,parseLabelToString,pause,placeSortArrow,play,play,popUpMenu,prevFrame,prevScene,refresh,refresh,refresh,reload,removeCellSelectionData,removeSortField,replayAutomatableEvent,resetNavItems,resolveAutomationIDPart,rollOutHandler,rollOverHandler,scrollPositionToIndex,scrollToViewColumn,scrollVertically,selectCellItem,selectColumnHeader,selectItem,selectRange,setContextMenu,setContextMenu,setItemIcon,setItemIcon,setMenuItemToggled,setProgress,setSelection,setSelection,shortMonthName,show,show,showBorderAndBackground,showBorderAndBackground,stop,stop,stringToDate,styleChanged,styleChanged,textInput_changeHandler,treeNavigationHandler,unloadAndStop,unselectColumnHeader,unsetContextMenu,unsetContextMenu,updateBackground,updateDisplayList,updateDisplayList,updateNavItemIcon,updateNavItemLabel,validateDisplayList,validateNow,validateProperties,validateSize,visibleToAbsoluteColumnIndex"><title>mx.controls.RadioButtonGroup</title><script src="../../AC_OETags.js" type="text/javascript"></script></head><body><script language="javascript" type="text/javascript" src="../../asdoc.js"></script><script language="javascript" type="text/javascript" src="../../help.js"></script><script language="javascript" type="text/javascript" src="../../cookies.js"></script><script language="javascript" type="text/javascript"><!--
asdocTitle = 'RadioButtonGroup - ApacheFlex API Reference';
var baseRef = '../../';
window.onload = configPage;
--></script>
<script type="text/javascript">
scrollToNameAnchor();
</script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">Apache Flex 4.16.1 API Reference </td><td class="titleTableTopNav" align="right"><a href="../../package-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Packages</a>&nbsp;|&nbsp;<a href="../../class-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Classes</a>&nbsp;|&nbsp;<a href="../../all-index-A.html" onclick="loadClassListFrame('../../index-list.html')">Index</a>&nbsp;|&nbsp;<a id="framesLink1" href="../../index.html?mx/controls/RadioButtonGroup.html&amp;mx/controls/class-list.html">Frames</a><a id="noFramesLink1" style="display:none" href="" onclick="parent.location=document.location"> No Frames </a></td><td class="titleTableLogo" align="right" rowspan="3"><img src="../../images/logo.jpg" class="logoImage" alt="AdobeLogo" title="AdobeLogo"></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">RadioButtonGroup</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a>&nbsp;| <a href="#eventSummary">Events</a>&nbsp;| <a href="#includeExamplesSummary">Examples</a></td></tr><tr class="titleTableRow3"><td colspan="3">&nbsp;</td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("RadioButtonGroup"); titleBar_setSubNav(false,true,false,false,false,false,true,false,true,true,false ,false,false,false,false,false);}
-->
</script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">mx.controls</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class RadioButtonGroup</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">RadioButtonGroup <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> flash.events.EventDispatcher</td></tr><tr><td class="classHeaderTableLabel">Implements</td><td> <a href="../../mx/core/IMXMLObject.html">IMXMLObject</a></td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p></p><br/><table width="100%" class="innertable"><tr><td bgcolor="#FFFFCC"><img src="../../images/P_AlternativeMetadataIndicator_30x28_N.png"></td><td bgcolor="#FFFFCC">Starting with Flex 4.0, Apache recommends that you use the <a href="../../spark/components/RadioButtonGroup.html">spark.components.RadioButtonGroup</a> class as an alternative to this class.</td></tr></table><br/><p></p>
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.
<p>The <code>id</code> property is required when you use the
<code>&lt;mx:RadioButtonGroup&gt;</code> tag to define the name
of the group.</p>
<p>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.</p>
<p>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.</p>
<p></p><a name="mxmlSyntaxSummary"></a><span class="classHeaderTableLabel">MXML Syntax</span><span id="showMxmlLink" style="display:none"><a href="#mxmlSyntaxSummary" onclick="toggleMXMLOnly();"><img src="../../images/collapsed.gif" title="collapsed" alt="collapsed" class="collapsedImage">Show MXML Syntax</a><br/></span><span id="hideMxmlLink"><a href="#mxmlSyntaxSummary" onclick="toggleMXMLOnly();"><img src="../../images/expanded.gif" title="expanded" alt="expanded" class="expandedImage">Hide MXML Syntax</a></span><div id="mxmlSyntax" class="mxmlSyntax"> <p>The <code>&lt;mx:RadioButtonGroup&gt;</code> tag inherits all of the
tag attributes of its superclass, and adds the following tag attributes:</p>
<pre>
&lt;mx:RadioButtonGroup
<strong>Properties</strong>
enabled="true|false"
id="<i>No default</i>"
labelPlacement="right|left|top|bottom"
<strong>Events</strong>
change="<i>No default</i>"
itemClick="<i>No default</i>"
/&gt;
</pre>
</div><script language="javascript" type="text/javascript"><!--
setMXMLOnly();
--></script><p><a href="#includeExamplesSummary">View the examples</a></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="RadioButton.html" target="">mx.controls.RadioButton</a></div><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProperty"><tr><th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#enabled" class="signatureLink">enabled</a> : Boolean<div class="summaryTableDescription">
Determines whether selection is allowed.</div></td><td class="summaryTableOwnerCol">RadioButtonGroup</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#labelPlacement" class="signatureLink">labelPlacement</a> : String<div class="summaryTableDescription">
Position of the RadioButton label relative to the RadioButton icon
for each control in the group.</div></td><td class="summaryTableOwnerCol">RadioButtonGroup</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#numRadioButtons" class="signatureLink">numRadioButtons</a> : int<div class="summaryTableDescription">[read-only]
The number of RadioButtons that belong to this RadioButtonGroup.</div></td><td class="summaryTableOwnerCol">RadioButtonGroup</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#selectedValue" class="signatureLink">selectedValue</a> : Object<div class="summaryTableDescription">
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).</div></td><td class="summaryTableOwnerCol">RadioButtonGroup</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#selection" class="signatureLink">selection</a> : <a href="../../mx/controls/RadioButton.html">RadioButton</a><div class="summaryTableDescription">
Contains a reference to the currently selected
RadioButton control in the group.</div></td><td class="summaryTableOwnerCol">RadioButtonGroup</td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#RadioButtonGroup()" class="signatureLink">RadioButtonGroup</a>(document:<a href="../../mx/core/IFlexDisplayObject.html">IFlexDisplayObject</a> = null)</div><div class="summaryTableDescription">
Constructor.</div></td><td class="summaryTableOwnerCol">RadioButtonGroup</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getRadioButtonAt()" class="signatureLink">getRadioButtonAt</a>(index:int):<a href="../../mx/controls/RadioButton.html">RadioButton</a></div><div class="summaryTableDescription">
Returns the RadioButton control at the specified index.</div></td><td class="summaryTableOwnerCol">RadioButtonGroup</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#initialized()" class="signatureLink">initialized</a>(document:Object, id:String):void</div><div class="summaryTableDescription">
Implementation of the IMXMLObject.initialized() method
to support deferred instantiation.</div></td><td class="summaryTableOwnerCol">RadioButtonGroup</td></tr></table></div><a name="eventSummary"></a><div class="summarySection"><div class="summaryTableTitle">Events</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableEvent"><tr><th>&nbsp;</th><th colspan="2">Event</th><th> Summary </th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:change" class="signatureLink">change</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when the value of the selected RadioButton control in this group changes.</td><td class="summaryTableOwnerCol">RadioButtonGroup</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:itemClick" class="signatureLink">itemClick</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when a user selects a RadioButton control in the group.</td><td class="summaryTableOwnerCol">RadioButtonGroup</td></tr></table></div><script language="javascript" type="text/javascript"><!--
showHideInherited();
--></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</div><a name="propertyDetail"></a><a name="enabled"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">enabled</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>enabled:Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
Determines whether selection is allowed.
</p><p> The default value is <code>true</code>.</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get enabled():Boolean</code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set enabled(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="labelPlacement"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">labelPlacement</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>labelPlacement:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
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.
<p>Valid values in MXML are <code>"right"</code>, <code>"left"</code>,
<code>"bottom"</code>, and <code>"top"</code>. </p>
<p>In ActionScript, you use the following constants to set this property:
<code>ButtonLabelPlacement.RIGHT</code>, <code>ButtonLabelPlacement.LEFT</code>,
<code>ButtonLabelPlacement.BOTTOM</code>, and <code>ButtonLabelPlacement.TOP</code>.</p>
</p><p> The default value is <code>"right"</code>.</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get labelPlacement():String</code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set labelPlacement(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="numRadioButtons"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">numRadioButtons</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>numRadioButtons:int</code>&nbsp;&nbsp;[read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
The number of RadioButtons that belong to this RadioButtonGroup.
</p><p> The default value is <code>"undefined"</code>.</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get numRadioButtons():int</code><br/></div><a name="propertyDetail"></a><a name="selectedValue"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">selectedValue</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>selectedValue:Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
The value of the <code>value</code> property of the selected
RadioButton control in the group, if this has been set
to be something other than <code>null</code> (the default value).
Otherwise, <code>selectedValue</code> is the value of the
<code>label</code> property of the selected RadioButton.
If no RadioButton is selected, this property is <code>null</code>.
<p>If you set <code>selectedValue</code>, Flex selects the
RadioButton control whose <code>value</code> or
<code>label</code> property matches this value.</p>
</p><p> The default value is <code>null</code>.</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get selectedValue():Object</code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set selectedValue(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="selection"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">selection</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>selection:<a href="../../mx/controls/RadioButton.html">RadioButton</a></code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
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 <code>null</code> deselects the currently selected RadioButton control.
</p><p> The default value is <code>null</code>.</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get selection():<a href="../../mx/controls/RadioButton.html">RadioButton</a></code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set selection(value:<a href="../../mx/controls/RadioButton.html">RadioButton</a>):void</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="RadioButtonGroup()"></a><a name="RadioButtonGroup(mx.core.IFlexDisplayObject)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">RadioButtonGroup</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function RadioButtonGroup(document:<a href="../../mx/core/IFlexDisplayObject.html">IFlexDisplayObject</a> = null)</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p>
Constructor.
</p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">document</span>:<a href="../../mx/core/IFlexDisplayObject.html">IFlexDisplayObject</a></code> (default = <code>null</code>)<code></code> &mdash; In simple cases where a class extends EventDispatcher,
the <code>document</code> parameter should not be used.
</td></tr></table><p><span class="label">See also</span></p><div class="seeAlso">flash.events.EventDispatcher</div></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="getRadioButtonAt()"></a><a name="getRadioButtonAt(int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getRadioButtonAt</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function getRadioButtonAt(index:int):<a href="../../mx/controls/RadioButton.html">RadioButton</a></code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
Returns the RadioButton control at the specified index.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">index</span>:int</code> &mdash; The index of the RadioButton control in the
RadioButtonGroup control, where the index of the first control is 0.
</td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code><a href="../../mx/controls/RadioButton.html">RadioButton</a></code> &mdash; The specified RadioButton control.
</td></tr></table></div><a name="initialized()"></a><a name="initialized(Object,String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">initialized</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function initialized(document:Object, id:String):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
Implementation of the <code>IMXMLObject.initialized()</code> method
to support deferred instantiation.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">document</span>:Object</code> &mdash; The MXML document that created this object.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">id</span>:String</code> &mdash; The identifier used by document to refer to this object.
If the object is a deep property on document, <code>id</code> is null.
</td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../mx/core/IMXMLObject.html" target="">mx.core.IMXMLObject</a></div></div><div class="detailSectionHeader"> Event Detail </div><a name="event:change"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">change</td><td class="detailHeaderType"> Event </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><code>flash.events.Event</code><br/><span class="label">Event.type property = </span><code>flash.events.Event.CHANGE</code><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
Dispatched when the value of the selected RadioButton control in
this group changes.
</p></div><a name="event:itemClick"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">itemClick</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/ItemClickEvent.html"><code>mx.events.ItemClickEvent</code></a><br/><span class="label">ItemClickEvent.type property = </span><a href="../../mx/events/ItemClickEvent.html#ITEM_CLICK"><code>mx.events.ItemClickEvent.ITEM_CLICK</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
Dispatched when a user selects a RadioButton control in the group.
You can also set a handler for individual RadioButton controls.
</p>
The <code>ItemClickEvent.ITEM_CLICK</code> constant defines the value of the
<code>type</code> property of the event object for an <code>itemClick</code> event.
<p>The properties of the event object have the following values:</p>
<table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the
event listener that handles the event. For example, if you use
<code>myButton.addEventListener()</code> to register an event listener,
myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>index</code></td><td>The index of the navigation item that was clicked.</td></tr><tr><td><code>item</code></td><td>The item in the data provider of the navigation
item that was clicked.</td></tr><tr><td><code>label</code></td><td>The label of the navigation item that was clicked.</td></tr><tr><td><code>relatedObject</code></td><td>The child object that generated the event.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event;
it is not always the Object listening for the event.
Use the <code>currentTarget</code> property to always access the
Object listening for the event.</td></tr></table>
</div><a name="includeExamplesSummary"></a><div class="detailSectionHeader">Examples</div><div class="exampleHeader">RadioButtonGroupExample.mxml</div><div class="detailBody"><div class="listing"><pre>&lt;?xml version="1.0" encoding="utf-8"?&gt;
&lt;!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
--&gt;
&lt;!-- Simple example to demonstrate Halo RadioButtonGroup control. --&gt;
&lt;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"&gt;
&lt;fx:Script&gt;
&lt;![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;
}
}
]]&gt;
&lt;/fx:Script&gt;
&lt;fx:Declarations&gt;
&lt;mx:RadioButtonGroup id="cardtype" itemClick="handleCard(event);"/&gt;
&lt;/fx:Declarations&gt;
&lt;s:Panel title="Halo RadioButtonGroup Control Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0"&gt;
&lt;s:VGroup left="10" right="10" top="10" bottom="10"&gt;
&lt;s:Label width="100%" color="blue"
text="Select a type of credit card."/&gt;
&lt;mx:RadioButton groupName="cardtype" id="americanExpress" value="AmEx"
label="American Express" width="150" /&gt;
&lt;mx:RadioButton groupName="cardtype" id="masterCard" value="MC"
label="MasterCard" width="150" /&gt;
&lt;mx:RadioButton groupName="cardtype" id="visa" value="Visa"
label="Visa" width="150" /&gt;
&lt;/s:VGroup&gt;
&lt;/s:Panel&gt;
&lt;/s:Application&gt;
</pre></div><script language="javascript" type="text/javascript"><!-- AC_FL_RunContent( "src", "examples/RadioButtonGroupExample", "width", "100%",
"height","400px", "salign", "TL", "id", "example1", "quality", "high", "bgcolor", "", "name",
"example1", "flashvars","", "allowScriptAccess","sameDomain", "type",
"application/x-shockwave-flash","pluginspage", "http://www.macromedia.com/go/getflashplayer" ); --></script></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>The Apache Software Foundation</footer><br/>Wed Nov 15 2017, 09:50 AM +01:00 </center></div></body></html><!--The Apache Software Foundation<br/>Wed Nov 15 2017, 09:50 AM +01:00 -->