Returns the text baseline measurement, in pixels.

The currently visible icon. The value will be null if there is no currently visible icon.

For internal use in subclasses.

An object that stores properties for the button's label text renderer when no specific properties are defined for the button's current state, and the properties will be passed down to the label text renderer when the button validates. The available properties depend on which ITextRenderer implementation is returned by labelFactory. Refer to feathers.core.ITextRenderer for a list of available text renderer implementations.

The following example gives the button default label properties to use for all states when no specific label properties are available (this example assumes that the label text renderer is a BitmapFontTextRenderer):

    button.defaultLabelProperties.textFormat = new BitmapFontTextFormat( bitmapFont );
    button.defaultLabelProperties.wordWrap = true;

The default value is null.

See also

The default IStyleProvider for all Button components.

The default value is null.

See also

Determines if FeathersEventType.LONG_PRESS will be dispatched.

The following example enables long presses:

    button.isLongPressEnabled = true;
    button.addEventListener( FeathersEventType.LONG_PRESS, function( event:Event ):void
    {
        // long press
    });

The default value is false.

See also

The text displayed on the button.

The following example gives the button some label text:

    button.label = "Click Me";

The default value is null.

A function used to instantiate the button's label text renderer sub-component. By default, the button will use the global text renderer factory, FeathersControl.defaultTextRendererFactory(), to create the label text renderer. The label text renderer must be an instance of ITextRenderer. To change properties on the label text renderer, see defaultLabelProperties and the other "LabelProperties" properties for each button state.

The factory should have the following function signature:

function():ITextRenderer

The following example gives the button a custom factory for the label text renderer:

    button.labelFactory = function():ITextRenderer
    {
        return new TextFieldTextRenderer();
    }

The default value is null.

See also

The value added to the styleNameList of the label text renderer. This variable is protected so that sub-classes can customize the label text renderer style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_LABEL.

To customize the label text renderer style name without subclassing, see customLabelStyleName.

See also

The text renderer for the button's label.

For internal use in subclasses.

See also

The duration, in seconds, of a long press.

The following example changes the long press duration to one full second:

    button.longPressDuration = 1.0;

The default value is 0.5.

See also

The number of text lines displayed by the button. The component may contain multiple text lines if the text contains line breaks or if the wordWrap property is enabled.

See also

Constructor.

Creates the label text renderer sub-component and removes the old instance, if one exists.

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

See also

Gets the font styles to be used to display the button's text when the button's currentState property matches the specified state value.

If font styles are not defined for a specific state, returns null.

Parameters

See also

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

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

Parameters

See also

Gets the scale to be used by the button when the button's currentState property matches the specified state value.

If a scale is not defined for a specific state, returns NaN.

Parameters

See also

Positions and sizes the button's content.

For internal use in subclasses.

Sets the currentIcon property.

For internal use in subclasses.

Sets the font styles to be used to display the button's text when the button's currentState property matches the specified state value.

If font styles are not defined for a specific state, the value of the fontStyles property will be used instead.

Note: if the text renderer has been customized with advanced font formatting, it may override the values specified with setFontStylesForState() and properties like fontStyles and disabledFontStyles.

Parameters

See also

Sets the icon to be used by the button when the button's currentState property matches the specified state value.

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

Parameters

See also

Sets the scale to be used by the button when the button's currentState property matches the specified state value.

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

Parameters

See also

Dispatched when the button is pressed for a long time. The property isLongPressEnabled must be set to true before this event will be dispatched.

The following example enables long presses:

button.isLongPressEnabled = true;
button.addEventListener( FeathersEventType.LONG_PRESS, function( event:Event ):void
{
    // long press
});

The properties of the event object have the following values:

See also

An alternate style name to use with Button to allow a theme to give it a "back button" style, perhaps with an arrow pointing backward. If a theme does not provide a style for a back button, the theme will automatically fall back to using the default button skin.

An alternate style name should always be added to a component's styleNameList before the component is initialized. If the style name is added later, it will be ignored.

In the following example, the back button style is applied to a button:

    var button:Button = new Button();
    button.styleNameList.add( Button.ALTERNATE_STYLE_NAME_BACK_BUTTON );
    this.addChild( button );

See also

An alternate style name to use with Button to allow a theme to give it a more prominent, "call-to-action" style. If a theme does not provide a style for a call-to-action button, the theme will automatically fall back to using the default button style.

An alternate style name should always be added to a component's styleNameList before the component is initialized. If the style name is added later, it will be ignored.

In the following example, the call-to-action style is applied to a button:

    var button:Button = new Button();
    button.styleNameList.add( Button.ALTERNATE_STYLE_NAME_CALL_TO_ACTION_BUTTON );
    this.addChild( button );

See also

An alternate style name to use with Button to allow a theme to give it a highly prominent, "danger" style. An example would be a delete button or some other button that has a destructive action that cannot be undone if the button is triggered. If a theme does not provide a style for the danger button, the theme will automatically fall back to using the default button style.

An alternate style name should always be added to a component's styleNameList before the component is initialized. If the style name is added later, it will be ignored.

In the following example, the danger button style is applied to a button:

    var button:Button = new Button();
    button.styleNameList.add( Button.ALTERNATE_STYLE_NAME_DANGER_BUTTON );
    this.addChild( button );

See also

An alternate style name to use with Button to allow a theme to give it a "forward" button style, perhaps with an arrow pointing forward. If a theme does not provide a style for a forward button, the theme will automatically fall back to using the default button style.

An alternate style name should always be added to a component's styleNameList before the component is initialized. If the style name is added later, it will be ignored.

In the following example, the forward button style is applied to a button:

    var button:Button = new Button();
    button.styleNameList.add( Button.ALTERNATE_STYLE_NAME_FORWARD_BUTTON );
    this.addChild( button );

See also

An alternate style name to use with Button to allow a theme to give it a less prominent, "quiet" style. If a theme does not provide a style for a quiet button, the theme will automatically fall back to using the default button style.

An alternate style name should always be added to a component's styleNameList before the component is initialized. If the style name is added later, it will be ignored.

In the following example, the quiet button style is applied to a button:

    var button:Button = new Button();
    button.styleNameList.add( Button.ALTERNATE_STYLE_NAME_QUIET_BUTTON );
    this.addChild( button );

See also

The default value added to the styleNameList of the label text renderer.

Note: the label text renderer is not a feathers.controls.Label. It is an instance of one of the ITextRenderer implementations.

See also