A text entry control that allows users to enter and edit multiple lines of uniformly-formatted text with the ability to scroll.

The following example sets the text in a text area, selects the text, and listens for when the text value changes:

var textArea = new TextArea();
textArea.text = "Hello\nWorld"; //it's multiline!
textArea.selectRange(0, textArea.text.length);
textArea.addEventListener(Event.CHANGE, textArea_changeHandler);
this.addChild( textArea );

Events:

openfl.events.Event.CHANGE

Dispatched when TextArea.text changes.

Available since

1.0.0

.

See also:

Static variables

@:value("textArea_errorCallout")staticfinalread onlyCHILD_VARIANT_ERROR_CALLOUT:String = "textArea_errorCallout"

The variant used to style the error string TextCallout child component in a theme.

To override this default variant, set the TextArea.customErrorCalloutVariant property.

Available since

1.0.0

.

See also:

Constructor

@:value({ text : "" })new(text:String = "", ?prompt:String, ?changeListener:Event ‑> Void)

Creates a new TextArea object.

Available since

1.0.0

.

Variables

@:bindable("stateChange")read onlycurrentState:TextInputState

The current state of the text area.

Available since

1.0.0

.

See also:

@:style@:flash.propertycustomErrorCalloutVariant:String

A custom variant to set on the error callout, instead of TextArea.CHILD_VARIANT_ERROR_CALLOUT.

The customErrorCalloutVariant will be not be used if the TextCallout already has a variant set.

Available since

1.0.0

.

See also:

@:style@:flash.propertydisabledTextFormat:AbstractTextFormat

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

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

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

1.0.0

.

See also:

displayAsPassword:Bool

Masks the text so that it cannot be read.

In the following example, the text area's text is displayed as a password:

textArea.displayAsPassword = true;
Available since

1.0.0

.

See also:

editable:Bool

Indicates if the text area is editable.

The following example disables editing:

textArea.editable = false;
Available since

1.0.0

.

@:style@:flash.propertyembedFonts:Bool

Determines if an embedded font is used or not.

In the following example, the text area uses embedded fonts:

textArea.embedFonts = true;
Available since

1.0.0

.

See also:

errorString:String

Error text to display in a TextCallout when the text input has focus. When this value is not null the text area's currentState is changed to TextInputState.ERROR.

An empty string will change the background, but no TextCallout will appear on focus.

To clear an error, the errorString property must be set to null.

The following example displays an error string:

texterror.errorString = "Something is wrong";
Available since

1.0.0

.

See also:

read onlyerrorStringCalloutOpen:Bool

Indicates if the callout for the errorString is currently open or closed.

Available since

1.0.0

.

See also:

maxChars:Int

The maximum number of characters that may be entered into the text input. If set to 0, the length of the text is unrestricted.

Available since

1.0.0

.

prompt:String

The text displayed by the text area when the length of the text property is 0.

The following example sets the text area's prompt:

textArea.prompt = "Minimum 8 characters required";
Available since

1.0.0

.

See also:

@:style@:flash.propertypromptTextFormat:AbstractTextFormat

The font styles used to render the text area's prompt text.

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

textArea.promptTextFormat = new TextFormat("Helvetica", 20, 0xcc0000);
Available since

1.0.0

.

See also:

restrict:String

Limits the set of characters that may be typed into the TextArea.

In the following example, the text area's allowed characters are restricted:

textArea.restrict = "0-9";
Available since

1.0.0

.

See also:

selectable:Bool

Indicates if the text can be selected.

The following example disables selection:

textArea.selectable = false;
Available since

1.0.0

.

read onlyselectionActiveIndex:Int

The character position of the active part of the selection. If the selection is changed with the arrow keys, the active index changes and the anchor index stays fixed. If both the active index and the anchor index are equal, then no text is selected and both values represent the position of the caret.

Available since

1.0.0

.

See also:

read onlyselectionAnchorIndex:Int

The character position of the anchor part of the selection. If the selection is changed with the arrow keys, the active index changes and the anchor index stays fixed. If both the active index and the anchor index are equal, then no text is selected and both values represent the position of the caret.

Available since

1.0.0

.

See also:

@:style@:flash.propertyshowPromptWhenEmptyAndFocused:Bool

Indicates if the prompt is shown when the length of the text is 0 and the text input is focused. Keeping the prompt visible until the user types something is considered better for usability because the user may look away for a moment and forget the prompt when they return.

The following example set the prompt to be hidden when focused and the text is empty:

input.showPromptWhenEmptyAndFocused = false;
Available since

1.1.0

.

@:style@:flash.propertysmoothScrolling:Bool

Indicates if scrolling is smooth or strictly by line.

