javax.swing

Class JTextArea

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JTextArea

All Implemented Interfaces:

ImageObserver ， MenuContainer ， Serializable ， Accessible ， Scrollable

public class JTextArea
extends JTextComponent

JTextArea是显示纯文本的多行区域。 它旨在成为一个轻量级组件，可以与java.awt.TextArea类合作来提供源兼容性。 你可以找到信息，并使用所有文本组件的例子Using Text Components ，在Java教程的部分。

该组件具有java.awt.TextArea类中找不到的java.awt.TextArea 。 应咨询超类以获得更多功能。 具有更多功能的替代多行文本课程是JTextPane和JEditorPane 。

java.awt.TextArea内部处理滚动。 JTextArea的不同之处在于它不管理滚动，而是实现了swing Scrollable界面。 如果需要滚动行为，则允许将其放置在JScrollPane内，如果不需要滚动则直接使用。

java.awt.TextArea具有进行线包装的能力。 这是由水平滚动政策控制的。 由于滚动不是直接由JTextArea完成， JTextArea向后兼容性必须另外提供。 JTextArea具有用于线条换行的绑定属性，用于控制是否将换行。 默认情况下，换行属性设置为false（不包装）。

java.awt.TextArea具有用于确定优选大小的两个属性rows和columns 。 JTextArea使用这些属性来表示当放置在JScrollPane以匹配java.awt.TextArea提供的java.awt.TextArea时视口的首选大小。 JTextArea有需要显示的所有文本，使其正常功能的里面有什么较好大小JScrollPane 。 如果rows或columns的值等于零，则沿该轴的优选尺寸用于沿相同轴的视口优选尺寸。

java.awt.TextArea可以通过为TextEvent添加一个TextListener来TextEvent变化。 在JTextComponent基组分，更改从模型经由广播DocumentEvent至DocumentListeners 。 如果需要， DocumentEvent给出了更改的位置和更改的种类。 代码片段可能如下所示：

  DocumentListener myListener = ??;
    JTextArea myArea = ??;
    myArea.getDocument().addDocumentListener(myListener); 

新线

有关如何处理换行符的讨论，请参阅DefaultEditorKit 。

警告： Swing不是线程安全的。 有关更多信息，请参阅Swing's Threading Policy 。

警告：此类的序列化对象与将来的Swing版本不兼容。 当前的序列化支持适用于运行相同版本的Swing的应用程序之间的短期存储或RMI。 从1.4开始，支持所有JavaBeans的长期存储已经添加到java.beans包中。 请参阅XMLEncoder 。

另请参见：

JTextPane ， JEditorPane

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	JTextArea.AccessibleJTextArea 这个类实现了可访问性支持 JTextArea类。

Nested classes/interfaces inherited from class javax.swing.text.JTextComponent

JTextComponent.AccessibleJTextComponent, JTextComponent.DropLocation, JTextComponent.KeyBinding

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.text.JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

构造方法摘要

构造方法

Constructor and Description
JTextArea() 构造一个新的TextArea。
JTextArea(Document doc) 使用给定的文档模型构造一个新的JTextArea，默认为所有其他参数（null，0，0）。
JTextArea(Document doc, String text, int rows, int columns) 构造具有指定行数和列数的新JTextArea以及给定模型。
JTextArea(int rows, int columns) 构造具有指定行数和列数的新的空TextArea。
JTextArea(String text) 构造一个新的TextArea，并显示指定的文本。
JTextArea(String text, int rows, int columns) 构造具有指定文本和行数和列数的新TextArea。

方法摘要

