The index of the button in the buttonsDataProvider to trigger when Keyboard.ENTER is pressed.

In the following example, the acceptButtonIndex is set to the first button in the data provider.

var alert:Alert = Alert.show( "This is an alert!", "Hello World", new ArrayCollection(
[
    { label: "OK" }
]));
alert.acceptButtonIndex = 0;

The default value is -1.

Returns a new Alert instance when Alert.show() is called. If one wishes to skin the alert manually, a custom factory may be provided.

This function is expected to have the following signature:

function():Alert

The following example shows how to create a custom alert factory:

Alert.alertFactory = function():Alert
{
    var alert:Alert = new Alert();
    //set properties here!
    return alert;
};

See also

A function used to generate the alerts's button group sub-component. The button group must be an instance of ButtonGroup. This factory can be used to change properties on the button group when it is first created. For instance, if you are skinning Feathers components without a theme, you might use this factory to set skins and other styles on the button group.

The function should have the following signature:

function():ButtonGroup

In the following example, a custom button group factory is provided to the alert:

alert.buttonGroupFactory = function():ButtonGroup
{
    return new ButtonGroup();
};

The default value is null.

See also

The button group sub-component.

For internal use in subclasses.

An object that stores properties for the alert's button group sub-component, and the properties will be passed down to the button group when the alert validates. For a list of available properties, refer to feathers.controls.ButtonGroup.

If the subcomponent has its own subcomponents, their properties can be set too, using attribute @ notation. For example, to set the skin on the thumb which is in a SimpleScrollBar, which is in a List, you can use the following syntax:

list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);

Setting properties in a buttonGroupFactory function instead of using buttonGroupProperties will result in better performance.

In the following example, the button group properties are customized:

alert.buttonGroupProperties.gap = 20;

The default value is null.

See also

The data provider of the alert's ButtonGroup.

The index of the button in the buttonsDataProvider to trigger when Keyboard.ESCAPE or Keyboard.BACK is pressed.

In the following example, the cancelButtonIndex is set to the second button in the data provider.

var alert:Alert = Alert.show( "This is an alert!", "Hello World", new ArrayCollection(
[
    { label: "OK" },
    { label: "Cancel" },
]));
alert.cancelButtonIndex = 1;

The default value is -1.

The default IStyleProvider for all Alert components.

The default value is null.

See also

The header sub-component.

For internal use in subclasses.

The alert's main text content.

A function used to instantiate the alert's message text renderer sub-component. By default, the alert will use the global text renderer factory, FeathersControl.defaultTextRendererFactory(), to create the message text renderer. The message text renderer must be an instance of ITextRenderer. This factory can be used to change properties on the message text renderer when it is first created. For instance, if you are skinning Feathers components without a theme, you might use this factory to style the message text renderer.

If you are not using a theme, the message factory can be used to provide skin the message text renderer with appropriate text styles.

The factory should have the following function signature:

function():ITextRenderer

In the following example, a custom message factory is passed to the alert:

alert.messageFactory = function():ITextRenderer
{
    var messageRenderer:TextFieldTextRenderer = new TextFieldTextRenderer();
    messageRenderer.textFormat = new TextFormat( "_sans", 12, 0xff0000 );
    return messageRenderer;
}

The default value is null.

See also

An object that stores properties for the alert's message text renderer sub-component, and the properties will be passed down to the text renderer when the alert validates. The available properties depend on which ITextRenderer implementation is returned by messageFactory. Refer to feathers.core.ITextRenderer for a list of available text renderer implementations.

In the following example, some properties are set for the alert's message text renderer (this example assumes that the message text renderer is a BitmapFontTextRenderer):

alert.messageProperties.textFormat = new BitmapFontTextFormat( bitmapFont );
alert.messageProperties.wordWrap = true;

If the subcomponent has its own subcomponents, their properties can be set too, using attribute @ notation. For example, to set the skin on the thumb which is in a SimpleScrollBar, which is in a List, you can use the following syntax:

