ilog.views.gantt.event

Class RowCollapsedEvent

java.lang.Object

java.util.EventObject

ilog.views.gantt.event.RowCollapsedEvent

All Implemented Interfaces:

Serializable

public class RowCollapsedEvent
extends EventObject

RowCollapsedEvent is fired on behalf of a Gantt configuration by an IlvVerticalExpansionMaster to notify all registered expandable UI components when a node has been collapsed within the data tree.

See Also:

IlvGanttConfiguration, IlvVerticalExpansionMaster, IlvVerticalExpandable, Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
RowCollapsedEvent(IlvGanttConfiguration ganttConfig, IlvHierarchyNode node, IlvHierarchyNode[] hiddenNodes, int firstHiddenRow) Constructs a new RowCollapsedEvent generated by the specified Gantt configuration that can be used to notify its registered IlvVerticalExpandable UI components when a node has been collapsed within the tree hierarchy.

Method Summary

Modifier and Type	Method and Description
IlvHierarchyNode	getCollapsedNode() Returns the node that was collapsed.
int	getFirstHiddenRow() Returns the first row that was hidden as a result of this collapse event.
IlvGanttConfiguration	getGanttConfiguration() Returns the Gantt configuration where the event originated.
IlvGanttModel	getGanttModel() Returns the data model currently being displayed by the Gantt configuration.
int	getHiddenNodeCount() Returns the number of previous visible nodes that were hidden as a result of this expansion event.
IlvHierarchyNode[]	getHiddenNodes() Returns the array of nodes that were hidden as a result of this expansion event.
int	getHiddenRowCount() Returns the number of previously visible rows that were hidden as a result of this collapse event.
int	getLastHiddenRow() Returns the last row that was hidden as a result of this collapse 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

RowCollapsedEvent

public RowCollapsedEvent(IlvGanttConfiguration ganttConfig,
                         IlvHierarchyNode node,
                         IlvHierarchyNode[] hiddenNodes,
                         int firstHiddenRow)

Constructs a new RowCollapsedEvent generated by the specified Gantt configuration that can be used to notify its registered IlvVerticalExpandable UI components when a node has been collapsed within the tree hierarchy.

Parameters:

ganttConfig - The Gantt configuration where the event originates.

node - The node that has been collapsed.

hiddenNodes - The array of IlvHierarchyNode's that were hidden as a result of this collapse event, ordered by their previous row number, from lowest to highest.

firstHiddenRow - The first row that was hidden as a result of this collapse event.

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

getCollapsedNode

public IlvHierarchyNode getCollapsedNode()

Returns the node that was collapsed.

Returns:

The IlvHierarchyNode that was collapsed.

getHiddenNodes

public IlvHierarchyNode[] getHiddenNodes()

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

Returns:

The array of hidden IlvHierarchyNode.

getHiddenNodeCount

public int getHiddenNodeCount()

Returns the number of previous visible nodes that were hidden as a result of this expansion event. This is getHiddenNodes().length.

Returns:

The number of hidden IlvHierarchyNode.

See Also:

getHiddenNodes()

getFirstHiddenRow

public int getFirstHiddenRow()

Returns the first row that was hidden as a result of this collapse event.

Returns:

The index of the first hidden row.

getLastHiddenRow

public int getLastHiddenRow()

Returns the last row that was hidden as a result of this collapse event.

Returns:

The index of the last hidden row.

getHiddenRowCount

public int getHiddenRowCount()

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

Returns:

The number of the hidden rows.