In the following example, smooth scrolling is enabled:

textArea.smoothScrolling = true;
Available since

1.0.0

.

@:bindable("change")text:String

The text displayed by the text area.

When the value of the text property changes, the text area will dispatch an event of type Event.CHANGE.

The following example sets the text area's text:

textArea.text = "Good afternoon!";
Available since

1.0.0

.

See also:

@:style@:flash.propertytextFormat:AbstractTextFormat

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

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

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

1.0.0

.

See also:

@:style@:flash.propertytextPaddingBottom:Float

The minimum space, in pixels, between the view port's bottom edge and the text.

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

textArea.textPaddingBottom = 20.0;
Available since

1.0.0

.

@:style@:flash.propertytextPaddingLeft:Float

The minimum space, in pixels, between the view port's left edge and the text.

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

textArea.textPaddingLeft = 20.0;
Available since

1.0.0

.

@:style@:flash.propertytextPaddingRight:Float

The minimum space, in pixels, between the view port's right edge and the text.

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

textArea.textPaddingRight = 20.0;
Available since

1.0.0

.

@:style@:flash.propertytextPaddingTop:Float

The minimum space, in pixels, between the view port's top edge and the text.

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

textArea.textPaddingTop = 20.0;
Available since

1.0.0

.

@:style@:flash.propertywordWrap:Bool

Determines if the text will wrap when reaching the right edge, or if horizontal scrolling will be required.

In the following example, the text area will not wrap its text:

textArea.wordWrap = false;
Available since

1.0.0

.

Methods

getSkinForState(state:TextInputState):DisplayObject

Gets the skin to be used by the text area when its currentState property matches the specified state value.

If a skin is not defined for a specific state, returns null.

Available since

1.0.0

.

See also:

getTextFormatForState(state:TextInputState):AbstractTextFormat

Gets the text format to be used by the text area when its currentState property matches the specified state value.

If a text format is not defined for a specific state, returns null.

Available since

1.0.0

.

See also:

selectAll():Void

Selects all of the text displayed by the text area.

Available since

1.0.0

.

See also:

selectRange(anchorIndex:Int, activeIndex:Int):Void

Selects the specified range of characters.

The following example selects the first three characters:

input.selectRange(0, 3);
Available since

1.0.0

.

See also:

@stylesetSkinForState(state:TextInputState, skin:DisplayObject):Void

Set the skin to be used by the text area when its currentState property matches the specified state value.

If a skin is not defined for a specific state, the value of the backgroundSkin property will be used instead.

Available since

1.0.0

.

See also:

@stylesetTextFormatForState(state:TextInputState, textFormat:AbstractTextFormat):Void

Set the text format to be used by the text area when its currentState property matches the specified state value.

If a text format is not defined for a specific state, the value of the textFormat property will be used instead.

Available since

1.0.0

.

See also:

setTextPadding(value:Float):Void

Sets all four text padding properties to the same value.

Available since

1.0.0

.

See also:

Inherited Variables

Defined by BaseScrollContainer

@:style@:flash.propertyautoHideScrollBars:Bool

Determines if the scroll bars should be automatically hidden after scrolling has ended, whether it was through user interaction or animation.

In the following example, scroll bar auto-hiding is disabled:

container.autoHideScrollBars = false;

This property has no effect if fixedScrollBars is true. Fixed scroll bars are always visible. Similarly, if showScrollBars is false, then the scroll bars are always hidden.

Available since

1.0.0

.

@:style@:flash.propertybackgroundSkin:DisplayObject

The default background skin to display behind all content added to the group. The background skin is resized to fill the complete width and height of the group.

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

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

1.0.0

.

See also:

@:style@:flash.propertydisabledBackgroundSkin:DisplayObject

The default background skin to display behind all content added to the group. The background skin is resized to fill the complete width and height of the group.

The following example gives the group a disabled background skin:

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

1.0.0

.

See also:

@:style@:flash.propertyfixedScrollBars:Bool

Determines if the scroll bars are fixed to the edges of the container, without overlapping the container's content, or if the scroll bars are floating above the container's content.

In the following example, the scroll bars are fixed:

container.fixedScrollBars = true;

This property has no effect if showScrollBars is false.

Available since

1.0.0

.

@:style@:flash.propertyhideScrollBarDuration:Float

The duration, measured in seconds, of the animation when a scroll bar fades out.

In the following example, the duration of the animation that hides the scroll bars is set to 500 milliseconds:

container.hideScrollBarDuration = 0.5;
Available since

1.0.0

.

@:style@:flash.propertyhideScrollBarEase:IEasing

The easing function used for hiding the scroll bars, if applicable.

