ilog.views.gantt.event

Class RowExpandedEvent

java.lang.Object

java.util.EventObject

ilog.views.gantt.event.RowExpandedEvent

All Implemented Interfaces:

Serializable

public class RowExpandedEvent
extends EventObject

RowExpandedEvent is fired on behalf of a Gantt configuration by an IlvVerticalExpansionMaster to notify all registered expandable UI components when a node has been expanded within the data tree. If the node that was expanded had ancestors that were also originally collapsed, they were expanded also in order to make the desired node visible. RowExpandedEvent maintains an array of all the ancestor nodes that had to be expanded in order to successfully expand and make visible the desired node. The nodes are ordered from the highest level ancestor node that was expanded first to the desired, lowest level node that was expanded last.

See Also:

IlvGanttConfiguration, IlvVerticalExpansionMaster, IlvVerticalExpandable, Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
RowExpandedEvent(IlvGanttConfiguration ganttConfig, IlvHierarchyNode[] expandedNodes, IlvHierarchyNode[] visibleNodes, int firstVisibleRow) Constructs a new RowExpandedEvent generated by the specified Gantt configuration that can be used to notify its registered IlvVerticalExpandable UI components when a node, and possibly some of its ancestors, have been expanded within the tree hierarchy.

Method Summary

Modifier and Type	Method and Description
int	getExpandedNodeCount() Returns the number of nodes that were expanded.
IlvHierarchyNode[]	getExpandedNodes() Returns the array of nodes that were expanded, ordered such that the first element in the array is the highest level node in the tree that was expanded and the last element in the array is the lowest level node that was expanded.
IlvHierarchyNode	getFirstExpandedNode() Returns the highest level node that was expanded.
IlvHierarchyNode	getFirstVisibleNode() Returns the first node that became visible as a result of this expansion event.
int	getFirstVisibleRow() Returns the first row that was made visible as a result of this expansion event.
IlvGanttConfiguration	getGanttConfiguration() Returns the Gantt configuration where the event originated.
IlvGanttModel	getGanttModel() Returns the data model currently being displayed by the Gantt configuration.
IlvHierarchyNode	getLastExpandedNode() Returns the lowest level node that was expanded.
IlvHierarchyNode	getLastVisibleNode() Returns the last node that became visible as a result of this expansion event.
int	getLastVisibleRow() Returns the last row that was made visible as a result of this expansion event.
int	getVisibleNodeCount() Returns the number of nodes that became visible as a result of this expansion event.
IlvHierarchyNode[]	getVisibleNodes() Returns the array of nodes that were made visible as a result of this expansion event.
int	getVisibleRowCount() Returns the number of previously hidden rows that were made visible as a result of this expansion event.

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

RowExpandedEvent

public RowExpandedEvent(IlvGanttConfiguration ganttConfig,
                        IlvHierarchyNode[] expandedNodes,
                        IlvHierarchyNode[] visibleNodes,
                        int firstVisibleRow)

Constructs a new RowExpandedEvent generated by the specified Gantt configuration that can be used to notify its registered IlvVerticalExpandable UI components when a node, and possibly some of its ancestors, have been expanded within the tree hierarchy.

Parameters:

ganttConfig - The Gantt configuration where the event originates.

expandedNodes - The array of IlvHierarchyNode's that were expanded, ordered such that the first element in the array is the highest level node that was expanded and the last element in the array is the lowest level node that was expanded.

visibleNodes - The array of IlvHierarchyNode's that were made visible as a result of this expansion event, ordered by their row number, from lowest to highest.

firstVisibleRow - The first row that was made visible as a result of this expansion event. This is the row that visibleNodes[0] is displayed on.

Method Detail

getGanttConfiguration

public IlvGanttConfiguration getGanttConfiguration()

Returns the Gantt configuration where the event originated.

Returns:

The IlvGanttConfiguration where the event originated.

getGanttModel

public 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

getExpandedNodes

public IlvHierarchyNode[] getExpandedNodes()

Returns the array of nodes that were expanded, ordered such that the first element in the array is the highest level node in the tree that was expanded and the last element in the array is the lowest level node that was expanded.

Returns:

The array of expanded IlvHierarchyNode.

getExpandedNodeCount

public int getExpandedNodeCount()

Returns the number of nodes that were expanded. This is getExpandedNodes().length.

Returns:

The number of expanded IlvHierarchyNode.

See Also:

getExpandedNodes()

getFirstExpandedNode

public IlvHierarchyNode getFirstExpandedNode()

Returns the highest level node that was expanded. This is getExpandedNodes()[0].

Returns:

The first expanded IlvHierarchyNode.

See Also:

getExpandedNodes()

getLastExpandedNode

public IlvHierarchyNode getLastExpandedNode()

Returns the lowest level node that was expanded. This is getExpandedNodes()[getExpandedNodeCount()-1].

Returns:

The last expanded IlvHierarchyNode.

See Also:

getExpandedNodes()

getVisibleNodes

public IlvHierarchyNode[] getVisibleNodes()

Returns the array of nodes that were made visible as a result of this expansion event. The nodes are ordered by sequential row number, from lowest to highest.

Returns:

The array of new visible IlvHierarchyNode.

getVisibleNodeCount

public int getVisibleNodeCount()

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

Returns:

The number of new visible IlvHierarchyNode.

See Also:

getVisibleNodes()

getFirstVisibleNode

public IlvHierarchyNode getFirstVisibleNode()

Returns the first node that became visible as a result of this expansion event. This is getVisibleNodes()[0].

Returns:

The first visible IlvHierarchyNode.

See Also:

getVisibleNodes()

getLastVisibleNode

public IlvHierarchyNode getLastVisibleNode()

Returns the last node that became visible as a result of this expansion event. This is getVisibleNodes()[getVisibleNodeCount()-1].

Returns:

The last visible IlvHierarchyNode.

See Also:

getVisibleNodes()

getVisibleRowCount

public int getVisibleRowCount()

Returns the number of previously hidden rows that were made visible as a result of this expansion event. This is the same as getVisibleNodeCount().

Returns:

The number of new visible rows.

See Also:

getVisibleNodeCount()

getFirstVisibleRow

public int getFirstVisibleRow()

Returns the first row that was made visible as a result of this expansion event. This is the row that getFirstVisibleNode() is displayed on.

Returns:

The index of the first visible row.

See Also:

getFirstVisibleNode()

getLastVisibleRow

public int getLastVisibleRow()

Returns the last row that was made visible as a result of this expansion event. This is the row that getLastVisibleNode() is displayed on.

Returns:

The index of the last visible row.

See Also:

getLastVisibleNode()