A selectable control that may be toggled on and off and exists in a group that requires a single, exclusive toggled item.

In the following example, a set of radios are created, along with a ToggleGroup to group them together:

var group = new ToggleGroup();
group.addEventListener(Event.CHANGE, group_changeHandler);

var radio1 = new Radio();
radio1.text = "One";
radio1.toggleGroup = group;
this.addChild(radio1);

var radio2 = new Radio();
radio2.text = "Two";
radio2.toggleGroup = group;
this.addChild(radio2);

var radio3 = new Radio();
radio3.text = "Three";
radio3.toggleGroup = group;
this.addChild(radio3);
Available since

1.0.0

.

See:

Constructor

new ()

Creates a new Radio object.

Available since

1.0.0

.

Variables

@:value(null)toggleGroup:ToggleGroup = null

The ToggleGroup that this radio has been added to, or null if the radio has not been added to a group.

Available since

1.0.0

.

See:

Static variables

@:value(new ToggleGroup())staticread onlydefaultRadioGroup:ToggleGroup = new ToggleGroup()

The default ToggleGroup that radios are added to when they are not added to any other group.

Available since

1.0.0

.

See:

Inherited Variables

Defined by ToggleButton

@:value(null)@:styledisabledIcon:DisplayObject = null

The icon to display when the button is disabled, and no higher priority icon was passed to setIconForState() for the button's current state.

In the following example, the button's disabled icon is changed:

button.enabled = false;
button.disabledIcon = new Bitmap(bitmapData);

The next example sets a disabled icon, but also provides an icon for the ToggleButtonState.DISABLED(true) state that will be used instead of the disabled icon:

button.disabledIcon = new Bitmap(bitmapData);
button.setIconForState(ToggleButtonState.DISABLED(true), new Bitmap(bitmapData2));

Note: If the current state is ToggleButtonState.DISABLED(true), and both the disabledIcon and selectedIcon are set, the disabledIcon takes precedence over the selectedIcon.

Available since

1.0.0

.

See:

@:value(null)@:styledisabledTextFormat:TextFormat = null

The font styles used to render the button's text when the button is disabled.

In the following example, the button's disabled text formatting is customized:

button.enabled = false;
button.disabledTextFormat = new TextFormat("Helvetica", 20, 0xee0000);

The next example sets a disabled text format, but also provides a text format for the ToggleButtonState.DISABLED(true) state that will be used instead of the disabled text format:

button.disabledTextFormat = new TextFormat("Helvetica", 20, 0xee0000);
button.setTextFormatForState(ToggleButtonState.DISABLED(true), new TextFormat("Helvetica", 20, 0xff0000));

Note: If the current state is ToggleButtonState.DISABLED(true), and both the disabledTextFormat and selectedTextFormat are set, the disabledTextFormat takes precedence over the selectedTextFormat.

Available since

1.0.0

.

See:

@:value(0.0)@:stylegap:Float = 0.0

The space, measured in pixels, between the button's icon and its text. Applies to either horizontal or vertical spacing, depending on the value of iconPosition.

If the gap is set to Math.POSITIVE_INFINITY, the icon and the text will be positioned as far apart as possible. In other words, they will be positioned at the edges of the button (adjusted for padding).

The following example creates a gap of 20 pixels between the icon and the text:

button.text = "Click Me";
button.icon = new Bitmap(bitmapData);
button.gap = 20.0;
Available since

1.0.0

.

See:

@:value(CENTER)@:stylehorizontalAlign:HorizontalAlign = CENTER

How the content is positioned horizontally (along the x-axis) within the button.

The following example aligns the button's content to the left:

button.verticalAlign = LEFT;

Note: The HorizontalAlign.JUSTIFY constant is not supported by this component.

See:

@:value(null)@:styleicon:DisplayObject = null

The display object to use as the button's icon.

To render a different icon depending on the button's current state, pass additional icons to setIconForState().

The following example gives the button an icon:

button.icon = new Bitmap(bitmapData);

To change the position of the icon relative to the button's text, see iconPosition and gap.

button.icon = new Bitmap(bitmapData);
button.iconPosition = RIGHT;
button.gap = 20.0;
Available since

1.0.0

.

See:

@:value(LEFT)@:styleiconPosition:RelativePosition = LEFT

