java.awt
クラス TextField

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.TextComponent
              |
              +--java.awt.TextField

すべての実装インタフェース:

Accessible, ImageObserver, MenuContainer, Serializable

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 に渡します。processActionEvent メソッドは、このテキストフィールドが生成するアクションイベントを受け取るよう登録されているすべての ActionListener オブジェクトにイベントを転送します。

導入されたバージョン:

JDK1.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), 直列化された形式

入れ子クラスの概要

protected class

TextField.AccessibleAWTTextField このクラスは TextField クラス用のユーザ補助機能のサポートを実装しています。

クラス java.awt.TextComponent から継承した入れ子クラス

クラス java.awt.Component から継承した入れ子クラス

Component.BltBufferStrategy, Component.FlipBufferStrategy

フィールドの概要

クラス java.awt.TextComponent から継承したフィールド

textListener

クラス java.awt.Component から継承したフィールド

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

インタフェース java.awt.image.ImageObserver から継承したフィールド

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

コンストラクタの概要

TextField()
新しいテキストフィールドを構築します。

TextField(int columns)
指定された列数で新しい空のテキストフィールドを構築します。

TextField(String text)
指定されたテキストで初期化された新しいテキストフィールドを構築します。

TextField(String text, int columns)
指定されたテキストが表示されるように初期化され、指定された列数を表示できる幅の新しいテキストフィールドを構築します。

メソッドの概要

void	addActionListener(ActionListener l) このテキストフィールドのアクションイベントを受け取るために、指定されたアクションリスナーを追加します。
void	addNotify() TextField のピアを作成します。
boolean	echoCharIsSet() このテキストフィールドでエコー用の文字が設定されているかどうかを示します。
AccessibleContext	getAccessibleContext() この TextField に関連した AccessibleContext を返します。
ActionListener[]	getActionListeners() このテキストフィールドに登録されたすべてのアクションリスナーの配列を返します。
int	getColumns() このテキストフィールドの列数を返します。
char	getEchoChar() エコー用に使用される文字を返します。
EventListener[]	getListeners(Class listenerType) この TextField に FooListener として、現在登録されているすべてのオブジェクトの配列を返します。
Dimension	getMinimumSize() このテキストフィールドの最小サイズを返します。
Dimension	getMinimumSize(int columns) 指定された列数での、このテキストフィールドの最小サイズを返します。
Dimension	getPreferredSize() このテキストフィールドの推奨サイズを返します。
Dimension	getPreferredSize(int columns) 指定された列数での、このテキストフィールドの推奨サイズを返します。
Dimension	minimumSize() 推奨されていません。 JDK バージョン 1.1 以降は、getMinimumSize() を使用
Dimension	minimumSize(int columns) 推奨されていません。 JDK バージョン 1.1 以降は、getPreferredSize(int) を使用
protected String	paramString() この TextField の状態を表す文字列を返します。
Dimension	preferredSize() 推奨されていません。 JDK バージョン 1.1 以降は、getPreferredSize() を使用
Dimension	preferredSize(int columns) 推奨されていません。 JDK バージョン 1.1 以降は、getPreferredSize(int) を使用
protected void	processActionEvent(ActionEvent e) このテキストフィールドで発生するアクションイベントを、登録された ActionListener オブジェクトにディスパッチすることにより、このイベントを処理します。
protected void	processEvent(AWTEvent e) このテキストフィールドのイベントを処理します。
void	removeActionListener(ActionListener l) 以降このテキストフィールドからアクションイベントを受け取らないように、指定されたアクションリスナーを削除します。
void	setColumns(int columns) このテキストフィールドの列数を設定します。
void	setEchoChar(char c) このテキストフィールドのエコー文字を設定します。
void	setEchoCharacter(char c) 推奨されていません。 JDK バージョン 1.1 以降は、setEchoChar(char) を使用
void	setText(String t) このテキストコンポーネントで表示されるテキストを、指定されたテキストに設定します。

クラス java.awt.TextComponent から継承したメソッド

