com.jaxfront.core.dom
Class DOMChangeEvent

java.lang.Object
  extended by java.util.EventObject
      extended by com.jaxfront.core.dom.DOMChangeEvent
All Implemented Interfaces:
java.io.Serializable

public class DOMChangeEvent
extends java.util.EventObject

Event class used to inform listeners about state changes in the JAXFront DOM.

Version:
1.60
See Also:
Serialized Form

Field Summary
static long DOM_ABOUT_TO_PERSIST
           
static long DOM_ADD_NODE
           
static long DOM_CANCELLED
           
static long DOM_CHANGE_NODE
           
static long DOM_COPY_CONTENT
           
static long DOM_DELETED
           
static long DOM_FINGERPRINT_CHANGED
           
static long DOM_FINISHED_BINDING
           
static long DOM_INITIALIZED
           
static long DOM_IS_ABOUT_TO_SAVE
           
static long DOM_IS_ABOUT_TO_VALIDATE
           
static long DOM_LIST_ITEM_DESELECT
           
static long DOM_LIST_ITEM_SELECT
           
static long DOM_MOVE_NODE
           
static long DOM_PASTE_CONTENT
           
static long DOM_PERSISTENT
           
static long DOM_REMOVE_NODE
           
static long DOM_SAVED
           
static long DOM_SORTED
           
static long DOM_SWAP_NODE
           
static long DOM_TREE_CHANGED
           
static long DOM_VISUALIZER_INITIALIZED
           
static long DOM_VISUALIZER_ONCREATE
           
static long NONE
           
static java.lang.String NULL_EVENT
           
 
Method Summary
static DOMChangeEvent DOM_ADD_NODE(Type newType)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_ADD_NODE(Type newType, int index)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_CANCELLED(java.lang.Object source)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_CHANGE_NODE(Type type)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_COPY_CONTENT(java.lang.Object source)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_DELETED(Document source)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_FINGERPRINT_CHANGED(Document source, java.lang.String name, java.lang.String oldValue, java.lang.String newValue)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_FINISHED_BINDING(Type type)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_INITIALIZED(Document dom)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_IS_ABOUT_TO_PERSIST(Type source)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_IS_ABOUT_TO_SAVE(java.lang.Object source)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_IS_ABOUT_TO_VALIDATE(java.lang.Object source)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_ITEM_DESELECTED(Type deselectedType)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_ITEM_SELECTED(Type selectedType)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_PASTE_CONTENT(java.lang.Object source)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_PERSISTENT(Document source)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_PERSISTENT(Type source)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_REMOVE_NODE(Type type)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_REMOVE_NODE(Type type, int index)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_SAVED(Document source)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_SAVED(Type source)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_SORTED(ListType listType, int[] indexes)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_SWAP_NODE(java.lang.Object source, int movedFrom, int movedTo)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_TREE_CHANGED(java.lang.Object source)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_VISUALIZER_INITIALIZED(java.lang.Object source)
          Factory method for creating a DOMChangeEvent
static DOMChangeEvent DOM_VISUALIZER_ONCREATE(java.lang.Object source)
          Factory method for creating a DOMChangeEvent
 java.lang.String getChangeName()
           
 int getIndex()
          Returns the position of a removed/add type if type is belonging to a list else return 0.
 int[] getIndexes()
          Returns the indexes after a sort.
 int getMovedFromIndex()
          Returns the source index (old index) of a movement.
 int getMovedToIndex()
          Returns the target index (new index) of a movement.
 java.lang.String getNewValue()
           
 java.lang.String getOldValue()
           
 long getType()
          Return final static type of event.
 boolean isAboutToPersist()
           
 boolean isAboutToSave()
          Returns true if this event is an DOM_IS_ABOUT_TO_SAVE event.
 boolean isAboutToValidate()
          Returns true if this event is an DOM_IS_ABOUT_TO_VALIDATE event.
 boolean isAddingNode()
          Returns true if this event is an DOM_ADD_NODE event.
 boolean isCancelled()
          Returns true if this event is an DOM_CANCELLED event.
 boolean isChangingNode()
          Returns true if this event is an DOM_CHANGE_NODE event.
 boolean isCopyContent()
          Returns true if this event is an DOM_INITIALIZED event.
 boolean isDeleted()
           
 boolean isFingerprintChanged()
          Returns true if this event is an DOM_FINISHED_BINDING event.
 boolean isFinishedBinding()
          Returns true if this event is an DOM_FINISHED_BINDING event.
 boolean isInitialized()
          Returns true if this event is an DOM_INITIALIZED event.
 boolean isListItemDeselected()
          Returns true if this event is an DOM_VISUALIZEDevent.
 boolean isListItemSelected()
          Returns true if this event is an DOM_VISUALIZEDevent.
 boolean isMovingNode()
          Returns true if this event is an DOM_MOVE_NODE event.
 boolean isNullEvent()
          Returns true if this event is an DOM_SAVED event.
 boolean isOnCreate()
          Returns true if this event is an DOM_INITIALIZED event.
 boolean isPasteContent()
          Returns true if this event is an DOM_INITIALIZED event.
 boolean isPersistent()
           
 boolean isRemovingNode()
          Returns true if this event is an DOM_REMOVE_NODE event.
 boolean isSaved()
          Returns true if this event is an DOM_SAVED event.
 boolean isSorted()
          Returns true if this event is an DOM_SORTED event.
 boolean isSwappingNode()
          Returns true if this event is an DOM_SWAP_NODE event.
 boolean isTemporary()
          Returns true if this event is just temporarly fired.
 boolean isTreeChange()
          Returns true if this event is an DOM_TREE_CHANGE event.
