View source

class TextCallout

package feathers.controls

extends Callout › FeathersControl › MeasureSprite › ValidatingSprite

implements IHTMLTextControl, ITextControl

@:directlyUsed@:build(feathers.macros.StyleContextMacro.build())@:autoBuild(feathers.macros.StyleContextMacro.build())@:build(feathers.macros.StyleMacro.build())@:autoBuild(feathers.macros.StyleMacro.build())@defaultXmlProperty("text")@:styleContext

A special type of Callout designed to display text only.

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

function button_triggerHandler(event:TriggerEvent):Void
{
	var button = cast(event.currentTarget, Button);
	TextCallout.show("Hello World", button);
}
button.addEventListener(TriggerEvent.TRIGGER, button_triggerHandler);
Available since

1.0.0

.

See also:

Static variables

@:value("danger")staticfinalread onlyVARIANT_DANGER:String = "danger"

A variant used to style the callout in a style that indicates that something related to the origin is considered dangerous or in error. Variants allow themes to provide an assortment of different appearances for the same type of UI component.

The following example uses this variant:

callout.variant = TextCallout.VARIANT_DANGER;
Available since

1.0.0

.

See also:

Static methods

@:value({ modal : true })staticshow(text:String, origin:DisplayObject, ?supportedPositions:RelativePositions, modal:Bool = true):TextCallout

Creates a text callout, and then positions and sizes it automatically based based on an origin component and an optional set of positions.

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

function button_triggerHandler(event:TriggerEvent):Void
{
	var button = cast(event.currentTarget, Button);
	TextCallout.show("Hello World", button);
}
button.addEventListener(TriggerEvent.TRIGGER, button_triggerHandler);
Available since

1.0.0

.

Constructor

@:value({ text : "" })new(text:String = "")

Creates a new TextCallout object.

In general, a TextCallout shouldn't be instantiated directly with the constructor. Instead, use the static function TextCallout.show() to create a TextCallout, as this often requires less pop-up management code.

Available since

1.0.0

.

See also:

Variables

read onlybaseline:Float

See also:

@:style@:flash.propertydisabledTextFormat:AbstractTextFormat

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

In the following example, the text callout's disabled text formatting is customized:

callout.enabled = false;
callout.disabledTextFormat = new TextFormat("Helvetica", 20, 0xee0000);
Available since

1.0.0

.

See also:

@:style@:flash.propertyembedFonts:Bool

Determines if an embedded font is used or not.

In the following example, the callout uses embedded fonts:

callout.embedFonts = true;
Available since

1.0.0

.

See also:

htmlText:String

Text displayed by the callout that is parsed as a simple form of HTML.

The following example sets the callout's HTML text:

callout.htmlText = "<b>Hello</b> <i>World</i>";
Available since

1.0.0

.

See also:

@:inspectabletext:String

The text displayed by the text callout.

The following example creates a text callout and changes its text:

var callout = TextCallout.show("Good morning!", origin);
callout.text = "Good afternoon!";
Available since

1.0.0

.

See also:

@:style@:flash.propertytextFormat:AbstractTextFormat

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

In the following example, the text callout's formatting is customized:

callout.textFormat = new TextFormat("Helvetica", 20, 0xcc0000);
Available since

1.0.0

.

See also:

@:style@:flash.propertywordWrap:Bool

Determines if the text is displayed on a single line, or if it wraps.

In the following example, the callout's text wraps at 150 pixels:

callout.width = 150.0;
callout.wordWrap = true;
Available since

1.0.0

.

Inherited Variables

Defined by Callout

@:style@:flash.propertyarrowPosition:RelativePosition

The edge of the callout where the arrow is positioned.

When calling Callout.show(), the arrowPosition property will be managed automatically and should not be modified.

Available since

1.0.0

.

@:style@:flash.propertybackgroundSkin:DisplayObject

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

In the following example, the callout's background is set to a bitmap:

callout.backgroundSkin = new Bitmap(bitmapData);
Available since

1.0.0

.

@:style@:flash.propertybottomArrowGap:Float

The gap, in pixels, between the callout and the bottomArrowSkin.

In the following example, the callout's bottom arrow gap is set to -1.0 pixels:

callout.bottomArrowGap = -1.0;
Available since

1.0.0

.

@:style@:flash.propertybottomArrowSkin:DisplayObject

