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

クラスTextField

java.lang.Object
java.awt.Component
java.awt.TextComponent
java.awt.TextField
すべての実装されたインタフェース:
ImageObserver, MenuContainer, Serializable, Accessible
public class TextField
extends TextComponent
TextFieldオブジェクトは、1行のテキストの編集を可能にするテキスト・コンポーネントです。

たとえば、次の図は、幅の異なる4つのテキスト・フィールドを持つフレームを示しています。 これらのテキスト・フィールドのうちの2つには、"Hello"という定義済みのテキストが表示されます。

前の本文でこのイメージを説明する

これら4つのテキスト・フィールドを生成するコードを次に示します。 

 TextField tf1, tf2, tf3, tf4;
 // a blank text field
 tf1 = new TextField();
 // blank field of 20 columns
 tf2 = new TextField("", 20);
 // predefined text displayed
 tf3 = new TextField("Hello!");
 // predefined text in 30 columns
 tf4 = new TextField("Hello", 30);

ユーザーがテキスト・フィールドでキーを押すたびに、1つ以上のキー・イベントがテキスト・フィールドに送られます。 KeyEventは、keyPressed、keyReleased、keyTypedという3つの型のいずれかになります。 キー・イベントのプロパティは、そのイベントがこれらの型のうちのどれになるか、およびキー・イベントに適用される修飾子やイベント発生の時間などのイベントに関する追加情報を示します。

キー・イベントは、そのコンポーネントのaddKeyListenerメソッドを使って、これらのイベントを受け取るように登録されているすべてのKeyListenerまたはKeyAdapterオブジェクトに渡されます。 (KeyAdapterオブジェクトはKeyListenerインタフェースを実装します。)

ActionEventをトリガーすることも可能です。 テキスト・フィールドでアクション・イベントが可能な場合、Returnキーを押すとイベントがトリガーされます。

TextFieldクラスのprocessEventメソッドがアクション・イベントを調べて、そのイベントをprocessActionEventに渡します。 後者のメソッドは、このテキスト・フィールドによって生成されるアクション・イベントを受け取るように登録しているすべてのActionListenerオブジェクトにそのイベントを送ります。

