F > FRadioButton (component)

 

FRadioButton (component)

Radio buttons are groups of selectable buttons from which only one button can be selected at a time. The RadioButton component in the Flash authoring environment provides drag-and-drop functionality for adding groups of radio buttons to Flash documents; it also provides a user interface for setting basic parameters. The methods of the FRadioButton component allow you to control radio buttons at runtime: you can create radio buttons, control radio buttons created in authoring, set or override basic parameters, and set additional runtime options. You do not need to use a constructor to access the methods of components.

The RadioButton component is supported by Flash Player 6 and later versions of the Flash Player.

Component methods do not perform error checking for type, as do other native ActionScript objects and actions; therefore, it is recommended that you validate parameters before passing them to methods.

For information on using the RadioButton component, setting parameters during authoring, and changing the color and appearance of components, see Customizing component colors and textand Customizing component skins in the Using Components chapter of Using Flash.

 
Method summary for the FRadioButton component

Method

Description

FRadioButton.getData

Returns a data value for a radio button instance.

FRadioButton.getEnabled

Returns true if the radio button is enabled, false if it is disabled.

FRadioButton.getLabel

Returns the radio button label as a string.

FRadioButton.getState

Returns the selected state of a radio button instance.

FRadioButton.getValue

Returns the data value of the selected radio button in a group, or returns the label if no data is specified.

FRadioButton.registerSkinElement

Registers a skin element to a style property.

FRadioButton.setChangeHandler

Specifies a function to call when the radio button selection changes.

FRadioButton.setData

Sets the data associated with a radio button instance.

FRadioButton.setEnabled

Determines whether the radio button is enabled or disabled.

FRadioButton.setGroupName

Specifies a group name for a radio button instance, or sets a new name for a group of radio buttons.

FRadioButton.setLabel

Applies a label for the radio button at runtime.

FRadioButton.setLabelPlacement

Specifies whether the label appears to the left or right of the radio button.

FRadioButton.setSize

Sets the width of the radio button, in pixels.

FRadioButton.setState

Sets the selected state of radio button instance.

FRadioButton.setStyleProperty

Sets a single style property for a component instance.

FRadioButton.setValue

Selects a radio button in a radio button group at runtime.