javax.swing
類別 JTextPane

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.text.JTextComponent
                  javax.swing.JEditorPane
                      javax.swing.JTextPane

所有已實作的介面：

ImageObserver, MenuContainer, Serializable, Accessible, Scrollable

public class JTextPane
extends JEditorPane

可以用以圖形方式表示的屬性來標記的文本元件。有關使用文本窗格的 how-to 資訊和範例，請參閱 The Java Tutorial 中的 Using Text Components 一節。

此元件模仿了由一串字元級屬性組成的段落。每個段落都可能有一個附加的邏輯樣式，如果預設屬性沒有通過段落上的屬性集或一串字元覆寫，則此樣式包含要使用的預設屬性。元件和圖像可以嵌入在文本串流中。

換行

有關如果處理換行的討論，請參閱 DefaultEditorKit。

警告：Swing 不是執行緒安全的。有關更多資訊，請參閱　Swing's Threading Policy。

警告：此類別的已序列化物件與以後的 Swing 版本不相容。當前序列化支持適用於短期存儲，或適用於在運行相同 Swing 版本的應用程序之間進行 RMI（Remote Method Invocation，遠端方法調用）。從 1.4 版本開始，已在 java.beans 套件中添加了支持所有 JavaBeans^TM 長期存儲的功能。請參見 XMLEncoder。

另請參見：

StyledEditorKit

巢狀類別摘要

從類別 javax.swing.JEditorPane 繼承的巢狀類別/介面

JEditorPane.AccessibleJEditorPane, JEditorPane.AccessibleJEditorPaneHTML, JEditorPane.JEditorPaneAccessibleHypertextSupport

從類別 javax.swing.text.JTextComponent 繼承的巢狀類別/介面

JTextComponent.AccessibleJTextComponent, JTextComponent.DropLocation, JTextComponent.KeyBinding

從類別 javax.swing.JComponent 繼承的巢狀類別/介面

JComponent.AccessibleJComponent

從類別 java.awt.Container 繼承的巢狀類別/介面

Container.AccessibleAWTContainer

從類別 java.awt.Component 繼承的巢狀類別/介面

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

欄位摘要

從類別 javax.swing.JEditorPane 繼承的欄位

HONOR_DISPLAY_PROPERTIES, W3C_LENGTH_UNITS

從類別 javax.swing.text.JTextComponent 繼承的欄位

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

從類別 javax.swing.JComponent 繼承的欄位

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

從類別 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

建構子摘要

JTextPane()
創建一個新的 JTextPane。

JTextPane(StyledDocument doc)
創建具有指定文檔模型的新 JTextPane。

方法摘要

Style	addStyle(String nm, Style parent) 將一個新樣式添加到邏輯樣式層次結構中。
protected EditorKit	createDefaultEditorKit() 創建預設使用的 EditorKit。
AttributeSet	getCharacterAttributes() 獲取在當前插入符號位置的有效字元屬性，或者 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 的字元串表示形式。
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) 將編輯器與一個文本文檔關聯。

從類別 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

從類別 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, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, updateUI, viewToModel, write

從類別 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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

從類別 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, transferFocusBackward, transferFocusDownCycle, validate, validateTree

從類別 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, hide, 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, transferFocusUpCycle

從類別 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。

覆寫：

類別 JEditorPane 中的 getUIClassID

返回：

字元串 "TextPaneUI"

另請參見：

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

setDocument

public void setDocument(Document doc)

將編輯器與一個文本文檔關聯。這必須是一個 StyledDocument。

覆寫：

類別 JTextComponent 中的 setDocument

參數：

doc - 要顯示/編輯的文檔

拋出：

IllegalArgumentException - 如果 doc 不能收縮為一個 StyledDocument，它是此文本元件所要求的模型型別

另請參見：

JTextComponent.getDocument()

setStyledDocument

public void setStyledDocument(StyledDocument doc)

將編輯器與一個文本文檔關聯。當前註冊的處理器用來產生文檔的一個視圖，此視圖由編輯器來顯示。

參數：

doc - 要顯示/編輯的文檔

getStyledDocument

public StyledDocument getStyledDocument()

獲取與編輯器關聯的模型。

返回：

模型

replaceSelection

public void replaceSelection(String content)

用給定字元串所表示的新內容替換當前選擇的內容。如果沒有選擇的內容，則該操作插入給定的文本。如果沒有替換文本，則該操作移除當前選擇的內容。替換文本將具有針對插入點的輸入當前定義的屬性。如果文檔不是可編輯的，則發出蜂鳴並返回。

雖然大多數 Swing 方法不是執行緒安全的，但此方法是執行緒安全的。有關更多資訊，請參閱 How to Use Threads。

覆寫：

類別 JEditorPane 中的 replaceSelection