The arrow skin to display when the arrow is positioned on the bottom of the callout.

In the following example, the callout's bottom arrow skin is set to a bitmap:

callout.bottomArrowSkin = new Bitmap(bitmapData);
Available since

1.0.0

.

@:value(true)closeOnPointerOutside:Bool = true

Available since

1.0.0

.

content:DisplayObject

The display object that will be displayed by the callout.

This object may be resized to fit the callout's bounds. If the content needs to be scrolled when placed into a smaller region than its ideal size, it should be added to a ScrollContainer, and the ScrollContainer should be passed in as the content.

In the following example, the callout's content is a bitmap:

callout.content = new Bitmap(bitmapData);
Available since

1.0.0

.

See also:

@:style@:flash.propertygap:Float

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

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

callout.gap = 20.0;
Available since

1.0.0

.

@:style@:flash.propertyhorizontalAlign:HorizontalAlign

The horizontal alignment of the callout, relative to the origin, if the callout is positioned on the top or bottom side of the origin.

The following example aligns the callout to the right:

callout.horizontalAlign = RIGHT;

Note: The HorizontalAlign.JUSTIFY constant is not supported by this component.

Available since

1.0.0

.

See also:

@:style@:flash.propertyleftArrowGap:Float

The gap, in pixels, between the callout and the leftArrowSkin.

In the following example, the callout's left arrow gap is set to -1.0 pixels:

callout.leftArrowGap = -1.0;
Available since

1.0.0

.

@:style@:flash.propertyleftArrowSkin:DisplayObject

The arrow skin to display when the arrow is positioned on the left side of the callout.

In the following example, the callout's left arrow skin is set to a bitmap:

callout.leftArrowSkin = new Bitmap(bitmapData);
Available since

1.0.0

.

@:style@:flash.propertymarginBottom:Float

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

In the following example, the callout's bottom margin is set to 20 pixels:

callout.marginBottom = 20.0;
Available since

1.0.0

.

@:style@:flash.propertymarginLeft:Float

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

In the following example, the callout's left margin is set to 20 pixels:

callout.marginLeft = 20.0;
Available since

1.0.0

.

@:style@:flash.propertymarginRight:Float

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

In the following example, the callout's right margin is set to 20 pixels:

callout.marginRight = 20.0;
Available since

1.0.0

.

@:style@:flash.propertymarginTop:Float

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

In the following example, the callout's top margin is set to 20 pixels:

callout.marginTop = 20.0;
Available since

1.0.0

.

origin:DisplayObject

A callout may be positioned relative to another display object, known as the origin. Even if the position of the origin changes, the callout will be re-positioned automatically to always point at the origin.

Available since

1.0.0

.

See also:

@:style@:flash.propertypaddingBottom:Float

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

In the following example, the callout's bottom padding is set to 20 pixels:

callout.paddingBottom = 20.0;
Available since

1.0.0

.

@:style@:flash.propertypaddingLeft:Float

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

In the following example, the callout's left padding is set to 20 pixels:

callout.paddingLeft = 20.0;
Available since

1.0.0

.

@:style@:flash.propertypaddingRight:Float

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

In the following example, the callout's right padding is set to 20 pixels:

callout.paddingRight = 20.0;
Available since

1.0.0

.

@:style@:flash.propertypaddingTop:Float

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

In the following example, the callout's top padding is set to 20 pixels:

callout.paddingTop = 20.0;
Available since

1.0.0

.

@:style@:flash.propertyrightArrowGap:Float

The gap, in pixels, between the callout and the rightArrowSkin.

In the following example, the callout's right arrow gap is set to -1.0 pixels:

callout.rightArrowGap = -1.0;
Available since

1.0.0

.

@:style@:flash.propertyrightArrowSkin:DisplayObject

The arrow skin to display when the arrow is positioned on the right side of the callout.

In the following example, the callout's right arrow skin is set to a bitmap:

callout.rightArrowSkin = new Bitmap(bitmapData);
Available since

1.0.0

.

supportedPositions:Array<RelativePosition>

The set of positions that the callout may appear at, relative to its origin. Positioning of the callout is attempted in order, and if the callout does not fit between the origin and the edge of the stage, the next position is attempted. If the callout is too large for all positions, the position with the most space will be used.

Available since

1.0.0

.

See also:

