Packagecom.ghostwire.ui.controls
Classpublic class uiTextArea
InheritanceuiTextArea Inheritance uiScrollable Inheritance uiComponent Inheritance flash.display.Sprite

The uiTextArea is used to display multiline editable text with scrollbars. The component is a composite consisting of a uiTextInput, uiScrollBar and uiVScrollBar.

To access the embedded uiTextInput object, use the property uitextinput. For example, to get or set the text displayed, use uitextinput.text.

This component is a subclass of uiScrollable, which implements the layout of the scrollbars.

"hScrollPolicy" Property
If you set the property hScrollPolicy to SCROLLBAR.OFF, the text will automatically wrap.

"skin" Property
The default value is "TextArea" and the asset(s) used are:

 TextArea.png
 
The skins of the embedded scrollbars depend on what uiScrollBar and uiVScrollBar are using and are not affected by what the "skin" property of the uiTextArea itself.

Default Size
The component has a default desired size of 100 x 100 (width x height).

Tab Focus
The uiTextArea component in itself is not focusable but the embedded uiTextInput instance will be included in the tab order.

~ This class is available in Aspire UI Components Lite Edition ~



Public Properties
 PropertyDefined by
 InheritedalignX : Number
Indicates how the component would like to be aligned horizontally within its allocated space.
uiComponent
 InheritedalignY : Number
Indicates how the component would like to be aligned vertically within its allocated space.
uiComponent
 Inheritedbackground : Object
Indicates the style of the background for this component.
uiComponent
 Inheritedcontainer : uiComponent
Indicates the uiComponent instance that contains this instance.
uiComponent
 Inheriteddepth : int
Indicates how deep the component is in the containment hierarchy.
uiComponent
 InheriteddesiredAllocationHeight : int
Indicates the vertical space this component would like to be allocated.
uiComponent
 InheriteddesiredAllocationWidth : int
Indicates the horizontal space this component would like to be allocated.
uiComponent
  editable : Boolean
Indicates whether the text in the embedded uiTextInput instance can be edited by end-users.
uiTextArea
 Inheritedenabled : Boolean
Indicates whether the component is enabled for user interaction.
uiComponent
 InheritedfillX : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated horizontal space.
uiComponent
 InheritedfillY : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated vertical space.
uiComponent
 InheritedfocusPadding : Object
Indicates the thickness of the interior space from the edge of the component to the focus rectangle.
uiComponent
 InheritedfocusRect : Object
Indicates the class to use when rendering the rectangle around the component to indicate that it is in focus.
uiComponent
 Inheritedheight : Number
Indicates the current height of the component.
uiComponent
 InheritedhScrollPolicy : String
A String value indicating if the horizontal scroll bar should be shown.
uiScrollable
 Inheritedmargin : Object
Indicates the thickness of the space surrounding the component.
uiComponent
 InheritedmaxHeight : int
Indicates the upper limit for height.
uiComponent
 InheritedmaxWidth : int
Indicates the upper limit for width.
uiComponent
 InheritedminHeight : int
Indicates the lower limit for height.
uiComponent
 InheritedminWidth : int
Indicates the lower limit for width.
uiComponent
 Inheritedpadding : Object
Indicates the thickness of the interior space from the edge of the component to the content area, which is where child components, if any, are contained.
uiComponent
 InheritedrangeH : uiRange
Returns the uiRange object used to represent the horizontal scroll range.
uiScrollable
 InheritedrangeV : uiRange
Returns the uiRange object used to represent the vertical scroll range.
uiScrollable
 InheritedscrollX : Number
Indicates the horizontal scroll position.
uiScrollable
 InheritedscrollY : Number
Indicates the vertical scroll position.
uiScrollable
 Inheritedskin : String
Indicates the name of the skin to use for this component instance.
uiComponent
 Inheritedstretch : Boolean
Indicates whether surplus space available in the parent container should be allocated to this component.
uiComponent
  text : String
Indicates the text displayed in the embedded uiTextInput instance.
uiTextArea
 InheritedtextStyle : String
