| Package | feathers.controls |
| Class | public class Radio |
| Inheritance | Radio  Button FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object |
| Implements | IGroupedToggle |
See also
| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number The opacity of the object. | DisplayObject | |
| autoFlatten : Boolean
Determines if the button should automatically call flatten()
after it finishes drawing. | Button | |
| base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject | |
| blendMode : String The blend mode determines how the object is blended with the objects underneath. | DisplayObject | |
| bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject | |
| clipRect : Rectangle [override] | FeathersControl | |
| defaultIcon : DisplayObject
The icon used when no other icon is defined for the current state. | Button | |
| defaultLabelProperties : Object
The default label properties are a set of key/value pairs to be
passed down ot the button's label instance, and it is used when no
other properties are defined for the button's current state. | Button | |
| defaultSelectedIcon : DisplayObject
The icon used when no other icon is defined for the current state
when the button is selected. | Button | |
| defaultSelectedLabelProperties : Object
The default selected label properties are a set of key/value pairs to
be passed down ot the button's label instance, and it is used when
the button is selected and no other properties are defined for the
button's current state. | Button | |
| defaultSelectedSkin : DisplayObject
The skin used when no other skin is defined for the current state
when the button is selected. | Button | |
| defaultSkin : DisplayObject
The skin used when no other skin is defined for the current state. | Button | |
| defaultTextEditorFactory : Function [static]
A function used by all UI controls that support text editor to
create an ITextEditor instance. | FeathersControl | |
| defaultTextRendererFactory : Function [static]
A function used by all UI controls that support text renderers to
create an ITextRenderer instance. | FeathersControl | |
| disabledIcon : DisplayObject
The icon used for the button's disabled state. | Button | |
| disabledLabelProperties : Object
A set of key/value pairs to be passed down ot the button's label
instance when the button is in the disabled state. | Button | |
| disabledSkin : DisplayObject
The skin used for the button's disabled state. | Button | |
| downIcon : DisplayObject
The icon used for the button's down state. | Button | |
| downLabelProperties : Object
A set of key/value pairs to be passed down ot the button's label
instance when the button is in the down state. | Button | |
| downSkin : DisplayObject
The skin used for the button's down state. | Button | |
| filter : FragmentFilter The filter that is attached to the display object. | DisplayObject | |
| focusManager : IFocusManager
The current focus manager for this component. | FeathersControl | |
| gap : Number
The space, in pixels, between the icon and the label. | Button | |
| hasVisibleArea : Boolean [read-only] Indicates if an object occupies any visible area. | DisplayObject | |
| height : Number [override]
The height of the component, in pixels. | FeathersControl | |
| horizontalAlign : String
The location where the button's content is aligned horizontally (on
the x-axis). | Button | |
| hoverIcon : DisplayObject
The icon used for the button's hover state. | Button | |
| hoverLabelProperties : Object
A set of key/value pairs to be passed down ot the button's label
instance when the button is in the hover state. | Button | |
| hoverSkin : DisplayObject
The skin used for the button's hover state. | Button | |
| iconOffsetX : Number
Offsets the x position of the icon by a certain number of pixels. | Button | |
| iconOffsetY : Number
Offsets the y position of the icon by a certain number of pixels. | Button | |
| iconPosition : String
The location of the icon, relative to the label. | Button | |
| includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
| isEnabled : Boolean [override]
| Button | |
| isFlattened : Boolean [read-only] Indicates if the sprite was flattened. | Sprite | |
| isFocusEnabled : Boolean
Determines if this component can receive focus. | FeathersControl | |
| isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
| isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
| isSelected : Boolean
Indicates if the button is selected or not. | Button | |
| keepDownStateOnRollOut : Boolean = false
Determines if a pressed button should remain in the down state if a
touch moves outside of the button's bounds. | Button | |
| label : String
The text displayed on the button. | Button | |
| labelFactory : Function
A function used to instantiate the button's label subcomponent. | Button | |
| labelOffsetX : Number
Offsets the x position of the label by a certain number of pixels. | Button | |
| labelOffsetY : Number
Offsets the y position of the label by a certain number of pixels. | Button | |
| layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
| maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| maxWidth : Number
The maximum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| minHeight : Number
The minimum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| minTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's
height is smaller than this value, it will be expanded. | FeathersControl | |
| minTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's
width is smaller than this value, it will be expanded. | FeathersControl | |
| minWidth : Number
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| name : String [override]
The concatenated nameList, with each name separated by
spaces. | FeathersControl | |
| nameList : TokenList [read-only]
Contains a list of all "names" assigned to this control. | FeathersControl | |
| nextTabFocus : IFocusDisplayObject
The next object that will receive focus when the tab key is pressed. | FeathersControl | |
| numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer | |
| padding : Number
Quickly sets all padding properties to the same value. | Button | |
| paddingBottom : Number
The minimum space, in pixels, between the button's bottom edge and
the button's content. | Button | |
| paddingLeft : Number
The minimum space, in pixels, between the button's left edge and the
button's content. | Button | |
| paddingRight : Number
The minimum space, in pixels, between the button's right edge and the
button's content. | Button | |
| paddingTop : Number
The minimum space, in pixels, between the button's top edge and the
button's content. | Button | |
| parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject | |
| pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject | |
| rotation : Number The rotation of the object in radians. | DisplayObject | |
| scaleX : Number The horizontal scale factor. | DisplayObject | |
| scaleY : Number The vertical scale factor. | DisplayObject | |
| selectedDisabledIcon : DisplayObject
The icon used for the button's disabled state when the button is
selected. | Button | |
| selectedDisabledLabelProperties : Object
A set of key/value pairs to be passed down ot the button's label
instance when the button is in the disabled state and is selected. | Button | |
| selectedDisabledSkin : DisplayObject
The skin used for the button's disabled state when the button is
selected. | Button | |
| selectedDownIcon : DisplayObject
The icon used for the button's down state when the button is
selected. | Button | |
| selectedDownLabelProperties : Object
A set of key/value pairs to be passed down ot the button's label
instance when the button is in the down state and is selected. | Button | |
| selectedDownSkin : DisplayObject
The skin used for the button's down state when the button is
selected. | Button | |
| selectedHoverIcon : DisplayObject
The icon used for the button's hover state when the button is
selected. | Button | |
| selectedHoverLabelProperties : Object
A set of key/value pairs to be passed down ot the button's label
instance when the button is in the hover state and is selected. | Button | |
| selectedHoverSkin : DisplayObject
The skin used for the button's hover state when the button is
selected. | Button | |
| selectedUpIcon : DisplayObject
The icon used for the button's up state when the button is
selected. | Button | |
| selectedUpLabelProperties : Object
A set of key/value pairs to be passed down ot the button's label
instance when the button is in the up state and is selected. | Button | |
| selectedUpSkin : DisplayObject
The skin used for the button's up state when the button is selected. | Button | |
| skewX : Number The horizontal skew angle in radians. | DisplayObject | |
| skewY : Number The vertical skew angle in radians. | DisplayObject | |
| stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected
to the stage. | DisplayObject | |
| stateToIconFunction : Function
Returns an icon for the current state. | Button | |
| stateToLabelPropertiesFunction : Function
Returns a text format for the current state. | Button | |
| stateToSkinFunction : Function
Returns a skin for the current state. | Button | |
| toggleGroup : ToggleGroup
The group that the toggle has been added to. | Radio | ||
| touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
| transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject | |
| upIcon : DisplayObject
The icon used for the button's up state. | Button | |
| upLabelProperties : Object
A set of key/value pairs to be passed down ot the button's label
instance when the button is in the up state. | Button | |
| upSkin : DisplayObject
The skin used for the button's up state. | Button | |
| useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject | |
| verticalAlign : String
The location where the button's content is aligned vertically (on
the y-axis). | Button | |
| visible : Boolean The visibility of the object. | DisplayObject | |
| width : Number [override]
The width of the component, in pixels. | FeathersControl | |
| x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| Method | Defined By | ||
|---|---|---|---|
Radio()
Constructor. | Radio | ||
| Adds a child to the container. | DisplayObjectContainer | |
| Adds a child to the container at a certain index. | DisplayObjectContainer | |
| addEventListener(type:String, listener:Function):void [override] | DisplayObject | |
| alignPivot(hAlign:String = center, vAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system
of the object. | DisplayObject | |
| broadcastEvent(event:Event):void Dispatches an event on all children (recursively). | DisplayObjectContainer | |
| broadcastEventWith(type:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively). | DisplayObjectContainer | |
| contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively). | DisplayObjectContainer | |
| dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher | |
| dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered
listeners for the given type. | EventDispatcher | |
| dispose():void [override] Disposes the resources of all children. | Sprite | |
| flatten():void Optimizes the sprite for optimal rendering performance. | Sprite | |
| getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Returns a rectangle that completely encloses the object as it appears in another
coordinate system. | Sprite | |
| getChildAt(index:int):DisplayObject Returns a child object at a certain index. | DisplayObjectContainer | |
| getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively). | DisplayObjectContainer | |
| getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found. | DisplayObjectContainer | |
| getClipRect(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle Returns the bounds of the container's clipRect in the given coordinate space, or
null if the sprite doens't have a clipRect. | Sprite | |
| getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
| globalToLocal(globalPoint:Point, resultPoint:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
| hasEventListener(type:String):Boolean Returns if there are listeners registered for a certain event type. | EventDispatcher | |
| hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil if
the test fails. | Sprite | |
| invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending. | FeathersControl | |
| isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not. | FeathersControl | |
| localToGlobal(localPoint:Point, resultPoint:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
| Removes a child from the container. | DisplayObjectContainer | |
| removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index. | DisplayObjectContainer | |
| removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included). | DisplayObjectContainer | |
| removeEventListener(type:String, listener:Function):void [override] | DisplayObject | |
| removeEventListeners(type:String = null):void [override] | DisplayObject | |
| removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject | |
| render(support:RenderSupport, parentAlpha:Number):void [override] Renders the display object with the help of a support object. | Sprite | |
| setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer | |
| setSize(width:Number, height:Number):void
Sets both the width and the height of the control. | FeathersControl | |
| sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function
of the Vector class). | DisplayObjectContainer | |
| Swaps the indexes of two children. | DisplayObjectContainer | |
| swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer | |
| unflatten():void Removes the rendering optimizations that were created when flattening the sprite. | Sprite | |
| validate():void
Immediately validates the control, which triggers a redraw, if one
is pending. | FeathersControl | |
| Constant | Defined By | ||
|---|---|---|---|
| DEFAULT_CHILD_NAME_LABEL : String = feathers-button-label [static]
The default value added to the nameList of the label. | Button | |
| defaultRadioGroup : ToggleGroup [static]
If a Radio has not been added to a ToggleGroup,
it will automatically be added to this group. | Radio | ||
| HORIZONTAL_ALIGN_CENTER : String = center [static]
The icon and label will be aligned horizontally to the center of the button. | Button | |
| HORIZONTAL_ALIGN_LEFT : String = left [static]
The icon and label will be aligned horizontally to the left edge of the button. | Button | |
| HORIZONTAL_ALIGN_RIGHT : String = right [static]
The icon and label will be aligned horizontally to the right edge of the button. | Button | |
| ICON_POSITION_BOTTOM : String = bottom [static]
The icon will be positioned below the label. | Button | |
| ICON_POSITION_LEFT : String = left [static]
The icon will be positioned to the left of the label. | Button | |
| ICON_POSITION_LEFT_BASELINE : String = leftBaseline [static]
The icon will be positioned to the left the label, and the bottom of
the icon will be aligned to the baseline of the label text. | Button | |
| ICON_POSITION_MANUAL : String = manual [static]
The icon will be positioned manually with no relation to the position
of the label. | Button | |
| ICON_POSITION_RIGHT : String = right [static]
The icon will be positioned to the right of the label. | Button | |
| ICON_POSITION_RIGHT_BASELINE : String = rightBaseline [static]
The icon will be positioned to the right the label, and the bottom of
the icon will be aligned to the baseline of the label text. | Button | |
| ICON_POSITION_TOP : String = top [static]
The icon will be positioned above the label. | Button | |
| INVALIDATION_FLAG_ALL : String = all [static]
Flag to indicate that everything is invalid and should be redrawn. | FeathersControl | |
| INVALIDATION_FLAG_DATA : String = data [static]
Invalidation flag to indicate that the primary data displayed by the
UI control has changed. | FeathersControl | |
| INVALIDATION_FLAG_LAYOUT : String = layout [static]
Invalidation flag to indicate that the layout of the UI control has
changed. | FeathersControl | |
| INVALIDATION_FLAG_SCROLL : String = scroll [static]
Invalidation flag to indicate that the scroll position of the UI
control has changed. | FeathersControl | |
| INVALIDATION_FLAG_SELECTED : String = selected [static]
Invalidation flag to indicate that the selection of the UI control
has changed. | FeathersControl | |
| INVALIDATION_FLAG_SIZE : String = size [static]
Invalidation flag to indicate that the dimensions of the UI control
have changed. | FeathersControl | |
| INVALIDATION_FLAG_SKIN : String = skin [static]
Invalidation flag to indicate that the skin of the UI control has changed. | FeathersControl | |
| INVALIDATION_FLAG_STATE : String = state [static]
Invalidation flag to indicate that the state has changed. | FeathersControl | |
| INVALIDATION_FLAG_STYLES : String = styles [static]
Invalidation flag to indicate that the styles or visual appearance of
the UI control has changed. | FeathersControl | |
| VERTICAL_ALIGN_BOTTOM : String = bottom [static]
The icon and label will be aligned vertically to the bottom edge of the button. | Button | |
| VERTICAL_ALIGN_MIDDLE : String = middle [static]
The icon and label will be aligned vertically to the middle of the button. | Button | |
| VERTICAL_ALIGN_TOP : String = top [static]
The icon and label will be aligned vertically to the top edge of the button. | Button | |
| toggleGroup | property |
Hide Inherited Public Properties
Show Inherited Public PropertiestoggleGroup:ToggleGroupThe group that the toggle has been added to.
public function get toggleGroup():ToggleGroup public function set toggleGroup(value:ToggleGroup):void| Radio | () | Constructor |
public function Radio()Constructor.
| defaultRadioGroup | Constant |
public static const defaultRadioGroup:ToggleGroup
If a Radio has not been added to a ToggleGroup,
it will automatically be added to this group. If the Radio's
toggleGroup property is set to a different group, it
will be automatically removed from this group, if required.