The final height value that should be used for layout. If the height has been explicitly set, then that value is used. If not, the actual height will be calculated automatically. Each component has different automatic sizing behavior, but it's usually based on the component's skin or content, including text or subcomponents.

The final minimum height value that should be used for layout. If the minimum height has been explicitly set, then that value is used. If not, the actual minimum height will be calculated automatically. Each component has different automatic sizing behavior, but it's usually based on the component's skin or content, including text or subcomponents.

The final minimum width value that should be used for layout. If the minimum width has been explicitly set, then that value is used. If not, the actual minimum width will be calculated automatically. Each component has different automatic sizing behavior, but it's usually based on the component's skin or content, including text or subcomponents.

The final width value that should be used for layout. If the width has been explicitly set, then that value is used. If not, the actual width will be calculated automatically. Each component has different automatic sizing behavior, but it's usually based on the component's skin or content, including text or subcomponents.

An optional effect that is activated when the component is added to the stage. Typically used to animate the component's appearance when it is first displayed.

In the following example, an added effect fades the component's alpha property from 0 to 1:

control.addedEffect = Fade.createFadeBetweenEffect(0, 1);

A number of animated effects may be found in the feathers.motion package. However, you are not limited to only these effects. It's possible to create custom effects too.

A custom effect function should have the following signature:

function(target:DisplayObject):IEffectContext

The IEffectContext is used by the component to control the effect, performing actions like playing the effect, pausing it, or cancelling it.

Custom animated effects that use starling.display.Tween typically return a TweenEffectContext. In the following example, we recreate the Fade.createFadeBetweenEffect() used in the previous example.

control.addedEffect = function(target:DisplayObject):IEffectContext
{
    target.alpha = 0;
    var tween:Tween = new Tween(target, 0.5, Transitions.EASE_OUT);
    tween.fadeTo(1);
    return new TweenEffectContext(target, tween);
};

The default value is null.

See also

When the FeathersControl constructor is called, the styleProvider property is set to this value. May be null.

Typically, a subclass of FeathersControl will override this function to return its static globalStyleProvider value. For instance, feathers.controls.Button overrides this function, and its implementation looks like this:

override protected function get defaultStyleProvider():IStyleProvider
{
    return Button.globalStyleProvider;
}

See also

A function used by all UI controls that support text editor to create an ITextEditor instance. You may replace the default function with your own, if you prefer not to use the StageTextTextEditor.

The function is expected to have the following signature:

function():ITextEditor

See also

A function used by all UI controls that support text renderers to create an ITextRenderer instance. You may replace the default function with your own, if you prefer not to use the BitmapFontTextRenderer.

The function is expected to have the following signature:

function():ITextRenderer

See also

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

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

Indicates if effects have been suspended.

See also

The height value explicitly set by passing a value to the height setter or by calling the setSize() function.

The maximum height value explicitly set by passing a value to the maxHeight setter.

If no value has been passed to the maxHeight setter, this property returns NaN.

The maximum width value explicitly set by passing a value to the maxWidth setter.

If no value has been passed to the maxWidth setter, this property returns NaN.

The minimum height value explicitly set by passing a value to the minHeight setter.

If no value has been passed to the minHeight setter, this property returns NaN.

The minimum width value explicitly set by passing a value to the minWidth setter.

If no value has been passed to the minWidth setter, this property returns NaN.

The width value explicitly set by passing a value to the width setter or to the setSize() method.

An optional effect that is activated when the component receives focus.

The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.

A number of animated effects may be found in the feathers.motion package. However, you are not limited to only these effects. It's possible to create custom effects too.

A custom effect function should have the following signature:

function(target:DisplayObject):IEffectContext

The IEffectContext is used by the component to control the effect, performing actions like playing the effect, pausing it, or cancelling it.

Custom animated effects that use starling.display.Tween typically return a TweenEffectContext.

The default value is null.

See also

The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.

The default value is null.

See also

An optional effect that is activated when the component loses focus.

The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.

The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.

A number of animated effects may be found in the feathers.motion package. However, you are not limited to only these effects. It's possible to create custom effects too.

