Packageorg.unbland.ui
Classpublic class UITextArea
InheritanceUITextArea Inheritance UIBase Inheritance flash.display.Sprite

このクラスは UITextField をスクロール可能な矩形領域に配置し, 制御する機能を有します.

このクラスは抽象クラスのため直接インスタンス化できません.

See also

org.unbland.ui.UIScrollBar


Public Properties
 PropertyDefined by
  allSelected : Boolean
テキストフィールドをクリックしてフォーカスが移った際, テキストを全選択するか否かです.
UITextArea
  alwaysShowSelection : Boolean
true に設定されフォーカスがない場合, テキスト内の選択内容は灰色でハイライト表示されます.
UITextArea
  antiAliasType : String
テキストに使用されるアンチエイリアス処理のタイプです.
UITextArea
  areaBounds : Rectangle
[read-only] 各パラメータの計算結果が反映されたこの UI のエリア領域です.
UITextArea
  areaHeight : Number
この UI のエリア領域の高さを示す数値です.
UITextArea
  areaWidth : Number
この UI のエリア領域の幅を示す数値です.
UITextArea
 InheritedautoRendering : Boolean
この UI のレンダリングを自動的に行うか否かです.
UIBase
  background : Sprite
[read-only]
UITextArea
  bottomScrollV : int
[read-only] 現在表示されている一番下の行を示す, 1 から始まるインデックス値です.
UITextArea
  caretIndex : int
[read-only] カーソル (キャレット) 位置のインデックスです.
UITextArea
  condenseWhite : Boolean
HTML テキストが含まれるテキストフィールド内の余分な空白 (スペース, 改行など) を削除するか否かです.
UITextArea
  corner : Sprite
[read-only] cornerClass を元に生成されたコーナーです.
UITextArea
  cornerBounds : Rectangle
[read-only] 各パラメータの計算結果が反映されたコーナーのエリア領域です.
UITextArea
  cornerClass : Class
この UI に使用するコーナーのクラスです.
UITextArea
  cornerMargin : Margin
コーナーのマージンを設定するためのオブジェクトです.
UITextArea
  defaultTextFormat : TextFormat
新しく挿入するテキスト (ユーザーが入力したテキストや replaceSelectedText メソッドで挿入したテキストなど) に適用するフォーマットを指定します.
UITextArea
  displayAsPassword : Boolean
テキストをパスワードとして扱うか否かです.
UITextArea
  editable : Boolean
テキストがユーザー入力により編集可能か否かです.
UITextArea
  embedFonts : Boolean
埋め込みフォントのアウトラインを使用してレンダリングするか否かです.
UITextArea
  enabled : Boolean
この UI がユーザーのマウスやキーボード操作を受け付けるか否かです.
UITextArea
  foreground : Sprite
[read-only]
UITextArea
  gridFitType : String
このテキストに使用されるグリッドフィッティングのタイプです.
UITextArea
  hScrollBar : UIScrollBar
[read-only] vScrollBarClass を元に生成された水平スクロールバーです.
UITextArea
  hScrollBarBounds : Rectangle
[read-only] 各パラメータの計算結果が反映された水平方向スクロールバーのエリア領域です.
UITextArea
  hScrollBarClass : Class
この UI に使用する水平スクロールバーのクラスです.
UITextArea
  hScrollBarMargin : Margin
水平スクロールバーのマージンを設定するためのオブジェクトです.
UITextArea
  hScrollBarVisibility : String
水平スクロールバーの表示設定です.
UITextArea
  htmlText : String
テキストフィールドの内容を HTML で表します.
UITextArea
  imeMode : String
IME (入力メソッドエディタ) のモードを指定します.
UITextArea
  length : int
[read-only] テキストの文字数です.
UITextArea
  maxAreaHeight : Number
この UI のエリア領域の最大高を示す数値です.
UITextArea
  maxAreaWidth : Number
この UI のエリア領域の最大幅を示す数値です.
UITextArea
  maxChars : int
ユーザーが入力するときに, テキストに入る最大の文字数です.
UITextArea
  maxScrollH : Number
[read-only] 水平方向の最大スクロール量を示す数値です.
UITextArea
  maxScrollV : Number
[read-only] 垂直方向の最大スクロール量を示す数値です.
UITextArea
  minAreaHeight : Number
この UI のエリア領域の最小高を示す数値です.
UITextArea
  minAreaWidth : Number
この UI のエリア領域の最小幅を示す数値です.
UITextArea
  minKnobSize : Number
