モジュール java.desktop
パッケージ java.awt

クラスTextArea

java.lang.Object
java.awt.Component
java.awt.TextComponent
java.awt.TextArea
すべての実装されたインタフェース:
ImageObserver, MenuContainer, Serializable, Accessible
public class TextArea
extends TextComponent
TextAreaオブジェクトは、テキストを表示する複数行領域です。 編集可能に設定することも、読込み専用に設定することもできます。

次の図は、テキスト領域の外観を示します。

'Hello!'という語を表示するTextArea

このテキスト領域は、次のコードによって作成できます。 

 new TextArea("Hello", 5, 40);

導入されたバージョン:
1.0
関連項目:
直列化された形式

  • フィールド詳細

    • SCROLLBARS_BOTH

      public static final int SCROLLBARS_BOTH
      水平と垂直スクロール・バーを作成し、表示します。
      導入されたバージョン:
      1.1
      関連項目:
      定数フィールド値

    • SCROLLBARS_VERTICAL_ONLY

      public static final int SCROLLBARS_VERTICAL_ONLY
      垂直スクロール・バーだけを作成し、表示します。
      導入されたバージョン:
      1.1
      関連項目:
      定数フィールド値

    • SCROLLBARS_HORIZONTAL_ONLY

      public static final int SCROLLBARS_HORIZONTAL_ONLY
      水平スクロール・バーだけを作成し、表示します。
      導入されたバージョン:
      1.1
      関連項目:
      定数フィールド値

    • SCROLLBARS_NONE

      public static final int SCROLLBARS_NONE
      このテキスト領域のどのスクロール・バーも作成しません。
      導入されたバージョン:
      1.1
      関連項目:
      定数フィールド値

  • コンストラクタの詳細

    • TextArea

      public TextArea() throws HeadlessException
      空の文字列で新しいテキスト領域を構築します。 このテキスト領域はSCROLLBARS_BOTHに等しいスクロール・バーの可視性で作成されるため、このテキスト領域では、垂直スクロール・バーと水平スクロール・バーの両方が表示されます。
      例外:
      HeadlessException - GraphicsEnvironment.isHeadlessがtrueを返した場合
      関連項目:
      GraphicsEnvironment.isHeadless()

    • TextArea

      public TextArea​(String text) throws HeadlessException
      指定されたテキストで新しいテキスト領域を構築します。 このテキスト領域はSCROLLBARS_BOTHに等しいスクロール・バーの可視性で作成されるため、このテキスト領域では、垂直スクロール・バーと水平スクロール・バーの両方が表示されます。
      パラメータ:
      text - 表示されるテキスト。textがnullである場合は、空の文字列""が表示される
      例外:
      HeadlessException - GraphicsEnvironment.isHeadlessがtrueを返した場合
      関連項目:
      GraphicsEnvironment.isHeadless()

    • TextArea

      public TextArea​(int rows, int columns) throws HeadlessException
      指定された行数と列数と空のテキスト文字列を持つ新しいテキスト領域を構築します。 列幅は、プラットフォームにより異なり、およそ平均文字幅になります。 このテキスト領域はSCROLLBARS_BOTHに等しいスクロール・バーの可視性で作成されるため、このテキスト領域では、垂直スクロール・バーと水平スクロール・バーの両方が表示されます。
      パラメータ:
      rows - 行の数
      columns - 列の数
      例外:
      HeadlessException - GraphicsEnvironment.isHeadlessがtrueを返した場合
      関連項目:
      GraphicsEnvironment.isHeadless()

    • TextArea

      public TextArea​(String text, int rows, int columns) throws HeadlessException
      指定された行数と列数を持つ空のテキスト領域を、指定されたテキストで構築します。 列幅は、プラットフォームにより異なり、およそ平均文字幅になります。 このテキスト領域はSCROLLBARS_BOTHに等しいスクロール・バーの可視性で作成されるため、このテキスト領域では、垂直スクロール・バーと水平スクロール・バーの両方が表示されます。
      パラメータ:
      text - 表示されるテキスト。textがnullである場合は、空の文字列""が表示される
      rows - 行の数
      columns - 列の数
      例外:
      HeadlessException - GraphicsEnvironment.isHeadlessがtrueを返した場合
      関連項目:
      GraphicsEnvironment.isHeadless()

    • TextArea

      public TextArea​(String text, int rows, int columns, int scrollbars) throws HeadlessException
      指定された行数および列数の、指定されたテキストが表示される新しいテキスト領域を、指定されたスクロール・バーの可視性で構築します。 すべてのTextAreaコンストラクタはこのコンストラクタに従います。

      TextAreaクラスは、scrollbars引数の値として指定できる次のようないくつかの定数を定義します。

      • SCROLLBARS_BOTH、
      • SCROLLBARS_VERTICAL_ONLY、
      • SCROLLBARS_HORIZONTAL_ONLY、
      • SCROLLBARS_NONE
      scrollbars引数のその他の値は無効となり、その場合このテキスト領域はデフォルト値SCROLLBARS_BOTHに等しいスクロール・バーの可視性で作成されます。

      パラメータ:
      text - 表示されるテキスト。textがnullである場合は、空の文字列""が表示される
      rows - 行数。rowsが0より小さい場合、rowsは0に設定される
      columns - 列数。columnsが0より小さい場合、columnsは0に設定される
      scrollbars - テキスト領域を表示するためにどのスクロール・バーが作成されるかを指定する定数
      例外:
      HeadlessException - GraphicsEnvironment.isHeadlessがtrueを返した場合
      導入されたバージョン:
      1.1
      関連項目:
      GraphicsEnvironment.isHeadless()

  • メソッドの詳細

    • addNotify

      public void addNotify()
      TextAreaのピアを作成します。 ピアを使用すると、TextAreaの機能を変更せずに外観を変更することができます。
      オーバーライド:
      addNotify、クラス: TextComponent
      関連項目:
      TextComponent.removeNotify()

    • insert

      public void insert​(String str, int pos)
      このテキスト領域内の指定された位置に、指定されたテキストを挿入します。

      nullや整合性のないパラメータを渡すことは無効であり、指定されていない動作の原因になることに注意してください。

      パラメータ:
      str - 挿入するnull以外のテキスト
      pos - 挿入する位置
      導入されたバージョン:
      1.1
      関連項目:
      TextComponent.setText(java.lang.String), replaceRange(java.lang.String, int, int), append(java.lang.String)

    • insertText

      @Deprecatedpublic void insertText​(String str, int pos)
      非推奨。
      JDK Version 1.1以降は、insert(String, int)に置き換えられています。
      このテキスト領域内の指定された位置に、指定されたテキストを挿入します。
      パラメータ:
      str - 挿入するnull以外のテキスト
      pos - 挿入する位置

    • append

      public void append​(String str)
      テキスト領域の現在のテキストに、指定されたテキストを追加します。

      nullや整合性のないパラメータを渡すことは無効であり、指定されていない動作の原因になることに注意してください。

      パラメータ:
      str - 追加するnull以外のテキスト
      導入されたバージョン:
      1.1
      関連項目:
      insert(java.lang.String, int)

    • appendText

      @Deprecatedpublic void appendText​(String str)
      非推奨。
      JDK Version 1.1以降は、append(String)に置き換えられています。
      テキスト領域の現在のテキストに、指定されたテキストを追加します。
      パラメータ:
      str - 追加するテキスト

    • replaceRange

      public void replaceRange​(String str, int start, int end)
      指定された始点と終点の間のテキストを、指定されたテキストに置き換えます。 終点のテキストは置き換えられません。 始点のテキストは、始点が終点と同じ位置にない場合に置き換えられます。 テキストの位置はゼロから始まります。 挿入される部分文字列は、置き換えるテキストと長さが異なる場合があります。

      nullや整合性のないパラメータを渡すことは無効であり、指定されていない動作の原因になることに注意してください。

      パラメータ:
      str - 置換えに使用するnull以外のテキスト
      start - 始点
      end - 終点
      導入されたバージョン:
      1.1
      関連項目:
      insert(java.lang.String, int)

    • replaceText

      @Deprecatedpublic void replaceText​(String str, int start, int end)
      非推奨。
      JDK Version 1.1以降は、replaceRange(String, int, int)に置き換えられています。
      指定された開始位置と終了位置の間の文字の範囲を、指定された置換テキスト(終了位置のテキストは置き換えられません)に置き換えます。
      パラメータ:
      str - 置換えに使用するnull以外のテキスト
      start - 始点
      end - 終点

    • getRows

      public int getRows()
      テキスト領域の行数を返します。
      戻り値:
      テキスト領域の行数
      導入されたバージョン:
      1.0
      関連項目:
      setRows(int), getColumns()

    • setRows

      public void setRows​(int rows)
      このテキスト領域の行数を設定します。
      パラメータ:
      rows - 行の数
      例外:
      IllegalArgumentException - rowsに指定された値が0より小さい場合
      導入されたバージョン:
      1.1
      関連項目:
      getRows(), setColumns(int)

    • getColumns

      public int getColumns()
      このテキスト領域の列数を返します。
      戻り値:
      テキスト領域の列数
      関連項目:
      setColumns(int), getRows()

    • setColumns

      public void setColumns​(int columns)
      このテキスト領域の列数を設定します。
      パラメータ:
      columns - 列の数
      例外:
      IllegalArgumentException - columnsに指定された値が0より小さい場合
      導入されたバージョン:
      1.1
      関連項目:
      getColumns(), setRows(int)

    • getScrollbarVisibility

      public int getScrollbarVisibility()
      テキスト領域が使用するスクロール・バーを示す列挙された値を返します。

      TextAreaクラスは、どのスクロール・バーが利用可能かを指定するために使用される4つの整数型定数を定義します。 TextAreaは、アプリケーションにスクロール・バーの選択を与える1つのコンストラクタを持ちます。

      戻り値:
      どのスクロール・バーを使用するかを示す整数型
      導入されたバージョン:
      1.1
      関連項目:
      SCROLLBARS_BOTH, SCROLLBARS_VERTICAL_ONLY, SCROLLBARS_HORIZONTAL_ONLY, SCROLLBARS_NONE, TextArea(java.lang.String, int, int, int)

    • getPreferredSize

      public Dimension getPreferredSize​(int rows, int columns)
      指定された行数および列数のテキスト領域の推奨サイズを判定します。
      パラメータ:
      rows - 行の数
      columns - 列の数
      戻り値:
      指定された行数および列数のテキスト領域を表示するために必要な推奨寸法
      導入されたバージョン:
      1.1
      関連項目:
      Component.getPreferredSize()

    • preferredSize

      @Deprecatedpublic Dimension preferredSize​(int rows, int columns)
      非推奨。
      JDK Version 1.1以降は、getPreferredSize(int, int)に置き換えられています。
      指定された行数と列数でテキスト領域の優先サイズを決定します。
      パラメータ:
      rows - 行の数
      columns - 列の数
      戻り値:
      テキスト領域に必要な優先ディメンション

    • getPreferredSize

      public Dimension getPreferredSize()
      このテキスト領域の推奨サイズを判定します。
      オーバーライド:
      getPreferredSize、クラス: Component
      戻り値:
      このテキスト領域に必要な推奨サイズ
      導入されたバージョン:
      1.1
      関連項目:
      Component.getPreferredSize()

    • preferredSize

      @Deprecated public Dimension preferredSize()
      非推奨。
      JDK Version 1.1以降は、getPreferredSize()に置き換えられています。
      次のクラスからコピーされた説明: Component
      コンポーネントの優先サイズを返します。
      オーバーライド:
      preferredSize、クラス: Component
      戻り値:
      コンポーネントの優先サイズ

    • getMinimumSize

      public Dimension getMinimumSize​(int rows, int columns)
      指定された行数および列数のテキスト領域の最小サイズを判定します。
      パラメータ:
      rows - 行の数
      columns - 列の数
      戻り値:
      指定された行数および列数のテキスト領域を表示するために必要な最小寸法
      導入されたバージョン:
      1.1
      関連項目:
      Component.getMinimumSize()

    • minimumSize

      @Deprecatedpublic Dimension minimumSize​(int rows, int columns)
      非推奨。
      JDK Version 1.1以降は、getMinimumSize(int, int)に置き換えられています。
      指定された行数と列数でテキスト領域の最小サイズを決定します。
      パラメータ:
      rows - 行の数
      columns - 列の数
      戻り値:
      テキスト領域の最小サイズ

    • getMinimumSize

      public Dimension getMinimumSize()
      このテキスト領域の最小サイズを判定します。
      オーバーライド:
      getMinimumSize、クラス: Component
      戻り値:
      このテキスト領域に必要な推奨サイズ
      導入されたバージョン:
      1.1
      関連項目:
      Component.getPreferredSize()

    • minimumSize

      @Deprecated public Dimension minimumSize()
      非推奨。
      JDK Version 1.1以降は、getMinimumSize()に置き換えられています。
      次のクラスからコピーされた説明: Component
      このコンポーネントの最小サイズを返します。
      オーバーライド:
      minimumSize、クラス: Component
      戻り値:
      このコンポーネントの最小サイズ

    • paramString

      protected String paramString()
      このTextAreaの状態を表す文字列を返します。 このメソッドはデバッグ専用であり、返される文字列の内容および形式は実装によって異なる可能性があります。 返される文字列は空でもかまいませんが、nullにはできません。
      オーバーライド:
      paramString、クラス: TextComponent
      戻り値:
      テキスト領域のパラメータの文字列

    • getAccessibleContext

      public AccessibleContext getAccessibleContext()
      このTextAreaに関連付けられたAccessibleContextを返します。 テキスト領域の場合、AccessibleContextはAccessibleAWTTextAreaの形式を取ります。 必要に応じて、新しいAccessibleAWTTextAreaインスタンスが作成されます。
      定義:
      getAccessibleContext、インタフェース: Accessible
      オーバーライド:
      getAccessibleContext、クラス: TextComponent
      戻り値:
      このTextAreaのAccessibleContextとして機能するAccessibleAWTTextArea
      導入されたバージョン:
      1.3