list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);

Setting properties in a messageFactory function instead of using messageProperties will result in better performance.

The default value is null.

See also

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

See also

The message text renderer sub-component.

For internal use in subclasses.

Creates overlays for modal alerts. When this property is null, uses the overlayFactory defined by PopUpManager instead.

Note: Specific, individual alerts may have custom overlays that are different than the default by passing a different overlay factory to Alert.show().

This function is expected to have the following signature:

function():DisplayObject

The following example uses a semi-transparent Quad as a custom overlay:

Alert.overlayFactory = function():Quad
{
    var quad:Quad = new Quad(10, 10, 0x000000);
    quad.alpha = 0.75;
    return quad;
};

The default value is null.

See also

Constructor.

Creates and adds the buttonGroupFooter 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

Creates and adds the header 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

Creates and adds the messageTextRenderer 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

The default factory that creates alerts when Alert.show() is called. To use a different factory, you need to set Alert.alertFactory to a Function instance.

See also

Creates an alert, sets common properties, and adds it to the PopUpManager with the specified modal and centering options.

In the following example, an alert is shown when a Button is triggered:

button.addEventListener( Event.TRIGGERED, button_triggeredHandler );
function button_triggeredHandler( event:Event ):void
{
    var alert:Alert = Alert.show( "This is an alert!", "Hello World", new ArrayCollection(
    [
        { label: "OK" }
    ]);
}

Parameters

Dispatched when the alert is closed. The data property of the event object will contain the item from the ButtonGroup data provider for the button that is triggered. If no button is triggered, then the data property will be null.

The properties of the event object have the following values:

The alert's optional icon content to display next to the text.

In the following example, the icon is privated:

alert.icon = new Image( texture );

The default value is null.

The space, in pixels, between the alert's icon and its message text renderer.

In the following example, the gap is set to 20 pixels:

alert.gap = 20;

The default value is 0.

The font styles used to display the alert's message text.

These styles will only apply to the alert's message. The header's title font styles should be set directly on the header. The button font styles should be set directly on the buttons.

In the following example, the font styles are customized:

alert.fontStyles = new TextFormat( "Helvetica", 20, 0xcc0000 );

Note: The starling.text.TextFormat class defines a number of common font styles, but the text renderer being used may support a larger number of ways to be customized. Use the messageFactory to set more advanced styles.

The default value is null.

See also

The font styles used to display the alert's message text when the alert is disabled.

These styles will only apply to the alert's message. The header's title font styles should be set directly on the header. The button font styles should be set directly on the buttons.

In the following example, the disabled font styles are customized:

alert.disabledFontStyles = new TextFormat( "Helvetica", 20, 0x999999 );

Note: The starling.text.TextFormat class defines a number of common font styles, but the text renderer being used may support a larger number of ways to be customized. Use the messageFactory to set more advanced styles on the text renderer.

The default value is null.

See also

A style name to add to the alert's message text renderer sub-component. Typically used by a theme to provide different styles to different alerts.

In the following example, a custom message style name is passed to the alert:

alert.customMessageStyleName = "my-custom-button-group";

In your theme, you can target this sub-component style name to provide different styles than the default:

getStyleProviderForClass( BitmapFontTextRenderer ).setFunctionForStyleName( "my-custom-message", setCustomMessageStyles );

The default value is null.

See also

A style name to add to the alert's button group sub-component. Typically used by a theme to provide different styles to different alerts.

In the following example, a custom button group style name is passed to the alert:

alert.customButtonGroupStyleName = "my-custom-button-group";

In your theme, you can target this sub-component style name to provide different styles than the default:

getStyleProviderForClass( ButtonGroup ).setFunctionForStyleName( "my-custom-button-group", setCustomButtonGroupStyles );

The default value is null.

See also

The default value added to the styleNameList of the button group.

See also

The default value added to the styleNameList of the header.

See also

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

See also