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

public class JTextPane

extends JEditorPane

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

標準の Look & Feel (L&F) 表現でこのコンポーネントが使用するキーボードのキーについては、JTextPane のキーの割り当てを参照してください。

警告: このクラスの直列化されたオブジェクトは、今後の Swing リリースと互換ではなくなる予定です。現在の直列化のサポートは、短期間の運用や、同じバージョンの Swing を実行するアプリケーション間の RMI に適しています。今後の Swing リリースでは、長期間の持続性をサポートする予定です。

関連項目:

text.StyledEditorKit, 直列化された形式

クラス javax.swing.JEditorPane から継承した内部クラス

JEditorPane.AccessibleJEditorPane, JEditorPane.AccessibleJEditorPaneHTML, JEditorPane.JEditorPaneAccessibleHypertextSupport

クラス javax.swing.text.JTextComponent から継承した内部クラス

JTextComponent.AccessibleJTextComponent, JTextComponent.KeyBinding

クラス javax.swing.JComponent から継承した内部クラス

JComponent.AccessibleJComponent

クラス 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

コンストラクタの概要

JTextPane()
新しい JTextPane を構築します。

JTextPane(StyledDocument doc)
新しい JTextPane を指定されたドキュメントモデルで構築します。

メソッドの概要

Style	addStyle(String nm, Style parent) 新しい書式を論理書式階層に追加します。
protected EditorKit	createDefaultEditorKit() デフォルトで使う EditorKit を作成します。
AttributeSet	getCharacterAttributes() 現在のキャレット位置で有効な文字属性がある場合はそれを取得します。
MutableAttributeSet	getInputAttributes() 区画の入力属性を取得します。
Style	getLogicalStyle() 現在のキャレット位置で表される段落に割り当てられている論理書式がある場合はそれを取得します。
AttributeSet	getParagraphAttributes() キャレット位置で有効な現在の段落属性がある場合はそれを取得します。
boolean	getScrollableTracksViewportWidth() ビューポートが常にこの Scrollable の幅を強制的にビューポートの幅に一致させる場合に true を返します。
Style	getStyle(String nm) それまでに追加済みの無効でない名前付き書式を取得します。
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) ドキュメントにそれまでに追加済みの無効でない名前付き書式を削除します。
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, getEditorKitForContentType, getPage, getPreferredSize, getScrollableTracksViewportHeight, getStream, getText, isManagingFocus, processComponentKeyEvent, read, registerEditorKitForContentType, registerEditorKitForContentType, removeHyperlinkListener, scrollToReference, setContentType, setEditorKitForContentType, setPage, setPage, setText

クラス javax.swing.text.JTextComponent から継承したメソッド

addCaretListener, addKeymap, copy, cut, fireCaretUpdate, getActions, getCaret, getCaretColor, getCaretPosition, getDisabledTextColor, getDocument, getFocusAccelerator, getHighlighter, getKeymap, getKeymap, getMargin, getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getUI, isEditable, isFocusTraversable, isOpaque, loadKeymap, modelToView, moveCaretPosition, paste, read, removeCaretListener, removeKeymap, removeNotify, select, selectAll, setCaret, setCaretColor, setCaretPosition, setDisabledTextColor, setEditable, setEnabled, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setOpaque, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, updateUI, viewToModel, write

クラス javax.swing.JComponent から継承したメソッド

addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isLightweightComponent, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, unregisterKeyboardAction, update

クラス java.awt.Container から継承したメソッド

add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree

クラス java.awt.Component から継承したメソッド

action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hide, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus

クラス java.lang.Object から継承したメソッド

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

コンストラクタの詳細

JTextPane

public JTextPane()

新しい JTextPane を構築します。StyledEditorKit の新しいインスタンスが生成および設定され、ドキュメントモデルは無効に設定されます。

JTextPane

public JTextPane(StyledDocument doc)

新しい JTextPane を指定されたドキュメントモデルで構築します。text.StyledEditorKit の新しいインスタンスが生成および設定されます。

パラメータ:

doc - ドキュメントモデル

メソッドの詳細

getUIClassID

public String getUIClassID()

UI のクラス ID を返します。

戻り値:

ID (TextPaneUI)

オーバーライド:

クラス JEditorPane 内の getUIClassID

関連項目:

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

setDocument

public void setDocument(Document doc)

エディタをテキストドキュメントに関連付けます。これは StyledDocument でなければなりません。

パラメータ:

doc - 表示/編集するドキュメント

例外:

IllegalArgumentException - doc をこのテキストコンポーネントに必要なタイプのモデルである StyledDocument に限定できない場合

オーバーライド:

クラス JTextComponent 内の setDocument

setStyledDocument

public void setStyledDocument(StyledDocument doc)

エディタをテキストドキュメントに関連付けます。現在登録されているファクトリを使うと、ドキュメントのビューを構築できます。このドキュメントは、エディタによって表示されます。

パラメータ:

doc - 表示/編集するドキュメント

getStyledDocument

public StyledDocument getStyledDocument()

エディタに関連付けられているモデルを取得します。

戻り値:

モデル

replaceSelection

public void replaceSelection(String content)

現在選択されているコンテンツを、指定された文字列で表された新しいコンテンツで置き換えます。選択領域がない場合、これは指定されたテキストの挿入に相当します。 置換後のテキストがない場合、これは現在の選択領域の削除に相当します。置換後のテキストには、入力用に現在定義されている属性が設定されます。コンポーネントが編集できない状態であれば、ビープ音が鳴って復帰改行します。ドキュメントが無効な場合は何も行いません。挿入するコンテンツが無効か空の場合は、それを無視します。

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

