ilog.views.gantt.event

Class RowChildEvent

java.lang.Object

java.util.EventObject

ilog.views.gantt.event.RowChildEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

RowsInsertedEvent, RowsRemovedEvent

public abstract class RowChildEvent
extends EventObject

RowChildEvent is the superclass of events that are fired on behalf of a Gantt configuration by an IlvVerticalExpansionMaster to notify all registered expandable UI components when children have been inserted or removed from a common parent in the displayed data tree. The child rows must be siblings and direct descendents (not grandchildren) of the specified parent row.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
RowChildEvent(IlvGanttConfiguration ganttConfig, IlvHierarchyNode parent, IlvHierarchyNode[] children, int[] childIndices) Constructs a new RowChildEvent generated by the specified Gantt configuration that can be used to notify listeners when child rows have been inserted or removed from a common parent.

Method Summary

Modifier and Type	Method and Description
int[]	getChildIndices() Returns the indices of the child rows.
IlvHierarchyNode[]	getChildren() Returns the array of child IlvHierarchyNode's that have been inserted or removed.
IlvGanttConfiguration	getGanttConfiguration() Returns the Gantt configuration where the event originated.
IlvGanttModel	getGanttModel() Returns the data model currently being displayed by the Gantt configuration.
IlvHierarchyNode	getParent() Returns the parent row which has had children inserted or removed.

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

RowChildEvent

public RowChildEvent(IlvGanttConfiguration ganttConfig,
                     IlvHierarchyNode parent,
                     IlvHierarchyNode[] children,
                     int[] childIndices)

Constructs a new RowChildEvent generated by the specified Gantt configuration that can be used to notify listeners when child rows have been inserted or removed from a common parent.

Parameters:

ganttConfig - The Gantt configuration where the event originated.

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

children - The array of child IlvHierarchyNode's that have been inserted or removed. The rows must be arranged in parallel with childIndices, ordered according to their indices within their common parent row from lowest to highest.

childIndices - An int array of the child row indices, arranged in parallel with children, ordered from lowest to highest. If this is an insert event, the indices point to the final locations in the parent row where the children were inserted. If this is a removal event, then the indices point to the original locations in the parent row where the children were removed.

Method Detail

getGanttConfiguration

public IlvGanttConfiguration getGanttConfiguration()

Returns the Gantt configuration where the event originated.

Returns:

The IlvGanttConfiguration where the event originated.

getGanttModel

public final IlvGanttModel getGanttModel()

Returns the data model currently being displayed by the Gantt configuration.

Returns:

The IlvGanttModel currently displayed by the Gantt configuration.

Since:

JViews 5.5

getParent

public IlvHierarchyNode getParent()

Returns the parent row which has had children inserted or removed. If the insertion or deletion being reported is the hierarchy's root row, then this method returns null.

Returns:

The parent IlvHierarchyNode.

getChildIndices

public int[] getChildIndices()

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

Returns:

The array of child row indices.

getChildren

public IlvHierarchyNode[] getChildren()

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

Returns:

The array of child nodes that have been inserted or removed.