Package com.intellij.openapi.editor.event

Class DocumentEvent

java.lang.Object

java.util.EventObject

com.intellij.openapi.editor.event.DocumentEvent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DocumentEventImpl, MockDocumentEvent

public abstract class DocumentEvent
extends java.util.EventObject

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DocumentEvent(Document document)

Method Summary

Modifier and Type	Method and Description
Document	getDocument()
int	getMoveOffset() In case of any document modifications other than moving text, this method returns the same as getOffset().
abstract java.lang.CharSequence	getNewFragment()
abstract int	getNewLength()
abstract int	getOffset() The start offset of a text change.
abstract java.lang.CharSequence	getOldFragment()
abstract int	getOldLength()
abstract long	getOldTimeStamp()
boolean	isWholeTextReplaced()

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentEvent

protected DocumentEvent(Document document)

Method Detail

getDocument

public Document getDocument()

getOffset

public abstract int getOffset()

The start offset of a text change.

getMoveOffset

public int getMoveOffset()

In case of any document modifications other than moving text, this method returns the same as getOffset(). Moving a text fragment using DocumentEx.moveText(int, int, int) is accomplished by a combination of insertion and deletion. For these two events this method returns the offset of the complementary deletion/insertion event:

• On insertion: returns the source offset, that is, the offset of the original text fragment, which will be removed.
• On deletion: returns the destination offset, that is, the offset of the newly inserted text fragment.

Note that the result of this method points to a relevant fragment of the document content only as long as both the source and the destination copies of the fragment are still there, that is, only: a) during DocumentListener.documentChanged(com.intellij.openapi.editor.event.DocumentEvent) of the insertion event, and b) during DocumentListener.beforeDocumentChange(com.intellij.openapi.editor.event.DocumentEvent) of the deletion event. In order to obtain an adjusted value before the new fragment is inserted or after deleting the original one, consider using the DocumentEventUtil.getMoveOffsetBeforeInsertion(com.intellij.openapi.editor.event.DocumentEvent) and the DocumentEventUtil.getMoveOffsetAfterDeletion(com.intellij.openapi.editor.event.DocumentEvent) methods, accordingly.

Examples: Moving text to the left:

   document.moveText(2, 6, 0);  //  aa^^^^bb  ->  ^^^^aa^^^^bb  ->  ^^^^aabb
 

In this example the following listener calls are performed:

   beforeDocumentChange(insert):  aa^^^^bb      [ offset: 0, oldLength: 0, newLength: 4, moveOffset: 6, moveOffsetBeforeInsertion: 2 ]
        documentChanged(insert):  ^^^^aa^^^^bb  [ offset: 0, oldLength: 0, newLength: 4, moveOffset: 6 ] // moveOffset == delete.offset
   beforeDocumentChange(delete):  ^^^^aa^^^^bb  [ offset: 6, oldLength: 4, newLength: 0, moveOffset: 0 ] // moveOffset == insert.offset
        documentChanged(delete):  ^^^^aabb      [ offset: 6, oldLength: 4, newLength: 0, moveOffset: 0, moveOffsetAfterDeletion: 0 ]
 

Moving text to the right:

   document.moveText(2, 6, 8);  //  aa^^^^bb  ->  aa^^^^bb^^^^  ->  aabb^^^^
 

In this example the following listener calls are performed:

   beforeDocumentChange(insert):  aa^^^^bb      [ offset: 8, oldLength: 0, newLength: 4, moveOffset: 2, moveOffsetBeforeInsertion: 2 ]
        documentChanged(insert):  aa^^^^bb^^^^  [ offset: 8, oldLength: 0, newLength: 4, moveOffset: 2 ] // moveOffset == delete.offset
   beforeDocumentChange(delete):  aa^^^^bb^^^^  [ offset: 2, oldLength: 4, newLength: 0, moveOffset: 8 ] // moveOffset == insert.offset
        documentChanged(delete):  aabb^^^^      [ offset: 2, oldLength: 4, newLength: 0, moveOffset: 8, moveOffsetAfterDeletion: 4 ]
 

getOldLength

public abstract int getOldLength()

getNewLength

public abstract int getNewLength()

getOldFragment

public abstract java.lang.CharSequence getOldFragment()

getNewFragment

public abstract java.lang.CharSequence getNewFragment()

getOldTimeStamp

public abstract long getOldTimeStamp()

isWholeTextReplaced

public boolean isWholeTextReplaced()