static DOMChangeEvent NULL_EVENT()
           
 void setIsTemporary(boolean temporary)
          Makes this event temporary or not.
 java.lang.String toString()
           
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NULL_EVENT

public static final java.lang.String NULL_EVENT
See Also:
Constant Field Values

NONE

public static final long NONE
See Also:
Constant Field Values

DOM_SAVED

public static final long DOM_SAVED
See Also:
Constant Field Values

DOM_REMOVE_NODE

public static final long DOM_REMOVE_NODE
See Also:
Constant Field Values

DOM_IS_ABOUT_TO_SAVE

public static final long DOM_IS_ABOUT_TO_SAVE
See Also:
Constant Field Values

DOM_IS_ABOUT_TO_VALIDATE

public static final long DOM_IS_ABOUT_TO_VALIDATE
See Also:
Constant Field Values

DOM_VISUALIZER_INITIALIZED

public static final long DOM_VISUALIZER_INITIALIZED
See Also:
Constant Field Values

DOM_SORTED

public static final long DOM_SORTED
See Also:
Constant Field Values

DOM_CANCELLED

public static final long DOM_CANCELLED
See Also:
Constant Field Values

DOM_TREE_CHANGED

public static final long DOM_TREE_CHANGED
See Also:
Constant Field Values

DOM_CHANGE_NODE

public static final long DOM_CHANGE_NODE
See Also:
Constant Field Values

DOM_MOVE_NODE

public static final long DOM_MOVE_NODE
See Also:
Constant Field Values

DOM_SWAP_NODE

public static final long DOM_SWAP_NODE
See Also:
Constant Field Values

DOM_FINISHED_BINDING

public static final long DOM_FINISHED_BINDING
See Also:
Constant Field Values

DOM_ADD_NODE

public static final long DOM_ADD_NODE
See Also:
Constant Field Values

DOM_PERSISTENT

public static final long DOM_PERSISTENT
See Also:
Constant Field Values

DOM_ABOUT_TO_PERSIST

public static final long DOM_ABOUT_TO_PERSIST
See Also:
Constant Field Values

DOM_INITIALIZED

public static final long DOM_INITIALIZED
See Also:
Constant Field Values

DOM_LIST_ITEM_SELECT

public static final long DOM_LIST_ITEM_SELECT
See Also:
Constant Field Values

DOM_LIST_ITEM_DESELECT

public static final long DOM_LIST_ITEM_DESELECT
See Also:
Constant Field Values

DOM_VISUALIZER_ONCREATE

public static final long DOM_VISUALIZER_ONCREATE
See Also:
Constant Field Values

DOM_COPY_CONTENT

public static final long DOM_COPY_CONTENT
See Also:
Constant Field Values

DOM_PASTE_CONTENT

public static final long DOM_PASTE_CONTENT
See Also:
Constant Field Values

DOM_DELETED

public static final long DOM_DELETED
See Also:
Constant Field Values

DOM_FINGERPRINT_CHANGED

public static final long DOM_FINGERPRINT_CHANGED
See Also:
Constant Field Values
Method Detail

DOM_ADD_NODE

