The data provider of the toast's ButtonGroup.

A function used to generate the toast'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 toast:

toast.actionsFactory = function():ButtonGroup
{
    return new ButtonGroup();
};

The default value is null.

See also

The actions button group sub-component.

For internal use in subclasses.

The value added to the styleNameList of the toast's actions button group. This variable is protected so that sub-classes can customize the actions style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_ACTIONS.

See also

An optional effect that is activated when the toast is closed.

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

toast.closeEffect = Fade.createFadeBetweenEffect(1, 0);

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.

toast.closeEffect = function(target:DisplayObject):IEffectContext
{
    toast.alpha = 1;
    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

Create a container for toasts that is added to the pop-up manager. Useful for customizing the layout of toasts.

This function is expected to have the following signature:

function():DisplayObjectContainer

The following example shows how to create a custom toast container:

Toast.containerFactory = function():DisplayObjectContainer
{
    var container:LayoutGroup = new LayoutGroup();
    container.layout = new VerticalLayout();
    return container;
};

See also

Optional custom content to display in the toast.

Determines if the toast's content will be disposed when the toast is disposed. If set to false, the toast's content may be added to the display list again later.

In the following example, the toast's content will not be disposed when the toast is disposed:

toast.disposeContent = false;

The default value is true.

See also

Determines if the toast will be disposed when close() is called internally. Close may be called internally in a variety of cases, depending on values such as timeout and actions. If set to false, you may reuse the toast later by passing it to Toast.showToast().

In the following example, the toast will not be disposed when it closes itself:

toast.disposeOnSelfClose = false;

The default value is true.

See also

The default IStyleProvider for all Toast components.

The default value is null.

See also

Indicates if the toast is currently closing.

See also

Indicates if the toast is currently open. Does not change from false to true until the open effect has completed. Similarly, does not change from true to false until the close effect has completed.

See also

Indicates if the toast is currently opening.

See also

The maximum number of toasts that can be displayed simultaneously. Additional toasts will be queued up to display after the current toasts are removed.

The toast's main text content.

A function used to instantiate the toast's message text renderer sub-component. By default, the toast 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 toast:

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

The default value is null.

See also

The value added to the styleNameList of the toast'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.

An optional effect that is activated when the toast is opened.

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

toast.openEffect = 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.

toast.closeEffect = function(target:DisplayObject):IEffectContext
{
    toast.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

Determines how timeouts are treated when toasts need to be queued up because there are already maxVisibleToasts visible. Either waits until the timeout is complete, or immediately closes an existing toast and shows the queued toast after the closing effect is done.

The time, in seconds, when the toast will automatically close. Set to Number.POSITIVE_INFINITY to require the toast to be closed manually.

The default value is Number.POSITIVE_INFINITY.

Used to create a new Toast instance in the showMessage(), showMessageWithActions(), or showContent() functions. Useful for customizing the styles of toasts without a theme.

This function is expected to have the following signature:

function():Toast

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

Toast.toastFactory = function():Toast
{
    var toast:Toast = new Toast();
    toast.backgroundSkin = new Image( texture );
    toast.padding = 10;
    return toast;
};

See also

Constructor.

If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself. If the explicitWidth or explicitHeight member variables are set, those value will be used without additional measurement. If one is set, but not the other, the dimension with the explicit value will not be measured, but the other non-explicit dimension will still need 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.

Closes the toast and optionally disposes it. If a closeEffect has been specified, it will be played.

Parameters

See also

Creates and adds the actionsGroup 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 the action button group. To use a different factory, you need to set actionsFactory to a Function instance.

Positions and sizes the toast's content.

For internal use in subclasses.

Shows a toast with custom content.

Parameters

See also

Shows a toast with a simple text message.

Parameters

See also

Shows a toast with a text message and some action buttons.

Parameters

See also

Shows a toast instance.

Parameters

See also

Dispatched when the toast is closed. This event is dispatched after the closeEffect has completed, if one is defined.

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:

See also

Dispatched when the toast is opened. This event is dispatched after the openEffect has completed, if one is defined.

The properties of the event object have the following values:

See also

The minimum space, in pixels, between the toast's left edge and the toast's content.

In the following example, the padding on the left edge of the toast is set to 20 pixels:

toast.paddingLeft = 20;

The default value is 0.

See also

The minimum space, in pixels, between the toast's bottom edge and the toast's content.

In the following example, the padding on the bottom edge of the toast is set to 20 pixels:

toast.paddingBottom = 20;

The default value is 0.

See also

The minimum space, in pixels, between the toast's right edge and the toast's content.

In the following example, the padding on the right edge of the toast is set to 20 pixels:

toast.paddingRight = 20;

The default value is 0.

See also

The minimum space, in pixels, between the toast's top edge and the toast's content.

In the following example, the padding on the top edge of the toast is set to 20 pixels:

toast.paddingTop = 20;

The default value is 0.

See also

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

In the following example, the padding of all sides of the toast is set to 20 pixels:

toast.padding = 20;

The default value is 0.

See also

If the value of the gap property is Number.POSITIVE_INFINITY, meaning that the gap will fill as much space as possible, the final calculated value will not be smaller than the value of the minGap property.

The following example ensures that the gap is never smaller than 20 pixels:

toast.gap = Number.POSITIVE_INFINITY;
toast.minGap = 20;

The default value is 0.

See also

The space, in pixels, between the message text renderer and the actions button group. Applies to either horizontal or vertical spacing, depending on the value of actionsPosition.

If gap is set to Number.POSITIVE_INFINITY, the message and actions will be positioned as far apart as possible. In other words, they will be positioned at the edges of the toast, adjusted for padding.

The following example creates a gap of 50 pixels between the label and the icon:

toast.gap = 50;

The default value is 0.

See also

The font styles used to display the toast's message.

In the following example, the font styles are customized:

toast.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 toast's message when the button is disabled.

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

toast.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 toast's message text renderer sub-component. Typically used by a theme to provide different styles to different toasts.

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

toast.customMessageStyleName = "my-custom-toast-message";

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

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

The default value is null.

See also

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

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

toast.customActionsStyleName = "my-custom-toast-actions";

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

getStyleProviderForClass( ButtonGroup ).setFunctionForStyleName( "my-custom-toast-actions", setCustomToastActionsStyles );

The default value is null.

See also

The primary background to display behind the toast's content.

In the following example, the toast's background is set to an image:

toast.backgroundSkin = new Image( texture );

The default value is null.

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

See also

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

See also