All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface uhr.core.structure.ContainerEvent

public interface ContainerEvent
This event occurs when the various constants happen.

Currently we strongly discourage the use of the SEMANTIC event because this results in unpublished part output. JH

Variable Index

o ALL_CHILDREN_REMOVED
The event type for all child nodes removed from a container node.
o CHILD_APPENDED
The event type for a child node appended to a container node.
o CHILD_INSERTED
The event type for a child node inserted in a container node.
o CHILD_REMOVED
The event type for a child node removed from a container node.
o SEMANTIC
The event type for semantic events.

Method Index

o getChildNode()
Returns the child node that was appended, inserted or removed.
o getContainer()
Returns the orginiating node of the event.
o getEventName()
Returns the event name, such as "uhr.core.CheckNeeds".
o getEventType()
Returns the event type, which is one of the constants in this interface.
o getNodeBefore()
For event type CHILD_INSERTED, returns the "node before".
o getNodeRemoved()
For event type CHILD_REMOVED, returns the node actually removed, which may be null.

Variables

o CHILD_APPENDED 
 public static final int CHILD_APPENDED
The event type for a child node appended to a container node. This is also triggered by Container.appendPart(...).

o CHILD_INSERTED 
 public static final int CHILD_INSERTED
The event type for a child node inserted in a container node.

o CHILD_REMOVED 
 public static final int CHILD_REMOVED
The event type for a child node removed from a container node.

o ALL_CHILDREN_REMOVED 
 public static final int ALL_CHILDREN_REMOVED
The event type for all child nodes removed from a container node.

o SEMANTIC 
 public static final int SEMANTIC
The event type for semantic events. These are used by parts to notify other parts of purely semantic state changes.

Methods

o getEventType 
 public abstract int getEventType()
Returns the event type, which is one of the constants in this interface.

Returns:
the event type constant.
o getContainer 
 public abstract Container getContainer()
Returns the orginiating node of the event. For example if a CHILD_APPENDED event occurred, it was appended to the ContainerNode returned.

Returns:
the originating node of the event.
o getChildNode 
 public abstract Node getChildNode()
Returns the child node that was appended, inserted or removed. For ALL_CHILDREN_REMOVED null is returned.

Returns:
the child node involved in the event or null.
o getNodeBefore 
 public abstract Node getNodeBefore()
For event type CHILD_INSERTED, returns the "node before". For all other event types returns null.

Returns:
the "node before" or null.
o getNodeRemoved 
 public abstract Node getNodeRemoved()
For event type CHILD_REMOVED, returns the node actually removed, which may be null. For all other event types returns null.

Returns:
the actual node removed or null.
o getEventName 
 public abstract String getEventName()
Returns the event name, such as "uhr.core.CheckNeeds". This may be null for non-semantic events. 

All Packages  Class Hierarchy  This Package  Previous  Next  Index