com.xmlmind.xml.doc

Class InclusionUpdatedEvent

java.lang.Object

com.xmlmind.xml.doc.DocumentEvent

com.xmlmind.xml.doc.InclusionUpdatedEvent

All Implemented Interfaces:

Cloneable

public final class InclusionUpdatedEvent
extends DocumentEvent

Used to signal that an Inclusion has been updated, that is, that a sequence of contiguous included nodes has been replaced by another sequence of contiguous included nodes.

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
InclusionUpdatedEvent() Constructs an event intended to be used several times with different field values.
InclusionUpdatedEvent(Object source, Inclusion inclusion, Node[] oldChildren, Node[] newChildren) Contructs an event.

Method Summary

Modifier and Type	Method and Description
Node	getBeforeChild() Convenience method: returns child node before which the replacement of nodes was made.
Document	getDocumentSource() Convenience method: returns the document containing included nodes.
Element	getElementSource() Convenience method: returns the element containing included nodes.
Inclusion	getInclusion() Returns the Inclusion which has been updated.
Node[]	getNewChildren() Returns replacement child nodes, a possibly empty array.
Node[]	getOldChildren() Returns replaced child nodes, a possibly empty array.
Tree	getTreeSource() Returns the tree containing included nodes.
void	initialize(Object source, Inclusion inclusion, Node[] oldChildren, Node[] newChildren) 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

InclusionUpdatedEvent

public InclusionUpdatedEvent()

Constructs an event intended to be used several times with different field values. Use initialize(java.lang.Object, com.xmlmind.xml.doc.Inclusion, com.xmlmind.xml.doc.Node[], com.xmlmind.xml.doc.Node[]) to initialize its fields.

InclusionUpdatedEvent

public InclusionUpdatedEvent(Object source,
                             Inclusion inclusion,
                             Node[] oldChildren,
                             Node[] newChildren)

Contructs an event.

Parameters:

source - the modified tree

inclusion - the Inclusion which has been updated

oldChildren - removed or replaced child nodes. May be null or an empty array.

newChildren - added or replacement child nodes. May be null or an empty array.

Method Detail

initialize

public void initialize(Object source,
                       Inclusion inclusion,
                       Node[] oldChildren,
                       Node[] newChildren)

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

Parameters:

source - the modified tree

inclusion - the Inclusion which has been updated

oldChildren - removed or replaced child nodes. May be null or an empty array.

newChildren - added or replacement child nodes. May be null or an empty array.

getTreeSource

public Tree getTreeSource()

Returns the tree containing included nodes.

getElementSource

public Element getElementSource()

Convenience method: returns the element containing included nodes.

getDocumentSource

public Document getDocumentSource()

Convenience method: returns the document containing included nodes.

getInclusion

public Inclusion getInclusion()

Returns the Inclusion which has been updated.

getOldChildren

public Node[] getOldChildren()

Returns replaced child nodes, a possibly empty array.

getNewChildren

public Node[] getNewChildren()

Returns replacement child nodes, a possibly empty array.

getBeforeChild

public Node getBeforeChild()

Convenience method: returns child node before which the replacement of nodes was made. May be null.

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