qnx.fuse.ui.text.TextArea

TextArea

Properties | Methods


Packageqnx.fuse.ui.text
Classpublic class TextArea
InheritanceTextArea Inheritance TextInputBase Inheritance SkinnableComponent Inheritance UIComponent Inheritance flash.display.MovieClip

The TextArea class provides developers with a multi-line input component.

Class information:
PlayBook Tablet OS Version:   1.0.6

See also

TextInput



Public Properties

 PropertyDefined By
 InheritedautoCapitalize : String
Gets or sets a value that enables auto-capitalization when the user inputs text.
TextInputBase
 InheritedautoCorrect : Boolean
Gets or sets a value that enables auto-correct when text is entered by the user.
TextInputBase
 InheriteddisableReturnKey : Boolean
Gets or sets a value that disables the return key on the soft keyboard.
TextInputBase
 InheriteddisplayAsPassword : Boolean
Gets or sets a value that determines whether text is masked (as in a password field).
TextInputBase
 Inheritededitable : Boolean
Gets or sets a value that determines if text can be modified.
TextInputBase
 InheritedexplicitHeight : Number
[read-only] Returns the explicit height (actual height, in pixels) of the UI component.
UIComponent
 InheritedexplicitWidth : Number
[read-only] Returns the explicit width (actual width, in pixels) of the UI component.
UIComponent
 Inheritedformat : TextFormat
Gets or sets the format of the text.
TextInputBase
 InheritedincludeInLayout : Boolean
Specifies whether or not the component should be included in its parent container's layout.
UIComponent
 InheritedlayoutData : Object
Returns the layout data for the object.
UIComponent
 Inheritedlength : int
[read-only] Returns the length of the text that is being rendered.
TextInputBase
 Inheritedlocale : String
Gets or sets the current locale of the text.
TextInputBase
 InheritedmaxChars : int
Gets or sets the maximum number of characters that can be entered in the field.
TextInputBase
  maxLines : int
Gets or sets the maximum number of lines to be measured by a layout.
TextArea
 InheritedminHeight : Number
Gets or sets the minimum preferred height of the control.
UIComponent
  minLines : int
Gets or sets the minimum number of lines to be measured by a layout.
TextArea
 InheritedminWidth : Number
Gets or sets the minimum preferred width of the control.
UIComponent
 Inheritedrestrict : String
Gets or sets the set of characters (as a String) that a user can enter into the text field.
TextInputBase
 InheritedreturnKeyLabel : String
Gets or sets the label of the return key on the soft keyboard.
TextInputBase
 Inheritedselectable : Boolean
Gets or sets a value that determines whether text can be selected.
TextInputBase
 InheritedselectionActiveIndex : int
[read-only] Returns the zero-based index of the first character in the selection.
TextInputBase
 InheritedselectionAnchorIndex : int
[read-only] Returns the zero-based index of the last character in the selection.
TextInputBase
 InheritedsoftKeyboardType : String
Gets or sets the type of keyboard to be displayed when an editing session begins.
TextInputBase
 InheritedspellCheck : Boolean
Gets or sets a value that enables spell-check.
TextInputBase
 Inheritedstate : String
Gets or sets the state of the component.
SkinnableComponent
 Inheritedtext : String
Gets or sets the text of the component.
TextInputBase

Public Methods

 MethodDefined By
  
Creates a new TextArea instance.
TextArea
 Inherited
childChanged(resizedChild:DisplayObject = null):Boolean
Notifies the UIComponent that one or more of its children has changed in a manner that may affect this object's layout.
UIComponent
 Inherited
destroy():void
Call this method when you want to have your object collected by the garbage collector.
UIComponent
  
[override] Returns a value indicating whether or not this control can grow or shrink horizontally.
TextArea
 Inherited
Calling this method results in a call to the components validateDisplayList() method before the display list is rendered.
UIComponent
 Inherited
Calling this method results in a call to the components validateProperties() method before the display list is rendered.
UIComponent
 Inherited
measure(availableWidth:Number, availableHeight:Number):LayoutMeasurement
This method calls doMeasure() in order to calculate the preferred size of the control.
UIComponent
 Inherited
registerEmoticons(emoticons:Vector.<Emoticon>):void
Registers a set of emoticons with the TextField.
TextInputBase
 Inherited
replaceText(startIndex:int, endIndex:int, insert:String):void
Replaces the text between at a given start and end index.
TextInputBase
 Inherited
setActualSize(w:Number, h:Number):void
Sets the width and height of the object without setting the explicitWidth and explicitHeight.
UIComponent
 Inherited
setLayoutBounds(bounds:Rectangle):void
Sets the receiver's size and location to the rectangular area specified by the arguments.
UIComponent
 Inherited
setPosition(x:Number, y:Number):void
Sets the x and y position of the component.
UIComponent
 Inherited
setSelection(anchorIndex:int, activeIndex:int):void
Sets the range of selected text.
TextInputBase
 Inherited
setSkin(newSkin:Object):void
Set the skin object on the component for it to render.
SkinnableComponent
 Inherited
Validates the display list of the component by calling the updateDisplayList().
UIComponent
 Inherited
Validates the component immediately by calling validateProperties(), validateSizes(), and validateDisplayList() if necessary.
UIComponent
 Inherited
Validates the properties of the component by calling the commitProperties() method.
UIComponent

Protected Methods

 MethodDefined By
 Inherited
Process properties of the component.
UIComponent
 Inherited
Process the state of the component.
UIComponent
 Inherited
doMeasure(availableWidth:Number, availableHeight:Number):LayoutMeasurement
Performs a measurement on the control, and returns a LayoutMeasurement instance containing the available width and height within the layout.
UIComponent
 Inherited
flushCache():void
Invoked as part of parentLayoutChanged.
UIComponent
 Inherited
onAdded():void
Called when the instance is added to the stage.
UIComponent
 Inherited
onRemoved():void
Called when the instance is removed from the stage.
UIComponent
 Inherited
Invalidates the parent's size and display list if includeInLayout property is set to true.
UIComponent
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Sets the size and position of the children of the component.
UIComponent
 Inherited
updateSkin(unscaledWidth:Number, unscaledHeight:Number):void
Updates the skin.
SkinnableComponent

Property Detail

maxLines


maxLines:int

Gets or sets the maximum number of lines to be measured by a layout.

The text component will render additional lines, if necessary, and will be clipped from view. Setting this value to 0 causes all lines to be measured.


Implementation

public function get maxLines():int
public function set maxLines(value:int):void

minLines


minLines:int

Gets or sets the minimum number of lines to be measured by a layout.

If the full text results in less lines than the minimum number of lines, then the size of the minimum number of lines will be returned when measuring the text. Setting this value less then 1 will have no effect and will be constrained to 1.


Implementation

public function get minLines():int
public function set minLines(value:int):void

Constructor Detail

TextArea()


public function TextArea()

Creates a new TextArea instance.

Method Detail

getSizeOptions()


override public function getSizeOptions():int

Returns a value indicating whether or not this control can grow or shrink horizontally.

Returns

int — 1 if the value can be resized horizontally, otherwise 0.