Spec-Zone.ru › OpenJDK 21

Класс TextArea

java.lang.Object
java.awt.Component
java.awt.TextComponent
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
См. также:
  • GraphicsEnvironment.isHeadless()

TextArea

public TextArea(String text) throws HeadlessException
Создаёт новую область ввода текста со заданным текстом. Эта область ввода создаётся со видимостью полос прокрутки, равной SCROLLBARS_BOTH, поэтому и вертикальные, и горизонтальные полосы прокрутки будут видны для этой области ввода текста.
Параметры:
text - текст, который должен быть отображён; если text является null, будет отображена пустая строка ""
Исключения:
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 является null, будет отображена пустая строка ""
rows - количество строк
columns - количество столбцов
Исключения:
HeadlessException - если GraphicsEnvironment.isHeadless возвращает true
См. также:
  • GraphicsEnvironment.isHeadless()

Текстовая область

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
См. также:
  • GraphicsEnvironment.isHeadless()

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

addNotify

public void addNotify()
Создаёт виджет (peer) для TextArea. Виджет позволяет изменять внешний вид TextArea без изменения его функциональности.
Переопределяет:
addNotify в классе TextComponent
См. также:
  • TextComponent.removeNotify()

вставить

public void insert(String str, int pos)
Вставляет указанный текст в указанную позицию в этой области текста.

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

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

вставитьТекст

@Deprecated public void insertText(String str, int pos)
Устарело.
Начиная с версии JDK 1.1, заменено на insert(String, int).
Вставляет указанный текст в указанную позицию в этой области текста.
Параметры:
str - вставляемый текст
pos - позиция для вставки

добавить

public void append(String str)
Добавляет указанный текст к текущему тексту области текста.

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

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

добавитьТекст

@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:
  • insert(java.lang.String, int)

replaceText

@Deprecated public void replaceText(String str, int start, int end)
Deprecated.
С версии JDK 1.1 заменено на replaceRange(String, int, int).
Заменяет диапазон символов между указанными начальной и конечной позициями на указанный текст замены (текст в конечной позиции не будет заменён).
Parameters:
str - текст замены
start - начальная позиция
end - конечная позиция

getRows

public int getRows()
Возвращает количество строк в области текста.
Returns:
количество строк в области текста
Since:
1.0
See Also:
  • 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.
Overrides:
paramString в классе TextComponent
Возвращает:
строку параметров этого текстового поля

getAccessibleContext

public AccessibleContext getAccessibleContext()
Возвращает AccessibleContext, связанный с этим TextArea. Для текстовых областей AccessibleContext представлен в виде AccessibleAWTTextArea. Новый экземпляр AccessibleAWTTextArea создаётся при необходимости.
Specified by:
getAccessibleContext в интерфейсе Accessible
Overrides:
getAccessibleContext в классе TextComponent
Возвращает:
AccessibleAWTTextArea, который служит AccessibleContext этого TextArea
Since:
1.3

© 1993, 2023, 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/21/docs/api/java.desktop/java/awt/TextArea.html

Spec-Zone.ru

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