Package com.intellij.openapi.editor.impl.event

Class DocumentEventImpl

java.lang.Object

java.util.EventObject

com.intellij.openapi.editor.event.DocumentEvent

com.intellij.openapi.editor.impl.event.DocumentEventImpl

All Implemented Interfaces:

java.io.Serializable

public class DocumentEventImpl
extends DocumentEvent

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
DocumentEventImpl(Document document, int offset, java.lang.CharSequence oldString, java.lang.CharSequence newString, long oldTimeStamp, boolean wholeTextReplaced)
DocumentEventImpl(Document document, int offset, java.lang.CharSequence oldString, java.lang.CharSequence newString, long oldTimeStamp, boolean wholeTextReplaced, int initialStartOffset, int initialOldLength, int moveOffset)

Method Summary

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

Methods inherited from class com.intellij.openapi.editor.event.DocumentEvent

getDocument

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentEventImpl

public DocumentEventImpl(Document document,
                         int offset,
                         java.lang.CharSequence oldString,
                         java.lang.CharSequence newString,
                         long oldTimeStamp,
                         boolean wholeTextReplaced)

DocumentEventImpl

public DocumentEventImpl(Document document,
                         int offset,
                         java.lang.CharSequence oldString,
                         java.lang.CharSequence newString,
                         long oldTimeStamp,
                         boolean wholeTextReplaced,
                         int initialStartOffset,
                         int initialOldLength,
                         int moveOffset)

Method Detail

getOffset

public int getOffset()

Description copied from class: DocumentEvent

The start offset of a text change.

Specified by:

getOffset in class DocumentEvent

getOldLength

public int getOldLength()

Specified by:

getOldLength in class DocumentEvent

getNewLength

public int getNewLength()

Specified by:

getNewLength in class DocumentEvent

getOldFragment

public java.lang.CharSequence getOldFragment()

Specified by:

getOldFragment in class DocumentEvent

getNewFragment

public java.lang.CharSequence getNewFragment()

Specified by:

getNewFragment in class DocumentEvent

getInitialStartOffset

public int getInitialStartOffset()

Returns:

initial start offset as requested in Document.replaceString(int, int, CharSequence) call, before common prefix and suffix were removed from the changed range.

getInitialOldLength

public int getInitialOldLength()

Returns:

initial "old fragment" length (endOffset - startOffset) as requested in Document.replaceString(int, int, CharSequence) call, before common prefix and suffix were removed from the changed range.

getMoveOffset

public int getMoveOffset()

Description copied from class: DocumentEvent

In case of any document modifications other than moving text, this method returns the same as DocumentEvent.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 ]
 

Overrides:

getMoveOffset in class DocumentEvent

getOldTimeStamp

public long getOldTimeStamp()

Specified by:

getOldTimeStamp in class DocumentEvent

toString

public java.lang.String toString()

Overrides:

toString in class java.util.EventObject

isWholeTextReplaced

public boolean isWholeTextReplaced()

Overrides:

isWholeTextReplaced in class DocumentEvent

translateLineViaDiff

public int translateLineViaDiff(int line)
                         throws FilesTooBigForDiffException

Throws:

FilesTooBigForDiffException

translateLineViaDiffStrict

public int translateLineViaDiffStrict(int line)
                               throws FilesTooBigForDiffException

Throws:

FilesTooBigForDiffException