condenseWhite:Boolean  [read-write]

HTML テキストの TextArea コントロールから余分な空白文字 (スペースや改行など) を削除するかどうかを指定します。

condenseWhite プロパティは、text プロパティではなく htmlText プロパティで設定されたテキストにのみ影響します。text プロパティでテキストを設定した場合、condenseWhite は無視されます。

condenseWhite プロパティを true に設定した場合は、テキストフィールド内で改行を指定するときに <br> や <p> などの標準の HTML コマンドを使用する必要があります。

デフォルト値false.

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get condenseWhite():Boolean
    public function set condenseWhite(value:Boolean):void

data:Object  [read-write]

アイテムレンダラーまたはアイテムエディタでコンポーネントを使用するときに、コンポーネントに値を渡すことができます。通常、データバインディングを使用して、data プロパティのフィールドをこのコンポーネントのプロパティにバインドします。

ドロップインアイテムレンダラーまたはドロップインアイテムエディタとしてコントロールを使用すると、アイテムの現在の値が、このコントロールの text プロパティに自動的に書き込まれます。

MXML でこのプロパティを設定することはありません。

デフォルト値ヌル (null).

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get data():Object
    public function set data(value:Object):void

関連項目

displayAsPassword:Boolean  [read-write]

このコントロールがパスワードの入力で使用されるかどうかを示します。true の場合、入力されたテキストはフィールドには表示されません。代わりに、コントロールに入力された各テキストの文字は、文字 "*" として表示されます。

デフォルト値false.

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get displayAsPassword():Boolean
    public function set displayAsPassword(value:Boolean):void

editable:Boolean  [read-write]

このコントロール内のテキストをユーザーが編集できるかどうかを示します。true の場合、ユーザーがテキストを編集できます。

デフォルト値true;.

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get editable():Boolean
    public function set editable(value:Boolean):void

horizontalScrollPolicy:String  [read-write]

水平スクロールバーを常にオンにするか (ScrollPolicy.ON)、常にオフにするか (ScrollPolicy.OFF)、または必要に応じてオンにするか (ScrollPolicy.AUTO) を指定します。

デフォルト値ScrollPolicy.AUTO.

実装
    public function get horizontalScrollPolicy():String
    public function set horizontalScrollPolicy(value:String):void

horizontalScrollPosition:Number  [write-only]

現在表示されているコンテンツ領域の一番左にあるピクセルのピクセル位置です。(コンテンツ領域には、現在表示されている部分だけではなく、コントロールのすべての内容が含まれます)。このプロパティは常に 0 に設定されており、wordWrap が true に設定されている場合は変更も無視されます。

デフォルト値0.

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function set horizontalScrollPosition(value:Number):void

htmlText:String  [read-write]

TextArea コントロールによって表示されるテキストを指定します。テキストのスタイルを表す HTML マークアップを含めて指定します。このプロパティで HTML テキストを指定する場合は、Flash TextField コントロールでサポートされている HTML タグのサブセットを使用できます。

このプロパティを設定すると、TextArea インスタンスに CSS スタイルが適用された後に HTML マークアップが適用されます。このプロパティを取得すると、HTML マークアップに CSS スタイルが含まれます。

たとえば、"This is an example of <b>bold</b> markup",という文字列を設定した場合、TextArea には、通常適用される CSS スタイルが適用された 「This is an example of bold markup」というテキストが表示されます。また、<b> マークアップによって、"bold" という単語がボールド体のフォントで表示されます。

HTML マークアップでは、< や > などの文字を使用します。これらの文字は、XML では特別な意味を持っています (MXML でも同じです) 。したがって、次のようなコードはコンパイルされません。

      <mx:TextArea htmlText="This is an example of <b>bold</b> markup"/>
      

この問題を回避するには、3 つの方法があります。