參數：

content - 替換選定內容的內容

insertComponent

public void insertComponent(Component c)

將一個元件插入到文檔中，以替換當前選擇的內容。如果當前沒有選擇的內容，則將元件插入到插入符號的當前位置。在相關文檔中這表示為內容字元的一個屬性。

給定元件是 JTextPane 所使用的實際元件。由於元件不能是多個容器的子級，因此此方法不能在多個文本元件共享模型的情形下使用。

根據 Component.getAlignmentY 返回的值，元件相對於文本基線放置。對於 Swing 元件，可以方便地使用 JComponent.setAlignmentY 方法來設置此值。例如，設置值 0.75 將導致元件的 75% 位於基線之上，元件的 25% 位於基線之下。

雖然大多數 Swing 方法不是執行緒安全的，但此方法是執行緒安全的。有關更多資訊，請參閱 How to Use Threads。

參數：

c - 要插入的元件

insertIcon

public void insertIcon(Icon g)

將一個圖標插入文檔中，以替換當前選擇的內容。如果當前沒有選擇的內容，則將圖標插入到插入符號的當前位置。在相關文檔中這被表示為內容字元的一個屬性。

雖然大多數 Swing 方法不是執行緒安全的，但此方法是執行緒安全的。有關更多資訊，請參閱 How to Use Threads。

參數：

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)

設置在當前插入符號位置用於段落的邏輯樣式。如果沒有為字元和段落屬性顯式設置屬性，則它們將通過分派給段落的邏輯樣式進行解析，也就是通過某個層次結構來解析，該層次結構完全獨立於文檔中元素的層次結構。

雖然大多數 Swing 方法不是執行緒安全的，但此方法是執行緒安全的。有關更多資訊，請參閱 How to Use Threads。

參數：

s - 要分派給段落的邏輯樣式，如果沒有樣式，則為 null

getLogicalStyle

public Style getLogicalStyle()

獲取分派給由當前插入符號位置表示的段落的邏輯樣式，或者 null。

返回：

Style

getCharacterAttributes

public AttributeSet getCharacterAttributes()

獲取在當前插入符號位置的有效字元屬性，或者 null。

返回：

屬性，或者 null

setCharacterAttributes

public void setCharacterAttributes(AttributeSet attr,
                                   boolean replace)

將給定屬性應用於字元內容。如果有選擇內容，則屬性將應用於所選擇的範圍。如果沒有選擇內容，則屬性將應用於輸入屬性集合，此集合定義了所有新插入文本的屬性。

雖然大多數 Swing 方法不是執行緒安全的，但此方法是執行緒安全的。有關更多資訊，請參閱 How to Use Threads。

參數：

attr - 屬性

replace - 如果為 true，則首先替換現有屬性

getParagraphAttributes

public AttributeSet getParagraphAttributes()

獲取插入符號位置的當前有效段落屬性，如果沒有，則返回 null。

返回：

屬性

setParagraphAttributes

public void setParagraphAttributes(AttributeSet attr,
                                   boolean replace)

將給定屬性應用於段落。如果有選擇內容，則將屬性應用於與選擇內容相交的段落。如果沒有選擇內容，則將屬性應用於當前插入符號位置的段落。

雖然大多數 Swing 方法不是執行緒安全的，但此方法是執行緒安全的。有關更多資訊，請參閱 How to Use Threads。

參數：

attr - 非 null 屬性

replace - 如果為 true，則首先替換現有屬性

getInputAttributes

public MutableAttributeSet getInputAttributes()

獲取窗格的輸入屬性。

返回：

屬性

getStyledEditorKit

protected final StyledEditorKit getStyledEditorKit()

獲取編輯器工具套件。

返回：

編輯器工具套件

createDefaultEditorKit

protected EditorKit createDefaultEditorKit()

創建預設使用的 EditorKit。此實作返回 javax.swing.text.StyledEditorKit。

覆寫：

類別 JEditorPane 中的 createDefaultEditorKit

返回：

編輯器工具套件

setEditorKit

public final void setEditorKit(EditorKit kit)

設置當前安裝的用於內容處理的工具套件。這是建立編輯器內容型別的綁定屬性。

覆寫：

類別 JEditorPane 中的 setEditorKit

參數：

kit - 所需的編輯器行為

拋出：

IllegalArgumentException - 如果 kit 不是一個 StyledEditorKit

另請參見：

JEditorPane.getEditorKit()

paramString

protected String paramString()

返回此 JTextPane 的字元串表示形式。此方法僅在進行除錯的時候使用，對於各個實作，所返回字元串的內容和格式可能有所不同。返回的字元串可能為空，但不可能為 null。

覆寫：

類別 JEditorPane 中的 paramString

返回：

此 JTextPane 的字元串表示形式