The location of the button's icon, relative to its text.

The following example positions the icon to the right of the text:

button.text = "Click Me";
button.icon = new Bitmap(texture);
button.iconPosition = RIGHT;
Available since

1.0.0

.

See:

@:value(0.0)@:styleminGap:Float = 0.0

If the value of the gap property is Math.POSITIVE_INFINITY, meaning that the gap will fill as much space as possible and position the icon and text on the edges of the button, the final calculated value of the gap will not be smaller than the value of the minGap property.

The following example ensures that the gap is never smaller than 20 pixels:

button.gap = Math.POSITIVE_INFINITY;
button.minGap = 20.0;
Available since

1.0.0

.

See:

@:value(0.0)@:stylepaddingBottom:Float = 0.0

The minimum space, in pixels, between the button's bottom edge and the button's content.

In the following example, the button's bottom padding is set to 20 pixels:

button.paddingBottom = 20.0;
Available since

1.0.0

.

@:value(0.0)@:stylepaddingLeft:Float = 0.0

The minimum space, in pixels, between the button's left edge and the button's content.

In the following example, the button's left padding is set to 20 pixels:

button.paddingLeft = 20.0;
Available since

1.0.0

.

@:value(0.0)@:stylepaddingRight:Float = 0.0

The minimum space, in pixels, between the button's right edge and the button's content.

In the following example, the button's right padding is set to 20 pixels:

button.paddingRight = 20.0;
Available since

1.0.0

.

@:value(0.0)@:stylepaddingTop:Float = 0.0

The minimum space, in pixels, between the button's top edge and the button's content.

In the following example, the button's top padding is set to 20 pixels:

button.paddingTop = 20.0;
Available since

1.0.0

.

@:value(null)@:styleselectedIcon:DisplayObject = null

The icon to display when the button is selected, and no higher priority icon was passed to setIconForState() for the button's current state.

In the following example, the button's selected icon is changed:

button.selected = true;
button.selectedIcon = new Bitmap(bitmapData);

The next example sets a selected icon, but also provides an icon for the ToggleButtonState.DOWN(true) state that will be used instead of the selected icon:

button.selectedIcon = new Bitmap(bitmapData);
button.setIconForState(ToggleButtonState.DOWN(true), new Bitmap(bitmapData2));

Note: If the current state is ToggleButtonState.DISABLED(true), and both the disabledIcon and selectedIcon are set, the disabledIcon takes precedence over the selectedIcon.

Available since

1.0.0

.

See:

@:value(null)@:styleselectedTextFormat:TextFormat = null

The font styles used to render the button's text when the button is selected.

In the following example, the button's selected text formatting is customized:

button.selected = true;
button.selectedTextFormat = new TextFormat("Helvetica", 20, 0xff0000);

The next example sets a selected text format, but also provides a text format for the ToggleButtonState.DOWN(true) state that will be used instead of the selected text format:

button.selectedTextFormat = new TextFormat("Helvetica", 20, 0xff0000);
button.setTextFormatForState(ToggleButtonState.DOWN(true), new TextFormat("Helvetica", 20, 0xcc0000));

Note: If the current state is ToggleButtonState.DISABLED(true), and both the disabledTextFormat and selectedTextFormat are set, the disabledTextFormat takes precedence over the selectedTextFormat.

Available since

1.0.0

.

See:

@:isVartext:String

The text displayed by the button.

The following example sets the button's text:

button.text = "Click Me";
Available since

1.0.0

.

See:

@:value(null)@:styletextFormat:TextFormat = null

The font styles used to render the button's text.

In the following example, the button's text formatting is customized:

button.textFormat = new TextFormat("Helvetica", 20, 0xcc0000);
Available since

1.0.0

.

See:

@:value(MIDDLE)@:styleverticalAlign:VerticalAlign = MIDDLE

How the content is positioned vertically (along the y-axis) within the button.

The following example aligns the button's content to the top:

button.verticalAlign = TOP;

Note: The VerticalAlign.JUSTIFY constant is not supported by this component.

See:

Defined by BasicToggleButton

@:value(null)@:stylebackgroundSkin:DisplayObject = null

The default background skin for the toggle button, which is used when no other skin is defined for the current state with setSkinForState().