スクロールバーのノブの最小サイズを示す数値です.
UITextArea
  numLines : int
[read-only] テキストの行数です.
UITextArea
  overlay : Boolean
各種スクロールバーやコーナーのエリア領域を踏まえずに viewport を計算するか否かです.
UITextArea
 InheritedpixelSnapped : Boolean
レンダリングの時に各パーツをピクセルに吸着して配置するか否かです.
UIBase
  resizable : Boolean
コーナーをドラッグしてのリサイズが可能か否かです.
UITextArea
  restrict : String
ユーザーがテキストに入力できる文字のセットを指定します.
UITextArea
  scrollH : Number
水平方向のスクロール量を示す数値です.
UITextArea
  scrollV : Number
垂直方向のスクロール量を示す数値です.
UITextArea
  selectionBeginIndex : int
[read-only] 現在の選択範囲の最初の文字を示す, 0 から始まるインデックス値です.
UITextArea
  selectionEndIndex : int
[read-only] 現在の選択範囲における最後の文字を示す, 0 から始まるインデックス値です.
UITextArea
  sharpness : Number
このテキスト内の文字エッジのシャープネスです.
UITextArea
  styleSheet : StyleSheet
テキストにスタイルシートを関連付けます.
UITextArea
  textColor : uint
テキストの色です (16 進数形式).
UITextArea
  textField : UITextField
[read-only] fieldClass を元に生成されたテキストフィールドです.
UITextArea
  textFieldBounds : Rectangle
[read-only] 各パラメータの計算結果が反映されたテキストフィールドのエリア領域です.
UITextArea
  textFieldClass : Class
この UI に使用するテキストフィールドのクラスです.
UITextArea
  textHeight : Number
[read-only] テキストの高さです (ピクセル単位).
UITextArea
  textWidth : Number
[read-only] テキストの高さです (ピクセル単位).
UITextArea
  thickness : Number
このテキスト内の文字エッジの太さです.
UITextArea
  useRichTextClipboard : Boolean
テキストと共にテキストのフォーマットをコピー&ペーストするか否かです.
UITextArea
  value : String
この UI が示すテキスト文字列です.
UITextArea
  vScrollBar : UIScrollBar
[read-only] vScrollBarClass を元に生成された垂直スクロールバーです.
UITextArea
  vScrollBarBounds : Rectangle
[read-only] 各パラメータの計算結果が反映された垂直方向スクロールバーのエリア領域です.
UITextArea
  vScrollBarClass : Class
この UI に使用する垂直スクロールバーのクラスです.
UITextArea
  vScrollBarMargin : Margin
垂直スクロールバーのマージンを設定するためのオブジェクトです.
UITextArea
  vScrollBarVisibility : String
垂直スクロールバーの表示設定です.
UITextArea
  wordWrap : Boolean
テキストを折り返すか否かです.
UITextArea
Public Methods
 MethodDefined by
  
UITextArea(areaWidth:Number, areaHeight:Number, textFieldClass:Class, vScrollBarClass:Class = null, hScrollBarClass:Class = null, cornerClass:Class = null, vScrollBarMargin:Margin = null, hScrollBarMargin:Margin = null, cornerMargin:Margin = null, pixelSnapped:Boolean = true, autoRendering:Boolean = true)
UITextArea クラスは抽象クラスのため直接インスタンス化できません.
UITextArea
  
appendText(newText:String):void
newText パラメータで指定された文字列を, テキストの最後に付加します.
UITextArea
 Inherited
bind(ui1:IUIBase, propName1:String, ui2:IUIBase, propName2:String, isTwoWay:Boolean = false):void
UI のプロパティ同士が同期するように設定します.
UIBase
  
dispose():void
このオブジェクト内で使用されている全てのオブジェクトを開放します.
UITextArea
  
getCharBoundaries(charIndex:int):Rectangle
charIndex パラメータで指定された文字の境界ボックスである矩形を返します.
UITextArea
  
getCharIndexAtPoint(x:Number, y:Number):int
x および y パラメータで指定された点にある文字の, 0 から始まるインデックス値を返します.
UITextArea
  
getFirstCharInParagraph(charIndex:int):int
指定したインデックスの文字と同じ段落内の最初の文字インデックス値を返します.
UITextArea
  
getImageReference(id:String):DisplayObject
タグを使用して HTML フォーマットのテキストフィールドに追加されたイメージ, または SWF の中で, 指定された id 属性をもつ表示オブジェクトを返します.
UITextArea
  
