com.xmlmind.xml.doc

Class TextEvent

java.lang.Object

com.xmlmind.xml.doc.DocumentEvent

com.xmlmind.xml.doc.TextEvent

All Implemented Interfaces:

Cloneable

public final class TextEvent
extends DocumentEvent

Used to signal that characters have been modified in a text node (text, comment, processing instruction).

Nested Class Summary

Nested classes/interfaces inherited from class com.xmlmind.xml.doc.DocumentEvent

DocumentEvent.Type

Field Summary

Fields inherited from class com.xmlmind.xml.doc.DocumentEvent

source, type

Constructor Summary

Constructors

Constructor and Description
TextEvent() Constructs an event intended to be used several times with different field values.
TextEvent(Object source, DocumentEvent.Type type, int offset, String oldString, String newString) Contructs an event.

Method Summary

Modifier and Type	Method and Description
String	getNewString() Returns deleted or replaced string or null if a string has been inserted.
int	getOffset() Returns index (within text node) of first character of newString if a string has been inserted or replaced or index of first character of oldString if a string has been deleted.
String	getOldString() Returns deleted or replaced string or null if a string has been inserted.
TextNode	getTextSource() Returns the text node which has been modified.
void	initialize(Object source, DocumentEvent.Type type, int offset, String oldString, String newString) Initializes this event.
String	toString() Returns a string representation of this event which can be used when debugging.

Methods inherited from class com.xmlmind.xml.doc.DocumentEvent

copy, getSource, getType, initialize

Methods inherited from class java.lang.Object

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

Constructor Detail

TextEvent

public TextEvent()

Constructs an event intended to be used several times with different field values. Use initialize(java.lang.Object, com.xmlmind.xml.doc.DocumentEvent.Type, int, java.lang.String, java.lang.String) to initialize its fields.

TextEvent

public TextEvent(Object source,
                 DocumentEvent.Type type,
                 int offset,
                 String oldString,
                 String newString)

Contructs an event.

Parameters:

source - the modified text node

type - the type of the event

offset - index (within text node) of first character of newString if a string has been inserted or replaced or index of first character of oldString if a string has been deleted

oldString - deleted or replaced string or null if a string has been inserted

newString - inserted or replacement string or null if a string has been deleted

Method Detail

initialize

public void initialize(Object source,
                       DocumentEvent.Type type,
                       int offset,
                       String oldString,
                       String newString)

Initializes this event. Allows to reuse the same event object.

Parameters:

source - the modified text node

type - the type of the event

getTextSource

public TextNode getTextSource()

Returns the text node which has been modified.

getOffset

public int getOffset()

Returns index (within text node) of first character of newString if a string has been inserted or replaced or index of first character of oldString if a string has been deleted.

getOldString

public String getOldString()

Returns deleted or replaced string or null if a string has been inserted.

getNewString

public String getNewString()

Returns deleted or replaced string or null if a string has been inserted.

toString

public String toString()

Description copied from class: DocumentEvent

Returns a string representation of this event which can be used when debugging.

Overrides:

toString in class DocumentEvent