Returns a new Callout instance when Callout.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():Callout

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

Callout.calloutFactory = function():Callout
{
    var callout:Callout = new Callout();
    //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

Returns an overlay to display with a callout that is modal. Uses the standard overlayFactory of the PopUpManager by default, but you can use this property to provide your own custom overlay, if you prefer.

This function is expected to have the following signature:

function():DisplayObject

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

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

See also

The callout will be closed if any of these keys are pressed.

In the following example, the callout close when the Escape key is pressed:

callout.closeOnKeys = new <uint>[Keyboard.ESCAPE];

See also

Determines if the callout is automatically closed if a touch in the TouchPhase.BEGAN phase happens outside of the callout's or the origin's bounds.

In the following example, the callout will not close when a touch event with TouchPhase.BEGAN is detected outside the callout's (or its origin's) bounds:

callout.closeOnTouchBeganOutside = false;

See also

Determines if the callout is automatically closed if a touch in the TouchPhase.ENDED phase happens outside of the callout's or the origin's bounds.

In the following example, the callout will not close when a touch event with TouchPhase.ENDED is detected outside the callout's (or its origin's) bounds:

callout.closeOnTouchEndedOutside = false;

See also

The display object that will be presented by the callout. This object may be resized to fit the callout's bounds. If the content needs to be scrolled if placed into a smaller region than its ideal size, it must provide its own scrolling capabilities because the callout does not offer scrolling.

In the following example, the callout's content is an image:

callout.content = new Image( texture );

The default value is null.

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

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

callout.disposeContent = false;

Determines if the callout will be disposed when close() is called internally. Close may be called internally in a variety of cases, depending on values such as closeOnTouchBeganOutside, closeOnTouchEndedOutside, and closeOnKeys. If set to false, you may reuse the callout later by giving it a new origin and adding it to the PopUpManager again.

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

callout.disposeOnSelfClose = false;

See also

The default IStyleProvider for all Callout components.

The default value is null.

See also

A callout may be positioned relative to another display object, known as the callout's origin. Even if the position of the origin changes, the callout will reposition itself to always point at the origin.

When an origin is set, the arrowPosition and arrowOffset properties will be managed automatically by the callout. Setting either of these values manually will either have no effect or unexpected behavior, so it is recommended that you avoid modifying those properties.

Note: The origin is excluded when using closeOnTouchBeganOutside and closeOnTouchEndedOutside. In other words, when the origin is touched, and either of these properties is true, the callout will not be closed. If the callout is not displayed modally, and touching the origin opens the callout, you should check if a callout is already visible. If a callout is visible, close it. If no callouts are visible, show one. However, if the callout is modal, the touch will be stopped by the overlay before it reaches the origin, so this behavior will not apply.

In general, if you use Callout.show(), you will rarely need to manually manage the origin property.

In the following example, the callout's origin is set to a button:

callout.origin = button;

The default value is null.

See also

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

The following example gives the stage 20 pixels of padding on all sides:

Callout.stagePadding = 20;

The default value is 0.

See also

The padding between a callout and the bottom edge of the stage when the callout is positioned automatically. May be ignored if the callout is too big for the stage.

In the following example, the bottom stage padding will be set to 20 pixels:

Callout.stagePaddingBottom = 20;

The margin between a callout and the top edge of the stage when the callout is positioned automatically. May be ignored if the callout is too big for the stage.

In the following example, the left stage padding will be set to 20 pixels:

Callout.stagePaddingLeft = 20;

The padding between a callout and the right edge of the stage when the callout is positioned automatically. May be ignored if the callout is too big for the stage.

In the following example, the right stage padding will be set to 20 pixels:

Callout.stagePaddingRight = 20;

The padding between a callout and the top edge of the stage when the callout is positioned automatically. May be ignored if the callout is too big for the stage.

In the following example, the top stage padding will be set to 20 pixels:

Callout.stagePaddingTop = 20;

The position of the callout, relative to its origin. Accepts a Vector.<String> containing one or more of the constants from feathers.layout.RelativePosition or null. If null, the callout will attempt to position itself using values in the following order:

• RelativePosition.BOTTOM
• RelativePosition.TOP
• RelativePosition.RIGHT
• RelativePosition.LEFT

Note: If the callout's origin is not set, the supportedPositions property will be ignored.

In the following example, the callout's supported positions are restricted to the top and bottom of the origin:

callout.supportedPositions = new <String>[RelativePosition.TOP, RelativePosition.BOTTOM];

In the following example, the callout's position is restricted to the right of the origin:

callout.supportedPositions = new <String>[RelativePosition.RIGHT];

Note: The arrowPosition property is related to this one, but they have different meanings and are usually opposites. For example, a callout on the right side of its origin will generally display its left arrow.

The default value is null.

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 callout.

Parameters

The default factory that creates callouts when Callout.show() is called. To use a different factory, you need to set Callout.calloutFactory to a Function instance.

Creates a callout, and then positions and sizes it automatically based on an origin rectangle and the specified direction relative to the original. The provided width and height values are optional, and these values may be ignored if the callout cannot be drawn at the specified dimensions.