getLineIndexAtPoint(x:Number, y:Number):int
x および y パラメータで指定された点にある行の 0 から始まるインデックス値を返します.
UITextArea
  
getLineIndexOfChar(charIndex:int):int
charIndex パラメータで指定された文字を含む行の 0 から始まるインデックス値を返します.
UITextArea
  
getLineLength(lineIndex:int):int
lineIndex パラメータで指定された行の文字数を返します.
UITextArea
  
getLineMetrics(lineIndex:int):TextLineMetrics
lineIndex パラメータで指定された行に関するメトリック情報を返します.
UITextArea
  
getLineOffset(lineIndex:int):int
lineIndex パラメータで指定された行の最初の 0 から始まる文字インデックス値を返します.
UITextArea
  
getLineText(lineIndex:int):String
lineIndex パラメータで指定された行のテキストを返します.
UITextArea
  
getParagraphLength(charIndex:int):int
charIndex パラメータで指定された文字を含む段落の長さを返します.
UITextArea
  
getTextFormat(beginIndex:int = -1, endIndex:int = -1):TextFormat
beginIndex パラメータと endIndex パラメータで指定された範囲のテキストのフォーマット情報を含む TextFormat オブジェクトを返します.
UITextArea
 Inherited
lock():void
update メソッドの呼び出しによる UI の更新処理をロックします.
UIBase
  
render():void
レンダリング (パーツの再配置など) を行います.
UITextArea
  
replaceSelectedText(value:String):void
現在の選択内容を value パラメータの内容に置き換えます.
UITextArea
  
replaceText(beginIndex:int, endIndex:int, newText:String):void
beginIndex パラメータと endIndex パラメータで指定された範囲を, newText パラメータの内容に置き換えます.
UITextArea
  
setSelection(beginIndex:int, endIndex:int):void
最初の文字と最後の文字のインデックス値によって指定されたテキストを選択済みに設定します.
UITextArea
  
setTextFormat(format:TextFormat, beginIndex:int = -1, endIndex:int = -1):void
format パラメータで指定したテキストフォーマットを, 指定された範囲のテキストに適用します.
UITextArea
 Inherited
unbind(ui1:IUIBase, propName1:String, ui2:IUIBase, propName2:String):void
UI のプロパティ同士の同期を解除します.
UIBase
 Inherited
unlock():void
更新処理のロックを解除し, ロック中に更新されたプロパティがある場合は更新処理を行います.
UIBase
 Inherited
update():void
各プロパティの情報を元に UI のエリア領域などを更新します.
UIBase
Property detail
allSelectedproperty
allSelected:Boolean  [read-write]

テキストフィールドをクリックしてフォーカスが移った際, テキストを全選択するか否かです.

The default value is false.

Implementation
    public function get allSelected():Boolean
    public function set allSelected(value:Boolean):void
alwaysShowSelectionproperty 
alwaysShowSelection:Boolean  [read-write]

true に設定されフォーカスがない場合, テキスト内の選択内容は灰色でハイライト表示されます.

Implementation
    public function get alwaysShowSelection():Boolean
    public function set alwaysShowSelection(value:Boolean):void
antiAliasTypeproperty 
antiAliasType:String  [read-write]

テキストに使用されるアンチエイリアス処理のタイプです.

Implementation
    public function get antiAliasType():String
    public function set antiAliasType(value:String):void
areaBoundsproperty 
areaBounds:Rectangle  [read-only]

各パラメータの計算結果が反映されたこの UI のエリア領域です.

Implementation
    public function get areaBounds():Rectangle
areaHeightproperty 
areaHeight:Number  [read-write]

この UI のエリア領域の高さを示す数値です. 範囲外の数値は丸め込まれます.

Implementation
    public function get areaHeight():Number
    public function set areaHeight(value:Number):void

See also

areaWidthproperty 
areaWidth:Number  [read-write]

この UI のエリア領域の幅を示す数値です. 範囲外の数値は丸め込まれます.

Implementation
    public function get areaWidth():Number
    public function set areaWidth(value:Number):void

See also

backgroundproperty 
background:Sprite  [read-only]

Implementation
    public function get background():Sprite
bottomScrollVproperty 
bottomScrollV:int  [read-only]

現在表示されている一番下の行を示す, 1 から始まるインデックス値です.

Implementation
    public function get bottomScrollV():int
caretIndexproperty 
caretIndex:int  [read-only]

カーソル (キャレット) 位置のインデックスです.

