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

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

TextComponent.AccessibleAWTTextComponent

Вложенные классы/интерфейсы, объявленные в классе java.awt.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`	Создаёт и отображает только вертикальную полосу прокрутки.

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

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

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

Конструктор	Описание
`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()`	Создаёт виджет-представитель `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)`	Устанавливает количество строк для этой области ввода текста.

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

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

Методы, объявленные в классе 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, 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

Методы, объявленные в классе java.lang.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()

Создаёт виджет-представителя для TextArea. Представитель позволяет изменять внешний вид TextArea без изменения его функциональности.

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

addNotify в классе TextComponent

См. также:

insert

public void insert(String str, int pos)

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

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

Параметры:

str - текст для вставки

pos - позиция для вставки

С момента:

1.1

См. также:

insertText

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

Устарело.

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

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

Параметры:: str - текст для вставки; pos - позиция для вставки

append

public void append(String str)

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

Параметры:

str - текст для добавления

С момента:

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)

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

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

Parameters:

str - текст замены

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

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

Since:

1.1

See Also:

replaceText

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

Устарело.

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

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

Parameters:: str - текст замены; start - начальная позиция; end - конечная позиция

getRows

public int getRows()

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

Returns:

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

Since:

1.0

See Also:

setRows

public void setRows(int rows)

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

Parameters:

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

Throws:

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

Since:

1.1

See Also:

getColumns

public int getColumns()

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

Returns:

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

See Also:

setColumns

public void setColumns(int columns)

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

Parameters:

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

Throws:

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

Since:

1.1

See Also:

getScrollbarVisibility

public int getScrollbarVisibility()

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

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

Returns:

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

Since:

1.1

See Also:

getPreferredSize

public Dimension getPreferredSize(int rows, int columns)

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

Parameters:

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

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

Returns:

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

Since:

1.1

See Also:

preferredSize

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

Устарело.

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

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

Parameters:: rows - количество строк; columns - количество столбцов
Returns:: предпочтительные размеры для текстовой области

getPreferredSize

public Dimension getPreferredSize()

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

Overrides:

getPreferredSize в классе Component

Returns:

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

Since:

1.1

See Also:

preferredSize

@Deprecated public Dimension preferredSize()

Устарело.

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

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

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

Overrides:: preferredSize в классе Component
Returns:: предпочтительный размер компонента

getMinimumSize

public Dimension getMinimumSize(int rows, int columns)

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

Parameters:

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

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

Returns:

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

Since:

1.1

See Also:

minimumSize

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

Устарело.

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

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

Parameters:: rows - количество строк; columns - количество столбцов
Returns:: минимальный размер текстовой области

getMinimumSize

public Dimension getMinimumSize()

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

Overrides:

getMinimumSize в классе Component

Returns:

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

Since:

1.1

See Also:

minimumSize

@Deprecated public Dimension minimumSize()

Устарело.

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

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

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

Overrides:: minimumSize в классе Component
Returns:: минимальный размер этого компонента

paramString

protected String paramString()

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

Overrides:: paramString в классе TextComponent
Returns:: строка параметров этой текстовой области

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://download.java.net/java/early_access/jdk24/docs/api/java.desktop/java/awt/TextArea.html