addTextListener, enableInputMethods, getBackground, getCaretPosition, getSelectedText, getSelectionEnd, getSelectionStart, getText, getTextListeners, isEditable, processTextEvent, removeNotify, removeTextListener, select, selectAll, setBackground, setCaretPosition, setEditable, setSelectionEnd, setSelectionStart

クラス java.awt.Component から継承したメソッド

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, postEvent, prepareImage, prepareImage, print, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate

クラス java.lang.Object から継承したメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

TextField

public TextField()
          throws HeadlessException

新しいテキストフィールドを構築します。

例外:

HeadlessException - GraphicsEnvironment.isHeadless() が true を返す場合

関連項目:

GraphicsEnvironment.isHeadless()

TextField

public TextField(String text)
          throws HeadlessException

指定されたテキストで初期化された新しいテキストフィールドを構築します。

パラメータ:

text - 表示するテキスト。text が null の場合は、空の文字列 "" が表示される

例外:

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 の場合は、空の文字列 "" が表示される

columns - 列数。columns が 0 より小さい場合、columns は 0 に設定される

例外:

HeadlessException - GraphicsEnvironment.isHeadless() が true を返す場合

関連項目:

GraphicsEnvironment.isHeadless()

メソッドの詳細

addNotify

public void addNotify()

TextField のピアを作成します。ピアを使うことにより、機能を変更せずに TextField の外見を変更することができます。

オーバーライド:

クラス TextComponent 内の addNotify

関連項目:

TextComponent.removeNotify()

getEchoChar

public char getEchoChar()

エコー用に使用される文字を返します。

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

戻り値:

このテキストフィールドのエコー文字

関連項目:

echoCharIsSet(), setEchoChar(char)

setEchoChar

public void setEchoChar(char c)

このテキストフィールドのエコー文字を設定します。

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

パラメータ:

c - このテキストフィールドのエコー文字

導入されたバージョン:

JDK1.1

関連項目:

echoCharIsSet(), getEchoChar()

setEchoCharacter

public void setEchoCharacter(char c)

推奨されていません。 JDK バージョン 1.1 以降は、setEchoChar(char) を使用

setText

public void setText(String t)

このテキストコンポーネントで表示されるテキストを、指定されたテキストに設定します。

オーバーライド:

クラス TextComponent 内の setText

パラメータ:

t - 新しいテキスト

関連項目:

TextComponent.getText()

echoCharIsSet

public boolean echoCharIsSet()

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

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

戻り値:

このテキストフィールドにエコー用の文字セットがある場合は true、そうでない場合は false

関連項目:

setEchoChar(char), getEchoChar()

getColumns

public int getColumns()

このテキストフィールドの列数を返します。列幅は、プラットフォームにより異なりおよそ平均文字幅になります。

戻り値:

列数

導入されたバージョン:

JDK1.1

関連項目:

setColumns(int)

setColumns

public void setColumns(int columns)

このテキストフィールドの列数を設定します。列幅は、プラットフォームにより異なりおよそ平均文字幅になります。

パラメータ:

columns - 列数

例外:

IllegalArgumentException - columns に指定された値が 0 より小さい場合

導入されたバージョン:

JDK1.1

関連項目:

getColumns()

getPreferredSize

public Dimension getPreferredSize(int columns)

指定された列数での、このテキストフィールドの推奨サイズを返します。

パラメータ:

columns - このテキストフィールドの列数

戻り値:

このテキストフィールドを表示するための推奨サイズ

導入されたバージョン:

JDK1.1

preferredSize

public Dimension preferredSize(int columns)

推奨されていません。 JDK バージョン 1.1 以降は、getPreferredSize(int) を使用

getPreferredSize

public Dimension getPreferredSize()

このテキストフィールドの推奨サイズを返します。

オーバーライド:

クラス Component 内の getPreferredSize

戻り値:

このテキストフィールドを表示するための推奨サイズ

導入されたバージョン:

JDK1.1

関連項目:

Component.getMinimumSize(), LayoutManager

preferredSize

public Dimension preferredSize()

推奨されていません。 JDK バージョン 1.1 以降は、getPreferredSize() を使用

オーバーライド:

クラス Component 内の preferredSize

getMinimumSize

