TextArea  - AS3 Flex

パッケージ	spark.components
クラス	public class TextArea
継承	TextArea SkinnableTextBase SkinnableComponent UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object

Spark テーマのスキンは RichEditableText クラスを使用します。つまり、Spark の TextArea コントロールは、Flash Text Engine（FTE）上に構築される Text Layout Framework（TLF）ライブラリをサポートしています。これらのレイヤーを組み合わせることにより、国際化対応の高品質な文字体裁とレイアウト機能を備えたテキスト編集が可能になります。このスキンには、テキストをスクロールするための水平方向と垂直方向のスクロールバーを表示し、マウスホイールによる垂直スクロールをサポートするスクローラーが含まれています。RichEditableText には textDisplay としてアクセスでき、Scroller には scroller としてアクセスできます。

モバイルテーマのスキンは StyleableStageText クラスを使用します。 StyleableStageText はネイティブテキストフィールドを使用するので、モバイルデバイス上のテキストの入力および操作がしやすくなりますが、いくつかの制限および相違を考慮する必要があります。 StageText にはテキスト測定機能がないので、TextArea に、パーセントベースまたは制約ベースの width および height を明示的に指定する必要があります。StyleableStageText には textDisplay としてアクセスできます。 StageText ベースではなく TextField ベースのスキンを使用する場合は、skinClass プロパティを「spark.skins.mobile.TextAreaSkin」に設定します。

text プロパティを使用すると、表示するテキストを設定したり、ユーザーが入力したテキストを取得したりできます。

テキストのフォーマットは、fontFamily や fontSize などの CSS スタイルを使用して設定されます。

Spark テーマの場合は、widthInChars および heightInLines プロパティで、フォントサイズに合わせて拡大 / 縮小するように TextArea の幅および高さを指定するか、typicalText プロパティを使用できます。typicalText を使用する場合、widthInChars および heightInLines プロパティは無視されることに注意してください。 また、すべてのテーマで、幅や高さを明示的にピクセル単位で指定したり、パーセントで指定したり、left と right や top と bottom などの制約を使用することもできます。

maxChars プロパティを使用して、ユーザーが入力できる文字数を制限したり、restrict を使用して、ユーザーが入力できる文字を制限したりすることもできます。パスワード入力用にこのコントロールを使用するには、displayAsPassword プロパティを true に設定します。

モバイルテーマの場合、ソフトキーボード固有のプロパティである、autoCapitalize、autoCorrect、returnKeyLabel および softKeyboardType プロパティでキーボードヒントを指定します。 ソフトキーボードは存在するが、ヒントで表される機能をサポートしない場合は、ヒントが無視されます。ハードウェアキーボードのみのモバイル環境では、これらのヒントが無視されます。

Spark テーマのテキスト領域

Spark の TextArea と MX の TextArea コントロールの最も重要な違いは、次のとおりです。

• Spark の TextArea では、文字体裁、国際言語のサポート、およびテキストレイアウトの機能が向上しています。
• Spark の TextArea にはリッチテキストのオブジェクト指向モデルがありますが、MX 版にはありません。
• Spark の TextArea では、大量のテキストを表示する機能が強化されています。
• Spark の TextArea では、MX 版とは異なる方法でフォントを埋め込む必要があります。フォントを埋め込む際に embedAsCFF 属性を使用する方法については、フォントのマニュアルを参照してください。

Spark の TextArea コンロールでは、リッチテキストの TLF オブジェクト指向モデルが使用されます。このモデルでは、区分、段落、スパン、ハイパーリンク、画像などのテキストレイアウト要素が ActionScript オブジェクトによって実行時に表現されます。これらのオブジェクトは、プログラムを通じてアクセスして操作できます。リッチテキストを表す TLF の中心的なオブジェクトは TextFlow です。TextArea コントロールに対してリッチテキストを指定するには、コントロールの textFlow プロパティを TextFlow インスタンスに設定します。

