Класс TextField

java.awt.TextField

Все реализуемые интерфейсы:: ImageObserver, MenuContainer, Serializable, Accessible

public non-sealed class TextField extends TextComponent

Объект TextField — это текстовый компонент, который позволяет редактировать одну строку текста.

Например, на следующем изображении показано окно с четырьмя текстовыми полями разной ширины. В двух из этих текстовых полей отображается предварительно заданный текст "Hello".

The preceding text describes this
image.

Ниже приведён код, создающий эти четыре текстовых поля:

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. Свойства события клавиатуры указывают его тип, а также дополнительную информацию о событии, например какие модификаторы применяются к нему и когда оно произошло.

Событие клавиатуры передаётся каждому объекту KeyListener или KeyAdapter, зарегистрированному для получения таких событий с помощью метода компонента addKeyListener. (Объекты KeyAdapter реализуют интерфейс KeyListener.)

Также можно создать ActionEvent. Если для текстового поля включена генерация событий действия, они могут генерироваться при нажатии клавиши Return.

Метод processEvent класса TextField обрабатывает событие действия и передаёт его методу processActionEvent. Последний метод перенаправляет событие всем объектам ActionListener, зарегистрированным для получения событий действия, создаваемых этим текстовым полем.

Начиная с:

1.0

См. также:

Краткое описание вложенных классов

Модификатор и тип	Класс	Описание
`protected class`	`TextField.AccessibleAWTTextField`	Этот класс реализует поддержку специальных возможностей для класса `TextField`.

Вложенные классы/интерфейсы, объявленные в классе TextComponent

TextComponent.AccessibleAWTTextComponent

Вложенные классы/интерфейсы, объявленные в классе Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Краткое описание полей

Поля, объявленные в классе TextComponent

textListener

Поля, объявленные в классе Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Поля, объявленные в интерфейсе 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()`	Создаёт peer-объект TextField.
`boolean`	`echoCharIsSet()`	Показывает, задан ли для этого текстового поля символ для отображения вместо вводимых символов.
`AccessibleContext`	`getAccessibleContext()`	Получает AccessibleContext, связанный с этим TextField.
`ActionListener[]`	`getActionListeners()`	Возвращает массив всех прослушивателей действий, зарегистрированных для этого текстового поля.
`int`	`getColumns()`	Получает число столбцов в этом текстовом поле.
`char`	`getEchoChar()`	Получает символ, используемый для отображения вместо вводимых символов.
`<T extends EventListener> T[]`	`getListeners(Class<T> listenerType)`	Возвращает массив всех объектов, зарегистрированных в данный момент в качестве `FooListener` для этого `TextField`.
`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 заменено на `getMinimumSize(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)`	Задаёт указанный текст, отображаемый этим текстовым компонентом.

Методы, объявленные в классе TextComponent

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

Методы, объявленные в классе 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, getBaseline, getBaselineResizeBehavior, 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, getMousePosition, getMouseWheelListeners, getName, getParent, 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, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, revalidate, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setMixingCutoutShape, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate

Методы, объявленные в классе Object

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

Подробное описание конструкторов

TextField

public TextField() throws HeadlessException

Создаёт новое текстовое поле.

Вызывает исключение:

HeadlessException — если GraphicsEnvironment.isHeadless() возвращает true.

См. также:

TextField

public TextField(String text) throws HeadlessException

Создаёт новое текстовое поле, инициализированное указанным текстом.

Параметры:

text — текст для отображения. Если text равно null, будет отображена пустая строка "". Если text содержит символы EOL и/или LF, каждый из них будет заменён пробелом.

Вызывает исключение:

HeadlessException — если GraphicsEnvironment.isHeadless() возвращает true.

См. также:

TextField

public TextField(int columns) throws HeadlessException

Создаёт новое пустое текстовое поле с указанным числом столбцов. Столбец — это приблизительная средняя ширина символа, зависящая от платформы.

Параметры:

columns — число столбцов. Если columns меньше 0, columns устанавливается в 0.

Вызывает исключение:

HeadlessException — если GraphicsEnvironment.isHeadless() возвращает true.

См. также:

TextField

public TextField(String text, int columns) throws HeadlessException

Создаёт новое текстовое поле, инициализированное указанным отображаемым текстом и достаточно широкое для размещения указанного числа столбцов. Столбец — это приблизительная средняя ширина символа, зависящая от платформы.

Параметры:

columns — число столбцов. Если columns меньше 0, columns устанавливается в 0.

Вызывает исключение:

HeadlessException — если GraphicsEnvironment.isHeadless() возвращает true.

См. также:

Подробное описание методов

addNotify

public void addNotify()

Создаёт peer-объект TextField. Peer-объект позволяет изменять внешний вид TextField, не меняя его функциональность.

