Класс 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()`	Deprecated. С версии JDK 1.1 заменено на `getMinimumSize()`.
`Dimension`	`minimumSize(int columns)`	Deprecated. С версии JDK 1.1 заменено на `getMinimumSize(int)`.
`protected String`	`paramString()`	Возвращает строку, представляющую состояние этого `TextField`.
`Dimension`	`preferredSize()`	Deprecated. С версии JDK 1.1 заменено на `getPreferredSize()`.
`Dimension`	`preferredSize(int columns)`	Deprecated. С версии 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)`	Deprecated. С версии 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

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

Параметры:

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
Возвращает:: предпочтительный размер компонента

END_OF_DOCUMENT_MARKER

getMinimumSize

public Dimension getMinimumSize(int columns)

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

Parameters:: columns - количество столбцов в этом текстовом поле.
Returns:: минимальный размер для этого текстового поля
Since:: 1.1

minimumSize

@Deprecated public Dimension minimumSize(int columns)

Устарело.

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

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

Parameters:: columns - количество столбцов
Returns:: минимальный размер для этого текстового поля

getMinimumSize

public Dimension getMinimumSize()

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

Overrides:

getMinimumSize в классе Component

Returns:

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

Since:

1.1

See Also:

minimumSize

@Deprecated public Dimension minimumSize()

Устарело.

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

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

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

Overrides:: minimumSize в классе Component
Returns:: минимальный размер этого компонента

addActionListener

public void addActionListener(ActionListener l)

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

См. Вопросы многопоточности AWT для получения подробной информации об архитектуре потоков AWT.

Parameters:

l - обработчик событий действия.

Since:

1.1

See Also:

removeActionListener

public void removeActionListener(ActionListener l)

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

См. Вопросы многопоточности AWT для получения подробной информации об архитектуре потоков AWT.

Parameters:

l - обработчик событий действия.

Since:

1.1

See Also:

getActionListeners

public ActionListener[] getActionListeners()

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

Returns:

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

Since:

1.4

See Also:

getListeners

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

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

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

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

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

Overrides:

getListeners в классе TextComponent

Type Parameters:

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

Parameters:

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

Returns:

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

Throws:

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

Since:

1.3

See Also:

processEvent

protected void processEvent(AWTEvent e)

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

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

Overrides:

processEvent в классе TextComponent

Parameters:

e - событие

Since:

1.1

See Also:

processActionEvent

protected void processActionEvent(ActionEvent e)

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

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

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

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

Parameters:

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

Since:

1.1

See Also:

paramString

protected String paramString()

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

Overrides:: paramString в классе TextComponent
Returns:: строка параметров этого текстового поля

getAccessibleContext

public AccessibleContext getAccessibleContext()

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

Specified by:: getAccessibleContext в интерфейсе Accessible
Overrides:: getAccessibleContext в классе TextComponent
Returns:: AccessibleAWTTextField, который служит AccessibleContext этого TextField
Since:: 1.3

© 1993, 2023, 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/21/docs/api/java.desktop/java/awt/TextField.html