Similar to a light switch, with on and off states that may be toggled. An alternative to a Check, especially on mobile.

The following example creates a toggle switch, programmatically selects it, and listens for when the selection changes:

var toggleSwitch = new ToggleSwitch();
toggleSwitch.selected = true;
toggleSwitch.addEventListener(Event.CHANGE, (event) -> {
	var toggleSwitch = cast(event.currentTarget, ToggleSwitch);
	trace("toggle switch changed: " + toggleSwitch.selected);
});
this.addChild(toggleSwitch);
Available since

1.0.0

.

See also:

Constructor

new()

Creates a new ToggleSwitch object.

Available since

1.0.0

.

Variables

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

The minimum space, measured in pixels, between the toggle switch's left edge and the left edge of the thumb.

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

toggleSwitch.paddingLeft = 20.0;
Available since

1.0.0

.

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

The minimum space, measured in pixels, between the toggle switch's right edge and the right edge of the thumb.

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

toggleSwitch.paddingRight = 20.0;
Available since

1.0.0

.

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

The skin to use for the toggle switch's optional secondary track. If a toggle switch has one track, it will fill the entire length of the toggle switch. If a toggle switch has a track and a secondary track, the primary track will stretch between the left edge of the toggle switch and the location of the slider's thumb, while the secondary track will stretch from the location of the toggle switch's thumb to the right edge of the toggle switch.

In the following example, a track skin and a secondary track skin are passed to the toggle switch:

var skin = new RectangleSkin();
skin.fill = SolidColor(0xaaaaaa);
toggleSwitch.trackSkin = skin;

var skin = new RectangleSkin();
skin.fill = SolidColor(0xcccccc);
toggleSwitch.secondaryTrackSkin = skin;
Available since

1.0.0

.

See also:

@:flash.propertyselected:Bool

Indicates if the toggle switch is selected or not.

The following example selects the toggle switch:

toggleSwitch.selected = true;

Note: When changing the selected property programatically, the position of the thumb is not animated. To change the selection with animation, call the setSelectionWithAnimation() method.

Available since

1.0.0

.

See also:

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

The skin to use for the toggle switch's thumb.

In the following example, a thumb skin is passed to the toggle switch:

var skin = new RectangleSkin();
skin.fill = SolidColor(0xcccccc);
toggleSwitch.thumbSkin = skin;
Available since

1.0.0

.

See also:

@:value(0.15)@:styletoggleDuration:Float = 0.15

The duration, measured in seconds, of the animation when the toggle switch is clicked or tap and the thumb slides to the other side.

In the following example, the duration of the animation that toggles the thumb is set to 500 milliseconds:

toggleSwitch.toggleDuration = 0.5;
Available since

1.0.0

.

@:value(Quart.easeOut)@:styletoggleEase:IEasing = Quart.easeOut

The easing function used for the animation when the toggle switch is clicked or tap and the thumb slides to the other side.

In the following example, the ease of the animation that toggles the thumb is customized:

toggleSwitch.toggleEase = Elastic.easeOut;
Available since

1.0.0

.

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

The skin to use for the toggle switch's track.

In the following example, a track skin is passed to the toggle switch:

var skin = new RectangleSkin();
skin.fill = SolidColor(0xcccccc);
toggleSwitch.trackSkin = skin;
Available since

1.0.0

.

See also:

Methods

setSelectionWithAnimation(selected:Bool):Bool

Changes the selected property and animates the position of the thumb.

See also:

Inherited Variables

Defined by FeathersControl

@:flash.propertyread onlycreated:Bool

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 also:

@:flash.propertyenabled:Bool

@style@:flash.propertyfocusRectSkin:DisplayObject

An optional skin to display when an IFocusObject component receives focus.

Available since

1.0.0

.

@:flash.propertyread onlyinitialized:Bool

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 also:

@:flash.propertyread 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

.

@:flash.propertystyleProvider: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 also:

@:flash.propertyvariant:String

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

@:flash.propertyexplicitWidth:Null<Float>

@:flash.propertymaxWidth:Float

@:flash.propertyminWidth:Float

Defined by ValidatingSprite

@:flash.propertyread onlydepth:Int

Inherited Methods

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 also:

  • 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 also:

  • 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 also:

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

.