In the following example, the ease of the animation that hides the scroll bars is customized:

container.hideScrollBarEase = Elastic.easeOut;
Available since

1.0.0

.

@:style@:flash.propertymaskSkin:DisplayObject

A skin to mask the content of the container. The skin is resized to the full dimensions of the container. It is passed to the mask property.

This property masks the entire container, including any chrome such as scroll bars or headers and footers. To mask only the scrollable region, use viewPortMaskSkin instead.

The following example passes a RectangleSkin with a cornerRadius for the container's mask skin:

var maskSkin = new RectangleSkin();
maskSkin.fill = SolidColor(0xff0000);
maskSkin.cornerRadius = 10.0;
container.maskSkin = maskSkin;
Available since

1.0.0

.

See also:

read onlymaxScrollX:Float

The number of pixels the container may be scrolled horizontally in the rightward direction. This value is automatically calculated based on the bounds of the container's viewport.

The scrollX property may have a higher value than the maximum if the elasticEdges property is enabled. However, once the user stops interacting with the container, it will automatically animate back to the maximum position.

Available since

1.0.0

.

See also:

read onlymaxScrollY:Float

The number of pixels the container may be scrolled vertically in the downward direction. This value is automatically calculated based on the bounds of the container's viewport.

The scrollY property may have a higher value than the maximum if the elasticEdges property is enabled. However, once the user stops interacting with the container, it will automatically animate back to the maximum position.

Available since

1.0.0

.

See also:

read onlyminScrollX:Float

The number of pixels the container may be scrolled horizontally in the leftward direction. This value is automatically calculated based on the bounds of the container's viewport.

The scrollX property may have a lower value than the minimum if the elasticEdges property is enabled. However, once the user stops interacting with the container, it will automatically animate back to the minimum position.

Available since

1.0.0

.

See also:

read onlyminScrollY:Float

The number of pixels the container may be scrolled vertically in the upward direction. This value is automatically calculated based on the bounds of the container's viewport.

The scrollY property may have a lower value than the minimum if the elasticEdges property is enabled. However, once the user stops interacting with the container, it will automatically animate back to the minimum position.

Available since

1.0.0

.

See also:

@:style@:flash.propertypaddingBottom:Float

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

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

container.paddingBottom = 20.0;
Available since

1.0.0

.

@:style@:flash.propertypaddingLeft:Float

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

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

container.paddingLeft = 20.0;
Available since

1.0.0

.

@:style@:flash.propertypaddingRight:Float

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

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

container.paddingRight = 20.0;
Available since

1.0.0

.

@:style@:flash.propertypaddingTop:Float

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

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

container.paddingTop = 20.0;
Available since

1.0.0

.

@:bindable("scroll")restrictedScrollX:Float

Setting scrollX will clamp the value between minScrollX and maxScrollX, but setting unrestrictedScrollX will allow values outside of that range.

Available since

1.0.0

.

See also:

@:bindable("scroll")restrictedScrollY:Float

Setting restrictedScrollY will clamp the value to the range between minScrollY and maxScrollY.

Available since

1.0.0

.

See also:

scrollBarXFactory:AbstractDisplayObjectFactory<Dynamic, HScrollBar>

Creates the horizontal scroll bar. The horizontal scroll bar may be any implementation of IScrollBar, but typically, the feathers.controls.HScrollBar component is used.

In the following example, a custom horizontal scroll bar factory is passed to the container:

container.scrollBarXFactory = () ->
{
	return new HScrollBar();
};
Available since

1.0.0

.

See also:

@:style@:flash.propertyscrollBarXPosition:RelativePosition

Determines the edge of the container where the horizontal scroll bar will be positioned (either on the top or the bottom).

In the following example, the horizontal scroll bar is positioned on the top edge of the container:

container.scrollBarXPosition = TOP;
Available since

1.0.0

.

See also:

scrollBarYFactory:AbstractDisplayObjectFactory<Dynamic, VScrollBar>

Creates the vertical scroll bar. The vertical scroll bar may be any implementation of IScrollBar, but typically, the feathers.controls.VScrollBar component is used.

In the following example, a custom vertical scroll bar factory is passed to the container:

container.scrollBarYFactory = () ->
{
	return new VScrollBar();
};
Available since

1.0.0

.

See also:

@:style@:flash.propertyscrollBarYPosition:RelativePosition

Determines the edge of the container where the vertical scroll bar will be positioned (either on the left or the right).

In the following example, the vertical scroll bar is positioned on the left edge of the container:

container.scrollBarYPosition = LEFT;
Available since

1.0.0

.

See also:

scrollMode:ScrollMode

Determines how scrolling is rendered by the container.

