A basic radio button component, meant to be used in groups, where only one button in the group can be selected.

Constructor

new (?parent:DisplayObjectContainer, ?xpos:Float, ?ypos:Float, ?label:String, ?checked:Bool, ?defaultHandler:Dynamic)

Constructor

Parameters:

parent

The parent DisplayObjectContainer on which to add this RadioButton.

xpos

The x position to place this component.

ypos

The y position to place this component.

label

The string to use for the initial label of this component.

defaultHandler

The event handling function to handle the default event for this component (click in this case).

Variables

groupName:String

Sets / gets the group name, which allows groups of RadioButtons to function seperately.

label:String

Sets / gets the label text shown on this CheckBox.

selected:Bool

Sets / gets the selected state of this CheckBox.

Methods

draw ():Void

Draws the visual ui of the component.

get_groupName ():String

get_label ():String

get_selected ():Bool

set_groupName (value:String):String

set_label (str:String):String

set_selected (s:Bool):Bool

Inherited Variables

Defined by Component

enabled:Bool

Sets/gets whether this component is enabled or not.

tag:Int

Sets/gets in integer that can identify the component.

Inherited Methods

Defined by Component

get_enabled ():Bool

get_height ():Float

get_tag ():Int

get_width ():Float

move (xpos:Float, ypos:Float):Void

Moves the component to the specified position.

Parameters:

xpos

the x position to move the component

ypos

the y position to move the component

setSize (w:Float, h:Float):Void

Sets the size of the component.

Parameters:

w

The width of the component.

h

The height of the component.

set_enabled (value:Bool):Bool

set_height (value:Float):Void

Sets/gets the height of the component.

set_tag (value:Int):Int

set_width (value:Float):Void

Sets/gets the width of the component.

set_x (value:Float):Void

Overrides the setter for x to always place the component on a whole pixel.

set_y (value:Float):Void

Overrides the setter for y to always place the component on a whole pixel.