• initialize ハンドラとして呼び出される ActionScript メソッドの htmlText プロパティを設定します。

        <mx:TextArea id="myTextArea" initialize="myTextArea_initialize()"/>
        

  myTextArea_initialize メソッドは、スクリプトの CDATA セクションに指定します。

        <mx:Script>
        <![CDATA[
        private function myTextArea_initialize():void {
            myTextArea.htmlText = "This is an example of <b>bold</b> markup";
        }
        ]]>
        </mx:Script>
        
        

  This is the simplest approach because the HTML markup remains easily readable. Notice that you must assign an id to the TextArea so you can refer to it in the initialize handler.

• Specify the htmlText property by using a child tag with a CDATA section. A CDATA section in XML contains character data where characters like < and > aren't given a special meaning.

        <mx:TextArea>
            <mx:htmlText><![CDATA[This is an example of <b>bold</b> markup]]></mx:htmlText>
        <mx:TextArea/>
        

  You must write the htmlText property as a child tag rather than as an attribute on the <mx:TextArea> tag because XML doesn't allow CDATA for the value of an attribute. Notice that the markup is readable, but the CDATA section makes this approach more complicated.

• Use an hmtlText attribute where any occurences of the HTML markup characters < and > in the attribute value are written instead as the XML "entities" < and >:

        <mx:TextArea htmlText="This is an example of &lt;b&gt;bold&lt;/b&gt; markup"/&gt;
        

  Adobe does not recommend this approach because the HTML markup becomes nearly impossible to read.

If the condenseWhite property is true when you set the htmlText property, multiple white-space characters are condensed, as in HTML-based browsers; for example, three consecutive spaces are displayed as a single space. The default value for condenseWhite is false, so you must set condenseWhite to true to collapse the white space.

If you read back the htmlText property quickly after setting it, you get the same string that you set. However, after the LayoutManager runs, the value changes to include additional markup that includes the CSS styles.

Setting the htmlText property affects the text property in several ways. If you read the text property quickly after setting the htmlText property, you get null, which indicates that the text corresponding to the new htmlText has not yet been determined. However, after the LayoutManager runs, the text property value changes to the htmlText string with all the HTML markup removed; that is, the value is the characters that the TextArea actually displays.

Conversely, if you set the text property, any previously set htmlText is irrelevant. If you read the htmlText property quickly after setting the text property, you get null, which indicates that the htmlText that corresponds to the new text has not yet been determined. However, after the LayoutManager runs, the htmlText property value changes to the new text plus the HTML markup for the CSS styles.

To make the LayoutManager run immediately, you can call the validateNow() method on the TextArea. For example, you could set some htmlText, call the validateNow() method, and immediately obtain the corresponding text that doesn't have the HTML markup.

If you set both text and htmlText properties in ActionScript, whichever is set last takes effect. Do not set both in MXML, because MXML does not guarantee that the properties of an instance get set in any particular order.

Setting either text or htmlText property inside a loop is a fast operation, because the underlying TextField that actually renders the text is not updated until the LayoutManager runs.

If you try to set this property to null, it is set, instead, to the empty string. If the property temporarily has the value null, it indicates that the text has been recently set and the corresponding htmlText has not yet been determined.

デフォルト値"".

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get htmlText():String
    public function set htmlText(value:String):void

関連項目

imeMode:String  [read-write]

IME (入力メソッドエディタ) のモードを指定します。IME を使用することによって、ユーザーは中国語、日本語、および韓国語のテキストを入力できます。Flex では、コントロールにフォーカスが置かれたときに、IME を指定されたモードに設定し、コントロールからフォーカスが離れたときに、元のモードに戻します。

flash.system.IMEConversionMode クラスで、このプロパティの有効な値の定数を定義します。IME をまったく指定しない場合は、null を指定します。

デフォルト値ヌル (null).

実装
    public function get imeMode():String
    public function set imeMode(value:String):void

関連項目

length:int  [read-only]

TextArea に表示されるテキストの文字数です。

デフォルト値0.

実装
    public function get length():int

listData:BaseListData  [read-write]

ドロップインアイテムレンダラーまたはドロップインアイテムエディタとして使用すると、このコンポーネントの listData プロパティが、リストコントロールからの該当するデータで初期化されます。その後、コンポーネントでこの listData プロパティを使用して、ドロップインアイテムレンダラーまたはドロップインアイテムエディタの data プロパティを初期化できます。