In the following example, scroll mode is changed to use a scrollRect:

container.scrollMode = SCROLL_RECT;
Available since

1.0.0

.

@:style@:flash.propertyscrollPixelSnapping:Bool

If enabled, the scroll position will always be adjusted to the nearest pixel in stage coordinates.

In the following example, the scroll position is snapped to pixels:

container.scrollPixelSnapping = true;
Available since

1.0.0

.

scrollPolicyX:ScrollPolicy

Determines whether the container may scroll horizontally (on the x-axis) or not.

In the following example, horizontal scrolling is disabled:

container.scrollPolicyX = OFF;
Available since

1.0.0

.

See also:

scrollPolicyY:ScrollPolicy

Determines whether the container may scroll vertically (on the y-axis) or not.

In the following example, vertical scrolling is disabled:

container.scrollPolicyY = OFF;
Available since

1.0.0

.

See also:

scrollStepX:Float

The number of pixels the horizontal scroll position can be adjusted by a step (such as with the left/right keyboard arrow keys, or a step button on the horizontal scroll bar).

In the following example, the horizontal scroll step is set to 20 pixels:

container.scrollStepX = 20.0;
Available since

1.0.0

.

scrollStepY:Float

The number of pixels the vertical scroll position can be adjusted by a step (such as with the up/down keyboard arrow keys, or a step button on the vertical scroll bar).

In the following example, the vertical scroll step is set to 20 pixels:

container.scrollStepY = 20.0;
Available since

1.0.0

.

@:bindable("scroll")scrollX:Float

The number of pixels the container has been scrolled horizontally (on the x-axis).

When setting scrollX, the new value will be automatically clamped to the range between minScrollX and maxScrollX. To programmatically set a scrollX to a value outside of that range, set unrestrictedScrollX instead.

When the value of scrollX changes, the container dispatches an event of type ScrollEvent.SCROLL. This event is dispatched when other scroll position properties change too.

In the following example, the horizontal scroll position is modified immediately, without being animated:

container.scrollX = 100.0;
Available since

1.0.0

.

See also:

@:bindable("scroll")scrollY:Float

The number of pixels the container has been scrolled vertically (on the y-axis).

When the value of scrollY changes, the container dispatches an event of type ScrollEvent.SCROLL. This event is dispatched when other scroll position properties change too.

In the following example, the vertical scroll position is modified immediately, without being animated:

container.scrollY = 100.0;
Available since

1.0.0

.

See also:

scrollerFactory:() ‑> Scroller

Creates the Scroller utility that manages touch and mouse wheel scrolling.

In the following example, a custom scroller factory is passed to the container:

container.scrollerFactory = () ->
{
	var scroller = new Scroller();
	scroller.elasticEdges = false;
	return scroller;
};
Available since

1.0.0

.

@:style@:flash.propertyshowScrollBarMinimumDuration:Float

The minimum time, in seconds, that the scroll bars will be shown, if autoHideScrollBars is enabled.

In the following example, the minimum duration to show scroll bars is increased:

container.showScrollBarMinimumDuration = 1.0;
Available since

1.0.0

.

See also:

@:style@:flash.propertyshowScrollBars:Bool

Determines if scroll bars are displayed or not.

In the following example, the scroll bars are hidden:

container.showScrollBars = false;
Available since

1.0.0

.

private@:dox(show)viewPort:IViewPort

The display object rendered and scrolled within the container, provided by a subclass of BaseScrollContainer.

Available since

1.0.0

.

@:style@:flash.propertyviewPortMaskSkin:DisplayObject

A skin to mask the view port (the scrollable region) of the container. The skin is resized to the dimensions of the view port only, and it does not affect any other chrome, such as scroll bars or a header or footer. It is passed to the mask property.

The following example passes a RectangleSkin with a cornerRadius for the container view port's mask skin:

var maskSkin = new RectangleSkin();
maskSkin.fill = SolidColor(0xff0000);
maskSkin.cornerRadius = 10.0;
container.viewPortMaskSkin = maskSkin;
Available since

1.0.0

.

See also:

Defined by FeathersControl

@: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);
}

See also:

@:value(null)@:styledisabledAlpha:Null<Float> = null

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

.

@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

@: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

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:

variant: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 onlyvalidating:Bool

Indicates if the display object is currently validating.

Available since

1.0.0

.

Inherited Methods

Defined by BaseScrollContainer

@:value({ result : null })getViewPortVisibleBounds(?result:Rectangle):Rectangle

Returns the visible bounds of the view port within the container's local coordinate system.

Available since

1.0.0

.

setPadding(value:Float):Void

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:

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

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

.

Defined by MeasureSprite

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

.