javax.swing.text
クラス DefaultStyledDocument

java.lang.Object
  |
  +--javax.swing.text.AbstractDocument
        |
        +--javax.swing.text.DefaultStyledDocument

すべての実装インタフェース:

Document, Serializable, StyledDocument

直系の既知のサブクラス:

HTMLDocument

public class DefaultStyledDocument

extends AbstractDocument

implements StyledDocument

RTF (Rich Text Format) に類似した方式を使って、字体や段落書式をマークアップできるドキュメントです。このドキュメントの要素構造は、スタイルランのスタイルの組み合わせを表します。こうしたスタイルランは、段落要素の構造 (ほかの構造に格納されている場合もあり) に対応付けられます。論理書式が段落境界に指定されているので、スタイルランは段落境界で分割されます。

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

関連項目:

Document, AbstractDocument, 直列化された形式

内部クラスの概要

static class	DefaultStyledDocument.AttributeUndoableEdit UndoableEdit は、Element の AttributeSet に加えられた変更を記憶するために使います。
class	DefaultStyledDocument.ElementBuffer 要素階層への変更を管理するためのクラスです。
static class	DefaultStyledDocument.ElementSpec 要素を構築するための仕様です。
protected class	DefaultStyledDocument.SectionElement ドキュメントのデフォルトのルート要素です。

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

AbstractDocument.AbstractElement, AbstractDocument.AttributeContext, AbstractDocument.BranchElement, AbstractDocument.Content, AbstractDocument.DefaultDocumentEvent, AbstractDocument.ElementEdit, AbstractDocument.LeafElement

フィールドの概要

protected DefaultStyledDocument.ElementBuffer	buffer
static int	BUFFER_SIZE_DEFAULT 初期コンテンツバッファのデフォルトサイズです。

クラス javax.swing.text.AbstractDocument から継承したフィールド

BAD_LOCATION, BidiElementName, ContentElementName, ElementNameAttribute, listenerList, ParagraphElementName, SectionElementName

インタフェース javax.swing.text.Document から継承したフィールド

StreamDescriptionProperty, TitleProperty

コンストラクタの概要

DefaultStyledDocument()
デフォルトの書式付きドキュメントを構築します。

DefaultStyledDocument(AbstractDocument.Content c, StyleContext styles)
書式付きドキュメントを構築します。

DefaultStyledDocument(StyleContext styles)
デフォルトのコンテンツ記憶域の実装と書式の共有セットを使って、書式付きドキュメントを構築します。

メソッドの概要

void	addDocumentListener(DocumentListener listener) ドキュメントリスナーを追加し、変更があったときに通知されるようにします。
Style	addStyle(String nm, Style parent) 論理書式階層に新しい書式を追加します。
protected void	create(DefaultStyledDocument.ElementSpec[] data) ドキュメントを初期化して、指定された要素構造 (getDefaultRootElement メソッドによって報告される構造) を反映します。
protected AbstractDocument.AbstractElement	createDefaultRoot() デフォルトのドキュメント構造を表すために使うルート要素を作成します。
Color	getBackground(AttributeSet attr) 属性セットからバックグラウンドカラーを返します。
Element	getCharacterElement(int pos) 位置に基づいて文字要素を返します。
Element	getDefaultRootElement() デフォルトのルート要素を返します。
Font	getFont(AttributeSet attr) 属性セットからフォントを返します。
Color	getForeground(AttributeSet attr) 属性セットからフォアグラウンドカラーを返します。
Style	getLogicalStyle(int p) 指定された位置によって表された段落に割り当てられた論理書式を取り出します。
Element	getParagraphElement(int pos) オフセット pos の段落の要素を返します。
Style	getStyle(String nm) 以前に追加された名前付き書式を取り出します。
Enumeration	getStyleNames() 書式名のリストを取り出します。
protected void	insert(int offset, DefaultStyledDocument.ElementSpec[] data) 新しい要素を一括して挿入します。
protected void	insertUpdate(AbstractDocument.DefaultDocumentEvent chng, AttributeSet attr) テキストの挿入に応じてドキュメントを更新します。
void	removeDocumentListener(DocumentListener listener) リスナーを削除します。
void	removeStyle(String nm) Removes a named style previously added to the document.
protected void	removeUpdate(AbstractDocument.DefaultDocumentEvent chng) テキスト削除の結果としてドキュメント構造を更新します。
void	setCharacterAttributes(int offset, int length, AttributeSet s, boolean replace) ドキュメントの一部に属性を設定します。
void	setLogicalStyle(int pos, Style s) 指定された位置の段落に使用する論理書式を設定します。
void	setParagraphAttributes(int offset, int length, AttributeSet s, boolean replace) 段落に属性を設定します。
protected void	styleChanged(Style style) ドキュメント全体に対する変更イベントを作成し、それをリスナーに伝達します。

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