MXML および ActionScript でこのプロパティを設定することはありません。このコンポーネントがドロップインアイテムレンダラーまたはドロップインアイテムエディタとして使用されるときに、Flex でプロパティが設定されます。

デフォルト値ヌル (null).

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get listData():BaseListData
    public function set listData(value:BaseListData):void

関連項目

maxChars:int  [read-write]

テキストフィールドにユーザーが入力できる最大文字数です。コントロールの text または htmlText プロパティの設定によって指定されるテキストの長さが、このプロパティによって制限されることはありません。

デフォルト値は 0 です。これは、制限がないことを意味します。

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get maxChars():int
    public function set maxChars(value:int):void

restrict:String  [read-write]

ユーザーがコントロールに入力できる文字のセットを示します。restrict プロパティの値が null である場合は、任意の文字を入力できます。restrict プロパティの値が空のストリングである場合は、いずれの文字も入力できません。このプロパティはユーザーの操作のみを制限します。スクリプトでテキストフィールドに入力するテキストは制限しません。restrict プロパティの値が文字のストリングである場合は、そのストリング内の文字のみをテキストフィールドに入力できます。

ストリングは左から右へスキャンされます。ハイフン (-) 文字を使用して、範囲を指定できます。ストリングがキャレット (^) 文字で始まる場合、そのストリングに含まれる文字を除いて、すべての文字を入力できます。ストリングがキャレット (^) 文字以外で始まる場合は、そのストリングに含まれる文字のみを入力できます。

一部の文字は restrict プロパティで使用すると特殊な意味を持つため、リテラル文字の -、^、および \ を指定するには、円記号を使用する必要があります。restrict プロパティを MXML タグで属性として使用する場合は、次の例に示すように、単一の円記号を使います。 \^\-\\.restrict を ActionScript 式に設定する場合、次の例に示すように、円記号を 2 つ続けて指定します。\\^\\-\\\.

デフォルト値ヌル (null).

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get restrict():String
    public function set restrict(value:String):void

関連項目

selectable:Boolean  [read-write]

テキストが選択可能であるかどうかを指定します。テキストを選択可能にすると、コントロールからテキストをコピーできます。

デフォルト値false;.

実装
    public function get selectable():Boolean
    public function set selectable(value:Boolean):void

selectionBeginIndex:int  [read-write]

現在の選択範囲の最初の文字を示す 0 ベースのインデックス値です。最初の文字が 0、2 番目の文字が 1 です (以下同様)。コントロールがフォーカスを取得したとき、selectionBeginIndex プロパティと selectionEndIndex プロパティが両方とも設定されている場合は選択範囲が表示されます。

デフォルト値0.

実装
    public function get selectionBeginIndex():int
    public function set selectionBeginIndex(value:int):void

selectionEndIndex:int  [read-write]

現在の選択範囲の最後の文字の直後の位置を示す 0 ベースのインデックスです。つまり、最後の文字の位置を示す 1 ベースインデックスと同じです。たとえば、選択範囲の最後の文字が 5 番目の文字だった場合、このプロパティの値は 5 になります。コントロールがフォーカスを取得したとき、selectionBeginIndex プロパティと selectionEndIndex プロパティが両方とも設定されている場合は選択範囲が表示されます。

デフォルト値0.

実装
    public function get selectionEndIndex():int
    public function set selectionEndIndex(value:int):void

styleSheet:StyleSheet  [read-write]

TextArea コントロールのテキスト上でレンダリングを実行できる flash.text.StyleSheet オブジェクトです。テキストに対する HTML スタイルを詳細に制御する場合に使用します。詳細については、flash.text.StyleSheet クラスの説明を参照してください。

デフォルト値ヌル (null).

実装
    public function get styleSheet():StyleSheet
    public function set styleSheet(value:StyleSheet):void

関連項目

text:String  [read-write]

コントロールに表示されるプレーンテキストです。その外観は、この Label コントロールの CSS スタイルによって決定されます。