導入されたバージョン:
1.0
関連項目:
KeyEvent, KeyAdapter, KeyListener, ActionEvent, Component.addKeyListener(java.awt.event.KeyListener), processEvent(java.awt.AWTEvent), processActionEvent(java.awt.event.ActionEvent), addActionListener(java.awt.event.ActionListener), 直列化された形式

  • コンストラクタの詳細

    • TextField

      public TextField() throws HeadlessException
      新しいテキスト・フィールドを構築します。
      例外:
      HeadlessException - GraphicsEnvironment.isHeadless()がtrueを返した場合。
      関連項目:
      GraphicsEnvironment.isHeadless()

    • TextField

      public TextField​(String text) throws HeadlessException
      指定されたテキストで初期化された新しいテキスト・フィールドを構築します。
      パラメータ:
      text - 表示されるテキスト。 textがnullである場合は、空の文字列""が表示されます。 textにEOLまたはLF文字が含まれている場合は、それぞれがスペース文字に置き換えられます。
      例外:
      HeadlessException - GraphicsEnvironment.isHeadless()がtrueを返した場合。
      関連項目:
      GraphicsEnvironment.isHeadless()

    • TextField

      public TextField​(int columns) throws HeadlessException
      指定された列数で新しい空のテキスト・フィールドを構築します。 列幅は、プラットフォームにより異なり、およそ平均文字幅になります。
      パラメータ:
      columns - 列の数。 columnsが0より小さい場合、columnsは0に設定されます。
      例外:
      HeadlessException - GraphicsEnvironment.isHeadless()がtrueを返した場合。
      関連項目:
      GraphicsEnvironment.isHeadless()

    • TextField

      public TextField​(String text, int columns) throws HeadlessException
      指定されたテキストが表示されるように初期化され、指定された列数を表示できる幅の新しいテキスト・フィールドを構築します。 列幅は、プラットフォームにより異なり、およそ平均文字幅になります。
      パラメータ:
      text - 表示されるテキスト。 textがnullである場合は、空の文字列""が表示されます。 textにEOLまたはLF文字が含まれている場合は、それぞれがスペース文字に置き換えられます。
      columns - 列の数。 columnsが0より小さい場合、columnsは0に設定されます。
      例外:
      HeadlessException - GraphicsEnvironment.isHeadless()がtrueを返した場合。
      関連項目:
      GraphicsEnvironment.isHeadless()

  • メソッドの詳細

    • addNotify

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

    • getEchoChar

      public char getEchoChar()
      エコー用に使用される文字を返します。

      エコー文字は、パスワード入力用テキスト・フィールドなど、ユーザー入力が画面に表示されてはならないテキスト・フィールドで使用されます。 echoChar = 0の場合、ユーザーが入力したまま画面に表示されます。

      Javaプラットフォーム実装では、エコー文字の空でない限定的なセットだけをサポートしている場合があります。 この関数は、もともとsetEchoChar()で要求されたエコー文字を返します。 TextField実装によって実際に使用されるエコー文字は、異なる場合があります。

      戻り値:
      このテキスト・フィールドのエコー文字
      関連項目:
      echoCharIsSet(), setEchoChar(char)

    • setEchoChar

      public void setEchoChar​(char c)
      このテキスト・フィールドのエコー文字を設定します。

      エコー文字は、パスワード入力用テキスト・フィールドなど、ユーザー入力が画面に表示されてはならないテキスト・フィールドで使用されます。 echoChar = 0に設定すると、ユーザー入力をふたたび画面に表示できます。

      Javaプラットフォーム実装では、エコー文字の空でない限定的なセットだけをサポートしている場合があります。 サポートされていないエコー文字を設定しようとすると、代わりにデフォルトのエコー文字が使用されます。 それ以降のgetEchoChar()の呼出しは、もともと要求されていたエコー文字を返します。 これは、TextField実装で実際に使用されるエコー文字と同一である場合も、同一でない場合もあります。

      パラメータ:
      c - このテキスト・フィールドのエコー文字。
      導入されたバージョン:
      1.1
      関連項目:
      echoCharIsSet(), getEchoChar()

    • setEchoCharacter

      @Deprecatedpublic void setEchoCharacter​(char c)
      Deprecated.
      JDK Version 1.1以降は、setEchoChar(char)に置き換えられています。
      保護された入力が表示されたときにエコーされる文字を設定します。
      パラメータ:
      c - このテキスト・フィールドのエコー文字

    • setText

      public void setText​(String t)
      このテキスト・コンポーネントで表示されるテキストを、指定されたテキストに設定します。
      オーバーライド:
      setText、クラス: TextComponent
      パラメータ:
      t - 新しいテキスト。 tがnullの場合、空の文字列""が表示されます。 tにEOLまたはLF文字が含まれている場合は、それぞれがスペース文字に置き換えられます。
      関連項目:
      TextComponent.getText()

    • echoCharIsSet

      public boolean echoCharIsSet()
      このテキスト・フィールドでエコー用の文字セットが設定されているかどうかを示します。

      エコー文字は、パスワード入力用テキスト・フィールドなど、ユーザー入力が画面に表示されてはならないテキスト・フィールドで使用されます。

      戻り値:
      このテキスト・フィールドにエコー用の文字セットが設定されている場合はtrue、そうでない場合はfalse。
      関連項目:
      setEchoChar(char), getEchoChar()

    • getColumns

      public int getColumns()
      このテキスト・フィールドの列数を返します。 列幅は、プラットフォームにより異なり、およそ平均文字幅になります。
      戻り値:
      列数
      導入されたバージョン:
      1.1
      関連項目:
      setColumns(int)

    • setColumns

      public void setColumns​(int columns)
      このテキスト・フィールドの列数を設定します。 列幅は、プラットフォームにより異なり、およそ平均文字幅になります。
      パラメータ:
      columns - 列の数。
      例外:
      IllegalArgumentException - columnsに指定された値が0より小さい場合。
      導入されたバージョン:
      1.1
      関連項目:
      getColumns()

    • getPreferredSize

      public Dimension getPreferredSize​(int columns)
      指定された列数での、このテキスト・フィールドの推奨サイズを返します。
      パラメータ:
      columns - このテキスト・フィールド内の列の数。
      戻り値:
      このテキスト・フィールドを表示するために適した寸法
      導入されたバージョン:
      1.1

    • preferredSize

      @Deprecatedpublic Dimension preferredSize​(int columns)
      Deprecated.
      JDK Version 1.1以降は、getPreferredSize(int)に置き換えられています。
      このテキスト・フィールドの優先サイズを、指定された列数で返します。
      パラメータ:
      columns - 列の数
      戻り値:
      テキスト・フィールドの優先サイズ

    • getPreferredSize

      public Dimension getPreferredSize()
      このテキスト・フィールドの推奨サイズを返します。
      オーバーライド:
      getPreferredSize、クラス: Component
      戻り値:
      このテキスト・フィールドを表示するために適した寸法
      導入されたバージョン:
      1.1
      関連項目:
      Component.getMinimumSize(), LayoutManager

    • preferredSize

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

    • getMinimumSize

      public Dimension getMinimumSize​(int columns)
      指定された列数を持つテキスト・フィールドの最小サイズを取得します。
      パラメータ:
      columns - このテキスト・フィールド内の列の数。
      戻り値:
      このテキスト・フィールドの最小サイズ
      導入されたバージョン:
      1.1

    • minimumSize

      @Deprecatedpublic Dimension minimumSize​(int columns)
      Deprecated.
      JDK Version 1.1以降は、getMinimumSize(int)に置き換えられています。
      指定された列数のテキスト・フィールドの最小ディメンションを返します。
      パラメータ:
      columns - 列の数
      戻り値:
      このテキスト・フィールドの最小サイズ

    • getMinimumSize

      public Dimension getMinimumSize()
      このテキスト・フィールドの最小サイズを取得します。
      オーバーライド:
      getMinimumSize、クラス: Component
      戻り値:
      このテキスト・フィールドを表示するための最小の寸法
      導入されたバージョン:
      1.1
      関連項目:
      Component.getPreferredSize(), LayoutManager

    • minimumSize

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

    • addActionListener

      public void addActionListener​(ActionListener l)
      このテキスト・フィールドのアクション・イベントを受け取るために、指定されたアクション・リスナーを追加します。 lがnullの場合、例外はスローされず、処理も実行されません。

      AWTスレッド・モデルの詳細は、「AWTのスレッドの問題」を参照してください。

      パラメータ:
      l - アクション・リスナー。
      導入されたバージョン:
      1.1
      関連項目:
      removeActionListener(java.awt.event.ActionListener), getActionListeners(), ActionListener

    • removeActionListener

      public void removeActionListener​(ActionListener l)
      以降このテキスト・フィールドからアクション・イベントを受け取らないように、指定されたアクション・リスナーを削除します。 lがnullの場合、例外はスローされず、処理も実行されません。

      AWTスレッド・モデルの詳細は、「AWTのスレッドの問題」を参照してください。

      パラメータ:
      l - アクション・リスナー。
      導入されたバージョン:
      1.1
      関連項目:
      addActionListener(java.awt.event.ActionListener), getActionListeners(), ActionListener

    • getActionListeners

      public ActionListener[] getActionListeners()
      このテキスト・フィールドに登録されたすべてのアクション・リスナーの配列を返します。
      戻り値:
      このテキスト・フィールドのすべてのActionListener。アクション・リスナーが現在登録されていない場合は空の配列
      導入されたバージョン:
      1.4
      関連項目:
      addActionListener(java.awt.event.ActionListener), removeActionListener(java.awt.event.ActionListener), ActionListener

    • getListeners

      public <T extends EventListener> T[] getListeners​(Class<T> listenerType)
      このTextFieldにFooListenerとして現在登録されているすべてのオブジェクトの配列を返します。 FooListenerは、addFooListenerメソッドを使用して登録されます。

      FooListener.classなどのクラス・リテラルを使用してlistenerType引数を指定できます。 たとえば、次のコードを使用して、そのアクション・リスナーのTextField tを照会できます。 

      ActionListener[] als = (ActionListener[])(t.getListeners(ActionListener.class));
      このようなリスナーがない場合は空の配列を返します。

      オーバーライド:
      getListeners、クラス: TextComponent
      型パラメータ:
      T - リスナーの型
      パラメータ:
      listenerType - 要求されるリスナーの型。java.util.EventListenerの子孫のインタフェースを指定してください
      戻り値:
      このテキスト・フィールドにFooListenerとして登録されているすべてのオブジェクトの配列。そのようなリスナーが登録されていない場合は空の配列
      例外:
      ClassCastException - listenerTypeで、java.util.EventListenerを実装するクラスまたはインタフェースが指定されなかった場合
      導入されたバージョン:
      1.3
      関連項目:
      getActionListeners()

    • processEvent

      protected void processEvent​(AWTEvent e)
      このテキスト・フィールドのイベントを処理します。 イベントがActionEventのインスタンスである場合は、processActionEventメソッドを呼び出します。 それ以外の場合は、スーパー・クラスのprocessEventを呼び出します。

      イベント・パラメータがnullである場合は、動作が未指定のため、例外が発生する可能性があります。

      オーバーライド:
      processEvent、クラス: TextComponent
      パラメータ:
      e - イベント
      導入されたバージョン:
      1.1
      関連項目:
      ActionEvent, processActionEvent(java.awt.event.ActionEvent)

    • processActionEvent

      protected void processActionEvent​(ActionEvent e)
      このテキスト・フィールドで発生するアクション・イベントを、登録されているすべてのActionListenerオブジェクトにディスパッチすることによって処理します。

      このコンポーネントに対してアクション・イベントが使用可能でないかぎり、このメソッドは呼び出されません。 アクション・イベントは、次のどちらかの場合に使用可能になります。

      • ActionListenerオブジェクトがaddActionListenerによって登録されている。
      • enableEventsによってアクション・イベントが使用可能になっている。

      イベント・パラメータがnullである場合は、動作が未指定のため、例外が発生する可能性があります。

      パラメータ:
      e - アクション・イベント
      導入されたバージョン:
      1.1
      関連項目:
      ActionListener, addActionListener(java.awt.event.ActionListener), Component.enableEvents(long)

    • paramString

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

    • getAccessibleContext

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