JavaTM 2 Platform
Standard Ed. 5.0

java.awt
类 TextField

java.lang.Object
  继承者 java.awt.Component
      继承者 java.awt.TextComponent
          继承者 java.awt.TextField
所有已实现的接口:
ImageObserver, MenuContainer, Serializable, javax.accessibility.Accessible

public class TextField
extends TextComponent

TextField 对象是允许编辑单行文本的文本组件。

例如,下图描绘了带有四个宽度各异的文本字段的帧。其中两个文本字段显示预定义文本 "Hello"

前面的文本描述了此图。

以下是产生四个文本字段的代码:


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);

每次用户在文本字段中键入一个键,就有一个或更多键事件被发送到该文本字段。KeyEvent 可以是以下三种类型之一:keyPressed、keyReleased 或 keyTyped。键事件的属性指示事件是这些类型中的哪一种,以及关于事件的其他信息,比如将哪种修改器应用于键事件和发生事件的时间。

键事件被传递给每一个 KeyListenerKeyAdapter 对象,这些对象使用组件的 addKeyListener 方法注册,以接收这类事件。(KeyAdapter 对象实现 KeyListener 接口。)

TextField 还可能触发 ActionEvent。如果为文本字段启用操作事件,则可以通过按下 Return 键触发它们。

TextField 类的 processEvent 方法检查操作事件,并将它们传递给 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 继承的嵌套类/接口
TextComponent.AccessibleAWTTextComponent
 
从类 java.awt.Component 继承的嵌套类/接口
Component.AccessibleAWTComponent, 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()
          指示此文本字段是否有一个回送字符集。
 javax.accessibility.AccessibleContext getAccessibleContext()
          获取与此 TextField 相关的 AccessibleContext。
 ActionListener[] getActionListeners()
          返回此文本字段上已注册的所有操作侦听器的数组。
 int getColumns()
          获取此文本字段中的列数。
 char getEchoChar()
          获取用于回送的字符。
<T extends EventListener>
T[]
getListeners(Class<T> listenerType)
          返回当前已在此 TextField 上注册为 FooListener 的所有对象的数组。
 Dimension getMinimumSize()
          获取此文本字段的最小尺寸。
 Dimension getMinimumSize(int columns)
          获取具有指定列数的文本字段的最小尺寸。
 Dimension getPreferredSize()
          获取此文本字段的首选大小。
 Dimension getPreferredSize(int columns)
          获取具有指定列数的文本字段的首选大小。
 Dimension minimumSize()
          已过时。 从 JDK version 1.1 开始,由 getMinimumSize() 取代。
 Dimension minimumSize(int columns)
          已过时。 从 JDK version 1.1 开始,由 getMinimumSize(int) 取代。
protected  String paramString()
          返回表示此 TextField 状态的字符串。
 Dimension preferredSize()
          已过时。 从 JDK version 1.1 开始,由 getPreferredSize() 取代。
 Dimension preferredSize(int columns)
          已过时。 从 JDK version 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 version 1.1 开始,由 setEchoChar(char) 取代。
 void setText(String t)
          将此文本组件显示的文本设置为指定文本。
 
从类 java.awt.TextComponent 继承的方法
addTextListener, enableInputMethods, getBackground, getCaretPosition, getInputMethodRequests, 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, firePropertyChange, firePropertyChange, firePropertyChange, 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, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, 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, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, 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, setMaximumSize, setMinimumSize, setName, setPreferredSize, 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 - 要显示的文本。如果 textnull,则显示空字符串 ""
抛出:
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 - 要显示的文本。如果 textnull,则显示空字符串 ""
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

@Deprecated
public void setEchoCharacter(char c)
已过时。 从 JDK version 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

@Deprecated
public Dimension preferredSize(int columns)
已过时。 从 JDK version 1.1 开始,由 getPreferredSize(int) 取代。


getPreferredSize

public Dimension getPreferredSize()
获取此文本字段的首选大小。

覆盖:
Component 中的 getPreferredSize
返回:
显示此文本字段的首选尺寸。
从以下版本开始:
JDK1.1
另请参见:
Component.getMinimumSize(), LayoutManager

preferredSize

@Deprecated
public Dimension preferredSize()
已过时。 从 JDK version 1.1 开始,由 getPreferredSize() 取代。

覆盖:
Component 中的 preferredSize

getMinimumSize

public Dimension getMinimumSize(int columns)
获取具有指定列数的文本字段的最小尺寸。

参数:
columns - 此文本字段中的列数。
从以下版本开始:
JDK1.1

minimumSize

@Deprecated
public Dimension minimumSize(int columns)
已过时。 从 JDK version 1.1 开始,由 getMinimumSize(int) 取代。


getMinimumSize

public Dimension getMinimumSize()
获取此文本字段的最小尺寸。

覆盖:
Component 中的 getMinimumSize
返回:
显示此文本字段的最小尺寸。
从以下版本开始:
JDK1.1
另请参见:
Component.getPreferredSize(), LayoutManager

minimumSize

@Deprecated
public Dimension minimumSize()
已过时。 从 JDK version 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 <T extends EventListener> T[] getListeners(Class<T> listenerType)
返回当前已在此 TextField 上注册为 FooListener 的所有对象的数组。FooListener 是用 addFooListener 方法注册的。

可以使用 class 字面值(如 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 对象。

除非此组件启用了操作事件,才会调用此方法。当发生以下事件之一时会启用操作事件:

注意,如果事件参数为 null,则未指定行为,并且可能导致异常。

参数:
e - 操作事件
从以下版本开始:
JDK1.1
另请参见:
ActionListener, addActionListener(java.awt.event.ActionListener), Component.enableEvents(long)

paramString

protected String paramString()
返回表示此 TextField 状态的字符串。此方法仅用于调试目的,对于各个实现,返回的字符串的内容和格式可能有所不同。返回的字符串可能为空,但不可能为 null

覆盖:
TextComponent 中的 paramString
返回:
此文本字段的参数字符串

getAccessibleContext

public javax.accessibility.AccessibleContext getAccessibleContext()
获取与此 TextField 相关的 AccessibleContext。对于文本字段,AccessibleContext 采用的是 AccessibleAWTTextField 的形式。如有必要,可创建一个新的 AccessibleAWTTextField 实例。

指定者:
接口 javax.accessibility.Accessible 中的 getAccessibleContext
覆盖:
TextComponent 中的 getAccessibleContext
返回:
一个 AccessibleAWTTextField,它充当此 TextField 的 AccessibleContext。

JavaTM 2 Platform
Standard Ed. 5.0

提交错误或意见
有关更多的 API 参考资料和开发人员文档,请参阅 Java 2 SDK SE 开发人员文档。该文档包含更详细的、面向开发人员的描述,以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2004 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策