テキストストリング内の HTML タグはすべて無視され、ストリングに入力したとおりに表示されます。HTML タグを使用してフォーマットされたテキストを表示するには、htmlText プロパティを使用します。htmlText プロパティを設定している場合は、その HTML で、設定されたテキストが置き換えられ、text プロパティは、HTML テキストから HTML タグを除いたプレーンテキストを返します。詳細については、「htmlText プロパティ」を参照してください。

特殊文字である左山括弧 (<)、右山括弧 (>)、アンパサンド (&) をテキストに含める場合は、CDATA タグでテキストストリングを囲む必要があります。特殊文字の代わりに、< などの HTML 文字エンティティを使用できます。

このプロパティを null に設定しようとした場合は、代わりに空のストリングに設定されます。text プロパティには、値 null を一時的に設定できます。これは、htmlText が最近設定され、対応する text 値がまだ決定されていないことを示します。

デフォルト値"".

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get text():String
    public function set text(value:String):void

protected var textField:UITextField

この TextArea のテキストを表示するための内部 UITextField です。

textHeight:Number  [read-only]

テキストの高さです。

textHeight プロパティの値は、コンポーネントが検証された後でのみ正しい値になります。text を設定し、その直後に textHeight を取得した場合は、間違った値を受け取る可能性があります。コンポーネントが検証されるまで待つか、値を取得する前に validateNow() メソッドを呼び出します。この動作は、値をただちに更新する flash.text.TextField コントロールの動作とは異なります。

実装
    public function get textHeight():Number

関連項目

textWidth:Number  [read-only]

テキストの幅です。

textWidth プロパティの値は、コンポーネントが検証された後でのみ正しい値になります。text を設定し、その直後に textWidth を取得した場合は、間違った値を受け取る可能性があります。コンポーネントが検証されるまで待つか、値を取得する前に validateNow() メソッドを呼び出します。この動作は、値をただちに更新する flash.text.TextField コントロールの動作とは異なります。

実装
    public function get textWidth():Number

関連項目

verticalScrollPolicy:String  [read-write]

垂直スクロールバーを常にオンにするか (ScrollPolicy.ON)、常にオフにするか (ScrollPolicy.OFF)、必要なときにオンにするか (ScrollPolicy.AUTO) を指定します。

デフォルト値ScrollPolicy.AUTO.

実装
    public function get verticalScrollPolicy():String
    public function set verticalScrollPolicy(value:String):void

verticalScrollPosition:Number  [write-only]

現在表示されている一番上の文字行の行番号です。デフォルト値は 0 です。

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function set verticalScrollPosition(value:Number):void

wordWrap:Boolean  [read-write]

テキストを行末で自動的に折り返すかどうかを示します。true の場合、テキストは折り返されて複数の行に表示されます (必要な場合)。

デフォルト値true.

このプロパティはデータバインディングのソースとして使用できます。

実装
    public function get wordWrap():Boolean
    public function set wordWrap(value:Boolean):void

public 関数 TextArea()

コンストラクタです。

public function getLineMetrics(lineIndex:int):TextLineMetrics

コントロール内のテキスト行のテキストの位置と測定に関する情報を持つ TextLineMetrics オブジェクトを返します。正しい数値を取得するには、コンポーネントを検証する必要があります。text または htmlText プロパティを設定し、その直後に getLineMetrics() を呼び出した場合は、間違った値を受け取る可能性があります。コンポーネントが検証されるまで待つか、validateNow() を呼び出します。この動作は、値をただちに更新する flash.text.TextField クラスの動作とは異なります。

パラメータ

lineIndex:int — メトリックを取得する行の 0 から始まるインデックスです。

戻り値

TextLineMetrics

関連項目

public function setSelection(beginIndex:int, endIndex:int):void

パラメータで指定された範囲のテキストを選択します。コントロールがフォーカスを持っていない場合、選択範囲は、コントロールがフォーカスを取得するまではハイライト表示されません。また、コントロールのクリックによってフォーカスが取得された場合、それまでのすべての選択範囲は失われます。2 つのパラメータが同一の場合、新しい選択範囲が挿入ポイントです。

