Класс TextComponent

Все реализованные интерфейсы:
ImageObserver, MenuContainer, Serializable, Accessible
Непосредственные известные подклассы:
TextArea, TextField 
public class TextComponent
extends Component
implements Accessible

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

Компонент текста представляет собой строку текста. Класс 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
См. также:
Component.processKeyEvent(java.awt.event.KeyEvent)

addNotify

public void addNotify()

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

Overrides:
addNotify в классе Component
См. также:
removeNotify()

removeNotify

public void removeNotify()

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

Overrides:
removeNotify в классе Component
См. также:
Component.isDisplayable(), Component.addNotify()

setText

public void setText(String t)

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

Параметры:
t - новый текст; если этот параметр null, то текст устанавливается в пустую строку ""
См. также:
getText()

getText

public String getText()

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

Возвращает:
значение этого TextComponent
См. также:
setText(java.lang.String)

getSelectedText

public String getSelectedText()

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

Возвращает:
выбранный текст этого компонента текста
См. также:
select(int, int)

isEditable

public boolean isEditable()

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

Возвращает:
true если этот компонент текста редактируемый; false в противном случае.
С:
1.0
См. также:
setEditable(boolean)

setEditable

public void setEditable(boolean b)

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

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

Параметры:
b - флаг, указывающий, редактируется ли этот компонент текста пользователем.
С:
1.0
См. также:
isEditable()

getBackground

public Color getBackground()

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

Overrides:
getBackground в классе Component
Возвращает:
Цвет фона этого компонента текста. Если у этого компонента текста нет цвета фона, возвращается цвет фона его родителя.
С:
1.0
См. также:
setBackground(Color)

setBackground

public void setBackground(Color c)

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

Overrides:
setBackground в классе Component
Параметры:
c - Цвет, который станет цветом фона этого компонента текста. Если этот параметр равен null, этот компонент текста будет наследовать цвет фона своего родителя.
С:
1.0
См. также:
getBackground()

getSelectionStart

public int getSelectionStart()

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

Возвращает:
начальную позицию выбранного текста
См. также:
setSelectionStart(int), getSelectionEnd()

setSelectionStart

public void setSelectionStart(int selectionStart)

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

Параметры:
selectionStart - начальная позиция выделенного текста
С:
1.1
См. также:
getSelectionStart(), setSelectionEnd(int)

getSelectionEnd

public int getSelectionEnd()

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

Возвращает:
конечная позиция выбранного текста
См. также:
setSelectionEnd(int), getSelectionStart()

setSelectionEnd

public void setSelectionEnd(int selectionEnd)

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

Параметры:
selectionEnd - конечная позиция выделенного текста
С:
1.1
См. также:
getSelectionEnd(), setSelectionStart(int)

select

public void select(int selectionStart,
                   int selectionEnd)

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

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

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

Параметры:
selectionStart - индекс первой позиции (char значение) для выделения, начиная с нуля
selectionEnd - конечная позиция текста для выделения, начиная с нуля; символ (char значение) в позиции selectionEnd не выделяется
См. также:
setSelectionStart(int), setSelectionEnd(int), selectAll()

selectAll

public void selectAll()

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

См. также:
select(int, int)

setCaretPosition

public void setCaretPosition(int position)

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

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

getCaretPosition

public int getCaretPosition()

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

Возвращает:
позиция курсора вставки текста
С:
1.1
См. также:
setCaretPosition(int)

addTextListener

public void addTextListener(TextListener l)

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

Подробную информацию о модели потоков AWT см. в AWT Threading Issues.

Параметры:
l - слушатель событий текста
См. также:
removeTextListener(java.awt.event.TextListener), getTextListeners(), TextListener

removeTextListener

public void removeTextListener(TextListener l)

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

Обратитесь к Проблемам с потоками AWT для получения подробностей о модели потоков AWT.

Параметры:
l - обработчик событий текста
С:
1.1
См. также:
addTextListener(java.awt.event.TextListener), getTextListeners(), TextListener

getTextListeners

public TextListener[] getTextListeners()

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

Возвращает:
все текстовые обработчики этого текстового компонента или пустой массив, если обработчики событий текста не зарегистрированы
С:
1.4
См. также:
addTextListener(java.awt.event.TextListener), removeTextListener(java.awt.event.TextListener)

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));
Если такие обработчики не существуют, этот метод возвращает пустой массив.
Переопределяет:
getListeners в классе Component
Параметры типа:
T - тип обработчиков
Параметры:
listenerType - тип запрашиваемых обработчиков; этот параметр должен указывать интерфейс, который наследуется от java.util.EventListener
Возвращает:
массив всех объектов, зарегистрированных в качестве FooListener в этом текстовом компоненте, или пустой массив, если такие обработчики не добавлены
Исключения:
ClassCastException - если listenerType не указывает класс или интерфейс, реализующий java.util.EventListener
С:
1.3
См. также:
getTextListeners()

processEvent

protected void processEvent(AWTEvent e)

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

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

Переопределяет:
processEvent в классе Component
Параметры:
e - событие
См. также:
Component.processComponentEvent(java.awt.event.ComponentEvent), Component.processFocusEvent(java.awt.event.FocusEvent), Component.processKeyEvent(java.awt.event.KeyEvent), Component.processMouseEvent(java.awt.event.MouseEvent), Component.processMouseMotionEvent(java.awt.event.MouseEvent), Component.processInputMethodEvent(java.awt.event.InputMethodEvent), Component.processHierarchyEvent(java.awt.event.HierarchyEvent), Component.processMouseWheelEvent(java.awt.event.MouseWheelEvent)

processTextEvent

protected void processTextEvent(TextEvent e)

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

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

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

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

Параметры:
e - событие текста
См. также:
Component.enableEvents(long)

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, 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/TextComponent.html

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