Modifier and Type	Method and Description
void	append(String str) 将给定的文本附加到文档的末尾。
protected Document	createDefaultModel() 如果没有明确给出，则创建要在构建中使用的模型的默认实现。
AccessibleContext	getAccessibleContext() 获取与此JTextArea关联的AccessibleContext。
int	getColumns() 返回TextArea中的列数。
protected int	getColumnWidth() 获取列宽。
int	getLineCount() 确定该区域中包含的行数。
int	getLineEndOffset(int line) 确定给定行末端的偏移量。
int	getLineOfOffset(int offset) 将偏移量转换为组件文本为行号。
int	getLineStartOffset(int line) 确定给定行开始的偏移量。
boolean	getLineWrap() 获取文本区域的换行政策。
Dimension	getPreferredScrollableViewportSize() 如果此组件嵌入在JScrollPane中，则返回视口的首选大小。
Dimension	getPreferredSize() 返回TextArea的首选大小。
protected int	getRowHeight() 定义一行高度的含义。
int	getRows() 返回TextArea中的行数。
boolean	getScrollableTracksViewportWidth() 如果视口应始终强制此Scrollable的宽度与视口的宽度相匹配，则返回true。
int	getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction) 显示逻辑行或列的组件应计算将根据取向值完全暴露一个新行或列的滚动增量。
int	getTabSize() 获取用于扩展选项卡的字符数。
String	getUIClassID() 返回UI的类ID。
boolean	getWrapStyleWord() 如果文本区域是包装线，则获取使用的包装样式。
void	insert(String str, int pos) 在指定的位置插入指定的文本。
protected String	paramString() 返回此JTextArea的字符串表示形式。
void	replaceRange(String str, int start, int end) 用指定的新文本替换指定的开始到结束位置的文本。
void	setColumns(int columns) 设置此TextArea的列数。
void	setFont(Font f) 设置当前字体。
void	setLineWrap(boolean wrap) 设置文本区域的换行策略。
void	setRows(int rows) 设置此TextArea的行数。
void	setTabSize(int size) 设置扩展标签的字符数。
void	setWrapStyleWord(boolean word) 如果文本区域是包装线，则设置使用的包装样式。

Methods inherited from class javax.swing.text.JTextComponent

addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getActions, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPrintable, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, print, print, print, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDocument, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, write

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

构造方法详细信息

JTextArea

public JTextArea()

构造一个新的TextArea。 设置默认模型，初始字符串为空，行/列设置为0。

JTextArea

public JTextArea(String text)

构造一个新的TextArea，并显示指定的文本。 创建默认模型，并将行/列设置为0。

参数

text - 要显示的文本，或null

JTextArea

public JTextArea(int rows,
                 int columns)

构造具有指定行数和列数的新的空TextArea。 创建默认模型，初始字符串为空。

参数

rows - 行数= 0

columns - 列数> = 0

异常

IllegalArgumentException - 如果行或列参数为负。

JTextArea

public JTextArea(String text,
                 int rows,
                 int columns)

构造具有指定文本和行数和列数的新TextArea。 创建默认模型。

参数

text - 要显示的文本，或null

rows - 行数= 0

columns - 列数> = 0

异常

IllegalArgumentException - 如果行或列参数为负。

JTextArea

public JTextArea(Document doc)

使用给定的文档模型构造一个新的JTextArea，默认为所有其他参数（null，0，0）。

参数

doc - 使用的型号

JTextArea

public JTextArea(Document doc,
                 String text,
                 int rows,
                 int columns)

构造具有指定行数和列数的新JTextArea以及给定模型。 所有的构造函数都通过这个构造函数。

参数

doc - 要使用的模型，或者如果为null，则创建一个默认模型

text - 要显示的文本，如果没有，则为null

rows - 行数= 0

columns - 列数> = 0

异常

IllegalArgumentException - 如果行或列参数为负。

方法详细信息

getUIClassID

public String getUIClassID()

返回UI的类ID。

重写：

getUIClassID在 JComponent

结果

ID（“TextAreaUI”）

另请参见：

JComponent.getUIClassID() ， UIDefaults.getUI(javax.swing.JComponent)

createDefaultModel

protected Document createDefaultModel()

如果没有明确给出，则创建要在构建中使用的模型的默认实现。 返回一个新的PlainDocument实例。

结果

默认文档模型

setTabSize

public void setTabSize(int size)

设置扩展标签的字符数。 这将乘以可变宽度字体的最大提前。 当选项卡大小更改时，将会触发PropertyChange事件（“tabSize”）。

