ilog.views.gantt.event

Class IlvHierarchyNodeChildEvent<N extends IlvHierarchyNode>

java.lang.Object

java.util.EventObject

ilog.views.gantt.event.IlvHierarchyNodeChildEvent<N>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ActivitiesInsertedEvent, ActivitiesRemovedEvent, ResourcesInsertedEvent, ResourcesRemovedEvent

public abstract class IlvHierarchyNodeChildEvent<N extends IlvHierarchyNode>
extends EventObject

IlvHierarchyNodeChildEvent is the superclass of all events that are used to notify listeners when children have been inserted or removed from a common parent node in a tree of nodes managed by an IlvGanttModel. The child nodes must be siblings and direct descendents (not grandchildren) of the specified parent node.

See Also:

IlvGanttModel, Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
IlvHierarchyNodeChildEvent(IlvGanttModel model, N parent, int[] childIndices) Constructs a new IlvHierarchyNodeChildEvent generated by the specified data model that can be used to notify listeners when child nodes have been inserted into a common parent.
IlvHierarchyNodeChildEvent(IlvGanttModel model, N parent, List<? extends N> children) Constructs a new IlvHierarchyNodeChildEvent generated by the specified data model that can be used to notify listeners when child nodes have been inserted into a common parent.
IlvHierarchyNodeChildEvent(IlvGanttModel model, N parent, List<? extends N> children, int[] childIndices) Constructs a new IlvHierarchyNodeChildEvent generated by the specified data model that can be used to notify listeners when child nodes have been removed from a common parent.

Method Summary

Modifier and Type	Method and Description
int[]	getChildIndices() Returns the indices of the child nodes.
IlvHierarchyNode[]	getChildNodes() Returns the array of child IlvHierarchyNode's that have been inserted or removed.
List<N>	getChildren() Returns the list of child IlvHierarchyNode's that have been inserted or removed.
IlvGanttModel	getGanttModel() Returns the data model where the event originated.
protected N	getParent() Returns the parent node which identifies the portion of the tree hierarchy that has been modified.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvHierarchyNodeChildEvent

public IlvHierarchyNodeChildEvent(IlvGanttModel model,
                                  N parent,
                                  int[] childIndices)

Constructs a new IlvHierarchyNodeChildEvent generated by the specified data model that can be used to notify listeners when child nodes have been inserted into a common parent. Note: This constructor cannot be used to notify listeners when the root node of the hierarchy has been inserted.

Parameters:

model - the data model where the event originated

parent - the parent node which has had children inserted

childIndices - an int array that specifies the index values of the inserted nodes. The indices represent the final state of the node tree, after the inserts have occurred. The indices do not have to be pre-sorted.

IlvHierarchyNodeChildEvent

public IlvHierarchyNodeChildEvent(IlvGanttModel model,
                                  N parent,
                                  List<? extends N> children)

Constructs a new IlvHierarchyNodeChildEvent generated by the specified data model that can be used to notify listeners when child nodes have been inserted into a common parent.

Parameters:

model - the data model where the event originated

parent - the parent node which has had children inserted. If the insertion being reported is the hierarchy's root node, parent should be null and children should be a single element list containing the root node.

children - the list of child IlvHierarchyNode's that have been inserted. The nodes do not have to be presorted.

IlvHierarchyNodeChildEvent

public IlvHierarchyNodeChildEvent(IlvGanttModel model,
                                  N parent,
                                  List<? extends N> children,
                                  int[] childIndices)

Constructs a new IlvHierarchyNodeChildEvent generated by the specified data model that can be used to notify listeners when child nodes have been removed from a common parent.

Parameters:

model - the data model where the event originated

parent - the parent node which has had children removed. If the deletion being reported is the hierarchy's root node, parent should be null, children should be a single element list containing the root node, and childIndices should be a single element array with childIndices[0]=0.

children - the list of child IlvHierarchyNode's that have been removed. The nodes do not have to be presorted, but must be arranged in parallel with childIndices. In other words, childIndices[i] must contain the index that node (IlvHierarchyNode)children.get(i) had before it was removed.

childIndices - an int array that specifies the index values that the child nodes had before they were removed. The indices do not have to be presorted, but must be arranged in parallel with children.

Method Detail

getGanttModel

public IlvGanttModel getGanttModel()

Returns the data model where the event originated.

Returns:

The IlvGanttModel where the event originated.

getChildIndices

public int[] getChildIndices()

Returns the indices of the child nodes. If this is a removal event then the indices point to the original locations in the parent node where the children were removed. If it is an insert event, the indices point to the final locations in the parent node where the children were inserted. The indices will be ordered from lowest to highest.

Returns:

The array of child node indices.

getChildren

public List<N> getChildren()

Returns the list of child IlvHierarchyNode's that have been inserted or removed. The nodes are ordered according to their indices within their common parent node, arranged from lowest to highest.

Returns:

The List of nodes that have been inserted or removed.

getChildNodes

public IlvHierarchyNode[] getChildNodes()

Returns the array of child IlvHierarchyNode's that have been inserted or removed. The nodes are ordered according to their indices within their common parent node, arranged from lowest to highest.

Returns:

The array of nodes that have been inserted or removed.

getParent

protected final N getParent()

Returns the parent node which identifies the portion of the tree hierarchy that has been modified.

Returns:

The parent IlvHierarchyNode.