Package org.eclipse.jface.text

Class DocumentEvent

  • Direct Known Subclasses:
    SlaveDocumentEvent
    public class DocumentEvent
extends java.lang.Object
    Specification of changes applied to documents. All changes are represented as replace commands, i.e. specifying a document range whose text gets replaced with different text. In addition to this information, the event also contains the changed document.
    See Also:
    IDocument

    • Field Summary

      Fields 
      Modifier and Type Field Description
      IDocument fDocument
      The changed document
      int fLength
      Length of the replaced document text
      long fModificationStamp
      The modification stamp of the document when firing this event.
      int fOffset
      The document offset
      java.lang.String fText
      Text inserted into the document

    • Constructor Summary

      Constructors 
      Constructor Description
      DocumentEvent()
      Creates a new, not initialized document event.
      DocumentEvent​(IDocument doc, int offset, int length, java.lang.String text)
      Creates a new document event.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      IDocument getDocument()
      Returns the changed document.
      int getLength()
      Returns the length of the replaced text.
      long getModificationStamp()
      Returns the document's modification stamp at the time when this event was sent.
      int getOffset()
      Returns the offset of the change.
      java.lang.String getText()
      Returns the text that has been inserted.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • fDocument

        public IDocument fDocument
        The changed document

      • fOffset

        public int fOffset
        The document offset

      • fLength

        public int fLength
        Length of the replaced document text

      • fText

        public java.lang.String fText
        Text inserted into the document

      • fModificationStamp

        public long fModificationStamp
        The modification stamp of the document when firing this event.
        Since:
        3.1 and public since 3.3

    • Constructor Detail

      • DocumentEvent

        public DocumentEvent​(IDocument doc,
                     int offset,
                     int length,
                     java.lang.String text)
        Creates a new document event.
        Parameters:
        doc - the changed document
        offset - the offset of the replaced text
        length - the length of the replaced text
        text - the substitution text

      • DocumentEvent

        public DocumentEvent()
        Creates a new, not initialized document event.

    • Method Detail

      • getDocument

        public IDocument getDocument()
        Returns the changed document.
        Returns:
        the changed document

      • getOffset

        public int getOffset()
        Returns the offset of the change.
        Returns:
        the offset of the change

      • getLength

        public int getLength()
        Returns the length of the replaced text.
        Returns:
        the length of the replaced text

      • getText

        public java.lang.String getText()
        Returns the text that has been inserted.
        Returns:
        the text that has been inserted

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object