A custom effect function should have the following signature:

function(target:DisplayObject):IEffectContext

The IEffectContext is used by the component to control the effect, performing actions like playing the effect, pausing it, or cancelling it.

Custom animated effects that use starling.display.Tween typically return a TweenEffectContext.

The default value is null.

See also

The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.

In the following example, the focus owner is changed:

object.focusOwner = otherObject;

The default value is null.

See also

The height of the component, in pixels. This could be a value that was set explicitly, or the component will automatically resize if no explicit height value is provided. Each component has a different automatic sizing behavior, but it's usually based on the component's skin or content, including text or subcomponents.

Note: Values of the width and height properties may not be accurate until after validation. If you are seeing width or height values of 0, but you can see something on the screen and know that the value should be larger, it may be because you asked for the dimensions before the component had validated. Call validate() to tell the component to immediately redraw and calculate an accurate values for the dimensions.

In the following example, the height is set to 120 pixels:

control.height = 120;

In the following example, the height is cleared so that the component can automatically measure its own height:

control.height = NaN;

See also

An optional effect that is activated when the component is hidden. More specifically, this effect plays when the visible property is set to false.

In the following example, a hide effect fades the component's alpha property to 0:

control.hideEffect = Fade.createFadeOutEffect();

A number of animated effects may be found in the feathers.motion package. However, you are not limited to only these effects. It's possible to create custom effects too.

A custom effect function should have the following signature:

function(target:DisplayObject):IEffectContext

The IEffectContext is used by the component to control the effect, performing actions like playing the effect, pausing it, or cancelling it.

Custom animated effects that use starling.display.Tween typically return a TweenEffectContext. In the following example, we recreate the Fade.createFadeOutEffect() used in the previous example.

control.hideEffect = function(target:DisplayObject):IEffectContext
{
    var tween:Tween = new Tween(target, 0.5, Transitions.EASE_OUT);
    tween.fadeTo(0);
    return new TweenEffectContext(target, tween);
};

The default value is null.

See also

Determines if the ILayout should use this object or ignore it.

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

object.includeInLayout = false;

The default value is true.

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 also

Indicates whether the control is interactive or not.

In the following example, the control is disabled:

control.isEnabled = false;

The default value is true.

The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.

In the following example, the focus is disabled:

object.isFocusEnabled = false;

The default value is true.

See also

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:

if( !control.isInitialized )
{
    control.addEventListener( FeathersEventType.INITIALIZE, initializeHandler );
}

See also

Similar to mouseChildren on the classic display list. If true, children cannot dispatch touch events, but hit tests will be much faster. Easier than overriding hitTest().

In the following example, the quick hit area is enabled:

control.isQuickHitAreaEnabled = true;

The default value is false.

The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.

if(object.isShowingFocus)
{

}

See also

Extra parameters associated with this display object that will be used by the layout algorithm.

The default value is null.

The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.

See also

The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component. This value is not strictly enforced in all cases. An explicit height value that is larger than maxHeight may be set and will not be affected by the maximum.

In the following example, the maximum width of the control is set to 120 pixels:

control.maxWidth = 120;

The default value is Number.POSITIVE_INFINITY.

The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component. This value is not strictly enforced in all cases. An explicit width value that is larger than maxWidth may be set and will not be affected by the maximum.

In the following example, the maximum width of the control is set to 120 pixels:

control.maxWidth = 120;

The default value is Number.POSITIVE_INFINITY.

The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component. This value is not strictly enforced in all cases. An explicit height value that is smaller than minHeight may be set and will not be affected by the minimum.

In the following example, the minimum height of the control is set to 120 pixels:

control.minHeight = 120;

The default value is 0.

If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.

In the following example, the minimum height of the hit area is set to 120 pixels:

control.minTouchHeight = 120;

The default value is 0.

If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded.

In the following example, the minimum width of the hit area is set to 120 pixels:

control.minTouchWidth = 120;

The default value is 0.

