Package com.bit101.components
Class public class TextArea
Inheritance TextArea InheritanceText InheritanceComponent Inheritance flash.display.Sprite


Public Properties
  Property Defined By
  Inherited editable : Boolean
Gets / sets whether or not this text component will be editable.
 Text
    enabled : Boolean
[override] Sets/gets whether this component is enabled or not.
 TextArea
  Inherited height : Number
[override] Sets/gets the height of the component.
 Component
  Inherited html : Boolean
Gets / sets whether or not text will be rendered as HTML or plain text.
 Text
  Inherited selectable : Boolean
Gets / sets whether or not this text component will be selectable.
 Text
  Inherited tag : int
Sets/gets in integer that can identify the component.
 Component
  Inherited text : String
Gets / sets the text of this Label.
 Text
  Inherited textField : TextField
[read-only] Returns a reference to the internal text field in the component.
 Text
  Inherited width : Number
[override] Sets/gets the width of the component.
 Component
  Inherited x : Number
[override] [write-only] Overrides the setter for x to always place the component on a whole pixel.
 Component
  Inherited y : Number
[override] [write-only] Overrides the setter for y to always place the component on a whole pixel.
 Component
Protected Properties
  Property Defined By
  Inherited _editable : Boolean = true
 Text
  Inherited _enabled : Boolean = true
 Component
  Inherited _height : Number = 0
 Component
  Inherited _html : Boolean = false
 Text
  Inherited _panel : Panel
 Text
  Inherited Ronda : Class
 Component
    _scrollbar : VScrollBar
 TextArea
  Inherited _selectable : Boolean = true
 Text
  Inherited _tag : int = -1
 Component
  Inherited _text : String
 Text
  Inherited _tf : TextField
 Text
  Inherited _width : Number = 0
 Component
Public Methods
  Method Defined By
   
TextArea(parent:DisplayObjectContainer = null, xpos:Number = 0, ypos:Number = 0, text:String)
Constructor
TextArea
   
draw():void
[override] Draws the visual ui of the component.
 TextArea
  Inherited
initStage(stage:Stage):void
[static] Utility method to set up usual stage align and scaling.
 Component
  Inherited
move(xpos:Number, ypos:Number):void
Moves the component to the specified position.
 Component
  Inherited
setSize(w:Number, h:Number):void
Sets the size of the component.
 Component
Protected Methods
  Method Defined By
   
addChildren():void
[override] Creates and adds the child display objects of this component.
 TextArea
  Inherited
getShadow(dist:Number, knockout:Boolean = false):DropShadowFilter
DropShadowFilter factory method, used in many of the components.
 Component
   
init():void
[override] Initilizes the component.
 TextArea
  Inherited
invalidate():void
Marks the component to be redrawn on the next frame.
 Component
   
onChange(event:Event):void
[override] Called when the text in the text field is manually changed.
 TextArea
  Inherited
onInvalidate(event:Event):void
Called one frame after invalidate is called.
 Component
   
onMouseWheel(event:MouseEvent):void
Called when the mouse wheel is scrolled over the component.
 TextArea
   
onScrollbarScroll(event:Event):void
Called when the scroll bar is moved.
 TextArea
   
onTextScroll(event:Event):void
Called when the text is scrolled manually.
 TextArea
   
onTextScrollDelay(event:Event):void
Waits one more frame before updating scroll bar.
 TextArea
   
updateScrollbar():void
Changes the thumb percent of the scrollbar based on how much text is shown in the text area.
 TextArea
Public Constants
  Constant Defined By
  Inherited DRAW : String = draw
[static]
Component
Property Detail
_scrollbar property
protected var _scrollbar:VScrollBar

enabled property  
enabled:Boolean[override]

Sets/gets whether this component is enabled or not.


Implementation
    public function get enabled():Boolean
    public function set enabled(value:Boolean):void
Constructor Detail
TextArea () Constructor
public function TextArea(parent:DisplayObjectContainer = null, xpos:Number = 0, ypos:Number = 0, text:String)

Constructor

Parameters
parent:DisplayObjectContainer (default = null) — The parent DisplayObjectContainer on which to add this Label.
 
xpos:Number (default = 0) — The x position to place this component.
 
ypos:Number (default = 0) — The y position to place this component.
 
text:String — The initial text to display in this component.
Method Detail
addChildren () method
override protected function addChildren():void

Creates and adds the child display objects of this component.

draw () method  
override public function draw():void

Draws the visual ui of the component.

init () method  
override protected function init():void

Initilizes the component.

onChange () method  
override protected function onChange(event:Event):void

Called when the text in the text field is manually changed.

Parameters

event:Event
onMouseWheel () method  
protected function onMouseWheel(event:MouseEvent):void

Called when the mouse wheel is scrolled over the component.

Parameters

event:MouseEvent
onScrollbarScroll () method  
protected function onScrollbarScroll(event:Event):void

Called when the scroll bar is moved. Scrolls text accordingly.

Parameters

event:Event
onTextScroll () method  
protected function onTextScroll(event:Event):void

Called when the text is scrolled manually. Updates the position of the scroll bar.

Parameters

event:Event
onTextScrollDelay () method  
protected function onTextScrollDelay(event:Event):void

Waits one more frame before updating scroll bar. It seems that numLines and maxScrollV are not valid immediately after changing a TextField's size.

Parameters

event:Event
updateScrollbar () method  
protected function updateScrollbar():void

Changes the thumb percent of the scrollbar based on how much text is shown in the text area.





Tue May 18 2010, 07:52 PM -04:00