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

既知のサブインタフェースの一覧:

StyledDocument

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

AbstractDocument

public abstract interface Document

テキスト用のコンテナであり、編集をサポートし、変更の通知を提供します (MVC 関係内のモデルとして機能する)。変更を追跡する構造でテキストをマークアップするためのサポートが提供されています。構造の単位は要素と呼ばれます。ビューは一般的に要素構造から構築されます。各要素は、それに関連付けられている任意の属性セットを持つことができます。ドキュメント構造の本質は実装で指定されるので、インタフェース自身は提供される構造のあらゆるポリシーの制約を受けないように意図されています。

一般的にドキュメント構造は 1 つだけですが、インタフェースはテキストデータに関して構造プロジェクションを任意の数だけ構築できるようにサポートしています。ドキュメントは、複数のドキュメント構造をサポートする複数のルート要素を持つことができます。以下に、例をいくつか示します。

• 論理ドキュメント構造
• ビュープロジェクション
• 字句トークンストリーム
• 構文木
• ネイティブ以外の形式への変換
• 変更の仕様
• 注釈

関連項目:

DocumentEvent, DocumentListener, Element, Position, AttributeSet

フィールドの概要

static String	StreamDescriptionProperty ドキュメントを初期化するのに使うストリーム記述のプロパティ名です。
static String	TitleProperty ドキュメントのタイトルがあれば、そのプロパティ名です。

メソッドの概要

void	addDocumentListener(DocumentListener listener) ドキュメントに変更が加えられたときに通知の受信を開始するように、指定されたオブザーバを登録します。
void	addUndoableEditListener(UndoableEditListener listener) ドキュメントに取り消し可能な編集が加えられたときに通知の受信を開始するように、指定されたオブザーバを登録します。
Position	createPosition(int offs) ドキュメントの変更に応じて変更を追跡する位置を返します。
Element	getDefaultRootElement() ビューを要素構造に割り当てるほかの特定の機構が提供されていないかぎり、ビューのベースとなるルート要素を返します。
Position	getEndPosition() ドキュメントの末尾を表す位置を返します。
int	getLength() ドキュメント内の現在のコンテンツの文字数を返します。
Object	getProperty(Object key) ドキュメントに関連付けられているプロパティを取得します。
Element[]	getRootElements() 定義されているすべてのルート要素を返します。
Position	getStartPosition() ドキュメントの先頭を表す位置を返します。
String	getText(int offset, int length) ドキュメントの指定部分内にあるテキストを取得します。
void	getText(int offset, int length, Segment txt) ドキュメントの指定部分内にあるテキストを取得します。
void	insertString(int offset, String str, AttributeSet a) コンテンツの文字列を挿入します。
void	putProperty(Object key, Object value) 新しいプロパティをリストに置きます。
void	remove(int offs, int len) ドキュメントのコンテンツの一部を削除します。
void	removeDocumentListener(DocumentListener listener) 指定されたオブザーバを通知リストから登録解除して、それ以上変更の更新を受信しないようにします。
void	removeUndoableEditListener(UndoableEditListener listener) 指定されたオブザーバを通知リストから登録解除して、それ以上更新を受信しないようにします。
void	render(Runnable r) モデルが非同期的な更新をサポートしている場合、並行性に直面してモデルを安全に描画できるようにします。

フィールドの詳細

StreamDescriptionProperty

public static final String StreamDescriptionProperty

ドキュメントを初期化するのに使うストリーム記述のプロパティ名です。ドキュメントがストリームから初期化され、ストリームについてなんらかの定義がある場合には、これを使います。

TitleProperty

public static final String TitleProperty

ドキュメントのタイトルがあれば、そのプロパティ名です。

メソッドの詳細

getLength

public int getLength()

ドキュメント内の現在のコンテンツの文字数を返します。

戻り値:

文字数 >= 0

addDocumentListener

public void addDocumentListener(DocumentListener listener)

ドキュメントに変更が加えられたときに通知の受信を開始するように、指定されたオブザーバを登録します。

パラメータ:

listener - 登録対象のオブザーバ

関連項目:

removeDocumentListener(javax.swing.event.DocumentListener)

removeDocumentListener

public void removeDocumentListener(DocumentListener listener)

指定されたオブザーバを通知リストから登録解除して、それ以上変更の更新を受信しないようにします。

パラメータ:

listener - 登録対象のオブザーバ

関連項目:

addDocumentListener(javax.swing.event.DocumentListener)

addUndoableEditListener

public void addUndoableEditListener(UndoableEditListener listener)

ドキュメントに取り消し可能な編集が加えられたときに通知の受信を開始するように、指定されたオブザーバを登録します。

パラメータ:

listener - 登録対象のオブザーバ

関連項目:

UndoableEditEvent