Implementation
    public function get caretIndex():int
condenseWhiteproperty 
condenseWhite:Boolean  [read-write]

HTML テキストが含まれるテキストフィールド内の余分な空白 (スペース, 改行など) を削除するか否かです.

Implementation
    public function get condenseWhite():Boolean
    public function set condenseWhite(value:Boolean):void
cornerproperty 
corner:Sprite  [read-only]

cornerClass を元に生成されたコーナーです.

このオブジェクトのプロパティは UITextArea クラスで操作されるため, 直接プロパティを指定することは推奨されません.

Implementation
    public function get corner():Sprite
cornerBoundsproperty 
cornerBounds:Rectangle  [read-only]

各パラメータの計算結果が反映されたコーナーのエリア領域です.

Implementation
    public function get cornerBounds():Rectangle
cornerClassproperty 
cornerClass:Class  [read-write]

この UI に使用するコーナーのクラスです.

指定することで resizable プロパティが true の場合, コーナーをドラッグしてのリサイズが可能になります.

指定するクラスは Sprite クラスを継承している必要があります. また, インスタンス化に引数が必要なクラスを指定することは出来ません.

Implementation
    public function get cornerClass():Class
    public function set cornerClass(value:Class):void

Throws
— インスタンス化に失敗した場合.

See also

cornerMarginproperty 
cornerMargin:Margin  [read-write]

コーナーのマージンを設定するためのオブジェクトです.

Implementation
    public function get cornerMargin():Margin
    public function set cornerMargin(value:Margin):void
defaultTextFormatproperty 
defaultTextFormat:TextFormat  [read-write]

新しく挿入するテキスト (ユーザーが入力したテキストや replaceSelectedText メソッドで挿入したテキストなど) に適用するフォーマットを指定します.

Implementation
    public function get defaultTextFormat():TextFormat
    public function set defaultTextFormat(value:TextFormat):void
displayAsPasswordproperty 
displayAsPassword:Boolean  [read-write]

テキストをパスワードとして扱うか否かです.

Implementation
    public function get displayAsPassword():Boolean
    public function set displayAsPassword(value:Boolean):void
editableproperty 
editable:Boolean  [read-write]

テキストがユーザー入力により編集可能か否かです.

Implementation
    public function get editable():Boolean
    public function set editable(value:Boolean):void
embedFontsproperty 
embedFonts:Boolean  [read-write]

埋め込みフォントのアウトラインを使用してレンダリングするか否かです.

Implementation
    public function get embedFonts():Boolean
    public function set embedFonts(value:Boolean):void
enabledproperty 
enabled:Boolean  [read-write]

この UI がユーザーのマウスやキーボード操作を受け付けるか否かです.

Implementation
    public function get enabled():Boolean
    public function set enabled(value:Boolean):void
foregroundproperty 
foreground:Sprite  [read-only]

Implementation
    public function get foreground():Sprite
gridFitTypeproperty 
gridFitType:String  [read-write]

このテキストに使用されるグリッドフィッティングのタイプです.

Implementation
    public function get gridFitType():String
    public function set gridFitType(value:String):void
hScrollBarproperty 
hScrollBar:UIScrollBar  [read-only]

vScrollBarClass を元に生成された水平スクロールバーです.

このオブジェクトのプロパティは UITextArea クラスで操作されるため, 直接プロパティを操作することは推奨されません.

Implementation
    public function get hScrollBar():UIScrollBar
hScrollBarBoundsproperty 
hScrollBarBounds:Rectangle  [read-only]

各パラメータの計算結果が反映された水平方向スクロールバーのエリア領域です.

Implementation
    public function get hScrollBarBounds():Rectangle
hScrollBarClassproperty 
hScrollBarClass:Class  [read-write]

この UI に使用する水平スクロールバーのクラスです.

指定することで水平方向のスクロールが可能になります.

指定するクラスは UIScrollBar クラスを継承しており, かつ rail や knob 用のオブジェクトが配置されている必要があります. また, インスタンス化に引数が必要なクラスを指定することは出来ません.

Implementation
    public function get hScrollBarClass():Class
    public function set hScrollBarClass(value:Class):void

Throws
— インスタンス化に失敗した場合.

See also

hScrollBarMarginproperty 
hScrollBarMargin:Margin  [read-write]

水平スクロールバーのマージンを設定するためのオブジェクトです.

Implementation
    public function get hScrollBarMargin():Margin
    public function set hScrollBarMargin(value:Margin):void