Indicates the style to use for uiText instances contained in this component.
uiComponent
 InheritedtoolTip : Object
Indicates the content (text) of the tooltip that should be shown when the mouse hovers over this control.
uiComponent
 Inheriteduihscrollbar : uiScrollBar
Returns the uiScrollBar instance used in this component.
uiScrollable
 Inheriteduiskin : uiBitmapImage
Returns the uiBitmapImage rendered as the skin - for advanced users only.
uiComponent
  uitextinput : uiTextInput
[read-only] Returns the embedded uiTextInput instance - for advanced users only.
uiTextArea
 Inheriteduivscrollbar : uiVScrollBar
Returns the uiVScrollBar instance used in this component.
uiScrollable
 Inheritedvisible : Boolean
Indicates whether or not the component is visible within its container.
uiComponent
 InheritedvScrollPolicy : String
A String value indicating if the vertical scroll bar should be shown.
uiScrollable
 Inheritedwidth : Number
Indicates the current width of the component.
uiComponent
Public Methods
 MethodDefined by
  
uiTextArea(txt:String = "")
Constructor - creates a new uiTextArea instance.
uiTextArea
 Inherited
invalidate(type:String):void
Invalidates this component's "size", "display", "layout" or "textstyle".
uiComponent
 Inherited
move(x:Number, y:Number, noEvent:Boolean = false):void
Moves the component to the specified position, disregarding its allocation.
uiComponent
 Inherited
removeAllChildren(all:Boolean = false):void
Removes all children from this component.
uiComponent
 Inherited
setFocus(flag:Boolean = true):void
Gives this component instance the focus; the component must be on the display list and has its tabEnabled property set to true, otherwise this method will fail silently.
uiComponent
 Inherited
setScrollPosition(x:int, y:int, noEvent:Boolean = false):void
Sets the scrollX and scrollY positions, dispatching a "scroll" event.
uiScrollable
 Inherited
setSize(width:Number, height:Number, noEvent:Boolean = false):void
Sets this component's size to the specified width and height.
uiComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Sets the visibility of this component instance, dispatching a "show" or "hide" event accordingly.
uiComponent
 Inherited
validateNow():void
Validates and render the component instance, and any component instances with depth higher than itself in the validation queue, immediately.
uiComponent
Events
 EventSummaryDefined by
   Dispatched when the text in the component changes.uiTextArea
 Inherited Dispatched when the component's visible property is changed from true to false via calling the setVisible() method.uiComponent
 Inherited Dispatched when the component's position within its parent container has changed via calling the move() method.uiComponent
 Inherited Dispatched when the component's size has changed via calling the setSize() method.uiComponent
 Inherited Dispatched when the scroll position of a scrollable component has changed.uiScrollable
 Inherited Dispatched when the component's visible property is changed from false to true via calling the setVisible() method.uiComponent
   Dispatched when the user enters, deletes, or pastes text into the component.uiTextArea
Property detail
editableproperty
editable:Boolean  [read-write]

Indicates whether the text in the embedded uiTextInput instance can be edited by end-users. This property is included for convenience - it is the same as accessing uitextinput.editable.

Implementation
    public function get editable():Boolean
    public function set editable(value:Boolean):void
textproperty 
text:String  [read-write]

Indicates the text displayed in the embedded uiTextInput instance. This property is included for convenience - it is the same as accessing uitextinput.text.

Implementation
    public function get text():String
    public function set text(value:String):void
uitextinputproperty 
uitextinput:uiTextInput  [read-only]

Returns the embedded uiTextInput instance - for advanced users only. This property is exposed in case you would like greater control over the embedded uiTextInput instance.

Implementation
    public function get uitextinput():uiTextInput
Constructor detail
uiTextArea()constructor
public function uiTextArea(txt:String = "")

Constructor - creates a new uiTextArea instance.

Parameters
txt:String (default = "") — A String value indicating the initial text to display.
Event detail
changeevent 
Event object type: flash.events.Event

Dispatched when the text in the component changes.

textInputevent  
Event object type: flash.events.TextEvent

Dispatched when the user enters, deletes, or pastes text into the component.