Класс 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 class hierarchy graph for TextComponent

Начиная с версии:

1.0

См. также:

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

Модификатор и тип	Класс	Описание
`protected class`	`TextComponent.AccessibleAWTTextComponent`	Этот класс реализует поддержку специальных возможностей для класса `TextComponent`.

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

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

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

Модификатор и тип	Поле	Описание
`protected TextListener`	`textListener`	Список прослушивателей, которые будут получать события от этого объекта.

Поля, объявленные в классе Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Поля, объявленные в интерфейсе 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`s для этого `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)`	Задает указанный текст для отображения в этом текстовом компоненте.

Методы, объявленные в классе 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

Методы, объявленные в классе Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

textListener

protected transient TextListener textListener

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

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

enableInputMethods

public void enableInputMethods(boolean enable)

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

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

enableInputMethods в классе Component

Параметры:

enable — true, чтобы включить, false, чтобы отключить

Начиная с версии:

1.2

См. также:

addNotify

public void addNotify()

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

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

addNotify в классе Component

См. также:

removeNotify

public void removeNotify()

Удаляет связанный объект TextComponent. Этот объект позволяет изменять внешний вид TextComponent, не меняя его функциональность.

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

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.

Начиная с версии:

1.0

См. также:

setEditable

public void setEditable(boolean b)

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

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

Параметры:

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

Начиная с версии:

1.0

См. также:

getBackground

public Color getBackground()

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

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

getBackground в классе Component

Возвращает:

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

Начиная с версии:

1.0

См. также:

setBackground

public void setBackground(Color c)

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

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

setBackground в классе Component

Параметры:

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

Начиная с версии:

1.0

См. также:

getSelectionStart

public int getSelectionStart()

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

Возвращает:

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

См. также:

setSelectionStart

public void setSelectionStart(int selectionStart)

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

Параметры:

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

Начиная с версии:

1.1

См. также:

getSelectionEnd

public int getSelectionEnd()

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

Возвращает:

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

См. также:

setSelectionEnd

public void setSelectionEnd(int selectionEnd)

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

Параметры:

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

Начиная с версии:

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

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

Возвращает:

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

Начиная с версии:

1.4

См. также:

getListeners

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

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

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

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

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

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

getListeners в классе Component

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

T — тип прослушивателей

Параметры:

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

Возвращает:

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

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

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.

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

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

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

Параметры:

e — текстовое событие

См. также:

paramString

protected String paramString()

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

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

getAccessibleContext

public AccessibleContext getAccessibleContext()

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

Определено в:: getAccessibleContext в интерфейсе Accessible
Переопределяет:: getAccessibleContext в классе Component
Возвращает:: AccessibleAWTTextComponent, который служит AccessibleContext этого TextComponent
Начиная с версии:: 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://docs.oracle.com/en/java/javase/25/docs/api/java.desktop/java/awt/TextComponent.html