Displays text next to a control in a form.

Available since

1.0.0

.

See also:

Constructor

@:value({ required : false, text : "" })new(text:String = "", ?content:DisplayObject, required:Bool = false)

Creates a new FormItem object.

Available since

1.0.0

.

Variables

@:style@:flash.propertybackgroundSkin:DisplayObject

The default background skin to display behind the form item's content.

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

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

1.0.0

.

See also:

content:DisplayObject

The content displayed by the form item.

The following example sets the form item's content:

var nameInput = new TextInput();
nameInput.prompt = "First and last name";
formItem.content = nameInput;
Available since

1.0.0

.

See also:

@:style@:flash.propertydisabledBackgroundSkin:DisplayObject

A background skin to display behind the form item's content when the form item is disabled.

The following example gives the form item a disabled background skin:

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

1.0.0

.

See also:

@:style@:flash.propertydisabledTextFormat:AbstractTextFormat

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

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

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

formItem.embedFonts = true;
Available since

1.0.0

.

See also:

@:style@:flash.propertygap:Float

The space, measured in pixels, between the form item's text and its content. Applies to either horizontal or vertical spacing, depending on the value of textPosition.

The following example creates a gap of 20 pixels between the text and the content:

formItem.text = "Name";
formItem.content = new TextInput();
formItem.gap = 20.0;
Available since

1.0.0

.

@:style@:flash.propertyhorizontalAlign:HorizontalAlign

How the content is positioned horizontally (along the x-axis) within the available space next to the form item's text.

The following example aligns the form item's content to the right:

formItem.verticalAlign = RIGHT;
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 form item's bottom edge and the form item's content.

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

formItem.paddingBottom = 20.0;
Available since

1.0.0

.

@:style@:flash.propertypaddingLeft:Float

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

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

formItem.paddingLeft = 20.0;
Available since

1.0.0

.

@:style@:flash.propertypaddingRight:Float

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

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

formItem.paddingRight = 20.0;
Available since

1.0.0

.

@:style@:flash.propertypaddingTop:Float

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

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

formItem.paddingTop = 20.0;
Available since

1.0.0

.

required:Bool

Indicates if the form item is required. This is purely a visual indicator, and it will not prevent the form from being submitted.

In the following example, the form item is required:

formItem.required = true;
Available since

1.0.0

.

See also:

@:style@:flash.propertyrequiredSkin:DisplayObject

The symbol displayed if the required property is true.

In the following example, the form item's required skin is set to a bitmap:

formItem.requiredSkin = new Bitmap(bitmapData);
Available since

1.0.0

.

See also:

selectable:Bool

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

In the following example, the form item's text is selectable:

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

.

@:style@:flash.propertystyleSheet:StyleSheet

A custom stylesheet to use with htmlText.

If the styleSheet style is not null, the textFormat style will be ignored.

Available since

1.0.0

.

See also:

@:value(true)submitOnEnterEnabled:Bool = true

Set to false to prevent Keyboard.ENTER from submitting the Form that contains this item.

In the following example, the form item does not submit when pressing the enter key:

formItem.submitOnEnterEnabled = false;
Available since

1.0.0

.

text:String

The text displayed by the form item.

The following example sets the form item's text:

formItem.text = "Address";
Available since

1.0.0

.

See also:

@:style@:flash.propertytextFormat:AbstractTextFormat

The font styles used to render the form item's text.

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

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

1.0.0

.

See also:

@:style@:flash.propertytextPosition:RelativePosition

The location of the form item's text, relative to its content.

The following example positions the text to the left of the text:

formItem.text = "Click Me";
formItem.content = new TextInput();
formItem.textPosition = LEFT;
Available since

1.0.0

.

See also:

@:style@:flash.propertyverticalAlign:VerticalAlign

How the content is positioned vertically (along the y-axis) within the available space next to the form item's text.

The following example aligns the form item's content to the bottom:

formItem.verticalAlign = BOTTOM;
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 form item's text wraps:

formItem.wordWrap = true;
Available since

1.0.0

.

Methods

getTextMeasuredMaxWidth():Float

Returns the maximum allowed width of the form item's text. Used by Form to position and size all form items correctly.

Available since

1.0.0

.

getTextMeasuredWidth():Float

Returns the measured width of the form item's text. Used by Form to position and size all form items correctly.

Available since

1.0.0

.

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

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

.

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

.