参数

size - 要扩展的 size数

另请参见：

getTabSize()

getTabSize

public int getTabSize()

获取用于扩展选项卡的字符数。 如果文档为空或没有制表符设置，则返回默认值8。

结果

字符数

setLineWrap

public void setLineWrap(boolean wrap)

设置文本区域的换行策略。 如果设置为true，则如果它们太长而不适合分配的宽度，则这些行将被包装。 如果设置为false，这些行将始终被展开。 当策略被更改时， PropertyChange事件（“lineWrap”）被触发。 默认情况下，此属性为false。

参数

wrap - 表示是否应该包装线

另请参见：

getLineWrap()

getLineWrap

public boolean getLineWrap()

获取文本区域的换行政策。 如果设置为true，则如果它们太长而不适合分配的宽度，则这些行将被包装。 如果设置为false，这些行将始终被展开。

结果

如果线条将被包裹

setWrapStyleWord

public void setWrapStyleWord(boolean word)

如果文本区域是包装线，则设置使用的包装样式。 如果设置为true，则如果它们太长而不能在分配的宽度内，那么这些行将被包围在字边界（空格）中。 如果设置为false，则行将被包裹在字符边界。 默认情况下，此属性为false。

参数

word - 表示是否应使用字边界进行换行

另请参见：

getWrapStyleWord()

getWrapStyleWord

public boolean getWrapStyleWord()

如果文本区域是包装线，则获取使用的包装样式。 如果设置为true，则如果它们太长而不能在分配的宽度内，则这些行将被包裹在字边界（即空格）处。 如果设置为false，则行将被包裹在字符边界。

结果

如果包装样式应该是字边界而不是字符边界

另请参见：

setWrapStyleWord(boolean)

getLineOfOffset

public int getLineOfOffset(int offset)
                    throws BadLocationException

将偏移量转换为组件文本为行号。

参数

offset - offset> = 0

结果

行号> = 0

异常

BadLocationException - 如果偏移小于零或大于文档长度，则抛出。

getLineCount

public int getLineCount()

确定该区域中包含的行数。

结果

行数> 0

getLineStartOffset

public int getLineStartOffset(int line)
                       throws BadLocationException

确定给定行开始的偏移量。

参数

line - 要翻译的行号> = 0

结果

offset> = 0

异常

BadLocationException - 如果行小于零或更大或等于文档中包含的行数（由getLineCount报告），则抛出。

getLineEndOffset

public int getLineEndOffset(int line)
                     throws BadLocationException

确定给定行末端的偏移量。

参数

line - 行> = 0

结果

offset> = 0

异常

BadLocationException - 如果行小于零或更大或等于文档中包含的行数（由getLineCount报告），则抛出。

insert

public void insert(String str,
                   int pos)

在指定的位置插入指定的文本。 如果模型为空或文本为空或为空，则不执行任何操作。

参数

str - 要插入的文本

pos - 要插入的位置> = 0

异常

IllegalArgumentException - 如果pos是模型中的无效位置

另请参见：

TextComponent.setText(java.lang.String) ， replaceRange(java.lang.String, int, int)

append

public void append(String str)

将给定的文本附加到文档的末尾。 如果模型为空或字符串为空或为空，则不执行任何操作。

参数

str - 要插入的文本

另请参见：

insert(java.lang.String, int)

replaceRange

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

用指定的新文本替换指定的开始到结束位置的文本。 如果模型为空，则不做任何操作。 如果新的字符串为空或为空，只需删除。

参数

str - 用作替代的文本

start - 起始位置> = 0

end - 结束位置> =开始

异常

IllegalArgumentException - 如果范围的一部分是模型中的无效位置

另请参见：

insert(java.lang.String, int) ， replaceRange(java.lang.String, int, int)

getRows

public int getRows()

返回TextArea中的行数。

结果

行数= 0

setRows

public void setRows(int rows)

设置此TextArea的行数。 在设置新值后调用invalidate（）。

参数

rows - 行数= 0

异常

IllegalArgumentException - 如果行小于0

另请参见：

getRows()

