Класс TextArea

Все реализованные интерфейсы:
ImageObserver, MenuContainer, Serializable, Accessible 
public 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 int SCROLLBARS_BOTH

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

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

Не создает и не отображает никакие полосы прокрутки для области ввода текста.
static 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()

Создаёт виджет (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)

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

Методы, объявленные в классе 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
См. также:
GraphicsEnvironment.isHeadless()

TextArea

public TextArea(String text)
         throws HeadlessException

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

Параметры:
text - текст для отображения; если text пусто, будет отображена пустая строка ""
Исключение:
HeadlessException - если GraphicsEnvironment.isHeadless возвращает true
См. также:
GraphicsEnvironment.isHeadless()

TextArea

public TextArea(int rows,
                int columns)
         throws HeadlessException

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

Параметры:
rows - количество строк
columns - количество столбцов
Исключение:
HeadlessException - если GraphicsEnvironment.isHeadless возвращает true
См. также:
GraphicsEnvironment.isHeadless()

TextArea

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

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

Параметры:
text - текст для отображения; если text пусто, будет отображена пустая строка ""
rows - количество строк
columns - количество столбцов
Исключение:
HeadlessException - если GraphicsEnvironment.isHeadless возвращает true
См. также:
GraphicsEnvironment.isHeadless()

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 пусто, будет отображена пустая строка ""
rows - количество строк; если rows меньше 0, rows устанавливается в 0
columns - количество столбцов; если columns меньше 0, columns устанавливается в 0
scrollbars - константа, определяющая, какие полосы прокрутки созданы для просмотра текстовой области
Исключение:
HeadlessException - если GraphicsEnvironment.isHeadless возвращает true
С момента:
1.1
См. также:
GraphicsEnvironment.isHeadless()

Методы

addNotify

public void addNotify()

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

Переопределяет:
addNotify в классе TextComponent
См. также:
TextComponent.removeNotify()

insert

public void insert(String str,
                   int pos)

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

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

Параметры:
str - вставляемый не-null текст
pos - позиция вставки
С:
1.1
См. также:
TextComponent.setText(java.lang.String), replaceRange(java.lang.String, int, int), append(java.lang.String)

insertText

@Deprecated
public void insertText(String str,
                       int pos)
Устарело.
Начиная с версии JDK 1.1, заменено на insert(String, int).

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

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

append

public void append(String str)

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

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

Параметры:
str - добавляемый не-null текст
С:
1.1
См. также:
insert(java.lang.String, int)

appendText

@Deprecated
public void appendText(String str)
Устарело.
Начиная с версии JDK 1.1, заменено на append(String).

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

Параметры:
str - добавляемый текст

replaceRange

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

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

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

Параметры:
str - заменяющий не-null текст
start - начальная позиция
end - конечная позиция
С:
1.1
См. также:
insert(java.lang.String, int)

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(int), getColumns()

setRows

public void setRows(int rows)

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

Параметры:
rows - количество строк
Исключения:
IllegalArgumentException - если значение, переданное для rows, меньше 0
С:
1.1
См. также:
getRows(), setColumns(int)

getColumns

public int getColumns()

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

Возвращает:
количество столбцов в текстовом поле
См. также:
setColumns(int), getRows()

setColumns

public void setColumns(int columns)

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

Параметры:
columns - количество столбцов
Исключения:
IllegalArgumentException - если значение, переданное для columns, меньше 0
С:
1.1
См. также:
getColumns(), setRows(int)

getScrollbarVisibility

public int getScrollbarVisibility()

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

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

Возвращает:
целое число, указывающее, какие полосы прокрутки используются
С:
1.1
См. также:
SCROLLBARS_BOTH, SCROLLBARS_VERTICAL_ONLY, SCROLLBARS_HORIZONTAL_ONLY, SCROLLBARS_NONE, TextArea(java.lang.String, int, int, int)

getPreferredSize

public Dimension getPreferredSize(int rows,
                                  int columns)

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

Параметры:
rows - количество строк
columns - количество столбцов
Возвращает:
предпочтительные размеры, необходимые для отображения текстового поля с заданным количеством строк и столбцов
С:
1.1
См. также:
Component.getPreferredSize()

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
См. также:
Component.getPreferredSize()

preferredSize

@Deprecated
public Dimension preferredSize()
Устарело.
Начиная с версии JDK 1.1, заменено на getPreferredSize().

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

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

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

getMinimumSize

public Dimension getMinimumSize(int rows,
                                int columns)

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

Параметры:
rows - количество строк
columns - количество столбцов
Возвращает:
минимальные размеры для отображения текстового поля с заданным количеством строк и столбцов
С:
1.1
См. также:
Component.getMinimumSize()

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
См. также:
Component.getPreferredSize()

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

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