複数のフォーマットが混在するテキストを表示する必要がない場合は、TextArea の text プロパティをプレーンテキスト文字列に設定します。text プロパティと textFlow プロパティの相互作用（例えば、一方を設定して他方を取得する方法など）について詳しくは、各プロパティの説明を参照してください。

次の例に示すように、コンパイル時に、TLF マークアップタグを TextArea タグ内に配置できます。

  <s:TextArea>Hello <s:span fontWeight="bold">World!</s:span></s:TextArea>
  

TextArea コントロールには、テキストのフォーマットを変更するためのユーザーインターフェイスはありませんが、プログラムを通じてテキストをフォーマットするために使用できる API が含まれています。例えば、クリックすると、選択したテキストが太字になるようなボタンを作成できます。

デフォルトのテキストフォーマットは、fontFamily や fontSize などの CSS スタイルによって決定されます。TextFlow オブジェクトでフォーマット情報が指定されている場合は、CSS スタイルで指定されているデフォルトのフォーマットがオーバーライドされます。

TextArea コンテンツの特性には、スタイルを使用して制御できるものが数多くあります。次に一般的な特性の一部を示します。

• 行の間隔は lineHeight スタイルを使用して制御します。
• 段落の間隔は paragraphSpaceBefore スタイルと paragraphSpaceAfter スタイルを使用して制御します。
• テキストの整列や均等割り付けには、textAlign スタイルと textAlignLast スタイルを使用します。
• コントロールの境界線からテキストまでのインセットを指定するには、paddingLeft、paddingTop、paddingRight、および paddingBottom スタイルを使用します。

デフォルトでは、コントロールの右端でテキストが折り返されます。テキストの量が TextArea に収まりきらない場合は、垂直スクロールバーが自動的に表示されます。lineBreak スタイルを explicit に設定すると、明示的に改行が指定されている位置でのみ行が折り返されます。これには、CR（¥r）、LF（¥n）または CR+LF（¥r¥n）を text で使用した場合、または <p> と <br/> を TLF マークアップで使用した場合と同じ効果があります。これらの場合、コントロールの幅を超えるテキスト行があるときは、水平スクロールバーが自動的に表示されます。

Spark の TextArea では、フランス語のように左から右（LTR）に読まれるテキスト、アラビア語のように右から左（RTL）に読まれるテキスト、またはフランス語のフレーズを含むアラビア語のように双方向から読まれるテキストを表示できます。主に右から左へのテキストを使用する場合は、direction スタイルを rtl に設定します。textAlign スタイルのデフォルト設定は start です。この設定では、direction が ltr の場合にテキストが左揃えになり、direction が rtl の場合に右揃えになります。反対に整列するには、textAlign を end に設定します。

Spark の TextArea では、1 回の編集セッション内で取り消し / やり直し操作を何度でも実行できます。編集セッションは、コントロールがキーボードフォーカスを取得したときに開始され、コントロールがフォーカスを失ったときに終了します。

List や DataGrid などのリストベースのコンポーネントでこのコンポーネントを使用するには、アイテムレンダラーを作成します。アイテムレンダラーの作成について詳しくは、「Custom Spark item renderers」を参照してください。

Spark テーマの場合、TextArea コントロールには、次のデフォルトの特性があります。

Mobile テーマの場合、TextArea コントロールには、次のデフォルトの特性があります。

MXML シンタックスを表示

MXML シンタックスを隠す

  <s:TextArea
    Properties
    heightInLines="Calculated default"  [Spark theme only]
    textFlow="TextFlow"  [Spark theme only]
    typicalText=null  [Spark theme only]
    widthInChars="Calculated default"  [Spark theme only]
  
    Styles
    horizontalScrollPolicy="auto"  [Spark theme only]
    symbolColor=""
    verticalScrollPolicy="auto"  [Spark theme only]
  />
  

デフォルトの MXML プロパティcontent

例を表示

さらに例を参照

関連する API エレメント