Класс TextComponent

java.lang.Object

java.awt.Component

java.awt.TextComponent

Все реализованные интерфейсы:: ImageObserver, MenuContainer, Serializable, Accessible

Прямые известные подклассы:: TextArea, TextField

public sealed class TextComponent extends Component implements Accessible permits TextArea, TextField

Класс TextComponent является суперклассом любого компонента, позволяющего редактировать текст.

Компонент текста представляет строку текста. Класс TextComponent определяет набор методов, которые определяют, является ли этот текст редактируемым. Если компонент редактируемый, он определяет другой набор методов, которые поддерживают курсор вставки текста.

Кроме того, класс определяет методы, используемые для поддержания текущего выделенного фрагмента текста. Выделенный фрагмент текста, подстрока текста компонента, является объектом операций редактирования. Его также называют выделенным текстом.

Диаграмма графа иерархии Sealed класса:

Sealed class hierarchy graph for TextComponent

С:

1.0

См. также:

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

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

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

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

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

Модификатор и тип	Поле	Описание
`protected TextListener`	`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

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`addNotify()`	Делает этот компонент отображаемым, подключив его к ресурсу нативного экрана.
`void`	`addTextListener(TextListener l)`	Добавляет указанного слушателя событий текста, чтобы получать события текста от этого компонента текста.
`void`	`enableInputMethods(boolean enable)`	Включает или отключает поддержку ввода метода для этого компонента текста.
`AccessibleContext`	`getAccessibleContext()`	Получает AccessibleContext, связанный с этим TextComponent.
`Color`	`getBackground()`	Получает цвет фона этого компонента текста.
`int`	`getCaretPosition()`	Возвращает позицию курсора вставки текста.
`<T extends EventListener> T[]`	`getListeners(Class<T> listenerType)`	Возвращает массив всех объектов, которые в настоящее время зарегистрированы как `FooListener` в этом `TextComponent`.
`String`	`getSelectedText()`	Возвращает выделенный текст из текста, представленного этим компонентом текста.
`int`	`getSelectionEnd()`	Получает конечную позицию выделенного текста в этом компоненте текста.
`int`	`getSelectionStart()`	Получает начальную позицию выделенного текста в этом компоненте текста.
`String`	`getText()`	Возвращает текст, представленный этим компонентом текста.
`TextListener[]`	`getTextListeners()`	Возвращает массив всех слушателей текста, зарегистрированных в этом компоненте текста.
`boolean`	`isEditable()`	Указывает, редактируем ли этот компонент текста.
`protected String`	`paramString()`	Возвращает строку, представляющую состояние этого `TextComponent`.
`protected void`	`processEvent(AWTEvent e)`	Обрабатывает события в этом компоненте текста.
`protected void`	`processTextEvent(TextEvent e)`	Обрабатывает события текста, происходящие в этом компоненте текста, рассылая их всем зарегистрированным `TextListener` объектам.
`void`	`removeNotify()`	Удаляет виджет `TextComponent`.
`void`	`removeTextListener(TextListener l)`	Удаляет указанного слушателя событий текста, чтобы он больше не получал события текста от этого компонента текста. Если `l` равен `null`, никакие исключения не выбрасываются, и никаких действий не выполняется.
`void`	`select(int selectionStart, int selectionEnd)`	Выделяет текст между заданными начальной и конечной позициями.
`void`	`selectAll()`	Выделяет весь текст в этом компоненте текста.
`void`	`setBackground(Color c)`	Устанавливает цвет фона этого компонента текста.
`void`	`setCaretPosition(int position)`	Устанавливает позицию курсора вставки текста.
`void`	`setEditable(boolean b)`	Устанавливает флаг, определяющий, является ли этот компонент текста редактируемым.
`void`	`setSelectionEnd(int selectionEnd)`	Устанавливает конечную позицию выделения для этого компонента текста в указанной позиции.
`void`	`setSelectionStart(int selectionStart)`	Устанавливает начальную позицию выделения для этого компонента текста в указанной позиции.
`void`	`setText(String t)`	Устанавливает текст, представленный этим компонентом текста, на указанный текст.

Методы, объявленные в классе 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, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPreferredSize, 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, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, postEvent, preferredSize, 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

Подробное описание полей

textListener

protected transient TextListener textListener

Список слушателей, которые будут получать события от этого объекта.

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

enableInputMethods

public void enableInputMethods(boolean enable)

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

Overrides:

enableInputMethods в классе Component

Параметры:

enable - true для включения, false для отключения

Since:

1.2

См. также:

addNotify

public void addNotify()

Делает этот компонент отображаемым, подключив его к ресурсу нативного экрана. Этот метод вызывается внутри инструментария и не должен вызываться программами напрямую.

Overrides:

addNotify в классе Component

См. также:

removeNotify

public void removeNotify()

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

Overrides:

removeNotify в классе Component

См. также:

setText

public void setText(String t)

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

Параметры:

t - новый текст; если этот параметр равен null, текст устанавливается в пустую строку ""

См. также:

getText

public String getText()

Возвращает текст, отображаемый этим текстовым компонентом. По умолчанию это пустая строка.

Возвращает:

значение этого TextComponent

См. также:

getSelectedText

public String getSelectedText()

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

Возвращает:

выбранный текст этого текстового компонента

См. также:

isEditable

public boolean isEditable()

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

Возвращает:

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

Since:

1.0

См. также:

setEditable

public void setEditable(boolean b)

Устанавливает флаг, определяющий, редактируется ли этот текстовый компонент.

Если флаг установлен в true, этот текстовый компонент становится редактируемым пользователем. Если флаг установлен в false, пользователь не может изменить текст этого текстового компонента. По умолчанию текстовые компоненты, не подлежащие редактированию, имеют цвет фона SystemColor.control. Это значение по умолчанию можно переопределить, вызвав setBackground.

Параметры:

b - флаг, указывающий, является ли этот текстовый компонент редактируемым пользователем.

Since:

1.0

См. также:

getBackground

public Color getBackground()

Получает цвет фона этого текстового компонента. По умолчанию текстовые компоненты, не подлежащие редактированию, имеют цвет фона SystemColor.control. Это значение по умолчанию можно переопределить, вызвав setBackground.

Overrides:

getBackground в классе Component

Возвращает:

Цвет фона этого текстового компонента. Если у этого текстового компонента нет цвета фона, возвращается цвет фона его родителя.

Since:

1.0

См. также:

setBackground

public void setBackground(Color c)

Устанавливает цвет фона этого текстового компонента.

Overrides:

setBackground в классе Component

Параметры:

c - цвет, который станет цветом фона этого текстового компонента. Если этот параметр равен null, этот текстовый компонент унаследует цвет фона своего родителя.

Since:

1.0

См. также:

getSelectionStart

public int getSelectionStart()

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

Возвращает:

начальную позицию выделенного текста

См. также:

setSelectionStart

public void setSelectionStart(int selectionStart)

Устанавливает начальную позицию выделения для этого текстового компонента в указанной позиции. Новая начальная точка ограничена текущей конечной позицией выделения. Она также не может быть установлена меньше нуля, начала текста компонента. Если вызывающий предоставляет значение для selectionStart, которое находится вне допустимого диапазона, метод применяет эти ограничения без сбоев и молча.

Параметры:

selectionStart - начальная позиция выделенного текста

Since:

1.1

См. также:

getSelectionEnd

public int getSelectionEnd()

Получает конечную позицию выделенного текста в этом текстовом компоненте.

Возвращает:

конечную позицию выделенного текста

См. также:

setSelectionEnd

public void setSelectionEnd(int selectionEnd)

Устанавливает конечную позицию выделения для этого текстового компонента в указанной позиции. Новая конечная точка ограничена текущей начальной позицией выделения. Она также не может быть установлена за пределами текста компонента. Если вызывающий предоставляет значение для selectionEnd, которое находится вне допустимого диапазона, метод применяет эти ограничения без сбоев и молча.

Параметры:

selectionEnd - конечная позиция выделенного текста

Since:

1.1

См. также:

select

public void select(int selectionStart, int selectionEnd)

Выделяет текст между указанными начальной и конечной позициями.

Этот метод устанавливает начальную и конечную позиции выделенного текста, соблюдая ограничение, что начальная позиция должна быть больше или равна нулю. Конечная позиция должна быть больше или равна начальной позиции и меньше или равна длине текста текстового компонента. Позиции символов индексируются, начиная с нуля. Длина выделения - endPosition - startPosition, поэтому символ в позиции endPosition не выделен. Если начальная и конечная позиции выделенного текста равны, весь текст снимается с выделения.

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

Параметры:

selectionStart - индекс первого символа (char значение) для выделения, начиная с нуля

selectionEnd - конечная позиция текста для выделения, начиная с нуля; символ (char значение) в позиции selectionEnd не выделен

См. также:

selectAll

public void selectAll()

Выбирает весь текст в этом текстовом компоненте.

См. также:

setCaretPosition

public void setCaretPosition(int position)

Устанавливает положение курсора вставки текста. Положение курсора ограничено значениями от 0 до последнего символа текста включительно. Если переданное значение больше этого диапазона, оно устанавливается на последний символ (или 0, если в TextComponent нет текста), и ошибка не возвращается. Если переданное значение меньше 0, выбрасывается IllegalArgumentException.

Параметры:: position - позиция курсора вставки текста
Исключения:: IllegalArgumentException - если position меньше нуля
С тех пор:: 1.1

getCaretPosition

public int getCaretPosition()

Возвращает позицию курсора вставки текста. Положение курсора ограничено значениями от 0 до последнего символа текста включительно. Если текст или курсор не заданы, используется значение по умолчанию - 0.

Возвращает:

позицию курсора вставки текста

С тех пор:

1.1

См. также:

addTextListener

public void addTextListener(TextListener l)

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

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

Параметры:

l - слушатель событий текста

См. также:

removeTextListener

public void removeTextListener(TextListener l)

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

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

Параметры:

l - слушатель событий текста

С тех пор:

1.1

См. также:

getTextListeners

public TextListener[] getTextListeners()

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

Возвращает:

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

С тех пор:

1.4

См. также:

getListeners

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

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

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

TextListener[] tls = (TextListener[])(t.getListeners(TextListener.class));

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

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

getListeners в классе Component

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

T - тип слушателей

Параметры:

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

Возвращает:

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

Исключения:

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

С тех пор:

1.3

См. также:

processEvent

protected void processEvent(AWTEvent e)

Обрабатывает события для этого текстового компонента. Если событие является TextEvent, вызывается метод processTextEvent, в противном случае вызывается метод родительского класса processEvent.

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

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

processEvent в классе Component

Параметры:

e - событие

См. также:

processTextEvent

protected void processTextEvent(TextEvent e)

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

ПРИМЕЧАНИЕ: Этот метод не будет вызван, если для этого компонента не включены события текста. Это происходит в следующих случаях:

Объект TextListener зарегистрирован через метод addTextListener
События текста включены через enableEvents

Параметры:

e - событие текста

См. также:

paramString

protected String paramString()

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

Переопределяет:: paramString в классе Component
Возвращает:: строку параметров этого текстового компонента

getAccessibleContext

public AccessibleContext getAccessibleContext()

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

Определено в:: getAccessibleContext в интерфейсе Accessible
Переопределяет:: getAccessibleContext в классе Component
Возвращает:: AccessibleAWTTextComponent, используемый в качестве AccessibleContext этого текстового компонента
С тех пор:: 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/TextComponent.html