-
- 既知のすべての実装クラス:
AbstractDocument.DefaultDocumentEvent
public interface DocumentEvent
ドキュメント変更の通知のインタフェースです。 Documentのオブザーバに、Documentがどのように変更されたか情報を詳しく提供します。 変更のタイプ、変更場所、さらに、どのElementが挿入または削除されたのかといった構造的な変更の詳細など、高レベルの情報を提供します。- 関連項目:
Document
,DocumentListener
-
-
ネストされたクラスのサマリー
ネストされたクラス 修飾子と型 インタフェース 説明 static interface
DocumentEvent.ElementChange
特定の要素に対して加えられた変更を記述します。static class
DocumentEvent.EventType
ドキュメント・イベント・タイプの列挙です。
-
メソッドのサマリー
すべてのメソッド インスタンス・メソッド 抽象メソッド 修飾子と型 メソッド 説明 DocumentEvent.ElementChange
getChange(Element elem)
指定された要素の変更情報を返します。Document
getDocument()
変更イベントの基となったドキュメントを返します。int
getLength()
変更の長さを返します。int
getOffset()
変更の始点のドキュメント内でのオフセットを返します。DocumentEvent.EventType
getType()
イベントのタイプを取得します。
-
-
-
メソッドの詳細
-
getOffset
int getOffset()
変更の始点のドキュメント内でのオフセットを返します。- 戻り値:
- オフセット>= 0
-
getLength
int getLength()
変更の長さを返します。- 戻り値:
- 長さ>= 0
-
getDocument
Document getDocument()
変更イベントの基となったドキュメントを返します。- 戻り値:
- ドキュメント
-
getType
DocumentEvent.EventType getType()
イベントのタイプを取得します。- 戻り値:
- タイプ
-
getChange
DocumentEvent.ElementChange getChange(Element elem)
指定された要素の変更情報を返します。 変更情報には、どの要素が追加および削除されたか、およびその位置が記述されています。 変更がなかった場合は、nullが返されます。このメソッドは、オブザーバが構造的な変更を見つけるためのものです。 つまり、変更される前から存在して、現在も存在している要素のみがElementChangeの記録を持つ必要があるのです。 使用できる変更は再帰的である必要はありません。
たとえば、ある要素がその親から削除された場合、このメソッドは親が変更されたことを通知し、親の変更を記述するElementChange実装を提供する必要があります。 削除された子に子がある場合には、この子要素については削除の通知を受ける必要はありません。
子要素が親要素に挿入された場合、親要素は変更の通知をする必要があります。 子要素が自身に挿入された要素を持っている場合(親にとっては孫にあたる)、これらの要素は変更通知をする必要はありません。
- パラメータ:
elem
- 要素- 戻り値:
- 変更情報。要素が変更されなかった場合はnull
-
-