JavaTM Platform
Standard Ed. 6

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

グラフィックで表現される属性でマークアップできるテキストコンポーネントです。使用方法およびテキスト区画の例については、「The Java Tutorial」の「Using Text Components」を参照してください。

このコンポーネントは、文字レベル属性の並びから構成される段落をモデル化します。各段落には、段落または文字の並びに設定される属性によってオーバーライドされないかぎり使用される、デフォルト属性を収めた論理書式が付属しています。コンポーネントとイメージは、テキストの中に組み込むことができます。

改行
改行の処理方法については、DefaultEditorKit を参照してください。

警告: Swing はスレッドに対して安全ではありません。詳細は、「Swing's Threading Policy」を参照してください。

警告: このクラスの直列化されたオブジェクトは、今後の Swing リリースと互換ではなくなる予定です。現在の直列化のサポートは、短期間の運用や、同じバージョンの Swing を実行するアプリケーション間の RMI に適しています。JDK Version 1.4 以降、すべての JavaBeans の長期間の運用サポートは、java.beans パッケージに追加されています。詳細は、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()
          現在のキャレット位置で有効な文字属性がある場合はそれを返します。
 MutableAttributeSet getInputAttributes()
          区画の入力属性を返します。
 Style getLogicalStyle()
          現在のキャレット位置で表される段落に割り当てられている論理書式がある場合はそれを返します。
 AttributeSet getParagraphAttributes()
          キャレット位置で有効な現在の段落属性がある場合はそれを返します。
 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)
現在選択されているコンテンツの置換後の内容としてドキュメントにコンポーネントを挿入します。選択範囲がない場合、コンポーネントは事実上、キャレットの現在の位置に挿入されます。これは、関連したドキュメントでコンテンツの 1 文字の属性として表現されます。

指定されるコンポーネントは、JTextPane が使う実際のコンポーネントです。コンポーネントは複数のコンテナの子になることはできないため、複数のテキストコンポーネントでモデルを共用する場合は、このメソッドを使わないでください。

コンポーネントは、Component.getAlignmentY によって返された値に従って、テキストベースラインに相対的に配置されます。Swing コンポーネントの場合、JComponent.setAlignmentY メソッドを使うと、この値を簡単に設定できます。たとえば、値を 0.75 に設定すると、コンポーネントの 75 パーセントがベースラインの上に、25 パーセントがベースラインの下になります。

このメソッドはスレッドに対して安全ですが、ほとんどの Swing メソッドは違います。詳細は、「How to Use Threads」を参照してください。

パラメータ:
c - 挿入されるコンポーネント

insertIcon

public void insertIcon(Icon g)
現在選択されているコンテンツの置換後の内容としてドキュメントにアイコンを挿入します。選択範囲がない場合、アイコンは事実上、キャレットの現在の位置に挿入されます。これは、関連したドキュメントでコンテンツの 1 文字の属性として表現されます。

このメソッドはスレッドに対して安全ですが、ほとんどの 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 - キットが StyledEditorKit ではない場合
関連項目:
JEditorPane.getEditorKit()

paramString

protected String paramString()
この JTextPane の文字列表現を返します。このメソッドはデバッグ専用であり、返される文字列の内容および形式は実装によって異なります。返される文字列は空の場合がありますが、null にはなりません。

オーバーライド:
クラス JEditorPane 内の paramString
戻り値:
この JTextPane の文字列表現

JavaTM Platform
Standard Ed. 6

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2009 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。