The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component. This value is not strictly enforced in all cases. An explicit width value that is smaller than minWidth may be set and will not be affected by the minimum.

In the following example, the minimum width of the control is set to 120 pixels:

control.minWidth = 120;

The default value is 0.

An optional effect that is activated when the component is moved to a new position. More specifically, this effect plays when the x or y property changes.

In the following example, a move effect will animate the new position of the component when it moves:

control.moveEffect = Move.createMoveEffect();

A custom effect function should have the following signature:

function(target:DisplayObject):IMoveEffectContext

The IMoveEffectContext is used by the component to control the effect, performing actions like playing the effect, pausing it, or cancelling it. Custom animated move effects that use starling.display.Tween typically return a TweenMoveEffectContext.

The default value is null.

See also

The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.

In the following example, the next down focus is changed:

object.nextDownFocus = otherObject;

To simulate KeyLocation.D_PAD in the AIR Debug Launcher on desktop for debugging purposes, set DeviceCapabilities.simulateDPad to true.

The default value is null.

See also

The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.

In the following example, the next left focus is changed:

object.nextLeftFocus = otherObject;

To simulate KeyLocation.D_PAD in the AIR Debug Launcher on desktop for debugging purposes, set DeviceCapabilities.simulateDPad to true.

The default value is null.

See also

The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.

In the following example, the next right focus is changed:

object.nextRightFocus = otherObject;

To simulate KeyLocation.D_PAD in the AIR Debug Launcher on desktop for debugging purposes, set DeviceCapabilities.simulateDPad to true.

The default value is null.

See also

The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.

In the following example, the next tab focus is changed:

object.nextTabFocus = otherObject;

The default value is null.

See also

The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.

In the following example, the next up focus is changed:

object.nextUpFocus = otherObject;

To simulate KeyLocation.D_PAD in the AIR Debug Launcher on desktop for debugging purposes, set DeviceCapabilities.simulateDPad to true.

The default value is null.

See also

The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.

In the following example, the previous tab focus is changed:

object.previousTabFocus = otherObject;

The default value is null.

See also

An optional effect that is activated when the component is resized with new dimensions. More specifically, this effect plays when the width or height property changes.

In the following example, a resize effect will animate the new dimensions of the component when it resizes:

control.resizeEffect = Resize.createResizeEffect();

A custom effect function should have the following signature:

function(target:DisplayObject):IResizeEffectContext

The IResizeEffectContext is used by the component to control the effect, performing actions like playing the effect, pausing it, or cancelling it. Custom animated resize effects that use starling.display.Tween typically return a TweenResizeEffectContext.

See also

An optional effect that is activated when the component is shown. More specifically, this effect plays when the visible property is set to true.

In the following example, a show effect fades the component's alpha property from 0 to 1:

control.showEffect = Fade.createFadeBetweenEffect(0, 1);

A number of animated effects may be found in the feathers.motion package. However, you are not limited to only these effects. It's possible to create custom effects too.

A custom effect function should have the following signature:

function(target:DisplayObject):IEffectContext

The IEffectContext is used by the component to control the effect, performing actions like playing the effect, pausing it, or cancelling it.

Custom animated effects that use starling.display.Tween typically return a TweenEffectContext. In the following example, we recreate the Fade.createFadeBetweenEffect() used in the previous example.

control.showEffect = function(target:DisplayObject):IEffectContext
{
    target.alpha = 0;
    var tween:Tween = new Tween(target, 0.5, Transitions.EASE_OUT);
    tween.fadeTo(1);
    return new TweenEffectContext(target, tween);
};

The default value is null.

See also

The concatenated styleNameList, with values separated by spaces. Style names are somewhat similar to classes in CSS selectors. In Feathers, they are a non-unique identifier that can differentiate multiple styles of the same type of UI control. A single control may have many style names, and many controls can share a single style name. A theme or another skinning mechanism may use style names to provide a variety of visual appearances for a single component class.

In general, the styleName property should not be set directly on a Feathers component. You should add and remove style names from the styleNameList property instead.

The default value is "".

See also