パラメータ:

content - 選択領域を置き換えるコンテンツ

オーバーライド:

クラス JEditorPane 内の replaceSelection

insertComponent

public void insertComponent(Component c)

現在選択されているコンテンツの置換後の内容としてドキュメントにコンポーネントを挿入します。選択領域がない場合、コンポーネントは事実上、キャレットの現在の位置に挿入されます。これは、関連付けられているドキュメントでコンテンツの 1 文字の属性として表現されます。

パラメータ:

c - 挿入するコンポーネント

insertIcon

public void insertIcon(Icon g)

現在選択されているコンテンツの置換後の内容としてドキュメントにアイコンを挿入します。選択領域がない場合、アイコンは事実上、キャレットの現在の位置に挿入されます。これは、関連付けられているドキュメントでコンテンツの 1 文字の属性として表現されます。

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

パラメータ:

g - 挿入するアイコン

関連項目:

Icon

addStyle

public Style addStyle(String nm,
                      Style parent)

新しい書式を論理書式階層に追加します。書式属性は下から上へ解釈処理されるので、子で指定された属性は親で指定された属性をオーバーライドします。

パラメータ:

nm - 書式名 (名前付き書式内のコレクションで一意でなければならない)。書式に名前が指定されていない場合には名前は無効だが、名前なし書式は名前で取得できないので、呼び出し側は返された参照の管理を担当する。名前なし書式は、スタイルランで見られるような文字属性オーバーライドなどで役立つ

parent - 親書式。未指定の属性をほかの特定の書式で解釈処理する必要がない場合は null

戻り値:

新しい Style

removeStyle

public void removeStyle(String nm)

ドキュメントにそれまでに追加済みの無効でない名前付き書式を削除します。

パラメータ:

nm - 削除する書式の名前

getStyle

public Style getStyle(String nm)

それまでに追加済みの無効でない名前付き書式を取得します。

パラメータ:

nm - 書式名

戻り値:

書式

setLogicalStyle

public void setLogicalStyle(Style s)

段落に使う論理書式を現在のキャレット位置に設定します。属性が文字属性や段落属性として明示的に設定されない場合、段落に割り当てられた論理書式を介して解釈処理されます。そして今度は論理書式が、ドキュメント内の要素階層から完全に独立した特定の階層を解釈処理します。

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

パラメータ:

s - 段落に割り当てる論理書式。書式なしの場合は null

getLogicalStyle

public Style getLogicalStyle()

現在のキャレット位置で表される段落に割り当てられている論理書式がある場合はそれを取得します。ない場合は null を取得します。

戻り値:

書式

getCharacterAttributes

public AttributeSet getCharacterAttributes()

現在のキャレット位置で有効な文字属性がある場合はそれを取得します。ない場合は null を取得します。

戻り値:

属性または null

setCharacterAttributes

public void setCharacterAttributes(AttributeSet attr,
                                   boolean replace)

指定された属性を文字コンテンツに適用します。選択されている領域がある場合、属性は選択範囲に対して適用されます。選択領域がない場合、挿入される新しいテキストの属性を定義する入力属性セットに適用されます。

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

パラメータ:

attr - 属性

replace - true の場合は、まず既存の属性を置き換える

getParagraphAttributes

public AttributeSet getParagraphAttributes()

キャレット位置で有効な現在の段落属性がある場合はそれを取得します。ない場合は null を取得します。

戻り値:

属性

setParagraphAttributes

public void setParagraphAttributes(AttributeSet attr,
                                   boolean replace)

指定された属性を段落に適用します。選択されている領域がある場合、属性は選択領域にかかっている各段落に対して適用されます。選択領域がない場合、属性は現在のキャレット位置の段落に適用されます。

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

パラメータ:

attr - null 以外の属性

replace - true の場合は、まず既存の属性を置き換える

getInputAttributes

public MutableAttributeSet getInputAttributes()

区画の入力属性を取得します。

戻り値:

属性

getStyledEditorKit

protected final StyledEditorKit getStyledEditorKit()

エディタキットを取得します。

戻り値:

エディタキット

createDefaultEditorKit

protected EditorKit createDefaultEditorKit()

デフォルトで使う EditorKit を作成します。これを実装すると、text.StyledEditorKit を返します。

戻り値:

エディタキット

オーバーライド:

クラス JEditorPane 内の createDefaultEditorKit

setEditorKit

public final void setEditorKit(EditorKit kit)

コンテンツを処理するために現在インストールされているキットを設定します。これは、エディタのコンテンツのタイプを確定するバウンドプロパティです。

パラメータ:

kit - 望ましいエディタ動作

例外:

IllegalArgumentException - キットが text.StyledEditorKit でない場合

オーバーライド:

クラス JEditorPane 内の setEditorKit

getScrollableTracksViewportWidth

public boolean getScrollableTracksViewportWidth()

ビューポートが常にこの Scrollable の幅を強制的にビューポートの幅に一致させる場合に true を返します。

戻り値:

ビューポートが Scrollable の幅をそれ自身に一致させる場合は true

オーバーライド:

クラス JEditorPane 内の getScrollableTracksViewportWidth

paramString

protected String paramString()

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

JFC コンポーネントの新しい側面についての情報を返すには、paramString() をオーバーライドします。

戻り値:

この JTextPane の文字列表現

オーバーライド:

クラス JEditorPane 内の paramString