Класс TextField
- java.lang.Object
-
- java.awt.Component
-
- java.awt.TextComponent
-
- 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, которые зарегистрированы на получение событий действия, сгенерированных этим текстовым полем.
- С тех пор:
- JDK1.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 Этот класс реализует поддержку доступности для класса |
Вложенные классы/интерфейсы унаследованные от класса 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> |
getListeners(Class<T> listenerType) Возвращает массив всех объектов, в настоящее время зарегистрированных как |
Dimension |
getMinimumSize() Возвращает минимальные размеры для этого текстового поля. |
Dimension |
getMinimumSize(int columns) Возвращает минимальные размеры текстового поля с указанным количеством столбцов. |
Dimension |
getPreferredSize() Возвращает предпочтительный размер этого текстового поля. |
Dimension |
getPreferredSize(int columns) Возвращает предпочтительный размер этого текстового поля с указанным количеством столбцов. |
Dimension |
minimumSize() Устарело. С версии JDK 1.1, заменено на |
Dimension |
minimumSize(int columns) Устарело. С версии JDK 1.1, заменено на |
protected String |
paramString() Возвращает строку, представляющую состояние этого |
Dimension |
preferredSize() Устарело. С версии JDK 1.1, заменено на |
Dimension |
preferredSize(int columns) Устарело. С версии JDK 1.1, заменено на |
protected void |
processActionEvent(ActionEvent e) Обрабатывает события действия, происходящие в этом текстовом поле, направляя их любым зарегистрированным объектам |
protected void |
processEvent(AWTEvent e) Обрабатывает события в этом текстовом поле. |
void |
removeActionListener(ActionListener l) Удаляет указанный обработчик событий действия, чтобы он больше не получал события действия от этого текстового поля. |
void |
setColumns(int columns) Устанавливает количество столбцов в этом текстовом поле. |
void |
setEchoChar(char c) Устанавливает символ эха для этого текстового поля. |
void |
setEchoCharacter(char c) Устарело. С версии JDK 1.1, заменено на |
void |
setText(String t) Устанавливает текст, который отображается этим текстовым компонентом, на указанный текст. |
Методы, унаследованные от класса java.awt.TextComponent
addTextListener, enableInputMethods, getBackground, getCaretPosition, getInputMethodRequests, 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, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, 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, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, revalidate, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, 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, будет отображена пустая строка"". - Исключение:
-
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, будет отображена пустая строка"". -
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- символ эха для этого текстового поля. - С:
- JDK1.1
- См. также:
-
echoCharIsSet(),getEchoChar()
setEchoCharacter
@Deprecated public void setEchoCharacter(char c)
Устарело. С версии JDK 1.1 заменено на setEchoChar(char).
setText
public void setText(String t)
Устанавливает текст, отображаемый этим текстовым компонентом, на указанный текст.
- Переопределяет:
-
setTextв классеTextComponent - Параметры:
-
t- новый текст. - См. также:
TextComponent.getText()
echoCharIsSet
public boolean echoCharIsSet()
Указывает, установлен ли символ эха для этого текстового поля.
Символ эха полезен для текстовых полей, где ввод пользователя не должен отображаться на экране, например, для поля ввода пароля.
- Возвращает:
-
trueесли в этом текстовом поле установлен символ эха;falseв противном случае. - См. также:
-
setEchoChar(char),getEchoChar()
getColumns
public int getColumns()
Возвращает количество столбцов в этом текстовом поле. Столбец — это приблизительная средняя ширина символа, зависящая от платформы.
- Возвращает:
- количество столбцов.
- С:
- JDK1.1
- См. также:
setColumns(int)
setColumns
public void setColumns(int columns)
Устанавливает количество столбцов в этом текстовом поле. Столбец — это приблизительная средняя ширина символа, зависящая от платформы.
- Параметры:
-
columns- количество столбцов. - Исключение:
-
IllegalArgumentException- если значение, предоставленное дляcolumns, меньше0. - С:
- JDK1.1
- См. также:
getColumns()
getPreferredSize
public Dimension getPreferredSize(int columns)
Возвращает предпочтительный размер этого текстового поля с указанным количеством столбцов.
- Параметры:
-
columns- количество столбцов в этом текстовом поле. - Возвращает:
- предпочтительные размеры для отображения этого текстового поля.
- С:
- JDK1.1
preferredSize
@Deprecated public Dimension preferredSize(int columns)
Устарело. С версии JDK 1.1 заменено на getPreferredSize(int).
getPreferredSize
public Dimension getPreferredSize()
Возвращает предпочтительный размер этого текстового поля.
- Переопределяет:
-
getPreferredSizeв классеComponent - Возвращает:
- предпочтительные размеры для отображения этого текстового поля.
- С:
- JDK1.1
- См. также:
-
Component.getMinimumSize(),LayoutManager
preferredSize
@Deprecated public Dimension preferredSize()
Устарело. С версии JDK 1.1 заменено на getPreferredSize().
- Переопределяет:
-
preferredSizeв классеComponent
getMinimumSize
public Dimension getMinimumSize(int columns)
Возвращает минимальные размеры текстового поля с указанным количеством столбцов.
- Параметры:
-
columns- количество столбцов в этом текстовом поле. - С:
- JDK1.1
minimumSize
@Deprecated public Dimension minimumSize(int columns)
Устарело. С версии JDK 1.1 заменено на getMinimumSize(int).
getMinimumSize
public Dimension getMinimumSize()
Возвращает минимальные размеры этого текстового поля.
- Переопределяет:
-
getMinimumSizeв классеComponent - Возвращает:
- минимальные размеры для отображения этого текстового поля.
- С:
- JDK1.1
- См. также:
-
Component.getPreferredSize(),LayoutManager
minimumSize
@Deprecated public Dimension minimumSize()
Устарело. С версии JDK 1.1 заменено на getMinimumSize().
- Переопределяет:
-
minimumSizeв классеComponent
addActionListener
public void addActionListener(ActionListener l)
Добавляет указанного обработчика событий действия для получения событий действия от этого текстового поля. Если l равно null, исключение не выбрасывается, и действие не выполняется.
Подробности о модели потоков AWT см. в AWT Threading Issues.
- Параметры:
-
l- обработчик событий действия. - С:
- JDK1.1
- См. также:
-
removeActionListener(java.awt.event.ActionListener),getActionListeners(),ActionListener
removeActionListener
public void removeActionListener(ActionListener l)
Удаляет указанного обработчика событий действия, чтобы он больше не получал события действия от этого текстового поля. Если l равно null, исключение не выбрасывается, и действие не выполняется.
Подробности о модели потоков AWT см. в AWT Threading Issues.
- Параметры:
-
l- обработчик событий действия. - С:
- JDK1.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)
Возвращает массив всех объектов, в настоящее время зарегистрированных в качестве FooListener на этом TextField. FooListener регистрируются с помощью метода addFooListener.
Вы можете указать аргумент listenerType с литералом класса, например FooListener.class. Например, вы можете запросить слушатели событий действия для TextField t с помощью следующего кода:
ActionListener[] als = (ActionListener[])(t.getListeners(ActionListener.class));Если такие слушатели не существуют, этот метод возвращает пустой массив.
- Переопределяет:
-
getListenersв классеTextComponent - Параметры:
-
listenerType- тип запрашиваемых слушателей; этот параметр должен указать интерфейс, который происходит отjava.util.EventListener - Возвращает:
- массив всех объектов, зарегистрированных в качестве
FooListenerна этом текстовом поле, или пустой массив, если такие слушатели не были добавлены - Исключения:
-
ClassCastException- еслиlistenerTypeне указывает класс или интерфейс, реализующийjava.util.EventListener - С:
- 1.3
- См. также:
getActionListeners()
processEvent
protected void processEvent(AWTEvent e)
Обрабатывает события в этом текстовом поле. Если событие является экземпляром ActionEvent, оно вызывает метод processActionEvent. В противном случае оно вызывает processEvent в суперклассе.
Обратите внимание, что если параметр события null, поведение не определено и может привести к исключению.
- Переопределяет:
-
processEventв классеTextComponent - Параметры:
-
e- событие - С:
- JDK1.1
- См. также:
-
ActionEvent,processActionEvent(java.awt.event.ActionEvent)
processActionEvent
protected void processActionEvent(ActionEvent e)
Обрабатывает события действия, происходящие в этом текстовом поле, перенаправляя их любым зарегистрированным ActionListener объектам.
Этот метод не вызывается, если события действия не включены для этого компонента. События действия включаются, когда происходит одно из следующего:
- Объект
ActionListenerрегистрируется черезaddActionListener. - События действия включаются через
enableEvents.
Обратите внимание, что если параметр события null, поведение не определено и может привести к исключению.
- Параметры:
-
e- событие действия - С:
- JDK1.1
- См. также:
-
ActionListener,addActionListener(java.awt.event.ActionListener),Component.enableEvents(long)
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, 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.