Класс TextField

java.awt.TextField

Все реализуемые интерфейсы:: ImageObserver, MenuContainer, Serializable, 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);

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

См. также:

GraphicsEnvironment.isHeadless()

TextField

public TextField(String text) throws HeadlessException

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

Параметры:

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

Выбрасывает:

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

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

Параметры:

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

Выбрасывает:

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

См. также:

GraphicsEnvironment.isHeadless()

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

addNotify

public void addNotify()

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

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

addNotify в классе TextComponent

См. также:

TextComponent.removeNotify()

getEchoChar

public char getEchoChar()

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

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

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

Возвращает:

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

См. также:

echoCharIsSet()
setEchoChar(char)

setEchoChar

public void setEchoChar(char c)

Устанавливает символ эха для данного текстового поля.

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

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

Параметры:

c - символ эха для данного текстового поля.

С:

1.1

См. также:

echoCharIsSet()
getEchoChar()

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, каждый из них заменяется пробелом.

См. также:

TextComponent.getText()

echoCharIsSet

public boolean echoCharIsSet()

Указывает, установлен ли символ эха для данного текстового поля.

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

Возвращает:

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

См. также:

setEchoChar(char)
getEchoChar()

getColumns

public int getColumns()

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

Возвращает:

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

С:

1.1

См. также:

setColumns(int)

setColumns

public void setColumns(int columns)

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

Параметры:

columns - количество столбцов.

Выбрасывает:

IllegalArgumentException - если значение, предоставленное для columns, меньше 0.

С:

1.1

См. также:

getColumns()

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(java.awt.event.ActionListener)
getActionListeners()
ActionListener

removeActionListener

public void removeActionListener(ActionListener l)

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

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

Параметры:

l - обработчик событий.

С:

1.1

См. также:

addActionListener(java.awt.event.ActionListener)
getActionListeners()
ActionListener

getActionListeners

public ActionListener[] getActionListeners()

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

Возвращает:

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

С:

1.4

См. также:

addActionListener(java.awt.event.ActionListener)
removeActionListener(java.awt.event.ActionListener)
ActionListener

getListeners

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

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

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

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

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

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

getListeners в классе TextComponent

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

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

Параметры:

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

Возвращает:

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

Исключения:

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

С:

1.3

См. также:

getActionListeners()

processEvent

protected void processEvent(AWTEvent e)

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

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

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

processEvent в классе TextComponent

Параметры:

e - событие

С:

1.1

См. также:

ActionEvent
processActionEvent(java.awt.event.ActionEvent)

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, 2021, 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/17/docs/api/java.desktop/java/awt/TextField.html