javax.swing.text
インタフェース StyledDocument

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

Document

既知の実装クラスの一覧:

DefaultStyledDocument

public interface StyledDocument

extends Document

書式付きドキュメントの汎用インタフェースです。

フィールドの概要

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

StreamDescriptionProperty, TitleProperty

メソッドの概要

Style	addStyle(String nm, Style parent) 論理書式階層に新しい書式を追加します。
Color	getBackground(AttributeSet attr) 属性セットを取得してバックグラウンドカラー指定に変換します。
Element	getCharacterElement(int pos) ドキュメント内の指定されたオフセットにある文字を表す要素を返します。
Font	getFont(AttributeSet attr) 属性セットをフォントの属性に変換します。
Color	getForeground(AttributeSet attr) 属性セットを取得してフォアグラウンドカラー指定に変換します。
Style	getLogicalStyle(int p) 段落内の指定された位置の論理書式を取得します。
Element	getParagraphElement(int pos) ドキュメント内の指定されたオフセットを含む段落を表す要素を返します。
Style	getStyle(String nm) 以前に追加された名前付き書式を取り出します。
void	removeStyle(String nm) 以前にドキュメントに追加された名前付き書式を削除します。
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) 段落の属性を設定します。

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

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

メソッドの詳細

addStyle

public Style addStyle(String nm,
                      Style parent)

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

パラメータ:

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

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

戻り値:

書式

removeStyle

public void removeStyle(String nm)

以前にドキュメントに追加された名前付き書式を削除します。

パラメータ:

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

getStyle

public Style getStyle(String nm)

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

パラメータ:

nm - 書式の名前

戻り値:

書式

setCharacterAttributes

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

ドキュメント内の指定された範囲の既存のコンテンツに使用されているコンテンツ要素属性を変更します。指定された属性引数で定義されているすべての属性が、指定された範囲に適用されます。このメソッドでは、属性の定義されていない属性引数を使い、replace を true に設定することで、指定された範囲のコンテンツレベルのすべての属性を完全に削除できます。

パラメータ:

offset - 変更の開始 >= 0

length - 変更の長さ >= 0

s - null 以外の新しい属性。定義された属性は指定された範囲のテキストに適用される

replace - 新しい属性が設定される前に以前の属性が削除されるかどうかを示す。true の場合、以前の属性が全体的に置き換えられる。false の場合、新しい属性が以前の属性にマージされる

setParagraphAttributes

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

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

パラメータ:

offset - 変更の開始 >= 0

length - 変更の長さ >= 0

s - null 以外の新しい属性。定義された属性は指定された範囲のテキストに適用される

replace - 新しい属性が設定される前に以前の属性が削除されるかどうかを示す。true の場合、以前の属性が全体的に置き換えられる。false の場合、新しい属性が以前の属性とマージされる

setLogicalStyle

public void setLogicalStyle(int pos,
                            Style s)

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

パラメータ:

pos - 開始位置 >= 0

s - 設定する書式

getLogicalStyle

public Style getLogicalStyle(int p)

段落内の指定された位置の論理書式を取得します。

パラメータ:

p - 位置 >= 0

戻り値:

書式

getParagraphElement

public Element getParagraphElement(int pos)

ドキュメント内の指定されたオフセットを含む段落を表す要素を返します。

パラメータ:

pos - オフセット >= 0

戻り値:

要素

getCharacterElement

public Element getCharacterElement(int pos)

ドキュメント内の指定されたオフセットにある文字を表す要素を返します。

パラメータ:

pos - オフセット >= 0

戻り値:

要素

getForeground

public Color getForeground(AttributeSet attr)

属性セットを取得してフォアグラウンドカラー指定に変換します。明るさや色合い等を強調する場合に使用します。

パラメータ:

attr - 属性セット

戻り値:

色

getBackground

public Color getBackground(AttributeSet attr)

属性セットを取得してバックグラウンドカラー指定に変換します。明るさや色合い等を強調する場合に使用します。

パラメータ:

attr - 属性セット

戻り値:

色

getFont

public Font getFont(AttributeSet attr)

属性セットをフォントの属性に変換します。このメソッドを使用すると、ファミリ、書式、サイズなどを、ドキュメントが現在使用されているシステムで使用できるフォントに変換できます。

パラメータ:

attr - 属性セット

戻り値:

フォント