hScrollBarVisibilityproperty 
hScrollBarVisibility:String  [read-write]

水平スクロールバーの表示設定です. Visibility クラスによって有効な方向が定義されています.

The default value is "auto".

Implementation
    public function get hScrollBarVisibility():String
    public function set hScrollBarVisibility(value:String):void

See also

htmlTextproperty 
htmlText:String  [read-write]

テキストフィールドの内容を HTML で表します.

Implementation
    public function get htmlText():String
    public function set htmlText(value:String):void
imeModeproperty 
imeMode:String  [read-write]

IME (入力メソッドエディタ) のモードを指定します.

IME を使用することによってユーザーは, 中国語・日本語・韓国語のテキストを入力できます. テキストにフォーカスが移った時に IME を指定されたモードに設定し, テキストにフォーカスが外れた時に IME を元のモードに設定します.

The default value is undefined.

Implementation
    public function get imeMode():String
    public function set imeMode(value:String):void

Throws
— 無効なモードを指定した場合.

See also

lengthproperty 
length:int  [read-only]

テキストの文字数です.

Implementation
    public function get length():int
maxAreaHeightproperty 
maxAreaHeight:Number  [read-write]

この UI のエリア領域の最大高を示す数値です. 最小値を下回る数値は丸め込まれます. 設定しない場合は NaN もしくは null を指定します.

The default value is NaN.

Implementation
    public function get maxAreaHeight():Number
    public function set maxAreaHeight(value:Number):void

See also

maxAreaWidthproperty 
maxAreaWidth:Number  [read-write]

この UI のエリア領域の最大幅を示す数値です. 最小値を下回る数値は丸め込まれます. 設定しない場合は NaN もしくは null を指定します.

The default value is NaN.

Implementation
    public function get maxAreaWidth():Number
    public function set maxAreaWidth(value:Number):void

See also

maxCharsproperty 
maxChars:int  [read-write]

ユーザーが入力するときに, テキストに入る最大の文字数です.

Implementation
    public function get maxChars():int
    public function set maxChars(value:int):void
maxScrollHproperty 
maxScrollH:Number  [read-only]

水平方向の最大スクロール量を示す数値です.

Implementation
    public function get maxScrollH():Number

See also

maxScrollVproperty 
maxScrollV:Number  [read-only]

垂直方向の最大スクロール量を示す数値です.

Implementation
    public function get maxScrollV():Number

See also

minAreaHeightproperty 
minAreaHeight:Number  [read-write]

この UI のエリア領域の最小高を示す数値です. 最大値を上回る数値は丸め込まれます. 設定しない場合は NaN もしくは null を指定します.

The default value is NaN.

Implementation
    public function get minAreaHeight():Number
    public function set minAreaHeight(value:Number):void

See also

minAreaWidthproperty 
minAreaWidth:Number  [read-write]

この UI のエリア領域の最小幅を示す数値です. 最大値を上回る数値は丸め込まれます. 設定しない場合は NaN もしくは null を指定します.

The default value is NaN.

Implementation
    public function get minAreaWidth():Number
    public function set minAreaWidth(value:Number):void

See also

minKnobSizeproperty 
minKnobSize:Number  [read-write]

スクロールバーのノブの最小サイズを示す数値です. 設定しない場合は NaN もしくは null を指定します.

The default value is NaN.

Implementation
    public function get minKnobSize():Number
    public function set minKnobSize(value:Number):void
numLinesproperty 
numLines:int  [read-only]

テキストの行数です.

Implementation
    public function get numLines():int
overlayproperty 
overlay:Boolean  [read-write]

各種スクロールバーやコーナーのエリア領域を踏まえずに viewport を計算するか否かです.

このプロパティを true に設定すると areaBounds 及び viewport は同じ幅・高さを返すようになります.

The default value is false.

Implementation
    public function get overlay():Boolean
    public function set overlay(value:Boolean):void

See also

resizableproperty 
resizable:Boolean  [read-write]

コーナーをドラッグしてのリサイズが可能か否かです.

cornerClass が設定されている場合のみ true に設定出来ます.

Implementation
    public function get resizable():Boolean
    public function set resizable(value:Boolean):void

Throws
— cornerClass が設定されていないのに true に設定しようとした場合.

See also

restrictproperty 
restrict:String  [read-write]

ユーザーがテキストに入力できる文字のセットを指定します.

Implementation
    public function get restrict():String
    public function set restrict(value:String):void
scrollHproperty 
scrollH:Number  [read-write]