The following example passes a bitmap for the button to use as a background skin:

button.backgroundSkin = new Bitmap(bitmapData);
Available since

1.0.0

.

See:

@:value(UP(false))read onlycurrentState:ToggleButtonState = UP(false)

The current state of the toggle button.

Available since

1.0.0

.

See:

@:value(false)@:stylekeepDownStateOnRollOut:Bool = false

Determines if a pressed button should remain in the down state if the pointer moves outside of the button's bounds. Useful for controls like HSlider, VSlider, or ToggleSwitch to keep a thumb in the down state while it is being dragged around by the pointer.

The following example ensures that the button's down state remains active on roll out.

button.keepDownStateOnRollOut = true;
Available since

1.0.0

.

@:value(false)@:isVarselected:Bool = false

Indicates if the button is selected or not. The button may be selected programmatically, even if toggleable is false, but generally, toggleable should be set to true to allow the user to select and deselect it by triggering the button with a click or tap. If focus management is enabled, and the button has focus, a button may also be triggered with the spacebar.

The following example selects the button:

button.selected = true;

Warning: Do not listen for FeathersEvent.TRIGGERED to be notified when the selected property changes. You must listen for Event.CHANGE, which is dispatched after FeathersEvent.TRIGGERED.

Available since

1.0.0

.

See:

@:value(null)@:styleselectedBackgroundSkin:DisplayObject = null

The default background skin for the toggle button when the selected property is true. Takes precendence over backgroundSkin, but will defer to another skin that is defined for the current state with setSkinForState().

The following example gives the toggle button a default selected skin:

button.selectedBackgroundSkin = new Bitmap(bitmapData);
Available since

1.0.0

.

See:

@:value(true)toggleable:Bool = true

Determines if the button may be selected or deselected as a result of user interaction. If true, the value of the selected property will be toggled when the button is triggered.

The following example disables the ability to toggle on click or tap:

button.toggleable = false;
Available since

1.0.0

.

See:

Defined by FeathersControl

@:value(false)read onlycreated:Bool = false

Determines if the component has been initialized and validated for the first time.

In the following example, we check if the component is created or not, and we listen for an event if it isn't:

if(!control.created)
{
	control.addEventListener(FeathersEventType.CREATION_COMPLETE, creationCompleteHandler);
}

See:

@:value(true)@:isVarenabled:Bool = true

@:value(false)read onlyinitialized:Bool = false

Determines if the component has been initialized yet. The initialize() function is called one time only, when the Feathers UI control is added to the display list for the first time.

In the following example, we check if the component is initialized or not, and we listen for an event if it isn't initialized:

if(!control.initialized)
{
	control.addEventListener(FeathersEvent.INITIALIZE, initializeHandler);
}
Available since

1.0.0

.

See:

read onlystyleContext:Class<IStyleObject>

The class used as the context for styling the component. If a subclass of a component should have different styles than its superclass, it should override the get_styleContext getter. However, if a subclass should continue using the same styles as its superclass, it happens automatically.

Available since

1.0.0

.

styleProvider:IStyleProvider

When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.

You can set or replace an existing style provider at any time before a component initializes without immediately affecting the component's visual appearance. After the component initializes, the style provider may still be changed, and any properties that were set by the previous style provider will be reset to their default values before applying the new style provider.

Available since

1.0.0

.

See:

@:value(null)variant:String = null

May be used to provide multiple different variations of the same UI component, each with a different appearance.

Available since

1.0.0

.

Defined by MeasureSprite

@:value(null)@:isVarexplicitHeight:Null<Float> = null

@:value(null)@:isVarexplicitMaxHeight:Null<Float> = null

@:value(null)@:isVarexplicitMaxWidth:Null<Float> = null

@:value(null)@:isVarexplicitMinHeight:Null<Float> = null

@:value(null)@:isVarexplicitMinWidth:Null<Float> = null

@:value(null)@:isVarexplicitWidth:Null<Float> = null

Defined by ValidatingSprite

@:value(-1)read onlydepth:Int = -1

Inherited Methods

Defined by ToggleButton

getIconForState (state:ToggleButtonState):DisplayObject

Gets the icon to be used by the button when its currentState property matches the specified state value.

If an icon is not defined for a specific state, returns null.

