java.awt
类 TextArea

java.lang.Object
  java.awt.Component
      java.awt.TextComponent
          java.awt.TextArea

所有已实现的接口：

ImageObserver, MenuContainer, Serializable, Accessible

public class TextArea
extends TextComponent

TextArea 对象是显示文本的多行区域。可以将它设置为允许编辑或只读。

下图显示了文本区的外观：

此文本区可以使用以下代码行来创建：

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

从以下版本开始：

JDK1.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 继承的字段

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 version 1.1 开始，由 append(String) 取代。
AccessibleContext	getAccessibleContext() 返回与此 TextArea 相关的 AccessibleContext。
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 version 1.1 开始，由 insert(String, int) 取代。
Dimension	minimumSize() 已过时。 从 JDK version 1.1 开始，由 getMinimumSize() 取代。
Dimension	minimumSize(int rows, int columns) 已过时。 从 JDK version 1.1 开始，由 getMinimumSize(int, int) 取代。
protected String	paramString() 返回表示此 TextArea 状态的字符串。
Dimension	preferredSize() 已过时。 从 JDK version 1.1 开始，由 getPreferredSize() 取代。
Dimension	preferredSize(int rows, int columns) 已过时。 从 JDK version 1.1 开始，由 getPreferredSize(int, int) 取代。
void	replaceRange(String str, int start, int end) 用指定替换文本替换指定开始位置与结束位置之间的文本。
void	replaceText(String str, int start, int end) 已过时。 从 JDK version 1.1 开始，由 replaceRange(String, int, int) 取代。
void	setColumns(int columns) 设置此文本区的列数。
void	setRows(int rows) 设置此文本区的行数。

从类 java.awt.TextComponent 继承的方法

addTextListener, enableInputMethods, getBackground, getCaretPosition, getInputMethodRequests, 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, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, 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, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, 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

创建并显示垂直和水平滚动条。

从以下版本开始：

JDK1.1

另请参见：

常量字段值

SCROLLBARS_VERTICAL_ONLY

public static final int SCROLLBARS_VERTICAL_ONLY

只创建并显示垂直滚动条。

从以下版本开始：

JDK1.1

另请参见：

常量字段值

SCROLLBARS_HORIZONTAL_ONLY

public static final int SCROLLBARS_HORIZONTAL_ONLY

只创建并显示水平滚动条。

从以下版本开始：

JDK1.1

另请参见：

常量字段值

SCROLLBARS_NONE

public static final int SCROLLBARS_NONE

不为文本区创建或显示任何滚动条。

从以下版本开始：

JDK1.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()

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

从以下版本开始：

JDK1.1

另请参见：

GraphicsEnvironment.isHeadless()

方法详细信息

addNotify

public void addNotify()

创建 TextArea 的同位体。该同位体允许修改 TextArea 的外观，而不更改其功能。

覆盖：

类 TextComponent 中的 addNotify

另请参见：

TextComponent.removeNotify()

insert

public void insert(String str,
                   int pos)

在此文本区的指定位置插入指定文本。

注意，传递 null 或不一致的参数是无效的，并且将导致不确定的行为。

参数：

str - 要插入的非 null 文本

pos - 插入的位置

从以下版本开始：

JDK1.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 version 1.1 开始，由 insert(String, int) 取代。

append

public void append(String str)

将给定文本追加到文本区的当前文本。

注意，传递 null 或不一致的参数是无效的，并且将导致不确定的行为。

参数：

str - 要追加的非 null 文本

从以下版本开始：

JDK1.1

另请参见：

insert(java.lang.String, int)

appendText

@Deprecated
public void appendText(String str)

已过时。 从 JDK version 1.1 开始，由 append(String) 取代。

replaceRange

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

用指定替换文本替换指定开始位置与结束位置之间的文本。结束处的文本不会被替换。开始位置处的文本会被替换（除非开始位置与结束位置相同）。文本位置是从零开始的。插入子字符串的长度可以与所替换文本的长度不同。

注意，传递 null 或不一致的参数是无效的，并且将导致不确定的行为。

