2.1.6 TextArea

TextAreaは、テキスト(単一行または複数行)の入力フィールドを表示する部品です。

注意

フォーカス時の動作について
Tabキーやマウスクリックによりフォーカスを移動した直後のカーソル位置および選択状態は、ブラウザおよびlabelProviderの指定により異なります。
改行コードについて
TextAreaに入力した文字列に改行を含む場合、valueプロパティの文字列値では「\n」(LF、文字コード10)として表現されます。APIやモデルとのバインディングで設定された文字列に「\r」がある場合、「\r」は取り除かれます。これにより、改行コードが「\r\n」(CR+LF、文字コード13,10)の場合は、「\n」に変換されます。

ポイント

機能付加部品のValidationHelperを利用して、検証を実行することができます。

表示例

本部品では、Ctrlキー + z が使用できます。詳細は、「5.1.7 テキスト入力部品でのCtrlキー+zによるやり直し」を参照してください。

記述形式

<div rcf:type="TextArea" ... ></div>

または

<span rcf:type="TextArea" ... ></span>

注意

子要素は指定できません。詳細は、「5.1.4 子要素を持たない部品に子要素を記述した場合の動作」を参照してください。
rcf:valueに改行を含む文字列を直接記述した場合、ブラウザによっては先頭と末尾の改行が取り除かれることがあります。

ポイント

本部品は以下のように表示されます。

<div>タグの場合:前後に改行コードが挿入されます。
<span>タグの場合:前後に改行コードは挿入されません。

プロパティ

表の項目の意味は、「Text」の「プロパティ」を参照してください。

名前	データ型	説明	省略	省略値	属性指定	更新	部分更新
value	String	テキストを指定します。	可	""	値、バインド	可	不可
title	String	ツールチップで表示されるテキストを指定します。	可	""	値	可	不可
labelProvider	getLabel関数を持つオブジェクト	テキストを表示するときにフォーマットするためのオブジェクトを指定します。詳細は、「フォーマッタについて」を参照してください。 getLabel関数を持たないオブジェクトが指定された場合、エラーになります。nullを指定した場合は、valueに指定された文字列がそのまま使用されます。	可	null	値	可	不可
enabled	Boolean	本部品の有効/無効を指定します。 true:有効 false:無効操作できなくなりイベントも発生しません。	可	true	値、バインド	可	不可
readOnly	Boolean	書込み禁止/許可を指定します。 true:禁止マウスオーバーなどの各種イベントは発生します。 false:許可	可	false	値、バインド	可	不可
rows	Number	行数を指定します。1以上の値を指定できます。スタイルプロパティのheightに部品の高さが指定された場合は、heightの値が優先されます。	可	2	値	可	不可
cols	Number	テキストエリアの平均的文字幅による文字数を指定します。1以上の値を指定できます。スタイルプロパティのwidthに部品の幅が指定された場合は、widthの値が優先されます。	可	20	値	可	不可
tabIndex	Number	Tabキーで移動するフォーカスの順番を指定します。 HTMLのtabindex属性と同様の指定ができます。1以上の整数を指定した場合、数字の小さい順にフォーカスが移動します。 FocusManagerによるフォーカス移動には関係しません。	可	0	値	可	不可
imeMode	String	IMEのモードを指定します。以下の値以外が指定された場合は、無視されます。 auto:自動 active:フォーカス時に日本語入力をONにする inactive:フォーカス時に日本語入力をOFFにする disabled:IMEを無効化	可	auto	値、バインド	可	不可

部品共通のプロパティも指定できます。詳細は、「2.8.1 画面部品共通プロパティ」を参照してください。

注意

titleプロパティについて

titleプロパティに長い文字列を指定すると、自動的に改行または省略されることがあります。
また、発生位置はブラウザにより異なります。

なお、空文字列を指定した場合は、表示されません。

colsプロパティに関する注意事項

colsにおける平均的文字幅の値は、ブラウザにより若干異なります。デフォルトでは、FirefoxがInternet Explorerよりわずかに長くなっています。

rowsプロパティに関する注意事項

Firefoxでは、rowsに指定した値よりも、約1行分高く表示されます。

フォーマッタについて

本部品へのフォーカスの有無によって、以下のようにフォーマットされます。

フォーカスがない場合
labelProviderプロパティで指定されたオブジェクトによってフォーマットされたvalueプロパティの値が表示されます。
フォーカスがある場合
valueプロパティに指定された値が表示されます。

フォーマッタの指定方法は、「フォーマッタの指定方法」を参照してください。

スタイルプロパティ

パーツ名	プレフィックス	クラス名	使用可能なスタイル
部品全体	なし	rcf-TextArea	サイズカラーフォントテキスト(whiteSpace、textIndentを除く) ボーダーパディング

詳細は、「2.9 スタイルプロパティ」を参照してください。

イベントリスナ

名前	説明	イベントオブジェクト
onFocus	部品がフォーカスを得たときに呼ばれます。	ActionEvent
onBlur	部品がフォーカスを失ったときに呼ばれます。
onChange	部品がフォーカスを失い、かつ値が変更されたときに呼ばれます。
onValueChange	値が入力され、かつ値が変更されたときに呼ばれます。	ValueChangeEvent

部品共通のイベントリスナもあります。詳細は、「2.8.2 画面部品共通イベントリスナ」を参照してください。

JavaScript API

固有のJavaScript APIはありません。部品共通のJavaScript APIは、「2.8.3 画面部品共通JavaScript API」を参照してください。