Класс TextArea

java.awt.TextArea

Все реализованные интерфейсы:: ImageObserver, MenuContainer, Serializable, Accessible

public non-sealed class TextArea extends TextComponent

Объект TextArea представляет собой многострочную область для отображения текста. Она может быть доступна для редактирования или только для чтения.

На следующем изображении показан внешний вид текстовой области:

A TextArea showing the word
'Hello!'

Эту текстовую область можно создать следующей строкой кода:

new TextArea("Hello", 5, 40);

Начиная с:

1.0

См. также:

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

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

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

TextComponent.AccessibleAWTTextComponent

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

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

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

Модификатор и тип	Поле	Описание
`static final int`	`SCROLLBARS_BOTH`	Создает и отображает вертикальную и горизонтальную полосы прокрутки.
`static final int`	`SCROLLBARS_HORIZONTAL_ONLY`	Создает и отображает только горизонтальную полосу прокрутки.
`static final int`	`SCROLLBARS_NONE`	Не создает и не отображает полосы прокрутки для текстовой области.
`static final int`	`SCROLLBARS_VERTICAL_ONLY`	Создает и отображает только вертикальную полосу прокрутки.

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

textListener

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

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Поля, объявленные в интерфейсе ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Краткое описание конструкторов

Конструктор	Описание
`TextArea()`	Создает новую текстовую область с пустой строкой в качестве текста.
`TextArea(int rows, int columns)`	Создает новую текстовую область с указанным числом строк и столбцов и пустой строкой в качестве текста.
`TextArea(String text)`	Создает новую текстовую область с указанным текстом.
`TextArea(String text, int rows, int columns)`	Создает новую текстовую область с указанным текстом и заданным числом строк и столбцов.
`TextArea(String text, int rows, int columns, int scrollbars)`	Создает новую текстовую область с указанным текстом, заданными числом строк и столбцов, а также видимостью полос прокрутки.

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`addNotify()`	Создает peer-объект для `TextArea`.
`void`	`append(String str)`	Добавляет указанный текст в конец текущего текста текстовой области.
`void`	`appendText(String str)`	Устарел. Начиная с JDK версии 1.1 заменен на `append(String)`.
`AccessibleContext`	`getAccessibleContext()`	Возвращает `AccessibleContext`, связанный с этим `TextArea`.
`int`	`getColumns()`	Возвращает число столбцов в этой текстовой области.
`Dimension`	`getMinimumSize()`	Определяет минимальный размер этой текстовой области.
`Dimension`	`getMinimumSize(int rows, int columns)`	Определяет минимальный размер текстовой области с указанным числом строк и столбцов.
`Dimension`	`getPreferredSize()`	Определяет предпочтительный размер этой текстовой области.
`Dimension`	`getPreferredSize(int rows, int columns)`	Определяет предпочтительный размер текстовой области с указанным числом строк и столбцов.
`int`	`getRows()`	Возвращает число строк в текстовой области.
`int`	`getScrollbarVisibility()`	Возвращает перечисляемое значение, указывающее, какие полосы прокрутки использует текстовая область.
`void`	`insert(String str, int pos)`	Вставляет указанный текст в указанную позицию этой текстовой области.
`void`	`insertText(String str, int pos)`	Устарел. Начиная с JDK версии 1.1 заменен на `insert(String, int)`.
`Dimension`	`minimumSize()`	Устарел. Начиная с JDK версии 1.1 заменен на `getMinimumSize()`.
`Dimension`	`minimumSize(int rows, int columns)`	Устарел. Начиная с JDK версии 1.1 заменен на `getMinimumSize(int, int)`.
`protected String`	`paramString()`	Возвращает строку, представляющую состояние этого объекта `TextArea`.
`Dimension`	`preferredSize()`	Устарел. Начиная с JDK версии 1.1 заменен на `getPreferredSize()`.
`Dimension`	`preferredSize(int rows, int columns)`	Устарел. Начиная с JDK версии 1.1 заменен на `getPreferredSize(int, int)`.
`void`	`replaceRange(String str, int start, int end)`	Заменяет текст между указанными начальной и конечной позициями указанным текстом.
`void`	`replaceText(String str, int start, int end)`	Устарел. Начиная с JDK версии 1.1 заменен на `replaceRange(String, int, int)`.
`void`	`setColumns(int columns)`	Задает число столбцов для этой текстовой области.
`void`	`setRows(int rows)`	Задает число строк для этой текстовой области.

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

addTextListener, enableInputMethods, getBackground, getCaretPosition, getListeners, getSelectedText, getSelectionEnd, getSelectionStart, getText, getTextListeners, isEditable, processEvent, processTextEvent, removeNotify, removeTextListener, select, selectAll, setBackground, setCaretPosition, setEditable, setSelectionEnd, setSelectionStart, setText