@:style@:flash.propertytopArrowGap:Float

The gap, in pixels, between the callout and the topArrowSkin.

In the following example, the callout's top arrow gap is set to -1.0 pixels:

callout.topArrowGap = -1.0;
Available since

1.0.0

.

@:style@:flash.propertytopArrowSkin:DisplayObject

The arrow skin to display when the arrow is positioned on the top of the callout.

In the following example, the callout's top arrow skin is set to a bitmap:

callout.topArrowSkin = new Bitmap(bitmapData);
Available since

1.0.0

.

@:style@:flash.propertyverticalAlign:VerticalAlign

The vertical alignment of the callout, relative to the origin, if the callout is positioned on the left or right side of the origin.

The following example aligns the callout to the top:

callout.verticalAlign = TOP;

Note: The VerticalAlign.JUSTIFY constant is not supported by this component.

Available since

1.0.0

.

See also:

Defined by FeathersControl

@:stylealwaysShowFocus:Bool

Indicates if the focusRectSkin should always be displayed when the component is focused, or only after keyboard focus changes.

Available since

1.3.0

.

@:bindable("creationComplete")read onlycreated:Bool

Determines if the component has been initialized and validated for the first time.

In the following example, we check if the component is created or not, and we listen for an event if it isn't:

if(!control.created)
{
	control.addEventListener(FeathersEventType.CREATION_COMPLETE, creationCompleteHandler);
}
Available since

1.0.0

.

See also:

@styledisabledAlpha:Null<Float>

When disabledAlpha is not null, sets the alpha property to this value when the the enabled property is set to false.

Available since

1.0.0

.

@:inspectable(defaultValue = "true")enabled:Bool

See also:

focusEnabled:Bool

See also:

focusManager:IFocusManager

See also:

focusOwner:IFocusObject

See also:

@stylefocusPaddingBottom:Float

Optional padding outside the bottom edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@stylefocusPaddingLeft:Float

Optional padding outside the left edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@stylefocusPaddingRight:Float

Optional padding outside the right edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@stylefocusPaddingTop:Float

Optional padding outside the top edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@stylefocusRectSkin:DisplayObject

An optional skin to display when an IFocusObject component receives focus.

Available since

1.0.0

.

@:bindable("layoutDataChange")includeInLayout:Bool

See also:

@:bindable("initialize")read onlyinitialized:Bool

Determines if the component has been initialized yet. The initialize() function is called one time only, when the Feathers UI control is added to the display list for the first time.

In the following example, we check if the component is initialized or not, and we listen for an event if it isn't initialized:

if(!control.initialized)
{
	control.addEventListener(FeathersEvent.INITIALIZE, initializeHandler);
}
Available since

1.0.0

.

See also:

@style@:bindable("layoutDataChange")layoutData:ILayoutData

See also:

read onlystyleContext:Class<IStyleObject>

The class used as the context for styling the component. If a subclass of a component should have different styles than its superclass, it should override the get_styleContext getter. However, if a subclass should continue using the same styles as its superclass, it happens automatically.

Available since

1.0.0

.

styleProvider:IStyleProvider

Typically used by the theme to provide styles to each component, but a custom style provider may be provided that will take precedence over the theme's style provider.

When a component initializes, its style provider sets properties that affect the component's visual appearance. If the style provider dispatches StyleProviderEvent.STYLES_CHANGE after the component has initialized, the original properties set by the style provider will be reset to their default values and before applying the new property values.

Setting the style provider or replacing an existing style provider before a component initializes will queue up the style changes until after initialization. Once a component initializes, the style provider may be changed, but the changes will be applied immediately. Similarly to when a style provider dispatcches StyleProviderEvent.STYLES_CHANGE, any properties that were set by the previous style provider will be reset to their default values before applying the new style provider.

If the themeEnabled property is false, the current theme's style provider will be ignored. However, if a custom style provider was provided from outside of the theme, it will still be used.

Available since

1.0.0

.

See also:

themeEnabled:Bool

See also:

toolTip:String

See also:

@:inspectablevariant:String

May be used to provide multiple different variations of the same UI component, each with a different appearance.

Available since

1.0.0

.

Defined by MeasureSprite

Defined by ValidatingSprite

read onlydepth:Int

See also:

read onlyvalidating:Bool

Indicates if the display object is currently validating.

Available since