Переопределяет:

addNotify в классе TextComponent

См. также:

getEchoChar

public char getEchoChar()

Возвращает символ, используемый для отображения вводимых символов.

Символ отображения полезен для текстовых полей, в которых введённые пользователем данные не должны отображаться на экране, например в поле для ввода пароля. Если echoChar = 0, введённые данные отображаются на экране без изменений.

Реализация платформы Java может поддерживать только ограниченный непустой набор символов отображения. Этот метод возвращает символ отображения, первоначально заданный с помощью setEchoChar(). Символ отображения, фактически используемый реализацией TextField, может отличаться.

Возвращает:

символ отображения для этого текстового поля.

См. также:

setEchoChar

public void setEchoChar(char c)

Задаёт символ отображения для этого текстового поля.

Символ отображения полезен для текстовых полей, в которых введённые пользователем данные не должны отображаться на экране, например в поле для ввода пароля. Установка echoChar = 0 позволяет снова отображать введённые пользователем данные на экране.

Реализация платформы Java может поддерживать только ограниченный непустой набор символов отображения. Попытка задать неподдерживаемый символ отображения приводит к использованию символа отображения по умолчанию. Последующие вызовы getEchoChar() возвращают первоначально запрошенный символ отображения. Он может совпадать или не совпадать с символом отображения, фактически используемым реализацией TextField.

Параметры:

c — символ отображения для этого текстового поля.

Начиная с:

1.1

См. также:

setEchoCharacter

@Deprecated public void setEchoCharacter(char c)

Устарел.

Начиная с JDK версии 1.1 заменён методом setEchoChar(char).

Задаёт символ, который будет отображаться вместо защищённых вводимых данных.

Параметры:: c — символ отображения для этого текстового поля

setText

public void setText(String t)

Задаёт для этого текстового компонента указанный текст.

Переопределяет:

setText в классе TextComponent

Параметры:

t — новый текст. Если t равно null, будет отображена пустая строка "". Если t содержит символы EOL и/или LF, каждый из них будет заменён пробелом.

См. также:

echoCharIsSet

public boolean echoCharIsSet()

Показывает, задан ли для этого текстового поля символ отображения.

Символ отображения полезен для текстовых полей, в которых введённые пользователем данные не должны отображаться на экране, например в поле для ввода пароля.

Возвращает:

true, если для этого текстового поля задан символ отображения; false — в противном случае.

См. также:

getColumns

public int getColumns()

Возвращает число столбцов в этом текстовом поле. Столбец — это приблизительная средняя ширина символа, зависящая от платформы.

Возвращает:

число столбцов.

Начиная с:

1.1

См. также:

setColumns

public void setColumns(int columns)

Задаёт число столбцов в этом текстовом поле. Столбец — это приблизительная средняя ширина символа, зависящая от платформы.

Параметры:

columns — число столбцов.

Вызывает исключение:

IllegalArgumentException — если заданное для columns значение меньше 0.

Начиная с:

1.1

См. также:

getPreferredSize

public Dimension getPreferredSize(int columns)

Возвращает предпочтительный размер этого текстового поля для указанного числа столбцов.

Параметры:: columns — число столбцов в этом текстовом поле.
Возвращает:: предпочтительные размеры для отображения этого текстового поля.
Начиная с:: 1.1

preferredSize

@Deprecated public Dimension preferredSize(int columns)

Устарел.

Начиная с JDK версии 1.1 заменён методом getPreferredSize(int).

Возвращает предпочтительный размер этого текстового поля для указанного числа столбцов.

Параметры:: columns — число столбцов
Возвращает:: предпочтительный размер текстового поля

getPreferredSize

public Dimension getPreferredSize()

Возвращает предпочтительный размер этого текстового поля.

Переопределяет:

getPreferredSize в классе Component

Возвращает:

предпочтительные размеры для отображения этого текстового поля.

Начиная с:

1.1

См. также:

preferredSize

@Deprecated public Dimension preferredSize()

Устарел.

Начиная с JDK версии 1.1 заменён методом getPreferredSize().

Описание скопировано из класса: Component

Возвращает предпочтительный размер компонента.

Переопределяет:: preferredSize в классе Component
Возвращает:: предпочтительный размер компонента

getMinimumSize

public Dimension getMinimumSize(int columns)

Возвращает минимальные размеры текстового поля для указанного числа столбцов.

Параметры:: columns — число столбцов в этом текстовом поле.
Возвращает:: минимальный размер этого текстового поля
Начиная с:: 1.1

minimumSize

@Deprecated public Dimension minimumSize(int columns)

Устарел.

Начиная с JDK версии 1.1 заменён методом getMinimumSize(int).

Возвращает минимальные размеры текстового поля для указанного числа столбцов.