Методы, объявленные в классе 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, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, 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, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, postEvent, 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

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

SCROLLBARS_BOTH

public static final int SCROLLBARS_BOTH

Создает и отображает вертикальную и горизонтальную полосы прокрутки.

С версии:

1.1

См. также:

SCROLLBARS_VERTICAL_ONLY

public static final int SCROLLBARS_VERTICAL_ONLY

Создает и отображает только вертикальную полосу прокрутки.

С версии:

1.1

См. также:

SCROLLBARS_HORIZONTAL_ONLY

public static final int SCROLLBARS_HORIZONTAL_ONLY

Создает и отображает только горизонтальную полосу прокрутки.

С версии:

1.1

См. также:

SCROLLBARS_NONE

public static final int SCROLLBARS_NONE

Не создает и не отображает полосы прокрутки для текстовой области.

С версии:

1.1

См. также:

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

TextArea

public TextArea() throws HeadlessException

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

Вызывает исключение:

HeadlessException - если GraphicsEnvironment.isHeadless возвращает true

См. также:

TextArea

public TextArea(String text) throws HeadlessException

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

Параметры:

text — текст для отображения; если text — null, будет отображаться пустая строка ""

Вызывает исключение:

HeadlessException - если GraphicsEnvironment.isHeadless возвращает true

См. также:

TextArea

public TextArea(int rows, int columns) throws HeadlessException

Создает новую текстовую область с указанным количеством строк и столбцов и пустой строкой в качестве текста. Ширина столбца приблизительно равна средней ширине символа и зависит от платформы. Текстовая область создается с видимостью полос прокрутки, равной SCROLLBARS_BOTH, поэтому в ней будут отображаться и вертикальная, и горизонтальная полосы прокрутки.

Параметры:

rows — количество строк

columns — количество столбцов

Вызывает исключение:

HeadlessException - если GraphicsEnvironment.isHeadless возвращает true

См. также:

TextArea

public TextArea(String text, int rows, int columns) throws HeadlessException

Создает новую текстовую область с указанным текстом и указанным количеством строк и столбцов. Ширина столбца приблизительно равна средней ширине символа и зависит от платформы. Текстовая область создается с видимостью полос прокрутки, равной SCROLLBARS_BOTH, поэтому в ней будут отображаться и вертикальная, и горизонтальная полосы прокрутки.

Параметры:

text — текст для отображения; если text — null, будет отображаться пустая строка ""

rows — количество строк

columns — количество столбцов

Вызывает исключение:

HeadlessException - если GraphicsEnvironment.isHeadless возвращает true

См. также:

TextArea

public TextArea(String text, int rows, int columns, int scrollbars) throws HeadlessException

Создает новую текстовую область с указанным текстом, количеством строк и столбцов, а также видимостью полос прокрутки. Все конструкторы TextArea делегируют вызов этому конструктору.

Класс TextArea определяет несколько констант, которые можно передать в качестве значений аргумента scrollbars:

SCROLLBARS_BOTH,
SCROLLBARS_VERTICAL_ONLY,
SCROLLBARS_HORIZONTAL_ONLY,
SCROLLBARS_NONE.

Любое другое значение аргумента scrollbars недопустимо. В этом случае текстовая область будет создана со значением видимости полос прокрутки по умолчанию — SCROLLBARS_BOTH.

Параметры:

text — текст для отображения; если text — null, будет отображаться пустая строка ""

rows — количество строк; если rows меньше 0, для rows устанавливается значение 0

columns — количество столбцов; если columns меньше 0, для columns устанавливается значение 0

scrollbars — константа, определяющая, какие полосы прокрутки создаются для просмотра текстовой области

Вызывает исключение:

HeadlessException - если GraphicsEnvironment.isHeadless возвращает true

С версии:

1.1

См. также:

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

addNotify

public void addNotify()

Создает peer для TextArea. Peer позволяет изменять внешний вид TextArea, не меняя его функциональность.

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

addNotify в классе TextComponent

См. также:

insert

public void insert(String str, int pos)

Вставляет указанный текст в указанную позицию этой текстовой области.

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

Параметры:

str — текст, не являющийся null, для вставки

pos — позиция вставки

С версии:

1.1

См. также:

insertText

@Deprecated public void insertText(String str, int pos)

Устарело.

Начиная с JDK версии 1.1 заменено на insert(String, int).

Вставляет указанный текст в указанную позицию этой текстовой области.

Параметры:: str — текст, не являющийся null, для вставки; pos — позиция вставки

append

public void append(String str)

Добавляет указанный текст в конец текущего текста текстовой области.

Параметры:

str — текст, не являющийся null, для добавления

С версии:

1.1

См. также:

appendText

@Deprecated public void appendText(String str)

Устарело.

Начиная с JDK версии 1.1 заменено на append(String).