public Dimension getMinimumSize(int columns)

指定された列数での、このテキストフィールドの最小サイズを返します。

パラメータ:

columns - このテキストフィールドの列数

導入されたバージョン:

JDK1.1

minimumSize

public Dimension minimumSize(int columns)

推奨されていません。 JDK バージョン 1.1 以降は、getPreferredSize(int) を使用

getMinimumSize

public Dimension getMinimumSize()

このテキストフィールドの最小サイズを返します。

オーバーライド:

クラス Component 内の getMinimumSize

戻り値:

このテキストフィールドを表示するための最小サイズ

導入されたバージョン:

JDK1.1

関連項目:

Component.getPreferredSize(), LayoutManager

minimumSize

public Dimension minimumSize()

推奨されていません。 JDK バージョン 1.1 以降は、getMinimumSize() を使用

オーバーライド:

クラス Component 内の minimumSize

addActionListener

public void addActionListener(ActionListener l)

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

パラメータ:

l - アクションリスナー

導入されたバージョン:

JDK1.1

関連項目:

removeActionListener(java.awt.event.ActionListener), getActionListeners(), ActionListener

removeActionListener

public void removeActionListener(ActionListener l)

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

パラメータ:

l - アクションリスナー

導入されたバージョン:

JDK1.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), java.awt.event

getListeners

public EventListener[] getListeners(Class listenerType)

この TextField に FooListener として、現在登録されているすべてのオブジェクトの配列を返します。FooListener は addFooListener メソッドを使用して登録されます。

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

ActionListener[] als = (ActionListener[])(t.getListeners(ActionListener.class));

このようなリスナーが存在しない場合、このメソッドは空の配列を返します。

オーバーライド:

クラス TextComponent 内の getListeners

パラメータ:

listenerType - 要求されたリスナーの型。このパラメータは java.util.EventListener から派生するインタフェースを指定する

戻り値:

このテキストフィールドの FooListener として登録されたすべてのオブジェクトの配列、またはこのようなリスナーが追加されなかった場合は空の配列

例外:

ClassCastException - listenerType が、java.util.EventListener を実装するクラスまたはインタフェースを指定しない場合

導入されたバージョン:

1.3

関連項目:

getActionListeners()

processEvent

protected void processEvent(AWTEvent e)

このテキストフィールドのイベントを処理します。イベントが ActionEvent のインスタンスである場合は、processActionEvent メソッドを呼び出します。そうでない場合はスーパークラスの processEvent を呼び出します。

イベントパラメータが null の場合、動作が指定されず例外が発生することに注意してください。

オーバーライド:

クラス TextComponent 内の processEvent

パラメータ:

e - イベント

導入されたバージョン:

JDK1.1

関連項目:

ActionEvent, processActionEvent(java.awt.event.ActionEvent)

processActionEvent

protected void processActionEvent(ActionEvent e)

このテキストフィールドで発生するアクションイベントを、登録された ActionListener オブジェクトにディスパッチすることにより、このイベントを処理します。

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

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

イベントパラメータが null の場合、動作が指定されず例外が発生することに注意してください。

パラメータ:

e - アクションイベント

導入されたバージョン:

JDK1.1

関連項目:

ActionListener, addActionListener(java.awt.event.ActionListener), Component.enableEvents(long)

paramString

protected String paramString()

この TextField の状態を表す文字列を返します。このメソッドは、デバッグ専用であり、返される文字列の内容および形式は実装によって異なります。返される文字列は空の場合がありますが、null にはなりません。

オーバーライド:

クラス TextComponent 内の paramString

戻り値:

このテキストフィールドのパラメータ文字列

getAccessibleContext

public AccessibleContext getAccessibleContext()

この TextField に関連した AccessibleContext を返します。テキストフィールドの場合、AccessibleContext は AccessibleAWTTextField の形式を取ります。新規の AccessibleAWTTextField インスタンスが必要に応じて作成されます。

定義:

インタフェース Accessible 内の getAccessibleContext

オーバーライド:

クラス TextComponent 内の getAccessibleContext

戻り値:

この TextField の AccessibleContext として機能する AccessibleAWTTextField