Класс TextField

Все реализованные интерфейсы:
ImageObserver, MenuContainer, Serializable, Accessible 
public 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.

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

С тех пор:
1.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.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

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

Параметры:
text - текст, который должен быть отображён. Если text является null, будет отображена пустая строка "". Если text содержит символы EOL и/или LF, каждый из них будет заменён на пробел.
columns - количество столбцов. Если columns меньше 0, columns устанавливается в 0.
Выбрасывает:
HeadlessException - если GraphicsEnvironment.isHeadless() возвращает true.
См. также:
GraphicsEnvironment.isHeadless()

Методы

addNotify

public void addNotify()

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

Overrides:
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)

Устанавливает текст, отображаемый этим текстовым компонентом, на указанный текст.

Overrides:
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()

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

Overrides:
getPreferredSize в классе Component
Возвращает:
предпочтительные размеры для отображения этого текстового поля.
С:
1.1
См. также:
Component.getMinimumSize(), LayoutManager

preferredSize

@Deprecated
public Dimension preferredSize()
Устаревшее.
Начиная с JDK версии 1.1, заменено на getPreferredSize().

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

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

Overrides:
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()

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

Overrides:
getMinimumSize в классе Component
Возвращает:
минимальные размеры для отображения этого текстового поля.
С:
1.1
См. также:
Component.getPreferredSize(), LayoutManager

minimumSize

@Deprecated
public Dimension minimumSize()
Устаревшее.
Начиная с JDK версии 1.1, заменено на getMinimumSize().

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

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

Overrides:
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));
Если таких обработчиков нет, метод возвращает пустой массив.
Overrides:
getListeners в классе TextComponent
Type Parameters:
T - тип слушателей
Parameters:
listenerType - тип запрошенных слушателей; этот параметр должен указать интерфейс, являющийся подклассом java.util.EventListener
Returns:
массив всех объектов, зарегистрированных как FooListener в этом текстовом поле, или пустой массив, если такие слушатели не были добавлены
Throws:
ClassCastException - если listenerType не указывает класс или интерфейс, реализующий java.util.EventListener
Since:
1.3
See Also:
getActionListeners()

processEvent

protected void processEvent(AWTEvent e)

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

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

Overrides:
processEvent в классе TextComponent
Parameters:
e - событие
Since:
1.1
See Also:
ActionEvent, processActionEvent(java.awt.event.ActionEvent)

processActionEvent

protected void processActionEvent(ActionEvent e)

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

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

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

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

Parameters:
e - событие действия
Since:
1.1
See Also:
ActionListener, addActionListener(java.awt.event.ActionListener), Component.enableEvents(long)

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

Spec-Zone .ru
спецификации, руководства, описания, API