Класс 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);

Каждый раз, когда пользователь нажимает клавишу в текстовом поле, одно или несколько событий нажатия клавиши отправляются в текстовое поле. Событие нажатия клавиши может быть одного из трёх типов: keyPressed, keyReleased или keyTyped. Свойства события нажатия клавиши указывают, к какому типу оно относится, а также дополнительную информацию об событии, такую как применяемые модификаторы к событию и время, когда оно произошло.

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

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

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

С момента:

1.0

См. также:

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

Модификатор и тип	Класс	Описание
`protected class`	`TextField.AccessibleAWTTextField`	Этот класс реализует поддержку доступности для класса `TextField`.

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

TextComponent.AccessibleAWTTextComponent

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

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

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

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

textListener

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

accessibleContext, 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()`	Возвращает 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)`	Устанавливает текст, отображаемый этим текстовым компонентом, на указанный текст.

Методы, объявленные в классе 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, 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

Методы, объявленные в классе java.lang.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

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

Параметры:

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

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

Исключение:

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

См. также:

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

addNotify

public void addNotify()

Создаёт компонент отображения TextField. Компонент отображения позволяет нам изменять внешний вид 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()

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

Возвращает:

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

С версии:

1.4

См. также:

getListeners

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

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

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

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

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

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

getListeners в классе TextComponent

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

T - тип обработчиков

Параметры:

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

Возвращает:

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

Исключения:

ClassCastException - если listenerType не указывает класс или интерфейс, реализующий java.util.EventListener

С версии:

1.3

См. также:

processEvent

protected void processEvent(AWTEvent e)

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

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

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

processEvent в классе TextComponent

Параметры:

e - событие

С версии:

1.1

См. также:

processActionEvent

protected void processActionEvent(ActionEvent e)

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

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

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

Параметры:

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://download.java.net/java/early_access/jdk24/docs/api/java.desktop/java/awt/TextField.html