1.0.0

.

Inherited Methods

Defined by Callout

close():Void

Closes the callout, if opened.

When the callout closes, it will dispatch an event of type Event.CLOSE.

Available since

1.0.0

.

See also:

setPadding(value:Float):Void

Sets all four padding properties to the same value.

Available since

1.0.0

.

See also:

Defined by FeathersControl

private@:dox(show)initialize():Void

Called the first time that the UI control is added to the stage, and you should override this function to customize the initialization process. Do things like create children and set up event listeners. After this function is called, `FeathersEvent.INITIALIZE is dispatched.

The following example overrides initialization:

override private function initialize():Void {
	super.initialize();

}
Available since

1.0.0

.

See also:

initializeNow():Void

See also:

move(x:Float, y:Float):Void

Sets both the x and y positions of the control in a single function call.

Available since

1.0.0

.

See also:

  • DisplayObject.x

  • DisplayObject.y

setFocusPadding(value:Float):Void

Sets all four padding properties to the same value.

Available since

1.0.0

.

See also:

setSize(width:Float, height:Float):Void

Sets both the width and height dimensions of the control in a single function call.

Available since

1.0.0

.

See also:

  • DisplayObject.width

  • DisplayObject.height

private@:dox(show)setStyle(styleName:String, ?state:EnumValue):Bool

Determines if a style may be changed, and restricts the style from being changed in the future, if necessary.

Available since

1.0.0

.

showFocus(show:Bool):Void

See also:

Defined by MeasureSprite

resetHeight():Void

See also:

resetMaxHeight():Void

See also:

resetMaxWidth():Void

See also:

resetMinHeight():Void

See also:

resetMinWidth():Void

See also:

resetWidth():Void

See also:

private@:value({ minHeight : 0.0, minWidth : 0.0 })@:dox(show)saveMeasurements(width:Float, height:Float, minWidth:Float = 0.0, minHeight:Float = 0.0, ?maxWidth:Float, ?maxHeight:Float):Bool

Saves the calculated dimensions for the component, replacing any values that haven't been set explicitly. Returns true if the reported values have changed and Event.RESIZE was dispatched.

Available since

1.0.0

.

Defined by ValidatingSprite

isInvalid(?flag:InvalidationFlag):Bool

Indicates whether the control is pending validation or not. By default, returns true if any invalidation flag has been set. If you pass in a specific flag, returns true only if that flag has been set (others may be set too, but it checks the specific flag only. If all flags have been marked as invalid, always returns true.

The following example invalidates a component:

component.setInvalid();
trace(component.isInvalid()); // true
Available since

1.0.0

.

runWithInvalidationFlagsOnly(callback:() ‑> Void):Void

Calls a function that temporarily limits setInvalid() calls to setting invalidation flags only, and the control will not be added to the validation queue. In other words, setInvalid() calls will work similarly to setInvalidationFlag() instead.

Typically, this method should be called only during validation. If called outside of update(), the component's validation may be delayed until a future call to setInvalid().

Available since

1.2.0

.

runWithoutInvalidation(callback:() ‑> Void):Void

Calls a function that temporarily disables invalidation. In other words, calls to setInvalid() will be ignored until the function returns.

Available since

1.0.0

.

setInvalid(?flag:InvalidationFlag):Void

Call this function to tell the UI control that a redraw is pending. The redraw will happen immediately before OpenFL renders the UI control to the screen. The validation system exists to ensure that multiple properties can be set together without redrawing multiple times in between each property change.

If you cannot wait until later for the validation to happen, you can call validate() to redraw immediately. As an example, you might want to validate immediately if you need to access the correct width or height values of the UI control, since these values are calculated during validation.

The following example invalidates a component:

component.setInvalid();
trace(component.isInvalid()); // true
Available since

1.0.0

.

private@:dox(show)setInvalidationFlag(flag:InvalidationFlag):Void

Sets an invalidation flag. This will not add the component to the validation queue. It only sets the flag. A subclass might use this function during draw() to manipulate the flags that its superclass sees.

Available since

1.0.0

.

See also:

private@:dox(show)update():Void

Override to customize layout and to adjust properties of children. Called when the component validates, if any flags have been marked to indicate that validation is pending.

The following example overrides updating after invalidation:

override private function update():Void {
	super.update();

}
Available since

1.0.0

.