水平方向のスクロール量を示す数値です.

Implementation
    public function get scrollH():Number
    public function set scrollH(value:Number):void

See also

scrollVproperty 
scrollV:Number  [read-write]

垂直方向のスクロール量を示す数値です.

Implementation
    public function get scrollV():Number
    public function set scrollV(value:Number):void

See also

selectionBeginIndexproperty 
selectionBeginIndex:int  [read-only]

現在の選択範囲の最初の文字を示す, 0 から始まるインデックス値です.

Implementation
    public function get selectionBeginIndex():int
selectionEndIndexproperty 
selectionEndIndex:int  [read-only]

現在の選択範囲における最後の文字を示す, 0 から始まるインデックス値です.

Implementation
    public function get selectionEndIndex():int
sharpnessproperty 
sharpness:Number  [read-write]

このテキスト内の文字エッジのシャープネスです.

Implementation
    public function get sharpness():Number
    public function set sharpness(value:Number):void
styleSheetproperty 
styleSheet:StyleSheet  [read-write]

テキストにスタイルシートを関連付けます.

Implementation
    public function get styleSheet():StyleSheet
    public function set styleSheet(value:StyleSheet):void
textColorproperty 
textColor:uint  [read-write]

テキストの色です (16 進数形式).

Implementation
    public function get textColor():uint
    public function set textColor(value:uint):void
textFieldproperty 
textField:UITextField  [read-only]

fieldClass を元に生成されたテキストフィールドです.

このオブジェクトのプロパティは UITextArea クラスで操作されるため, 直接プロパティを操作することは推奨されません.

Implementation
    public function get textField():UITextField
textFieldBoundsproperty 
textFieldBounds:Rectangle  [read-only]

各パラメータの計算結果が反映されたテキストフィールドのエリア領域です.

Implementation
    public function get textFieldBounds():Rectangle
textFieldClassproperty 
textFieldClass:Class  [read-write]

この UI に使用するテキストフィールドのクラスです.

指定するクラスは UITextField クラスを継承している必要があります. また, インスタンス化に引数が必要なクラスを指定することは出来ません.

Implementation
    public function get textFieldClass():Class
    public function set textFieldClass(value:Class):void

Throws
— インスタンス化に失敗した場合.

See also

textHeightproperty 
textHeight:Number  [read-only]

テキストの高さです (ピクセル単位).

Implementation
    public function get textHeight():Number
textWidthproperty 
textWidth:Number  [read-only]

テキストの高さです (ピクセル単位).

Implementation
    public function get textWidth():Number
thicknessproperty 
thickness:Number  [read-write]

このテキスト内の文字エッジの太さです.

Implementation
    public function get thickness():Number
    public function set thickness(value:Number):void
useRichTextClipboardproperty 
useRichTextClipboard:Boolean  [read-write]

テキストと共にテキストのフォーマットをコピー&ペーストするか否かです.

Implementation
    public function get useRichTextClipboard():Boolean
    public function set useRichTextClipboard(value:Boolean):void
valueproperty 
value:String  [read-write]

この UI が示すテキスト文字列です.

Implementation
    public function get value():String
    public function set value(value:String):void
vScrollBarproperty 
vScrollBar:UIScrollBar  [read-only]

vScrollBarClass を元に生成された垂直スクロールバーです.

このオブジェクトのプロパティは UITextArea クラスで操作されるため, 直接プロパティを操作することは推奨されません.

Implementation
    public function get vScrollBar():UIScrollBar
vScrollBarBoundsproperty 
vScrollBarBounds:Rectangle  [read-only]

各パラメータの計算結果が反映された垂直方向スクロールバーのエリア領域です.

Implementation
    public function get vScrollBarBounds():Rectangle
vScrollBarClassproperty 
vScrollBarClass:Class  [read-write]

この UI に使用する垂直スクロールバーのクラスです.

指定することで垂直方向のスクロールが可能になります.

指定するクラスは UIScrollBar クラスを継承しており, かつ rail や knob 用のオブジェクトが配置されている必要があります. また, インスタンス化に引数が必要なクラスを指定することは出来ません.

Implementation
    public function get vScrollBarClass():Class
    public function set vScrollBarClass(value:Class):void

Throws
— インスタンス化に失敗した場合.

See also

vScrollBarMarginproperty 
vScrollBarMargin:Margin  [read-write]

垂直スクロールバーのマージンを設定するためのオブジェクトです.