Параметры:: columns — число столбцов
Возвращает:: минимальный размер этого текстового поля

getMinimumSize

public Dimension getMinimumSize()

Возвращает минимальные размеры этого текстового поля.

Переопределяет:

getMinimumSize в классе Component

Возвращает:

минимальные размеры для отображения этого текстового поля.

Начиная с:

1.1

См. также:

minimumSize

@Deprecated public Dimension minimumSize()

Устарел.

Начиная с JDK версии 1.1 заменён методом getMinimumSize().

Описание скопировано из класса: Component

Возвращает минимальный размер этого компонента.

Переопределяет:: minimumSize в классе Component
Возвращает:: минимальный размер этого компонента

addActionListener

public void addActionListener(ActionListener l)

Добавляет указанный прослушиватель действий для получения событий действий из этого текстового поля. Если l равно null, исключение не генерируется и никаких действий не выполняется.

Подробные сведения о модели многопоточности AWT см. в разделе Проблемы многопоточности AWT.

Параметры:

l — прослушиватель действий.

Начиная с:

1.1

См. также:

removeActionListener

public void removeActionListener(ActionListener l)

Удаляет указанный прослушиватель действий, чтобы он больше не получал события действий из этого текстового поля. Если l равно null, исключение не генерируется и никаких действий не выполняется.

Подробные сведения о модели многопоточности AWT см. в разделе Проблемы многопоточности AWT.

Параметры:

l — прослушиватель действий.

Начиная с:

1.1

См. также:

getActionListeners

public ActionListener[] getActionListeners()

Возвращает массив всех прослушивателей действий, зарегистрированных для этого текстового поля.

Возвращает:

все ActionListeners этого текстового поля или пустой массив, если прослушиватели действий не зарегистрированы

Начиная с:

1.4

См. также:

getListeners

public <T extends EventListener> T[] getListeners(Class<T> listenerType)

Возвращает массив всех объектов, зарегистрированных в данный момент как FooListeners для этого TextField. Регистрация FooListeners выполняется с помощью метода addFooListener.

В качестве аргумента listenerType можно указать литерал класса, например FooListener.class. Например, можно запросить у TextField t список прослушивателей действий с помощью следующего кода:

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

Если таких прослушивателей нет, этот метод возвращает пустой массив.

Переопределяет:

getListeners в классе TextComponent

Параметры типа:

T — тип прослушивателей

Параметры:

listenerType — тип запрашиваемых прослушивателей; этот параметр должен задавать интерфейс, производный от java.util.EventListener

Возвращает:

массив всех объектов, зарегистрированных как FooListeners для этого текстового поля, или пустой массив, если такие прослушиватели не добавлялись

Вызывает исключение:

ClassCastException — если listenerType не задаёт класс или интерфейс, реализующий java.util.EventListener

Начиная с:

1.3

См. также:

processEvent

protected void processEvent(AWTEvent e)

Обрабатывает события этого текстового поля. Если событие является экземпляром ActionEvent, вызывается метод processActionEvent. В противном случае вызывается processEvent в суперклассе.

Обратите внимание: если параметр event равен null, поведение не определено и может привести к исключению.

Переопределяет:

processEvent в классе TextComponent

Параметры:

e — событие

Начиная с:

1.1

См. также:

processActionEvent

protected void processActionEvent(ActionEvent e)

Обрабатывает события действий, возникающие в этом текстовом поле, передавая их всем зарегистрированным объектам ActionListener.

Этот метод вызывается только в том случае, если для компонента включены события действий. События действий включаются в одном из следующих случаев:

Объект ActionListener зарегистрирован с помощью addActionListener.
События действий включены с помощью enableEvents.

Обратите внимание: если параметр event равен null, поведение не определено и может привести к исключению.

Параметры:

e — событие действия

Начиная с:

1.1

См. также:

paramString

protected String paramString()

Возвращает строку, представляющую состояние этого TextField. Этот метод предназначен только для отладки, а содержимое и формат возвращаемой строки могут различаться в разных реализациях. Возвращаемая строка может быть пустой, но не может быть null.

Переопределяет:: paramString в классе TextComponent
Возвращает:: строка параметров этого текстового поля

getAccessibleContext

public AccessibleContext getAccessibleContext()

Возвращает AccessibleContext, связанный с этим TextField. Для текстовых полей AccessibleContext имеет тип AccessibleAWTTextField. При необходимости создаётся новый экземпляр AccessibleAWTTextField.

Определено в:: getAccessibleContext в интерфейсе Accessible
Переопределяет:: getAccessibleContext в классе TextComponent
Возвращает:: AccessibleAWTTextField, выполняющий роль AccessibleContext этого TextField
Начиная с:: 1.3

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/java.desktop/java/awt/TextField.html