javax.swing

Class JTextPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JEditorPane

javax.swing.JTextPane

All Implemented Interfaces:

ImageObserver ， MenuContainer ， Serializable ， Accessible ， Scrollable

public class JTextPane
extends JEditorPane

可以用图形化的属性标记的文本组件。 您可以在Using Text Components （Java教程中的一节）中找到使用文本窗格的操作方法信息和示例。

该组件模拟由字符级属性运行组成的段落。 每个段落可能具有连接到其上的逻辑风格，其中包含默认属性，如果不被该段落或字符运行时设置的属性覆盖，则使用默认属性。 组件和图像可能嵌入在文本流中。

新线

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

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

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

另请参见：

StyledEditorKit

Nested Class Summary

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

JEditorPane.AccessibleJEditorPane, JEditorPane.AccessibleJEditorPaneHTML, JEditorPane.JEditorPaneAccessibleHypertextSupport

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.JEditorPane

HONOR_DISPLAY_PROPERTIES, W3C_LENGTH_UNITS

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
JTextPane() 创建一个新的 JTextPane 。
JTextPane(StyledDocument doc) 创建一个新的 JTextPane ，具有指定的文档模型。

方法摘要

Modifier and Type	Method and Description
Style	addStyle(String nm, Style parent) 在逻辑样式层次结构中添加新样式。
protected EditorKit	createDefaultEditorKit() 创建默认使用的 EditorKit 。
AttributeSet	getCharacterAttributes() 获取在插入符号的当前位置生效的字符 null ，或 null 。
MutableAttributeSet	getInputAttributes() 获取窗格的输入属性。
Style	getLogicalStyle() 获取分配给由插入符号的当前位置表示的段落的逻辑样式，或 null 。
AttributeSet	getParagraphAttributes() 获取当前段落属性在插入符号的位置，或 null如果没有）。
Style	getStyle(String nm) 获取以前添加的命名非 null样式。
StyledDocument	getStyledDocument() 获取与编辑器相关联的模型。
protected StyledEditorKit	getStyledEditorKit() 获得编辑工具包。
String	getUIClassID() 返回UI的类ID。
void	insertComponent(Component c) 将组件插入到文档中作为当前所选内容的替代。
void	insertIcon(Icon g) 将图标插入到文档中作为当前所选内容的替代。
protected String	paramString() 返回此 JTextPane的字符串表示 JTextPane 。
void	removeStyle(String nm) 删除以前添加到文档的命名非 null样式。
void	replaceSelection(String content) 用给定字符串表示的新内容替换当前所选内容。
void	setCharacterAttributes(AttributeSet attr, boolean replace) 将给定的属性应用于字符内容。
void	setDocument(Document doc) 将编辑器与文本文档相关联。
void	setEditorKit(EditorKit kit) 设置当前安装的工具包来处理内容。
void	setLogicalStyle(Style s) 设置用于当前插入符位置的段落的逻辑样式。
void	setParagraphAttributes(AttributeSet attr, boolean replace) 将给定的属性应用于段落。
void	setStyledDocument(StyledDocument doc) 将编辑器与文本文档相关联。

Methods inherited from class javax.swing.JEditorPane

addHyperlinkListener, createEditorKitForContentType, fireHyperlinkUpdate, getAccessibleContext, getContentType, getEditorKit, getEditorKitClassNameForContentType, getEditorKitForContentType, getHyperlinkListeners, getPage, getPreferredSize, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getStream, getText, read, registerEditorKitForContentType, registerEditorKitForContentType, removeHyperlinkListener, scrollToReference, setContentType, setEditorKitForContentType, setPage, setPage, setText

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, getPreferredScrollableViewportSize, getPrintable, getScrollableBlockIncrement, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, print, print, print, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, 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, setFont, 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

构造方法详细信息

JTextPane

public JTextPane()

创建一个新的JTextPane 。 创建并设置了一个新的StyledEditorKit实例，并将文档模型设置为null 。

JTextPane

public JTextPane(StyledDocument doc)

创建一个新的JTextPane ，具有指定的文档模型。 创建并设置了一个新的javax.swing.text.StyledEditorKit实例。

参数

doc - 文件模型

方法详细信息

getUIClassID

public String getUIClassID()

返回UI的类ID。

重写：

getUIClassID在 JEditorPane

结果

字符串“TextPaneUI”

另请参见：

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

setDocument

public void setDocument(Document doc)

将编辑器与文本文档相关联。 这必须是StyledDocument 。

重写：

setDocument在 JTextComponent

参数

doc - 要显示/编辑的文档

异常

IllegalArgumentException - 如果 doc不能缩小为 StyledDocument ，这是此文本组件所需的模型类型

另请参见：

JTextComponent.getDocument()

setStyledDocument

public void setStyledDocument(StyledDocument doc)

将编辑器与文本文档相关联。 当前注册的工厂用于构建文档的视图，由编辑器显示。

参数

doc - 要显示/编辑的文档