getRowHeight

protected int getRowHeight()

定义一行高度的含义。 这默认为字体的高度。

结果

高度> = 1

getColumns

public int getColumns()

返回TextArea中的列数。

结果

列数= 0

setColumns

public void setColumns(int columns)

设置此TextArea的列数。 设置新值后，invalidate（）。

参数

columns - 列数> = 0

异常

IllegalArgumentException - 如果列小于0

另请参见：

getColumns()

getColumnWidth

protected int getColumnWidth()

获取列宽。 什么是列的意思可以被认为是一些相当弱的概念的一些字体。 此方法用于定义列的宽度。 默认情况下，这被定义为使用的字体的字符m的宽度。 这种方法可以重新定义为一些替代量。

结果

列宽> = 1

getPreferredSize

public Dimension getPreferredSize()

返回TextArea的首选大小。 这是显示文本所需大小的最大值和视口所请求的大小。

重写：

getPreferredSize在类 JComponent

结果

尺寸

另请参见：

JComponent.setPreferredSize(java.awt.Dimension) ， ComponentUI

setFont

public void setFont(Font f)

设置当前字体。 这将删除缓存的行高和列宽，以便反映新字体，并调用revalidate（）。

重写：

setFont在 JComponent

参数

f - 用作当前字体的字体

另请参见：

Component.getFont()

paramString

protected String paramString()

返回此JTextArea的字符串表示形式。 该方法仅用于调试目的，并且返回的字符串的内容和格式可能因实现而异。 返回的字符串可能为空，但可能不是null 。

重写：

paramString在 JTextComponent类

结果

这个JTextArea的字符串表示形式。

getScrollableTracksViewportWidth

public boolean getScrollableTracksViewportWidth()

如果视口应始终强制此Scrollable的宽度与视口的宽度相匹配，则返回true。 如果行换行策略为true，则实现返回true，如果行未被包装，则返回false。

Specified by:

getScrollableTracksViewportWidth在接口 Scrollable

重写：

getScrollableTracksViewportWidth在 JTextComponent

结果

如果视口应强制Scrollables宽度与其自身匹配，则为true。

getPreferredScrollableViewportSize

public Dimension getPreferredScrollableViewportSize()

如果此组件嵌入在JScrollPane中，则返回视口的首选大小。 如果设置了这些列和行设置，则使用所需的列和行设置，否则将使用超类行为。

Specified by:

getPreferredScrollableViewportSize在接口 Scrollable

重写：

getPreferredScrollableViewportSize在 JTextComponent

结果

JViewport的preferredSize的视图是此Scrollable。

另请参见：

JComponent.getPreferredSize()

getScrollableUnitIncrement

public int getScrollableUnitIncrement(Rectangle visibleRect,
                                      int orientation,
                                      int direction)

显示逻辑行或列的组件应计算将根据取向值完全暴露一个新行或列的滚动增量。 这被实现为使用getRowHeight和getColumnWidth方法返回的值。

滚动容器（如JScrollPane）将在用户请求单位滚动时使用此方法。

Specified by:

getScrollableUnitIncrement在界面 Scrollable

重写：

getScrollableUnitIncrement在 JTextComponent

参数

visibleRect - 在视口内可见的视图区域

orientation - SwingConstants.VERTICAL或SwingConstants.HORIZONTAL。

direction - 向上/向左滚动小于0，向下/向右大于零。

结果

在指定方向滚动的“单位”增量

异常

IllegalArgumentException - 针对无效的方向

另请参见：

JScrollBar.setUnitIncrement(int) ， getRowHeight() ， getColumnWidth()

getAccessibleContext

public AccessibleContext getAccessibleContext()

获取与此JTextArea关联的AccessibleContext。 对于JTextAreas，AccessibleContext采用AccessibleJTextArea的形式。 如有必要，将创建一个新的AccessibleJTextArea实例。

Specified by:

getAccessibleContext在接口 Accessible

重写：

getAccessibleContext在 JTextComponent

结果

一个AccessibleJTextArea作为这个JTextArea的AccessibleContext