パラメータ

	beginIndex:int — 選択範囲の先頭の文字の 0 ベースのインデックスです。つまり、先頭の文字が 0 で、2 番目の文字が 1 です (以下同様)。
	endIndex:int — 選択範囲の最後の文字の直後の位置を示す 0 ベースのインデックスです。つまり、最後の文字の位置を示す 1 ベースインデックスと同じです。パラメータが 5 の場合、選択範囲の最後の文字は 5 番目の文字です。TextArea コントロールがフォーカスを取得したとき、selectionBeginIndex プロパティと selectionEndIndex プロパティが両方とも設定されている場合は、選択範囲が表示されます。

イベントオブジェクトの型: flash.events.Event
Event.type property = flash.events.Event.CHANGE

TextArea コントロール内のテキストがユーザーの入力によって変化したときに送出されます。データバインディングまたは ActionScript コードを使用してテキストを変更した場合、このイベントは生成されません。

change イベントオブジェクトの type プロパティの値を定義します。

このイベントには、次のプロパティがあります。

プロパティ	値
bubbles	true
cancelable	false は、キャンセルするデフォルトの動作がないことを示します。
currentTarget	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
target	値が変更されたオブジェクトです。target は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、currentTarget プロパティを使用します。

イベントオブジェクトの型: mx.events.FlexEvent
FlexEvent.type property = mx.events.FlexEvent.DATA_CHANGE

data プロパティが変更されたときに送出されます。

コンポーネントをアイテムレンダラーとして使う場合、data プロパティは表示するデータを保持します。このイベントを受け取って、data プロパティが変更されたときにコンポーネントを更新することができます。

FlexEvent.DATA_CHANGE 定数により、dataChange イベントのイベントオブジェクトの type プロパティ値が定義されます。

イベントオブジェクトの各プロパティには次の値が設定されています。

プロパティ	値
bubbles	false
cancelable	false
currentTarget	イベント処理を行うイベントリスナーの定義用オブジェクトを表します。たとえば、イベントリスナーの登録に myButton.addEventListener() を使用すると、currentTarget の値は "myButton" となります。
target	イベントを送出したオブジェクトを表します。このオブジェクトは必ずイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトにアクセスするには、currentTarget プロパティを使用します。

イベントオブジェクトの型: flash.events.TextEvent
TextEvent.type property = flash.events.TextEvent.LINK

htmlText プロパティで定義されているテキストのハイパーリンクをユーザーがクリックしたときに送出されます (URL は "event:" で始まります)。"event:" の後の URL の残りの部分は、link イベントオブジェクトの text プロパティ内に配置されます。

link イベントを扱う場合、ハイパーリンクは自動的には実行されません。イベントハンドラ内から手動でハイパーリンクを実行する必要があります。通常、navigateToURL() メソッドを使用してハイパーリンクを実行します。これにより、アプリケーション内でハイパーリンクを変更することができ、場合によってはハイパーリンクの実行を禁止することもできます。

link イベントオブジェクトの type プロパティの値を定義します。

このイベントには、次のプロパティがあります。

プロパティ	値
bubbles	true
cancelable	false は、キャンセルするデフォルトの動作がないことを示します。
currentTarget	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
target	クリックされたハイパーリンクを含むテキストフィールドです。target は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、currentTarget プロパティを使用します。
text	"event:" の後の URL の残りの部分は、

イベントオブジェクトの型: flash.events.TextEvent
TextEvent.type property = flash.events.TextEvent.TEXT_INPUT

ユーザーがコントロールに対してテキストの入力、削除、またはペーストを実行したときに送出されます。

textInput イベントオブジェクトの type プロパティの値を定義します。

このイベントには、次のプロパティがあります。

プロパティ	値
bubbles	true
cancelable	true。preventDefault() メソッドを呼び出してデフォルトの動作を取り消します。
currentTarget	イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
target	文字が入力されるテキストフィールドです。target は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、currentTarget プロパティを使用します。
text	ユーザーが入力した文字または文字の連続です。