Класс 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 определяет набор методов, определяющих, редактируется ли этот текст. Если компонент редактируемый, он определяет еще один набор методов, поддерживающих курсор вставки текста.

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

С:: JDK1.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()` Возвращает положение курсора вставки текста.
`InputMethodRequests`	`getInputMethodRequests()` Получает обработчик запросов метода ввода, который поддерживает запросы от методов ввода для этого компонента.
`<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, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, 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, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, revalidate, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, 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
См. также:: Component.processKeyEvent(java.awt.event.KeyEvent)

getInputMethodRequests

public InputMethodRequests getInputMethodRequests()

Описание скопировано из класса: Component

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

Overrides:: getInputMethodRequests в классе Component
Возвращает:: обработчик запросов метода ввода для этого компонента, по умолчанию null
См. также:: Component.addInputMethodListener(java.awt.event.InputMethodListener)

addNotify

public void addNotify()

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

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

removeNotify

public void removeNotify()

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

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 в противном случае.
Since:: JDK1.0
См. также:: setEditable(boolean)

setEditable

public void setEditable(boolean b)

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

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

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

getBackground

public Color getBackground()

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

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

setBackground

public void setBackground(Color c)

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

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

getSelectionStart

public int getSelectionStart()

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

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

setSelectionStart

public void setSelectionStart(int selectionStart)

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

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

getSelectionEnd

public int getSelectionEnd()

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

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

setSelectionEnd

public void setSelectionEnd(int selectionEnd)

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

Параметры:: selectionEnd - конечная позиция выделенного текста
Since:: JDK1.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 меньше нуля
Since:: JDK1.1

getCaretPosition

public int getCaretPosition()

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

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

addTextListener

public void addTextListener(TextListener l)

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

Дополнительные сведения о модели потоков AWT см. в разделе Вопросы многопоточности AWT.

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

removeTextListener

public void removeTextListener(TextListener l)

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

Дополнительные сведения о модели потоков AWT см. в разделе Вопросы многопоточности AWT.

Параметры:: l - слушатель текста
С:: JDK1.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
Параметры:: 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.