public static DOMChangeEvent DOM_ADD_NODE(Type newType)
Factory method for creating a DOMChangeEvent

Parameters:
newType - new type added to the DOM

DOM_SORTED

public static DOMChangeEvent DOM_SORTED(ListType listType,
                                        int[] indexes)
Factory method for creating a DOMChangeEvent

Parameters:
listType - ListType which was sorted
indexes - indexes after the sort

NULL_EVENT

public static DOMChangeEvent NULL_EVENT()

DOM_ADD_NODE

public static DOMChangeEvent DOM_ADD_NODE(Type newType,
                                          int index)
Factory method for creating a DOMChangeEvent

Parameters:
newType - new type added to the DOM
index - indicates if listeners needs to check (-1) or not (0) if the added type is represented in the tree

DOM_CANCELLED

public static DOMChangeEvent DOM_CANCELLED(java.lang.Object source)
Factory method for creating a DOMChangeEvent

Parameters:
source - source of cancellation

DOM_COPY_CONTENT

public static DOMChangeEvent DOM_COPY_CONTENT(java.lang.Object source)
Factory method for creating a DOMChangeEvent

Parameters:
source - source of copy content

DOM_PASTE_CONTENT

public static DOMChangeEvent DOM_PASTE_CONTENT(java.lang.Object source)
Factory method for creating a DOMChangeEvent

Parameters:
source - source of paste content

DOM_CHANGE_NODE

public static DOMChangeEvent DOM_CHANGE_NODE(Type type)
Factory method for creating a DOMChangeEvent

Parameters:
type - type which has changed

DOM_INITIALIZED

public static DOMChangeEvent DOM_INITIALIZED(Document dom)
Factory method for creating a DOMChangeEvent

Parameters:
type - type which has changed

DOM_ITEM_SELECTED

public static DOMChangeEvent DOM_ITEM_SELECTED(Type selectedType)
Factory method for creating a DOMChangeEvent

Parameters:
type - type which has changed

DOM_ITEM_DESELECTED

public static DOMChangeEvent DOM_ITEM_DESELECTED(Type deselectedType)
Factory method for creating a DOMChangeEvent

Parameters:
type - type which has changed

DOM_FINISHED_BINDING

public static DOMChangeEvent DOM_FINISHED_BINDING(Type type)
Factory method for creating a DOMChangeEvent


DOM_VISUALIZER_INITIALIZED

public static DOMChangeEvent DOM_VISUALIZER_INITIALIZED(java.lang.Object source)
Factory method for creating a DOMChangeEvent

Parameters:
source - source which has been initialized

DOM_VISUALIZER_ONCREATE

public static DOMChangeEvent DOM_VISUALIZER_ONCREATE(java.lang.Object source)
Factory method for creating a DOMChangeEvent

Parameters:
source - source which has been initialized

DOM_TREE_CHANGED

public static DOMChangeEvent DOM_TREE_CHANGED(java.lang.Object source)
Factory method for creating a DOMChangeEvent

Parameters:
source - source which has been added/remove to/from tree

DOM_IS_ABOUT_TO_SAVE

public static DOMChangeEvent DOM_IS_ABOUT_TO_SAVE(java.lang.Object source)
Factory method for creating a DOMChangeEvent

Parameters:
source - source which is about to save

DOM_IS_ABOUT_TO_VALIDATE

public static DOMChangeEvent DOM_IS_ABOUT_TO_VALIDATE(java.lang.Object source)
Factory method for creating a DOMChangeEvent

Parameters:
source - source which is about to validate

DOM_REMOVE_NODE

public static DOMChangeEvent DOM_REMOVE_NODE(Type type)
Factory method for creating a DOMChangeEvent

Parameters:
type - type which has been removed

DOM_REMOVE_NODE

public static DOMChangeEvent DOM_REMOVE_NODE(Type type,
                                             int index)
Factory method for creating a DOMChangeEvent

Parameters:
type - type which has been removed
index - index of removed type (in a list)

DOM_SAVED

public static DOMChangeEvent DOM_SAVED(Type source)
Factory method for creating a DOMChangeEvent

Parameters:
source - source of saved type

DOM_SAVED

public static DOMChangeEvent DOM_SAVED(Document source)
Factory method for creating a DOMChangeEvent

Parameters:
source - source of saved type

DOM_PERSISTENT

public static DOMChangeEvent DOM_PERSISTENT(Type source)
Factory method for creating a DOMChangeEvent