参数：

str - 用于替换的非 null 文本

start - 开始位置

end - 结束位置

从以下版本开始：

JDK1.1

另请参见：

insert(java.lang.String, int)

replaceText

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

已过时。 从 JDK version 1.1 开始，由 replaceRange(String, int, int) 取代。

getRows

public int getRows()

返回此文本区的行数。

返回：

此文本区中的行数

从以下版本开始：

JDK1

另请参见：

setRows(int), getColumns()

setRows

public void setRows(int rows)

设置此文本区的行数。

参数：

rows - 行数

抛出：

IllegalArgumentException - 如果为 rows 提供的值小于 0

从以下版本开始：

JDK1.1

另请参见：

getRows(), setColumns(int)

getColumns

public int getColumns()

返回此文本区中的列数。

返回：

此文本区中的列数

另请参见：

setColumns(int), getRows()

setColumns

public void setColumns(int columns)

设置此文本区的列数。

参数：

columns - 列数

抛出：

IllegalArgumentException - 如果为 columns 提供的值小于 0

从以下版本开始：

JDK1.1

另请参见：

getColumns(), setRows(int)

getScrollbarVisibility

public int getScrollbarVisibility()

返回指示文本区使用何种滚动条的枚举值。

TextArea 类定义了四个整数常量，用来指定哪些滚动条是可用的。TextArea 有一个给出滚动条上的应用方向的构造方法。

返回：

指示使用哪种滚动条的整数

从以下版本开始：

JDK1.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 - 列数

返回：

显示具有指定行数和列数的文本区所需的首选尺寸

从以下版本开始：

JDK1.1

另请参见：

Component.getPreferredSize()

preferredSize

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

已过时。 从 JDK version 1.1 开始，由 getPreferredSize(int, int) 取代。

getPreferredSize

public Dimension getPreferredSize()

确定此文本区的首选大小。

覆盖：

类 Component 中的 getPreferredSize

返回：

此文本区所需的首选尺寸

从以下版本开始：

JDK1.1

另请参见：

Component.getPreferredSize()

preferredSize

@Deprecated
public Dimension preferredSize()

已过时。 从 JDK version 1.1 开始，由 getPreferredSize() 取代。

覆盖：

类 Component 中的 preferredSize

getMinimumSize

public Dimension getMinimumSize(int rows,
                                int columns)

确定具有指定行数和列数的文本区的最小大小。

参数：

rows - 行数

columns - 列数

返回：

显示具有指定行数和列数的文本区所需的最小尺寸

从以下版本开始：

JDK1.1

另请参见：

Component.getMinimumSize()

minimumSize

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

已过时。 从 JDK version 1.1 开始，由 getMinimumSize(int, int) 取代。

getMinimumSize

public Dimension getMinimumSize()

确定此文本区的最小大小。

覆盖：

类 Component 中的 getMinimumSize

返回：

此文本区所需的首选尺寸

从以下版本开始：

JDK1.1

另请参见：

Component.getPreferredSize()

minimumSize

@Deprecated
public Dimension minimumSize()

已过时。 从 JDK version 1.1 开始，由 getMinimumSize() 取代。

覆盖：

类 Component 中的 minimumSize

paramString

protected String paramString()

返回表示此 TextArea 状态的字符串。此方法仅用于调试目的，对于各个实现，返回的字符串的内容和格式可能有所不同。返回的字符串可能为空，但不可能为 null。

覆盖：

类 TextComponent 中的 paramString

返回：

此文本区的参数字符串

getAccessibleContext

public AccessibleContext getAccessibleContext()

返回与此 TextArea 相关的 AccessibleContext。对于文本区，AccessibleContext 采用 AccessibleAWTTextArea 的形式。如有必要，可创建一个新的 AccessibleAWTTextArea 实例。

指定者：

接口 Accessible 中的 getAccessibleContext

覆盖：

类 TextComponent 中的 getAccessibleContext

返回：

用作此 TextArea 的 AccessibleContext 的 AccessibleAWTTextArea

从以下版本开始：

1.3