Implementation
    public function get vScrollBarMargin():Margin
    public function set vScrollBarMargin(value:Margin):void
vScrollBarVisibilityproperty 
vScrollBarVisibility:String  [read-write]

垂直スクロールバーの表示設定です. Visibility クラスによって有効な方向が定義されています.

The default value is "auto".

Implementation
    public function get vScrollBarVisibility():String
    public function set vScrollBarVisibility(value:String):void

See also

wordWrapproperty 
wordWrap:Boolean  [read-write]

テキストを折り返すか否かです.

Implementation
    public function get wordWrap():Boolean
    public function set wordWrap(value:Boolean):void
Constructor detail
UITextArea()constructor
public function UITextArea(areaWidth:Number, areaHeight:Number, textFieldClass:Class, vScrollBarClass:Class = null, hScrollBarClass:Class = null, cornerClass:Class = null, vScrollBarMargin:Margin = null, hScrollBarMargin:Margin = null, cornerMargin:Margin = null, pixelSnapped:Boolean = true, autoRendering:Boolean = true)

UITextArea クラスは抽象クラスのため直接インスタンス化できません.

Parameters
areaWidth:Number — この UI のエリア領域の幅を示す数値です.
 
areaHeight:Number — この UI のエリア領域の高さを示す数値です.
 
textFieldClass:Class — この UI に使用するテキストフィールドのクラスです.
 
vScrollBarClass:Class (default = null) — この UI に使用する垂直スクロールバーのクラスです.
 
hScrollBarClass:Class (default = null) — この UI に使用する水平スクロールバーのクラスです.
 
cornerClass:Class (default = null) — この UI に使用するコーナーのクラスです.
 
vScrollBarMargin:Margin (default = null) — 垂直スクロールバーのマージンを設定するためのオブジェクトです.
 
hScrollBarMargin:Margin (default = null) — 垂直スクロールバーのマージンを設定するためのオブジェクトです.
 
cornerMargin:Margin (default = null) — コーナーのマージンを設定するためのオブジェクトです.
 
pixelSnapped:Boolean (default = true) — 自動レンダリングの時に各パーツをピクセルに吸着して配置するか否かです.
 
autoRendering:Boolean (default = true) — この UI のレンダリングを自動的に行うか否かです.
Method detail
appendText()method
public function appendText(newText:String):void

newText パラメータで指定された文字列を, テキストの最後に付加します.

Parameters
newText:String — 付加する文字列です.
dispose()method 
public override function dispose():void

このオブジェクト内で使用されている全てのオブジェクトを開放します.

getCharBoundaries()method 
public function getCharBoundaries(charIndex:int):Rectangle

charIndex パラメータで指定された文字の境界ボックスである矩形を返します.

Parameters
charIndex:int — 文字の 0 から始まるインデックス値です.

Returns
Rectangle — charIndex パラメータで指定された文字の境界ボックスである矩形です.
getCharIndexAtPoint()method 
public function getCharIndexAtPoint(x:Number, y:Number):int

x および y パラメータで指定された点にある文字の, 0 から始まるインデックス値を返します.

Parameters
x:Number — 文字の x 座標です.
 
y:Number — 文字の y 座標です.

Returns
int — 0 から始まる文字のインデックス値です.
getFirstCharInParagraph()method 
public function getFirstCharInParagraph(charIndex:int):int

指定したインデックスの文字と同じ段落内の最初の文字インデックス値を返します.

Parameters
charIndex:int — 文字の 0 から始まる文字のインデックス値です.

Returns
int — 0 から始まる文字のインデックス値です.

Throws
— 指定された文字のインデックス値が範囲外の場合.
getImageReference()method 
public function getImageReference(id:String):DisplayObject

タグを使用して HTML フォーマットのテキストフィールドに追加されたイメージ, または SWF の中で, 指定された id 属性をもつ表示オブジェクトを返します.

Parameters
id:String — <img> タグの id 属性値です.

Returns
DisplayObject — 一致する id 属性をもつ表示オブジェクトです.
getLineIndexAtPoint()method 
public function getLineIndexAtPoint(x:Number, y:Number):int

x および y パラメータで指定された点にある行の 0 から始まるインデックス値を返します.

Parameters
x:Number — 行の x 座標です.
 
y:Number — 行の y 座標です.

Returns
int — 0 から始まる行のインデックス値です.
getLineIndexOfChar()method 
public function getLineIndexOfChar(charIndex:int):int

charIndex パラメータで指定された文字を含む行の 0 から始まるインデックス値を返します.