Parameters:
source - source of persistend type

DOM_IS_ABOUT_TO_PERSIST

public static DOMChangeEvent DOM_IS_ABOUT_TO_PERSIST(Type source)
Factory method for creating a DOMChangeEvent

Parameters:
source - source of persistend type

DOM_PERSISTENT

public static DOMChangeEvent DOM_PERSISTENT(Document source)
Factory method for creating a DOMChangeEvent

Parameters:
source - source of persistend type

DOM_DELETED

public static DOMChangeEvent DOM_DELETED(Document source)
Factory method for creating a DOMChangeEvent

Parameters:
source - source of persistend type

DOM_FINGERPRINT_CHANGED

public static DOMChangeEvent DOM_FINGERPRINT_CHANGED(Document source,
                                                     java.lang.String name,
                                                     java.lang.String oldValue,
                                                     java.lang.String newValue)
Factory method for creating a DOMChangeEvent

Parameters:
source - source of persistend type

DOM_SWAP_NODE

public static DOMChangeEvent DOM_SWAP_NODE(java.lang.Object source,
                                           int movedFrom,
                                           int movedTo)
Factory method for creating a DOMChangeEvent

Parameters:
sourceNode - source node
targetNode - target node

getIndex

public int getIndex()
Returns the position of a removed/add type if type is belonging to a list else return 0.


getIndexes

public int[] getIndexes()
Returns the indexes after a sort.


getType

public long getType()
Return final static type of event.


isAboutToSave

public boolean isAboutToSave()
Returns true if this event is an DOM_IS_ABOUT_TO_SAVE event.


isFinishedBinding

public boolean isFinishedBinding()
Returns true if this event is an DOM_FINISHED_BINDING event.


isFingerprintChanged

public boolean isFingerprintChanged()
Returns true if this event is an DOM_FINISHED_BINDING event.


isAboutToValidate

public boolean isAboutToValidate()
Returns true if this event is an DOM_IS_ABOUT_TO_VALIDATE event.


isAddingNode

public boolean isAddingNode()
Returns true if this event is an DOM_ADD_NODE event.


isCancelled

public boolean isCancelled()
Returns true if this event is an DOM_CANCELLED event.


isPersistent

public boolean isPersistent()

isDeleted

public boolean isDeleted()

isAboutToPersist

public boolean isAboutToPersist()

isChangingNode

public boolean isChangingNode()
Returns true if this event is an DOM_CHANGE_NODE event.


isInitialized

public boolean isInitialized()
Returns true if this event is an DOM_INITIALIZED event.


isOnCreate

public boolean isOnCreate()
Returns true if this event is an DOM_INITIALIZED event.


isCopyContent

public boolean isCopyContent()
Returns true if this event is an DOM_INITIALIZED event.


isPasteContent

public boolean isPasteContent()
Returns true if this event is an DOM_INITIALIZED event.


isMovingNode

public boolean isMovingNode()
Returns true if this event is an DOM_MOVE_NODE event.


isSorted

public boolean isSorted()
Returns true if this event is an DOM_SORTED event.


isListItemSelected

public boolean isListItemSelected()
Returns true if this event is an DOM_VISUALIZEDevent.


isListItemDeselected

public boolean isListItemDeselected()
Returns true if this event is an DOM_VISUALIZEDevent.


isTreeChange

public boolean isTreeChange()
Returns true if this event is an DOM_TREE_CHANGE event.


isRemovingNode

public boolean isRemovingNode()
Returns true if this event is an DOM_REMOVE_NODE event.


isSaved

public boolean isSaved()
Returns true if this event is an DOM_SAVED event.


isNullEvent

public boolean isNullEvent()
Returns true if this event is an DOM_SAVED event.


isSwappingNode

public boolean isSwappingNode()
Returns true if this event is an DOM_SWAP_NODE event.


isTemporary

public boolean isTemporary()
Returns true if this event is just temporarly fired.


setIsTemporary

public void setIsTemporary(boolean temporary)
Makes this event temporary or not.

Parameters:
temporary - indicates if this event is temporary or not

getMovedFromIndex

public int getMovedFromIndex()
Returns the source index (old index) of a movement.


getMovedToIndex

public int getMovedToIndex()
Returns the target index (new index) of a movement.


getOldValue

public java.lang.String getOldValue()

getChangeName

public java.lang.String getChangeName()

getNewValue

public java.lang.String getNewValue()

toString

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