Available since

1.0.0

.

See:

getTextFormatForState (state:ToggleButtonState):TextFormat

Gets the text format to be used by the button when its currentState property matches the specified state value.

If a text format is not defined for a specific state, returns null.

Available since

1.0.0

.

See:

@stylesetIconForState (state:ToggleButtonState, icon:DisplayObject):Void

Set the icon to be used by the button when its currentState property matches the specified state value.

If an icon is not defined for a specific state, the value of the textFormat property will be used instead.

Available since

1.0.0

.

See:

@stylesetTextFormatForState (state:ToggleButtonState, textFormat:TextFormat):Void

Set the text format to be used by the button when its currentState property matches the specified state value.

If a text format is not defined for a specific state, the value of the textFormat property will be used instead.

Available since

1.0.0

.

See:

Defined by BasicToggleButton

getSkinForState (state:ToggleButtonState):DisplayObject

Gets the skin to be used by the toggle button when its currentState property matches the specified state value.

If a skin is not defined for a specific state, returns null.

Available since

1.0.0

.

See:

@stylesetSkinForState (state:ToggleButtonState, skin:DisplayObject):Void

Set the skin to be used by the toggle button when its currentState property matches the specified state value.

If a skin is not defined for a specific state, the value of the backgroundSkin property will be used instead.

Available since

1.0.0

.

See:

Defined by FeathersControl

private@:dox(show)initialize ():Void

Called the first time that the UI control is added to the stage, and you should override this function to customize the initialization process. Do things like create children and set up event listeners. After this function is called, Event.INIT is dispatched.

The following example overrides initialization:

override private function initialize():Void {
	super.initialize();

}
Available since

1.0.0

.

move (x:Float, y:Float):Void

Sets both the x and y positions of the control in a single function call.

Available since

1.0.0

.

See:

DisplayObject.x

DisplayObject.y

setSize (width:Float, height:Float):Void

Sets both the width and height dimensions of the control in a single function call.

Available since

1.0.0

.

See:

DisplayObject.width

DisplayObject.height

private@:dox(show)setStyle (styleName:String, ?state:EnumValue):Bool

Determines if a style may be changed, and restricts the style from being changed in the future, if necessary.

Available since

1.0.0

.

Defined by MeasureSprite

private@:value({ minHeight : 0.0, minWidth : 0.0 })@:dox(show)saveMeasurements (width:Float, height:Float, minWidth:Float = 0.0, minHeight:Float = 0.0, ?maxWidth:Float, ?maxHeight:Float):Bool

Saves the calculated dimensions for the component, replacing any values that haven't been set explicitly. Returns true if the reported values have changed and Event.RESIZE was dispatched.

Available since

1.0.0

.

Defined by ValidatingSprite

@:value({ flag : null })isInvalid (?flag:String):Bool

Indicates whether the control is pending validation or not. By default, returns true if any invalidation flag has been set. If you pass in a specific flag, returns true only if that flag has been set (others may be set too, but it checks the specific flag only. If all flags have been marked as invalid, always returns true.

The following example invalidates a component:

component.setInvalid();
trace(component.isInvalid()); // true
Available since

1.0.0

.

@:value({ flag : null })setInvalid (?flag:String):Void

Call this function to tell the UI control that a redraw is pending. The redraw will happen immediately before OpenFL renders the UI control to the screen. The validation system exists to ensure that multiple properties can be set together without redrawing multiple times in between each property change.

If you cannot wait until later for the validation to happen, you can call validate() to redraw immediately. As an example, you might want to validate immediately if you need to access the correct width or height values of the UI control, since these values are calculated during validation.

The following example invalidates a component:

component.setInvalid();
trace(component.isInvalid()); // true
Available since

1.0.0

.

private@:dox(show)setInvalidationFlag (flag:String):Void

Sets an invalidation flag. This will not add the component to the validation queue. It only sets the flag. A subclass might use this function during draw() to manipulate the flags that its superclass sees.

Available since

1.0.0

.

See:

private@:dox(show)update ():Void

Override to customize layout and to adjust properties of children. Called when the component validates, if any flags have been marked to indicate that validation is pending.

The following example overrides updating after invalidation:

override private function update():Void {
	super.update();

}
Available since

1.0.0

.