Добавляет указанный текст в конец текущего текста текстовой области.

Параметры:: str — текст для добавления

replaceRange

public void replaceRange(String str, int start, int end)

Заменяет текст между указанными начальной и конечной позициями указанным текстом. Текст в конечной позиции не заменяется. Текст в начальной позиции заменяется (если только начальная позиция не совпадает с конечной). Позиции текста нумеруются с нуля. Длина вставляемой подстроки может отличаться от длины заменяемого текста.

Параметры:

str — текст, не являющийся null, для замены

start — начальная позиция

end — конечная позиция

С версии:

1.1

См. также:

replaceText

@Deprecated public void replaceText(String str, int start, int end)

Устарело.

Начиная с JDK версии 1.1 заменено на replaceRange(String, int, int).

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

Параметры:: str — текст, не являющийся null, для замены; start — начальная позиция; end — конечная позиция

getRows

public int getRows()

Возвращает количество строк в текстовой области.

Возвращает:

количество строк в текстовой области

С версии:

1.0

См. также:

setRows

public void setRows(int rows)

Задает количество строк для этой текстовой области.

Параметры:

rows — количество строк

Вызывает исключение:

IllegalArgumentException — если значение, переданное для rows, меньше 0

С версии:

1.1

См. также:

getColumns

public int getColumns()

Возвращает количество столбцов в этой текстовой области.

Возвращает:

количество столбцов в текстовой области

См. также:

setColumns

public void setColumns(int columns)

Задает количество столбцов для этой текстовой области.

Параметры:

columns — количество столбцов

Вызывает исключение:

IllegalArgumentException — если значение, переданное для columns, меньше 0

С версии:

1.1

См. также:

getScrollbarVisibility

public int getScrollbarVisibility()

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

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

Возвращает:

целое число, указывающее, какие полосы прокрутки используются

С версии:

1.1

См. также:

getPreferredSize

public Dimension getPreferredSize(int rows, int columns)

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

Параметры:

rows — количество строк

columns — количество столбцов

Возвращает:

предпочтительные размеры, необходимые для отображения текстовой области с указанным количеством строк и столбцов

С версии:

1.1

См. также:

preferredSize

@Deprecated public Dimension preferredSize(int rows, int columns)

Устарело.

Начиная с JDK версии 1.1 заменено на getPreferredSize(int, int).

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

Параметры:: rows — количество строк; columns — количество столбцов
Возвращает:: предпочтительные размеры, необходимые для текстовой области

getPreferredSize

public Dimension getPreferredSize()

Определяет предпочтительный размер этой текстовой области.

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

getPreferredSize в классе Component

Возвращает:

предпочтительные размеры, необходимые для этой текстовой области

С версии:

1.1

См. также:

preferredSize

@Deprecated public Dimension preferredSize()

Устарело.

Начиная с JDK версии 1.1 заменено на getPreferredSize().

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

Возвращает предпочтительный размер компонента.

Переопределяет:: preferredSize в классе Component
Возвращает:: предпочтительный размер компонента

getMinimumSize

public Dimension getMinimumSize(int rows, int columns)

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

Параметры:

rows — количество строк

columns — количество столбцов

Возвращает:

минимальные размеры, необходимые для отображения текстовой области с указанным количеством строк и столбцов

С версии:

1.1

См. также:

minimumSize

@Deprecated public Dimension minimumSize(int rows, int columns)

Устарело.

Начиная с JDK версии 1.1 заменено на getMinimumSize(int, int).

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

Параметры:: rows — количество строк; columns — количество столбцов
Возвращает:: минимальный размер текстовой области

getMinimumSize

public Dimension getMinimumSize()

Определяет минимальный размер этой текстовой области.

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

getMinimumSize в классе Component

Возвращает:

предпочтительные размеры, необходимые для этой текстовой области

С версии:

1.1

См. также:

minimumSize

@Deprecated public Dimension minimumSize()

Устарело.

Начиная с JDK версии 1.1 заменено на getMinimumSize().

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

Возвращает минимальный размер этого компонента.

Переопределяет:: minimumSize в классе Component
Возвращает:: минимальный размер этого компонента

paramString

protected String paramString()

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

Переопределяет:: paramString в классе TextComponent
Возвращает:: строку параметров этой текстовой области

getAccessibleContext

public AccessibleContext getAccessibleContext()

Возвращает AccessibleContext, связанный с этим TextArea. Для текстовых областей AccessibleContext имеет вид AccessibleAWTTextArea. При необходимости создается новый экземпляр AccessibleAWTTextArea.

Определено в:: getAccessibleContext в интерфейсе Accessible
Переопределяет:: getAccessibleContext в классе TextComponent
Возвращает:: AccessibleAWTTextArea, выполняющий роль AccessibleContext этого TextArea
С версии:: 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/TextArea.html