Contains a list of all "styles" assigned to this control. Names are like classes in CSS selectors. They are a non-unique identifier that can differentiate multiple styles of the same type of UI control. A single control may have many names, and many controls can share a single name. A theme or another skinning mechanism may use style names to provide a variety of visual appearances for a single component class.

Names may be added, removed, or toggled on the styleNameList. Names cannot contain spaces.

In the following example, a name is added to the name list:

control.styleNameList.add( "custom-component-name" );

See also

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, but any properties that were set by the previous style provider will not be reset to their default values.

See also

Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.

The default value is null.

See also

The width of the component, in pixels. This could be a value that was set explicitly, or the component will automatically resize if no explicit width value is provided. Each component has a different automatic sizing behavior, but it's usually based on the component's skin or content, including text or subcomponents.

Note: Values of the width and height properties may not be accurate until after validation. If you are seeing width or height values of 0, but you can see something on the screen and know that the value should be larger, it may be because you asked for the dimensions before the component had validated. Call validate() to tell the component to immediately redraw and calculate an accurate values for the dimensions.

In the following example, the width is set to 120 pixels:

control.width = 120;

In the following example, the width is cleared so that the component can automatically measure its own width:

control.width = NaN;

See also

Constructor.

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

Parameters

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.

Default event handler for FeathersEventType.FOCUS_IN that may be overridden in subclasses to perform additional actions when the component receives focus.

Parameters

Default event handler for FeathersEventType.FOCUS_OUT that may be overridden in subclasses to perform additional actions when the component loses focus.

Parameters

Feathers components use an optimized getBounds() implementation that may sometimes behave differently than regular Starling display objects. For instance, filters may need some special customization. If a component's children appear outside of its bounds (such as at negative dimensions), padding should be added to the filter to account for these regions.

Parameters

The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.

Important: This function will not clear focus from the display object if it has focus. To clear focus from the display object, you should set the focus property on the focus manager to null or another display object.

See also

The next style that is set will not be restricted. This allows components to set defaults by calling the setter while still allowing the style property to be replaced by a theme in the future.

See also

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, FeathersEventType.INITIALIZE is dispatched.

See also

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

See also

Call this function to tell the UI control that a redraw is pending. The redraw will happen immediately before Starling 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.

Parameters

See also

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.

Parameters

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

Parameters

See also

Used by setters for properties that are considered "styles" to determine if the setter has been called directly on the component or from a style provider. A style provider is typically associated with a theme. When a style is set directly on the component (outside of a style provider), then any attempts by the style provider to set the style later will be ignored. This allows developers to customize a component's styles directly without worrying about conflicts from the style provider or theme.

If a style provider is currently applying styles to the component, returns true if the style is restricted or false if it may be set.

If the style setter is called outside of a style provider, marks the style as restricted and returns false.

The key parameter should be a unique value for each separate style. In most cases, processStyleRestriction() will be called in the style property setter, so arguments.callee is recommended. Alternatively, a unique string value may be used instead.

The following example shows how to use processStyleRestriction() in a style property setter:

private var _customStyle:Object;
public function get customStyle():Object
{
    return this._customStyle;
}
public function set customStyle( value:Object ):void
{
    if( this.processStyleRestriction( arguments.callee ) )
    {
        // if a style is restricted, don't set it
        return;
    }

    this._customStyle = value;
}

Parameters

See also

Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions. This function is not called automatically. Components that support focus should call this function at an appropriate point within the draw() function. This function may be overridden if the default behavior is not desired.

Plays an effect before removing the component from its parent.

In the following example, an effect fades the component's alpha property to 0 before removing the component from its parent:

control.removeFromParentWithEffect(Fade.createFadeOutEffect(), true);

A number of animated effects may be found in the feathers.motion package. However, you are not limited to only these effects. It's possible to create custom effects too.

A custom effect function should have the following signature:

function(target:DisplayObject):IEffectContext

The IEffectContext is used by the component to control the effect, performing actions like playing the effect, pausing it, or cancelling it.

Custom animated effects that use starling.display.Tween typically return a TweenEffectContext. In the following example, we recreate the Fade.createFadeOutEffect() used in the previous example.