addUndoableEditListener, createBranchElement, createLeafElement, createPosition, dump, fireChangedUpdate, fireInsertUpdate, fireRemoveUpdate, fireUndoableEditUpdate, getAsynchronousLoadPriority, getAttributeContext, getBidiRootElement, getContent, getCurrentWriter, getDocumentProperties, getEndPosition, getLength, getListeners, getProperty, getRootElements, getStartPosition, getText, getText, insertString, postRemoveUpdate, putProperty, readLock, readUnlock, remove, removeUndoableEditListener, render, setAsynchronousLoadPriority, setDocumentProperties, writeLock, writeUnlock

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

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

インタフェース javax.swing.text.Document から継承したメソッド

addUndoableEditListener, createPosition, getEndPosition, getLength, getProperty, getRootElements, getStartPosition, getText, getText, insertString, putProperty, remove, removeUndoableEditListener, render

フィールドの詳細

BUFFER_SIZE_DEFAULT

public static final int BUFFER_SIZE_DEFAULT

初期コンテンツバッファのデフォルトサイズです。

buffer

protected DefaultStyledDocument.ElementBuffer buffer

コンストラクタの詳細

DefaultStyledDocument

public DefaultStyledDocument(AbstractDocument.Content c,
                             StyleContext styles)

書式付きドキュメントを構築します。

パラメータ:

c - コンテンツのコンテナ

styles - ドキュメント間で共有できるリソースと書式定義

DefaultStyledDocument

public DefaultStyledDocument(StyleContext styles)

デフォルトのコンテンツ記憶域の実装と書式の共有セットを使って、書式付きドキュメントを構築します。

パラメータ:

styles - 書式

DefaultStyledDocument

public DefaultStyledDocument()

デフォルトの書式付きドキュメントを構築します。これは入力コンテンツを BUFFER_SIZE_DEFAULT のサイズによってバッファ処理し、ドキュメントの寿命によってスコープされたスタイルコンテキストを持ち、ほかのドキュメントとは共有されません。

メソッドの詳細

getDefaultRootElement

public Element getDefaultRootElement()

デフォルトのルート要素を返します。

定義:

インタフェース Document 内の getDefaultRootElement

オーバーライド:

クラス AbstractDocument 内の getDefaultRootElement

戻り値:

ルート

関連項目:

Document.getDefaultRootElement()

create

protected void create(DefaultStyledDocument.ElementSpec[] data)

ドキュメントを初期化して、指定された要素構造 (getDefaultRootElement メソッドによって報告される構造) を反映します。ドキュメントがなんらかのデータを保持している場合、それが最初に削除されます。

insert

protected void insert(int offset,
                      DefaultStyledDocument.ElementSpec[] data)
               throws BadLocationException

新しい要素を一括して挿入します。これは、ロック解除状態のドキュメントを解析して、要素構造の変更を準備するのに役立ちます。このメソッドは、要素構造を更新する方法を記述するトークンの配列を取得するので、書き込みロックに入る時間を非同期的な更新状況で大幅に減らすことができます。

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

パラメータ:

offset - 開始オフセット >= 0

data - 要素データ

例外:

BadLocationException - 開始オフセットが無効な場合

addStyle

public Style addStyle(String nm,
                      Style parent)

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

定義:

インタフェース StyledDocument 内の addStyle

パラメータ:

nm - 書式の名前。この名前は、名前付き書式のコレクションの中で一意でなければならない。名前は、書式に名前が付いていない場合は null も可能だが、呼び出し側は名前のない書式が名前で取り出せない場合に返される参照を管理しなければならない。名前のない書式は、スタイルランで見られるような文字属性のオーバーライドなどで便利な場合がある

parent - 親書式。指定されていない属性がほかの書式で解釈処理される必要がない場合は null も可

戻り値:

書式

removeStyle

public void removeStyle(String nm)

Removes a named style previously added to the document.以前にドキュメントに追加された名前付き書式を削除します。

定義:

インタフェース StyledDocument 内の removeStyle

パラメータ:

nm - 削除される書式の名前

getStyle

public Style getStyle(String nm)

以前に追加された名前付き書式を取り出します。

定義:

インタフェース StyledDocument 内の getStyle

パラメータ:

nm - 書式の名前

戻り値:

書式

getStyleNames

public Enumeration getStyleNames()

書式名のリストを取り出します。

戻り値:

すべての書式名

setLogicalStyle

public void setLogicalStyle(int pos,
                            Style s)

指定された位置の段落に使用する論理書式を設定します。文字および段落の属性に対して明示的に属性が設定されていない場合、属性はその段落に割り当てられている論理書式を介して解釈処理されます。論理書式は、ドキュメント内の要素階層にまったく依存しない階層を介して解釈処理されます。

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

定義:

インタフェース StyledDocument 内の setLogicalStyle