The supportedPositions parameter should be a Vector.<String> of values from the feathers.layout.RelativePosition class. The positions should be ordered by preference. This parameter is typed as Object to allow some deprecated String values. In a future version of Feathers, the type will change to Vector.<String> instead.

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

button.addEventListener( Event.TRIGGERED, button_triggeredHandler );
function button_triggeredHandler( event:Event ):void
{
    var label:Label = new Label();
    label.text = "Hello World!";
    var button:Button = Button( event.currentTarget );
    Callout.show( label, button );
}

Parameters

Dispatched when the callout is closed.

The properties of the event object have the following values:

The offset, in pixels, of the arrow skin from the horizontal center or vertical middle of the background skin, depending on the position of the arrow (which side it is on). This value is used to point at the callout's origin when the callout is not perfectly centered relative to the origin.

On the top and bottom edges, the arrow will move left for negative values of arrowOffset and right for positive values. On the left and right edges, the arrow will move up for negative values and down for positive values.

If you use Callout.show() or set the origin property manually, you should avoid manually modifying the arrowPosition and arrowOffset properties.

In the following example, the arrow offset is set to 20 pixels:

callout.arrowOffset = 20;

The default value is 0.

See also

The vertical alignment of the callout, relative to the origin.

Note: The VerticalAlign.JUSTIFY constant is not supported.

The default value is feathers.layout.VerticalAlign.MIDDLE.

See also

The arrow skin to display on the top edge of the callout. This arrow is displayed when the callout is displayed below the region it points at.

In the following example, the callout's top arrow skin is set to an image:

callout.topArrowSkin = new Image( texture );

The default value is null.

See also

The space, in pixels, between the top arrow skin and the background skin. To have the arrow overlap the background, you may use a negative gap value.

In the following example, the gap between the callout and its top arrow is set to -4 pixels (perhaps to hide a border on the callout's background):

callout.topArrowGap = -4;

The default value is 0.

See also

The arrow skin to display on the right edge of the callout. This arrow is displayed when the callout is displayed to the left of the region it points at.

In the following example, the callout's right arrow skin is set to an image:

callout.rightArrowSkin = new Image( texture );

The default value is null.

See also

The space, in pixels, between the right arrow skin and the background skin. To have the arrow overlap the background, you may use a negative gap value.

In the following example, the gap between the callout and its right arrow is set to -4 pixels (perhaps to hide a border on the callout's background):

callout.rightArrowGap = -4;

The default value is 0.

See also

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

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

callout.paddingLeft = 20;

The default value is 0.

See also

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

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

callout.paddingBottom = 20;

The default value is 0.

See also

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

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

callout.paddingRight = 20;

The default value is 0.

See also

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

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

callout.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 callout is set to 20 pixels:

callout.padding = 20;

The default value is 0.

See also

The space, in pixels, between the callout and the origin.

In the following example, the gap between the callout and its origin is set to 10 pixels:

callout.originGap = 10;

The default value is 0.

See also

The arrow skin to display on the left edge of the callout. This arrow is displayed when the callout is displayed to the right of the region it points at.

In the following example, the callout's left arrow skin is set to an image:

callout.leftArrowSkin = new Image( texture );

The default value is null.

See also

The space, in pixels, between the right arrow skin and the background skin. To have the arrow overlap the background, you may use a negative gap value.

In the following example, the gap between the callout and its left arrow is set to -4 pixels (perhaps to hide a border on the callout's background):

callout.leftArrowGap = -4;

The default value is 0.

See also

The horizontal alignment of the callout, relative to the origin.

Note: The HorizontalAlign.JUSTIFY constant is not supported.

The default value is feathers.layout.HorizontalAlign.CENTER.

See also

The arrow skin to display on the bottom edge of the callout. This arrow is displayed when the callout is displayed above the region it points at.

In the following example, the callout's bottom arrow skin is set to an image:

callout.bottomArrowSkin = new Image( texture );

The default value is null.

See also

The space, in pixels, between the bottom arrow skin and the background skin. To have the arrow overlap the background, you may use a negative gap value.

In the following example, the gap between the callout and its bottom arrow is set to -4 pixels (perhaps to hide a border on the callout's background):

callout.bottomArrowGap = -4;

The default value is 0.

See also

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

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

callout.backgroundSkin = new Image( texture );

The default value is null.

The position of the callout's arrow relative to the callout's background. If the callout's origin is set, this value will be managed by the callout and may change automatically if the origin moves to a new position or if the stage resizes.

The supportedPositions property is related to this one, but they have different meanings and are usually opposites. For example, a callout on the right side of its origin will generally display its left arrow.

If you use Callout.show() or set the origin property manually, you should avoid manually modifying the arrowPosition and arrowOffset properties.

In the following example, the callout's arrow is positioned on the left side:

callout.arrowPosition = RelativePosition.LEFT;

The default value is feathers.layout.RelativePosition.TOP.

See also

The default positions used by a callout.