function customEffect(target:DisplayObject):IEffectContext
{
    var tween:Tween = new Tween(target, 0.5, Transitions.EASE_OUT);
    tween.fadeTo(0);
    return new TweenEffectContext(target, tween);
}
control.removeFromParentWithEffect(customEffect, true);

Parameters

See also

Resets the styleProvider property to its default value, which is usually the global style provider for the component.

See also

Indicates that effects should be re-activated after being suspended.

See also

Saves the dimensions and minimum dimensions calculated for the component. Returns true if the reported values have changed and Event.RESIZE was dispatched.

Parameters

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.

Parameters

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

Parameters

See also

Sets the width and height of the control, with the option of invalidating or not. Intended to be used when the width and height values have not been set explicitly, and the UI control needs to measure itself and choose an "ideal" size.

Parameters

The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.

Important: This function will not give focus to the display object if it doesn't have focus. To give focus to the display object, you should set the focus property on the focus manager.

object.focusManager.focus = object;

See also

Indicates that effects should not be activated temporarily. Call resumeEffects() when effects should be allowed again.

See also

Immediately validates the display object, if it is invalid. The validation system exists to postpone updating a display object after properties are changed until until the last possible moment the display object is rendered. This allows multiple properties to be changed at a time without requiring a full update every time.

See also

Dispatched after the component has validated for the first time. Both initialize() and draw() will have been called, and all children will have been created.

The properties of the event object have the following values:

Dispatched after initialize() has been called, but before the first time that draw() has been called.

The properties of the event object have the following values:

Dispatched when the width or height of the control changes.

The properties of the event object have the following values:

The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin. A negative value may be used to expand the focus indicator skin outside the bounds of the object.

The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.

The following example gives the focus indicator skin -2 pixels of padding on the right edge only:

control.focusPaddingLeft = -2;

The default value is 0.

See also

The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin. A negative value may be used to expand the focus indicator skin outside the bounds of the object.

The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.

The following example gives the focus indicator skin -2 pixels of padding on the bottom edge only:

control.focusPaddingBottom = -2;

The default value is 0.

See also

The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin. A negative value may be used to expand the focus indicator skin outside the bounds of the object.

The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.

The following example gives the focus indicator skin -2 pixels of padding on the right edge only:

control.focusPaddingRight = -2;

The default value is 0.

See also

The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin. A negative value may be used to expand the focus indicator skin outside the bounds of the object.

The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.

The following example gives the focus indicator skin -2 pixels of padding on the top edge only:

control.focusPaddingTop = -2;

The default value is 0.

See also

Quickly sets all focus padding properties to the same value. The focusPadding getter always returns the value of focusPaddingTop, but the other focus padding values may be different.

The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.

The following example gives the button 2 pixels of focus padding on all sides:

control.focusPadding = 2;

The default value is 0.

See also

If this component supports focus, this optional skin will be displayed above the component when showFocus() is called. The focus indicator skin is not always displayed when the component has focus. Typically, if the component receives focus from a touch, the focus indicator is not displayed.

The touchable of this skin will always be set to false so that it does not "steal" touches from the component or its sub-components. This skin will not affect the dimensions of the component or its hit area. It is simply a visual indicator of focus.

The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.

In the following example, the focus indicator skin is set:

control.focusIndicatorSkin = new Image( texture );

The default value is null.

See also

Flag to indicate that everything is invalid and should be redrawn.

Invalidation flag to indicate that the primary data displayed by the UI control has changed.

Invalidation flag to indicate that the focus of the UI control has changed.

Invalidation flag to indicate that the layout of the UI control has changed.

Invalidation flag to indicate that the scroll position of the UI control has changed.

Invalidation flag to indicate that the selection of the UI control has changed.

Invalidation flag to indicate that the dimensions of the UI control have changed.

Invalidation flag to indicate that the skin of the UI control has changed.

Invalidation flag to indicate that the state has changed. Used by isEnabled, but may be used for other control states too.

See also

Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.