getStyledDocument

public StyledDocument getStyledDocument()

获取与编辑器相关联的模型。

结果

该模型

replaceSelection

public void replaceSelection(String content)

用给定字符串表示的新内容替换当前所选内容。 如果没有选择，这相当于给定文本的插入。 如果没有替换文本，则相当于删除当前选择。 替换文本将具有当前为插入点定义的输入属性。 如果文档不可编辑，则发出哔声并返回。

重写：

replaceSelection在 JEditorPane

参数

content - 用于替换选择的内容

insertComponent

public void insertComponent(Component c)

将组件插入到文档中作为当前所选内容的替代。 如果没有选择，组件将有效地插入到插入符号的当前位置。 这在相关联的文档中被表示为内容的一个字符的属性。

给出的组件是JTextPane使用的实际组件。 由于组件不能是多个容器的子级，所以在模型由文本组件共享的情况下不应使用此方法。

该组件是根据返回的值，以相对于文本基线放置Component.getAlignmentY 。 对于Swing组件，可以使用方法JComponent.setAlignmentY方便地设置该值。 例如，设置值为0.75将导致75％的组件高于基线，25％的组件将低于基线。

参数

c - 要插入的组件

insertIcon

public void insertIcon(Icon g)

将图标插入到文档中作为当前所选内容的替代。 如果没有选择，图标将有效插入插入符号的当前位置。 这在相关联的文档中被表示为内容的一个字符的属性。

参数

g - 要插入的图标

另请参见：

Icon

addStyle

public Style addStyle(String nm,
                      Style parent)

在逻辑样式层次结构中添加新样式。 样式属性从下到上解析，因此在孩子中指定的属性将覆盖父项中指定的属性。

参数

nm - 样式的名称（在命名样式的集合中必须是唯一的）。 如果样式未命名，则名称可能为null ，但是调用者负责管理返回的引用，因为未命名的样式无法通过名称获取。 一个未命名的样式可能对于诸如字符属性覆盖（例如在样式运行中找到）的事情是有用的。

parent - 父风格。 这可能是null如果未指定的属性不需要解决某些其他风格。

结果

新的 Style

removeStyle

public void removeStyle(String nm)

删除以前添加到文档的命名非 null样式。

参数

nm - 要删除的样式的名称

getStyle

public Style getStyle(String nm)

获取以前添加的一个名为非 null样式。

参数

nm - 风格的名称

结果

Style

setLogicalStyle

public void setLogicalStyle(Style s)

设置用于当前插入符位置的段落的逻辑样式。 如果没有为字符和段落属性显式设置属性，则它们将通过分配给段落的逻辑样式来解析，该段落可以通过某些层次结构完全独立于文档中的元素层次结构来解析。

参数

s - 分配给 s的逻辑风格，或没有风格的 null

getLogicalStyle

public Style getLogicalStyle()

获取分配给由插入符号的当前位置表示的段落的逻辑样式，或 null 。

结果

Style

getCharacterAttributes

public AttributeSet getCharacterAttributes()

获取在插入符号的当前位置有效的字符 null ，或 null 。

结果

属性，或 null

setCharacterAttributes

public void setCharacterAttributes(AttributeSet attr,
                                   boolean replace)

将给定的属性应用于字符内容。 如果有选择，属性将应用于选择范围。 如果没有选择，属性将应用于输入属性集，该属性集定义了任何插入的新文本的属性。

参数

attr - 属性

replace - 如果为true，则先替换现有属性

getParagraphAttributes

public AttributeSet getParagraphAttributes()

获取当前段落属性在插入符号的位置，或 null如果没有）。

结果

属性

setParagraphAttributes

public void setParagraphAttributes(AttributeSet attr,
                                   boolean replace)

将给定的属性应用于段落。 如果有选择，属性将应用于与选择相交的段落。 如果没有选择，属性将应用于当前插入符位置的段落。

参数

attr - 非 null属性

replace - 如果为true，请先替换现有属性

getInputAttributes

public MutableAttributeSet getInputAttributes()

获取窗格的输入属性。

结果

属性

getStyledEditorKit

protected final StyledEditorKit getStyledEditorKit()

获得编辑工具包。

结果

编辑工具包

createDefaultEditorKit

protected EditorKit createDefaultEditorKit()

创建默认使用的EditorKit 。 这是实现返回javax.swing.text.StyledEditorKit 。

重写：

createDefaultEditorKit在 JEditorPane

结果

编辑工具包

setEditorKit

public final void setEditorKit(EditorKit kit)

设置当前安装的工具包来处理内容。 这是建立编辑器的内容类型的bound属性。

重写：

setEditorKit在 JEditorPane

参数

kit - 所需的编辑器行为

异常

IllegalArgumentException - 如果套件不是 StyledEditorKit

另请参见：

JEditorPane.getEditorKit()

paramString

protected String paramString()

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

重写：

paramString在 JEditorPane

结果

这个 JTextPane的字符串表示 JTextPane