パラメータ:

pos - ドキュメントの先頭からのオフセット >= 0

s - 段落に割り当てられた論理書式。ない場合は null

getLogicalStyle

public Style getLogicalStyle(int p)

指定された位置によって表された段落に割り当てられた論理書式を取り出します。

定義:

インタフェース StyledDocument 内の getLogicalStyle

パラメータ:

p - 段落に変換して、割り当てる論理書式を指定する位置 >= 0。これは、ドキュメントの先頭からのオフセット

戻り値:

書式。ない場合は null

setCharacterAttributes

public void setCharacterAttributes(int offset,
                                   int length,
                                   AttributeSet s,
                                   boolean replace)

ドキュメントの一部に属性を設定します。この処理は変更の実行中に書き込みロックを保持し、変更が適切に完了すると DocumentEvent がリスナーに送られます。

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

定義:

インタフェース StyledDocument 内の setCharacterAttributes

パラメータ:

offset - ドキュメントのオフセット >= 0

length - 長さ >= 0

s - 属性

replace - 新しい属性の設定前に従来の属性を置換する必要がある場合は true

setParagraphAttributes

public void setParagraphAttributes(int offset,
                                   int length,
                                   AttributeSet s,
                                   boolean replace)

段落に属性を設定します。

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

定義:

インタフェース StyledDocument 内の setParagraphAttributes

パラメータ:

offset - 段落に対するオフセット >= 0

length - 影響を受ける文字数 >= 0

s - 属性

replace - 既存の属性を置換するか、マージするか

getParagraphElement

public Element getParagraphElement(int pos)

オフセット pos の段落の要素を返します。1 つの段落は、少なくとも 1 つの、通常は葉である子の Element から構成されています。

定義:

インタフェース StyledDocument 内の getParagraphElement

オーバーライド:

クラス AbstractDocument 内の getParagraphElement

パラメータ:

pos - 開始オフセット >= 0

戻り値:

要素

getCharacterElement

public Element getCharacterElement(int pos)

位置に基づいて文字要素を返します。

定義:

インタフェース StyledDocument 内の getCharacterElement

パラメータ:

pos - ドキュメントの位置 >= 0

戻り値:

要素

insertUpdate

protected void insertUpdate(AbstractDocument.DefaultDocumentEvent chng,
                            AttributeSet attr)

テキストの挿入に応じてドキュメントを更新します。このアクションは書き込みロックの中で発生します。この実装は、挿入されたコンテンツを単に改行ごとに解析し、要素バッファに対する一連の指示を構築します。

オーバーライド:

クラス AbstractDocument 内の insertUpdate

パラメータ:

chng - ドキュメント変更の説明

attr - 属性

removeUpdate

protected void removeUpdate(AbstractDocument.DefaultDocumentEvent chng)

テキスト削除の結果としてドキュメント構造を更新します。

オーバーライド:

クラス AbstractDocument 内の removeUpdate

パラメータ:

chng - ドキュメント変更の説明

createDefaultRoot

protected AbstractDocument.AbstractElement createDefaultRoot()

デフォルトのドキュメント構造を表すために使うルート要素を作成します。

戻り値:

要素ベース

getForeground

public Color getForeground(AttributeSet attr)

属性セットからフォアグラウンドカラーを返します。

定義:

インタフェース StyledDocument 内の getForeground

パラメータ:

attr - 属性セット

戻り値:

色

getBackground

public Color getBackground(AttributeSet attr)

属性セットからバックグラウンドカラーを返します。

定義:

インタフェース StyledDocument 内の getBackground

パラメータ:

attr - 属性セット

戻り値:

色

getFont

public Font getFont(AttributeSet attr)

属性セットからフォントを返します。

定義:

インタフェース StyledDocument 内の getFont

パラメータ:

attr - 属性セット

戻り値:

フォント

styleChanged

protected void styleChanged(Style style)

ドキュメント全体に対する変更イベントを作成し、それをリスナーに伝達します。サブクラスでは、何がダメージを受けたかわかるようにする必要があることがあります。

パラメータ:

style - 変更された Style

addDocumentListener

public void addDocumentListener(DocumentListener listener)

ドキュメントリスナーを追加し、変更があったときに通知されるようにします。

定義:

インタフェース Document 内の addDocumentListener

オーバーライド:

クラス AbstractDocument 内の addDocumentListener

パラメータ:

listener - リスナー

関連項目:

Document.addDocumentListener(javax.swing.event.DocumentListener)

removeDocumentListener

public void removeDocumentListener(DocumentListener listener)

リスナーを削除します。

定義:

インタフェース Document 内の removeDocumentListener

オーバーライド:

クラス AbstractDocument 内の removeDocumentListener

パラメータ:

listener - リスナー

関連項目:

Document.removeDocumentListener(javax.swing.event.DocumentListener)