Parameters
charIndex:int — 文字の 0 から始まる文字のインデックス値です.

Returns
int — 0 から始まる行のインデックス値です.

Throws
— 指定された文字のインデックス値が範囲外の場合.
getLineLength()method 
public function getLineLength(lineIndex:int):int

lineIndex パラメータで指定された行の文字数を返します.

Parameters
lineIndex:int — 0 から始まる行のインデックス値です.

Returns
int — lineIndex パラメータで指定された行の文字数です.

Throws
— 指定された行のインデックス値が範囲外の場合.
getLineMetrics()method 
public function getLineMetrics(lineIndex:int):TextLineMetrics

lineIndex パラメータで指定された行に関するメトリック情報を返します.

Parameters
lineIndex:int — 0 から始まる行のインデックス値です.

Returns
TextLineMetrics — lineIndex パラメータで指定された行に関するメトリック情報です.

Throws
— 指定された行のインデックス値が範囲外の場合.

See also

getLineOffset()method 
public function getLineOffset(lineIndex:int):int

lineIndex パラメータで指定された行の最初の 0 から始まる文字インデックス値を返します.

Parameters
lineIndex:int — 0 から始まる行のインデックス値です.

Returns
int — lineIndex パラメータで指定された行の最初の 0 から始まる文字インデックス値です.

Throws
— 指定された行のインデックス値が範囲外の場合.
getLineText()method 
public function getLineText(lineIndex:int):String

lineIndex パラメータで指定された行のテキストを返します.

Parameters
lineIndex:int — 0 から始まる行のインデックス値です.

Returns
String — lineIndex パラメータで指定された行のテキストです.

Throws
— 指定された行のインデックス値が範囲外の場合.
getParagraphLength()method 
public function getParagraphLength(charIndex:int):int

charIndex パラメータで指定された文字を含む段落の長さを返します.

Parameters
charIndex:int — 文字の 0 から始まる文字のインデックス値です.

Returns
int — charIndex パラメータで指定された文字を含む段落の長さです.

Throws
— 指定された文字のインデックス値が範囲外の場合.
getTextFormat()method 
public function getTextFormat(beginIndex:int = -1, endIndex:int = -1):TextFormat

beginIndex パラメータと endIndex パラメータで指定された範囲のテキストのフォーマット情報を含む TextFormat オブジェクトを返します.

Parameters
beginIndex:int (default = -1) — テキスト範囲の開始位置を示すインデックス値です.
 
endIndex:int (default = -1) — テキスト範囲の終了位置を示すインデックス値です.

Returns
TextFormat — 指定されたテキストのフォーマットプロパティを表す TextFormat オブジェクトです.
render()method 
public override function render():void

レンダリング (パーツの再配置など) を行います.

本来はこのメソッドを明示的に呼び出す必要はありませんが, プロパティを操作しても表示がおかしい場合は明示的に呼び出します.

プロパティを操作しても表示がおかしいのは以下のような場合です.

replaceSelectedText()method 
public function replaceSelectedText(value:String):void

現在の選択内容を value パラメータの内容に置き換えます.

Parameters
value:String — 現在選択されているテキストを置き換える文字列です.
replaceText()method 
public function replaceText(beginIndex:int, endIndex:int, newText:String):void

beginIndex パラメータと endIndex パラメータで指定された範囲を, newText パラメータの内容に置き換えます.

Parameters
beginIndex:int — テキスト範囲の開始位置を示すインデックス値です.
 
endIndex:int — テキスト範囲の終了位置を示すインデックス値です.
 
newText:String — 指定された範囲のテキストを置き換える文字列です.
setSelection()method 
public function setSelection(beginIndex:int, endIndex:int):void

最初の文字と最後の文字のインデックス値によって指定されたテキストを選択済みに設定します.

Parameters
beginIndex:int — テキスト範囲の開始位置を示すインデックス値です.
 
endIndex:int — テキスト範囲の終了位置を示すインデックス値です.
setTextFormat()method 
public function setTextFormat(format:TextFormat, beginIndex:int = -1, endIndex:int = -1):void

format パラメータで指定したテキストフォーマットを, 指定された範囲のテキストに適用します.

Parameters
format:TextFormat — 文字と段落のフォーマット情報を含む TextFormat オブジェクトです.
 
beginIndex:int (default = -1) — テキスト範囲の開始位置を示すインデックス値です.
 
endIndex:int (default = -1) — テキスト範囲の終了位置を示すインデックス値です.