Класс 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`.

Вложенные классы/интерфейсы, объявленные в классе 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 для отключения

С:

1.2

См. также:

addNotify

public void addNotify()

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

Overrides:

addNotify в классе Component

См. также:

removeNotify

public void removeNotify()

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

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 в противном случае.

С:

1.0

См. также:

setEditable

public void setEditable(boolean b)

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

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

Параметры:

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

С:

1.0

См. также:

getBackground

public Color getBackground()

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

Overrides:

getBackground в классе Component

Возвращает:

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

С:

1.0

См. также:

setBackground

public void setBackground(Color c)

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

Overrides:

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 значение), начиная с 0

selectionEnd - конечная позиция выбираемого текста; символ (char значение) в позиции selectionEnd не выбирается

См. также:

selectAll

public void selectAll()

Выделяет весь текст в этом текстовом компоненте.

См. также:

setCaretPosition

public void setCaretPosition(int position)

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

Parameters:: position - позиция курсора вставки текста
Throws:: IllegalArgumentException - если position меньше нуля
Since:: 1.1

getCaretPosition

public int getCaretPosition()

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

Returns:

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

Since:

1.1

See Also:

addTextListener

public void addTextListener(TextListener l)

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

См. AWT Threading Issues для получения подробной информации о модели потоков AWT.

Parameters:

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

See Also:

removeTextListener

public void removeTextListener(TextListener l)

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

См. AWT Threading Issues для получения подробной информации о модели потоков AWT.

Parameters:

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

Since:

1.1

See Also:

getTextListeners

public TextListener[] getTextListeners()

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

Returns:

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

Since:

1.4

See Also:

getListeners

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

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

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

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

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

Overrides:

getListeners в классе Component

Type Parameters:

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

Parameters:

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

Returns:

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

Throws:

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

Since:

1.3

See Also:

processEvent

protected void processEvent(AWTEvent e)

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

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

Overrides:

processEvent в классе Component

Parameters:

e - событие

See Also:

processTextEvent

protected void processTextEvent(TextEvent e)

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

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

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

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

Parameters:

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

See Also:

paramString

protected String paramString()

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

Overrides:: paramString в классе Component
Returns:: строка параметров этого текстового компонента

getAccessibleContext

public AccessibleContext getAccessibleContext()

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

Specified by:: getAccessibleContext в интерфейсе Accessible
Overrides:: getAccessibleContext в классе Component
Returns:: AccessibleAWTTextComponent, который служит AccessibleContext для этого TextComponent
Since:: 1.3

© 1993, 2023, 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/21/docs/api/java.desktop/java/awt/TextComponent.html