ilog.views.gantt.event

Class RowsInsertedEvent

java.lang.Object

java.util.EventObject

ilog.views.gantt.event.RowChildEvent

ilog.views.gantt.event.RowsInsertedEvent

All Implemented Interfaces:

Serializable

public class RowsInsertedEvent
extends RowChildEvent

RowsInsertedEvent is fired on behalf of a Gantt configuration by an IlvVerticalExpansionMaster to notify all registered expandable UI components when children have been inserted into a common parent node in the displayed data tree. If the configuration's row organization is ACTIVITY_ROWS then this event is similar to an ActivitiesInsertedEvent. Otherwise, the configuration's row organization is RESOURCE_ROWS and this event is similar to a ResourcesInsertedEvent. In either case, visibility info about the inserted nodes is provided that is not available from the data model events themselves. All, some, or none of the newly inserted nodes into the data model may actually be visible. The child nodes must be siblings and direct descendents (not grandchildren) of the specified parent node.

See Also:

IlvGanttConfiguration, IlvVerticalExpansionMaster, IlvVerticalExpandable, Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
RowsInsertedEvent(IlvGanttConfiguration ganttConfig, IlvHierarchyNode parent, IlvHierarchyNode[] children, int[] childIndices, IlvHierarchyNode[] visibleNodes, int[] visibleRows) Constructs a new RowsInsertedEvent generated by the specified Gantt configuration that can be used to notify its registered IlvVerticalExpandable UI components when child nodes have been inserted into a common parent.

Method Summary

Modifier and Type	Method and Description
int	getVisibleNodeCount() Returns the number of nodes that became visible as a result of this insertion event.
IlvHierarchyNode[]	getVisibleNodes() Returns the array of IlvHierarchyNode's that were made visible as a result of this insertion event.
int	getVisibleRowCount() Returns the number of rows that were made visible as a result of this insertion event.
int[]	getVisibleRows() Returns the array of rows that were made visible as a result of this insertion event.

Methods inherited from class ilog.views.gantt.event.RowChildEvent

getChildIndices, getChildren, getGanttConfiguration, getGanttModel, getParent

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

RowsInsertedEvent

public RowsInsertedEvent(IlvGanttConfiguration ganttConfig,
                         IlvHierarchyNode parent,
                         IlvHierarchyNode[] children,
                         int[] childIndices,
                         IlvHierarchyNode[] visibleNodes,
                         int[] visibleRows)

Constructs a new RowsInsertedEvent generated by the specified Gantt configuration that can be used to notify its registered IlvVerticalExpandable UI components when child nodes have been inserted into a common parent.

Parameters:

ganttConfig - the Gantt configuration 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, children should be a single element array containing the root node, and childIndices should be a single element array with childIndices[0]=0.

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

childIndices - an int array of the child node indices arranged in parallel with children, ordered from lowest to highest. The indices point to the final locations in the parent node where the children were inserted.

visibleNodes - the array of IlvHierarchyNode's that were made visible as a result of this insertion event. The nodes are ordered by their row number from lowest to highest. If no nodes became visible as a result of this event, then an array of zero length should be used.

visibleRows - the array of rows that were made visible as a result of this insertion event. The rows are arranged in parallel with visibleNodes, ordered from lowest to highest. In other words, visibleRow[i] is the row that visibleNodes[i] is displayed on. The rows do not necessarily have to be sequential.

Method Detail

getVisibleNodes

public IlvHierarchyNode[] getVisibleNodes()

Returns the array of IlvHierarchyNode's that were made visible as a result of this insertion event. The nodes are ordered by their row number from lowest to highest. If no nodes became visible as a result of this event, an array of zero length is returned.

Returns:

The array of new visible IlvHierarchyNode.

getVisibleNodeCount

public int getVisibleNodeCount()

Returns the number of nodes that became visible as a result of this insertion event. This is equivalent to getVisibleNodes().length.

Returns:

The number of new visible IlvHierarchyNode.

See Also:

getVisibleNodes()

getVisibleRows

public int[] getVisibleRows()

Returns the array of rows that were made visible as a result of this insertion event. The rows are arranged in parallel with getVisibleNodes(), ordered from lowest to highest. getVisibleRows()[i] is the row that getVisibleNodes()[i] is displayed on. The rows are not necessarily sequential.

Returns:

The array of new visible rows.

getVisibleRowCount

public int getVisibleRowCount()

Returns the number of rows that were made visible as a result of this insertion event. This is equivalent to getVisibleRows().length and is the same value as getVisibleNodeCount().

Returns:

The number of new visible rows.

See Also:

getVisibleRows(), getVisibleNodeCount()