removeUndoableEditListener

public void removeUndoableEditListener(UndoableEditListener listener)

指定されたオブザーバを通知リストから登録解除して、それ以上更新を受信しないようにします。

パラメータ:

listener - 登録対象のオブザーバ

関連項目:

UndoableEditEvent

getProperty

public Object getProperty(Object key)

ドキュメントに関連付けられているプロパティを取得します。ドキュメントタイトル、作成者などの情報を格納できるようにします。

パラメータ:

key - null 以外のプロパティ

戻り値:

プロパティ

putProperty

public void putProperty(Object key,
                        Object value)

新しいプロパティをリストに置きます。

パラメータ:

key - null 以外のプロパティキー

value - プロパティ値

remove

public void remove(int offs,
                   int len)
            throws BadLocationException

ドキュメントのコンテンツの一部を削除します。これは、例外がスローされないかぎり、通知をドキュメントのオブザーバに送るようにします。

パラメータ:

offs - 先頭からのオフセット >= 0

len - 削除対象の文字数 >= 0

例外:

BadLocationException - 削除範囲の特定部分がドキュメントの有効部分でなかった場合。例外内の位置は、最初に検出された不正な位置

関連項目:

DocumentEvent, DocumentListener

insertString

public void insertString(int offset,
                         String str,
                         AttributeSet a)
                  throws BadLocationException

コンテンツの文字列を挿入します。これは、例外がスローされないかぎり、通知をドキュメントのオブザーバに送るようにします。 位置は、ドキュメント内の項目間の位置をマークします。 定義済みの属性がその位置で定義されている現在の属性に正確に一致する場合、その位置のコンテンツを表す要素は単純に展開されます。定義されている属性が異なる場合、属性が一致する新しいコンテンツ要素が作成されます。null または空の文字列では何も行いません。

パラメータ:

offset - コンテンツを挿入するドキュメントに対するオフセット >= 0。指定位置やその後の変更を追跡するすべての位置が移動

str - 挿入対象の文字列

a - 挿入されたコンテンツに関連付ける属性。属性がない場合は null

例外:

BadLocationException - 指定された挿入位置が、ドキュメント内の有効な位置でなかった場合

関連項目:

DocumentEvent, DocumentListener

getText

public String getText(int offset,
                      int length)
               throws BadLocationException

ドキュメントの指定部分内にあるテキストを取得します。

パラメータ:

offset - テキストの望ましい先頭を表す、ドキュメントに対するオフセット >= 0

length - 望ましい文字列の長さ >= 0

戻り値:

長さ >= 0 の文字列内のテキスト

例外:

BadLocationException - 指定範囲の特定部分がドキュメントの有効部分でなかった場合。例外内の位置は、最初に検出された不正な位置

getText

public void getText(int offset,
                    int length,
                    Segment txt)
             throws BadLocationException

ドキュメントの指定部分内にあるテキストを取得します。

パラメータ:

offset - テキストの望ましい先頭を表す、ドキュメントに対するオフセット >= 0

length - 望ましい文字列の長さ >= 0

txt - テキストを返す先の Segment オブジェクト

例外:

BadLocationException - 指定範囲の特定部分がドキュメントの有効部分でなかった場合。例外内の位置は、最初に検出された不正な位置

getStartPosition

public Position getStartPosition()

ドキュメントの先頭を表す位置を返します。返された位置は、変更を追跡してドキュメントの先頭に常に位置するために利用できます。

戻り値:

位置

getEndPosition

public Position getEndPosition()

ドキュメントの末尾を表す位置を返します。返された位置は、変更を追跡してドキュメントの末尾に常に位置するために利用できます。

戻り値:

位置

createPosition

public Position createPosition(int offs)
                        throws BadLocationException

ドキュメントの変更に応じて変更を追跡する位置を返します。相対的な位置 pos が null の場合、ドキュメントの先頭が使われます。

パラメータ:

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

戻り値:

位置

例外:

BadLocationException - 指定された位置が、関連付けられているドキュメント内の有効な位置を表さない場合

getRootElements

public Element[] getRootElements()

定義されているすべてのルート要素を返します。

戻り値:

ルート要素

getDefaultRootElement

public Element getDefaultRootElement()

ビューを要素構造に割り当てるほかの特定の機構が提供されていないかぎり、ビューのベースとなるルート要素を返します。

戻り値:

ルート要素

render

public void render(Runnable r)

モデルが非同期的な更新をサポートしている場合、並行性に直面してモデルを安全に描画できるようにします。指定された実行可能ファイルは、その実行中に何の変更もなくモデルを安全に読み取る方法で実行されます。実行可能ファイルは、それ自身で変更を加えることはできません。

パラメータ:

r - モデルを描画するために使う実行可能ファイル