A simple toggle button control with selection, pointer states, but no content, that is useful for purposes like skinning. For a more full-featured toggle button, with a label and icon, see feathers.controls.ToggleButton instead.

Available since

1.0.0

.

See:

Constructor

new ()

Variables

@: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 gives the toggle button a default skin to use for all states when no specific skin is available:

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

1.0.0

.

See:

read onlycurrentState:String

The current state of the toggle button.

Available since

1.0.0

.

See:

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

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

@:value(true)toggleable:Bool = true

Methods

private@:dox(show)autoSizeIfNeeded ():Bool

If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself. For instance, if the explicitWidth property is set, that value will be used without additional measurement. If explicitWidth is set, but explicitHeight is not (or the other way around), the dimension with the explicit value will not be measured, but the other non-explicit dimension will still require measurement.

Calls saveMeasurements() to set up the actualWidth and actualHeight member variables used for layout.

Meant for internal use, and subclasses may override this function with a custom implementation.

Available since

1.0.0

.

See:

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:

Inherited Variables

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.isCreated )
{
	control.addEventListener( FeathersEventType.CREATION_COMPLETE, creationCompleteHandler );
}

See:

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

Indicates whether the control should respond when a user attempts to interact with it. The appearance of the control may also be affected by whether the control is enabled or disabled.

In the following example, the control is disabled:

component.enabled = false;
Available since

1.0.0

.

@:value(true)includeInLayout:Bool = true

Determines if the ILayout of the parent container should measure and position this object or ignore it.

In the following example, the object is excluded from the layout:

object.includeInLayout = false;
Available since

1.0.0

.

@: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.isInitialized )
{
	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:

variant

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

maxHeight:Float

maxWidth:Float

minHeight:Float

minWidth:Float

Defined by ValidatingSprite

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

The object's depth in the display list, relative to the stage. If the object isn't on the stage, its depth will be -1.

Used by the validation system to validate objects from the top down.

Available since

1.0.0

.

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.

Available since

1.0.0

.

initializeNow ():Void

If the component has not yet initialized, initializes immediately. The initialize() method will be called, and the FeathersEvent.INITIALIZE event will be dispatched. Then, if the component has a style provider, it will be applied. The component will not validate, though. To both initialize and validate immediately, call validateNow() instead.

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:String):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

resetHeight ():Void

Resets the height so that it will be calculated automatically by the component.

Available since

1.0.0

.

resetMaxHeight ():Void

Resets the maximum height so that it will be calculated automatically by the component.

Available since

1.0.0

.

resetMaxWidth ():Void

Resets the maximum width so that it will be calculated automatically by the component.

Available since

1.0.0

.

resetMinHeight ():Void

Resets the minimum height so that it will be calculated automatically by the component.

Available since

1.0.0

.

resetMinWidth ():Void

Resets the minimum width so that it will be calculated automatically by the component.

Available since

1.0.0

.

resetWidth ():Void

Resets the width so that it will be calculated automatically by the component.

Available since

1.0.0

.

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.

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.

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.

Available since

1.0.0

.