Spec-Zone.ru › OpenJDK 17

Класс TextArea

java.lang.Object
java.awt.Component
java.awt.TextComponent
java.awt.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 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
Создаёт и отображает вертикальную и горизонтальную полосы прокрутки.
Since:
1.1
См. также:
  • Значения константного поля

SCROLLBARS_VERTICAL_ONLY

public static final int SCROLLBARS_VERTICAL_ONLY
Создаёт и отображает только вертикальную полосу прокрутки.
Since:
1.1
См. также:
  • Значения константного поля

SCROLLBARS_HORIZONTAL_ONLY

public static final int SCROLLBARS_HORIZONTAL_ONLY
Создаёт и отображает только горизонтальную полосу прокрутки.
Since:
1.1
См. также:
  • Значения константного поля

SCROLLBARS_NONE

public static final int SCROLLBARS_NONE
Не создаёт и не отображает полосы прокрутки для текстовой области.
Since:
1.1
См. также:
  • Значения константного поля

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

TextArea

public TextArea() throws HeadlessException
Создаёт новую текстовую область с пустой строкой в качестве текста. Эта текстовая область создаётся с видимостью полос прокрутки, равной SCROLLBARS_BOTH, поэтому для этой текстовой области будут видны обе полосы прокрутки: вертикальная и горизонтальная.
Throws:
HeadlessException - если GraphicsEnvironment.isHeadless возвращает true
См. также:
  • GraphicsEnvironment.isHeadless()

TextArea

public TextArea(String text) throws HeadlessException
Создаёт новую текстовую область со заданным текстом. Эта текстовая область создаётся с видимостью полос прокрутки, равной SCROLLBARS_BOTH, поэтому для этой текстовой области будут видны обе полосы прокрутки: вертикальная и горизонтальная.
Параметры:
text - текст для отображения; если text является null, будет отображаться пустая строка ""
Throws:
HeadlessException - если GraphicsEnvironment.isHeadless возвращает true
См. также:
  • GraphicsEnvironment.isHeadless()

TextArea

public TextArea(int rows, int columns) throws HeadlessException
Создаёт новую текстовую область с заданным количеством строк и столбцов и пустой строкой в качестве текста. Столбец — это приблизительная средняя ширина символа, зависящая от платформы. Текстовая область создаётся с видимостью полос прокрутки, равной SCROLLBARS_BOTH, поэтому для этой текстовой области будут видны обе полосы прокрутки: вертикальная и горизонтальная.
Параметры:
rows - количество строк
columns - количество столбцов
Throws:
HeadlessException - если GraphicsEnvironment.isHeadless возвращает true
См. также:
  • GraphicsEnvironment.isHeadless()

TextArea

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

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

addNotify

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

insert

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

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

Параметры:
str - текст для вставки
pos - позиция для вставки
Since:
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 - текст для вставки
pos - позиция для вставки

append

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

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

Параметры:
str - текст для добавления
Since:
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 - текст для замены
start - начальная позиция
end - конечная позиция
Since:
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 - текст, используемый в качестве замены
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, 2021, 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/17/docs/api/java.desktop/java/awt/TextArea.html

Spec-Zone.ru

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