Spec-Zone.ru › OpenJDK 17

Класс TextComponent

java.lang.Object
java.awt.Component
java.awt.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.
Parameters:
position - позиция указателя ввода текста
Throws:
IllegalArgumentException - если position меньше нуля
Since:
1.1

getCaretPosition

public int getCaretPosition()
Возвращает позицию указателя ввода текста. Позиция указателя ограничена значениями от 0 до последнего символа текста включительно. Если текст или указатель не заданы, то используется значение по умолчанию - 0.
Returns:
позиция указателя ввода текста
Since:
1.1
See Also:
  • setCaretPosition(int)

addTextListener

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

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

Parameters:
l - слушатель событий текста
See Also:
  • removeTextListener(java.awt.event.TextListener)
  • getTextListeners()
  • TextListener

removeTextListener

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

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

Parameters:
l - слушатель текста
Since:
1.1
See Also:
  • addTextListener(java.awt.event.TextListener)
  • getTextListeners()
  • TextListener

getTextListeners

public TextListener[] getTextListeners()
Возвращает массив всех зарегистрированных слушателей событий текста для этого компонента текста.
Returns:
все слушатели событий текста этого компонента или пустой массив, если слушатели не зарегистрированы
Since:
1.4
See Also:
  • addTextListener(java.awt.event.TextListener)
  • removeTextListener(java.awt.event.TextListener)

getListeners

public <T extends EventListener> T[] getListeners(Class<T> listenerType)
Возвращает массив всех объектов, зарегистрированных в качестве слушателей для этого компонента. Слушатели регистрируются с помощью метода 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:
массив всех объектов, зарегистрированных в качестве слушателей для этого компонента текста, или пустой массив, если таких слушателей не добавлено
Throws:
ClassCastException - если listenerType не указывает класс или интерфейс, реализующий java.util.EventListener
Since:
1.3
See Also:
  • getTextListeners()

processEvent

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

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

Overrides:
processEvent в классе Component
Parameters:
e - событие
See Also:
  • 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, поведение не определено и может привести к исключению.

Parameters:
e - событие текста
See Also:
  • Component.enableEvents(long)

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, 2021, 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/17/docs/api/java.desktop/java/awt/TextComponent.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API