javax.swing.text
クラス AbstractDocument.DefaultDocumentEvent

java.lang.Object
  |
  +--javax.swing.undo.AbstractUndoableEdit
        |
        +--javax.swing.undo.CompoundEdit
              |
              +--javax.swing.text.AbstractDocument.DefaultDocumentEvent

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

DocumentEvent, Serializable, UndoableEdit

含まれているクラス:

AbstractDocument

public class AbstractDocument.DefaultDocumentEvent

extends CompoundEdit

implements DocumentEvent

ドキュメントが変更されるときに、変更を格納します。その後、ドキュメントの変更のトランザクションが完了したときに、変更の通知に使用できます。AbstractDocument クラスとその拡張が、変更の情報をドキュメントリスナーに配信するために使用することもできます。

関連項目:

直列化された形式

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

DocumentEvent.ElementChange, DocumentEvent.EventType

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

edits

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

RedoName, UndoName

コンストラクタの概要

AbstractDocument.DefaultDocumentEvent(int offs, int len, DocumentEvent.EventType type)
変更のレコードを構築します。

メソッドの概要

boolean	addEdit(UndoableEdit anEdit) ドキュメントの編集を追加します。
DocumentEvent.ElementChange	getChange(Element elem) 要素への変更を取得します。
Document	getDocument() 変更のイベントのソースとなるドキュメントを取得します。
int	getLength() 変更の長さを返します。
int	getOffset() 変更の開始点となる、ドキュメント内のオフセットを返します。
String	getPresentationName() 地域対応された、人間に読める形式で、編集の説明を提供します。
String	getRedoPresentationName() 地域対応された、人間に読める形式で、再実行できる形式の編集の説明を提供します。
DocumentEvent.EventType	getType() イベントのタイプを返します。
String	getUndoPresentationName() 地域対応された、人間に読める形式で、元に戻せる形式の編集の説明を提供します。
boolean	isSignificant() DefaultDocument の各イベントは重要です。
void	redo() 変更を再実行します。
String	toString() 変更のイベントの、文字列による説明を返します。
void	undo() 変更を元に戻します。

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

canRedo, canUndo, die, end, isInProgress, lastEdit

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

replaceEdit

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

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

コンストラクタの詳細

AbstractDocument.DefaultDocumentEvent

public AbstractDocument.DefaultDocumentEvent(int offs,
                                             int len,
                                             DocumentEvent.EventType type)

変更のレコードを構築します。

パラメータ:

offs - ドキュメントの変更位置のオフセット >= 0

len - 変更の長さ >= 0

type - イベントのタイプ (DocumentEvent.EventType)

メソッドの詳細

toString

public String toString()

変更のイベントの、文字列による説明を返します。

オーバーライド:

クラス CompoundEdit 内の toString

戻り値:

文字列

addEdit

public boolean addEdit(UndoableEdit anEdit)

ドキュメントの編集を追加します。編集の回数がしきい値を超えた場合は、ElementChange の実装を参照するハッシュテーブルに切り替わります。これは、編集の回数への参照をより高速にする必要があるからです。

オーバーライド:

クラス CompoundEdit 内の addEdit

パラメータ:

anEdit - ドキュメントの編集レコード

戻り値:

編集が追加された場合は true

redo

public void redo()
          throws CannotRedoException

変更を再実行します。

オーバーライド:

クラス CompoundEdit 内の redo

例外:

CannotRedoException - 変更を再実行できない場合

undo

public void undo()
          throws CannotUndoException

変更を元に戻します。

オーバーライド:

クラス CompoundEdit 内の undo

例外:

CannotUndoException - 変更を元に戻せない場合

isSignificant

public boolean isSignificant()

DefaultDocument の各イベントは重要です。DefaultDocumentEvents を集めてユーザに対して単一の編集として提供したい場合は、イベントを CompoundEdit に置きます。

オーバーライド:

クラス CompoundEdit 内の isSignificant

戻り値:

イベントが編集を元に戻す目的に関係するかどうか

getPresentationName

public String getPresentationName()

地域対応された、人間に読める形式で、編集の説明を提供します。たとえば変更のログなどに適しています。

オーバーライド:

クラス CompoundEdit 内の getPresentationName

戻り値:

説明

getUndoPresentationName

public String getUndoPresentationName()

地域対応された、人間に読める形式で、元に戻せる形式の編集の説明を提供します。「元に戻す」メニュー項目などに使用できます。通常は、getDescription() から派生します。

オーバーライド:

クラス CompoundEdit 内の getUndoPresentationName

戻り値:

説明

getRedoPresentationName

public String getRedoPresentationName()

地域対応された、人間に読める形式で、再実行できる形式の編集の説明を提供します。「再実行」メニュー項目などに使用できます。通常は、getPresentationName() から派生します。

オーバーライド:

クラス CompoundEdit 内の getRedoPresentationName

戻り値:

説明

getType

public DocumentEvent.EventType getType()

イベントのタイプを返します。

定義:

インタフェース DocumentEvent 内の getType

戻り値:

イベントのタイプ。DocumentEvent.EventType

関連項目:

DocumentEvent.getType()

getOffset

public int getOffset()

変更の開始点となる、ドキュメント内のオフセットを返します。

定義:

インタフェース DocumentEvent 内の getOffset

戻り値:

オフセット >= 0

関連項目:

DocumentEvent.getOffset()

getLength

public int getLength()

変更の長さを返します。

定義:

インタフェース DocumentEvent 内の getLength

戻り値:

長さ >= 0

関連項目:

DocumentEvent.getLength()

getDocument

public Document getDocument()

変更のイベントのソースとなるドキュメントを取得します。

定義:

インタフェース DocumentEvent 内の getDocument

戻り値:

ドキュメント

関連項目:

DocumentEvent.getDocument()

getChange

public DocumentEvent.ElementChange getChange(Element elem)

要素への変更を取得します。

定義:

インタフェース DocumentEvent 内の getChange

パラメータ:

elem - 要素

戻り値:

変更