class TextArea
package feathers.controls
extends BaseScrollContainer › FeathersControl › MeasureSprite › ValidatingSprite
implements ITextControl, IStateContext<TextInputState>
1.0.0
.Constructor
Variables
read onlycurrentState:TextInputState = ENABLED
The current state of the text area.
1.0.0
.See also:
editable:Bool = true
Indicates if the text area is editable.
The following example disables editing:
textArea.editable = false;
1.0.0
.embedFonts:Bool = false
Determines if an embedded font is used or not.
In the following example, the text area uses embedded fonts:
textArea.embedFonts = true;
1.0.0
.See also:
prompt:String = null
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";
1.0.0
.See also:
promptTextFormat:TextFormat = null
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);
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";
1.0.0
.See also:
smoothScrolling:Bool = false
Indicates if scrolling is smooth or strictly by line.
In the following example, smooth scrolling is enabled:
textArea.smoothScrolling = true;
1.0.0
.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!";
1.0.0
.See also:
openfl.events.Event.CHANGE
textFormat:TextFormat = null
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);
1.0.0
.See also:
textPaddingBottom:Float = 0.0
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;
1.0.0
.textPaddingLeft:Float = 0.0
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;
1.0.0
.textPaddingRight:Float = 0.0
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;
1.0.0
.textPaddingTop:Float = 0.0
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;
1.0.0
.wordWrap:Bool = true
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;
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
.
1.0.0
.See also:
getTextFormatForState(state:TextInputState):TextFormat
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
.
1.0.0
.See also:
setSkinForState(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.
1.0.0
.See also:
setTextFormatForState(state:TextInputState, textFormat:TextFormat):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.
1.0.0
.See also: