View source

class Label

package feathers.controls

extends FeathersControl › MeasureSprite › ValidatingSprite

implements IStageFocusDelegate, IFocusObject, IHTMLTextControl, ITextControl

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

Displays text with an optional background.

The following example creates a label and gives it text:

var label = new Label();
label.text = "Hello World";
this.addChild(label);
Available since

1.0.0

.

See also:

Static variables

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

A variant used to style the label using an appearance that indicates an error or warning.

The following example uses this variant:

var label = new Label();
label.variant = Label.VARIANT_DANGER;
Available since

1.1.0

.

See also:

@:value("detail")staticfinalread onlyVARIANT_DETAIL:String = "detail"

A variant used to style the label using a smaller text format for details. Variants allow themes to provide an assortment of different appearances for the same type of UI component.

The following example uses this variant:

var label = new Label();
label.variant = Label.VARIANT_DETAIL;
Available since

1.0.0

.

See also:

@:value("heading")staticfinalread onlyVARIANT_HEADING:String = "heading"

A variant used to style the label using a Larger text format for headings. Variants allow themes to provide an assortment of different appearances for the same type of UI component.

The following example uses this variant:

var label = new Label();
label.variant = Label.VARIANT_HEADING;
Available since

1.0.0

.

See also:

Constructor

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

Creates a new Label object.

Available since

1.0.0

.

Variables

@:style@:flash.propertybackgroundSkin:DisplayObject

The default background skin to display behind the label's text.

The following example passes a bitmap for the label to use as a background skin:

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

1.0.0

.

See also:

read onlybaseline:Float

See also:

@:style@:flash.propertydisabledBackgroundSkin:DisplayObject

A background skin to display behind the label's text when the label is disabled.

The following example gives the label a disabled background skin:

label.disabledBackgroundSkin = new Bitmap(bitmapData);
label.enabled = false;
Available since

1.0.0

.

See also:

@:style@:flash.propertydisabledTextFormat:AbstractTextFormat

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

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

label.enabled = false;
label.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 label uses embedded fonts:

label.embedFonts = true;
Available since

1.0.0

.

See also:

htmlText:String

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

The following example sets the label's HTML text:

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

1.0.0

.

See also:

@:style@:flash.propertypaddingBottom:Float

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

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

label.paddingBottom = 20.0;
Available since

1.0.0

.

@:style@:flash.propertypaddingLeft:Float

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

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

label.paddingLeft = 20.0;
Available since

1.0.0

.

@:style@:flash.propertypaddingRight:Float

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

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

label.paddingRight = 20.0;
Available since

1.0.0

.

@:style@:flash.propertypaddingTop:Float

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

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

label.paddingTop = 20.0;
Available since

1.0.0

.

selectable:Bool

Indicates if the label's text may be selected or not.

In the following example, the label text is selectable:

label.selectable = true;
Available since

1.0.0

.

read onlyselectionBeginIndex:Int

The start index of the selection.

If selectable is false, returns -1.

Available since

1.0.0

.

read onlyselectionEndIndex:Int

The end index of the selection.

If selectable is false, returns -1.

Available since

1.0.0

.

@:inspectabletext:String

The text displayed by the label.

The following example sets the label's text:

label.text = "Good afternoon!";

Note: If the htmlText property is not null, the text property will be ignored.

Available since

1.0.0

.

See also:

@:style@:flash.propertytextFormat:AbstractTextFormat

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

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

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

1.0.0

.

See also:

@:style@:flash.propertyverticalAlign:VerticalAlign

How the content is positioned vertically (along the y-axis) within the label.

The following example aligns the label's content to the top:

label.verticalAlign = TOP;

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

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 label's text wraps at 150 pixels:

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

1.0.0

.

Methods

setPadding(value:Float):Void

Sets all four padding properties to the same value.

Available since

1.0.0

.

See also:

Inherited Variables

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 FeathersControl

dispose():Void

See also:

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

.