Returns a new TextCallout instance when TextCallout.show() is called. If one wishes to skin the callout manually or change its behavior, a custom factory may be provided.

This function is expected to have the following signature:

function():TextCallout

The following example shows how to create a custom text callout factory:

TextCallout.calloutFactory = function():TextCallout
{
    var callout:TextCallout = new TextCallout();
    //set properties here!
    return callout;
};

Note: the default callout factory sets the following properties:

callout.closeOnTouchBeganOutside = true;
callout.closeOnTouchEndedOutside = true;
callout.closeOnKeys = new <uint>[Keyboard.BACK, Keyboard.ESCAPE];

See also

The default IStyleProvider for all Label components.

The default value is null.

See also

The text to display in the callout.

The text renderer.

See also

A function used to instantiate the callout's text renderer sub-component. By default, the callout will use the global text renderer factory, FeathersControl.defaultTextRendererFactory(), to create the text renderer. The text renderer must be an instance of ITextRenderer. This factory can be used to change properties on the 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 text renderer.

The factory should have the following function signature:

function():ITextRenderer

In the following example, a custom text renderer factory is passed to the callout:

callout.textRendererFactory = function():ITextRenderer
{
    return new TextFieldTextRenderer();
}

The default value is null.

See also

The value added to the styleNameList of the text renderer sub-component. 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_TEXT_RENDERER.

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

See also

Constructor.

Creates and adds the textRenderer 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 callouts when TextCallout.show() is called. To use a different factory, you need to set TextCallout.calloutFactory to a Function instance.

Creates a callout that displays some text, and then positions and sizes it automatically based on an origin rectangle and the specified positions, relative to the origin.

In the following example, a text callout is shown when a Button is triggered:

button.addEventListener( Event.TRIGGERED, button_triggeredHandler );
function button_triggeredHandler( event:Event ):void
{
    var button:Button = Button( event.currentTarget );
    TextCallout.show( "Hello World", button );
}

Parameters

Dispatched when the callout is closed.

The properties of the event object have the following values:

Determines if the text wraps to the next line when it reaches the width (or max width) of the component.

In the following example, the text is not wrapped:

label.wordWrap = false;

The default value is true.

The font styles used to display the callout's text.

In the following example, the font styles are customized:

callout.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 textRendererFactory to set more advanced styles.

The default value is null.

See also

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

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

callout.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 textRendererFactory to set more advanced styles on the text renderer.

The default value is null.

See also

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

In the following example, a custom text renderer style name is passed to the callout:

button.customTextRendererStyleName = "my-custom-text-callout-text-renderer";

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

getStyleProviderForClass( BitmapFontTextRenderer ).setFunctionForStyleName( "my-custom-text-callout-text-renderer", setCustomTextCalloutTextRendererStyles );

The default value is null.

See also

The default value added to the styleNameList of the text renderer sub-component.

See also