IlvVerticalExpansionMaster (Perforce JViews 10.0 API)

```
public interface IlvVerticalExpansionMaster
```
IlvVerticalExpansionMaster defines the behavior of a class that can track the expand/collapse status of an IlvGanttConfiguration's data tree and the rows that each activity or resource is displayed on. It is the responsibility of the vertical expansion master to receive data model and expand/collapse notifications from the IlvVerticalDisplayController, update its internal state, and then request the vertical display controller to republish the updated information as an event to all of the Gantt configuration's registered IlvVerticalExpandable user interface components and VerticalExpansionListeners.
An IlvVerticalExpansionMaster is responsible for publishing the following events by invoking the IlvVerticalDisplayController's appropriate fireXXXEvent() method:
An IlvVerticalExpansionMaster is associated with a Gantt configuration and its display controller by calling the IlvGanttConfiguration.setVerticalExpansionMaster(ilog.views.gantt.IlvVerticalExpansionMaster) method.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`ganttModelChanged(GanttModelChangedEvent event)` Invoked by the Gantt configuration when the data model has been replaced.
`IlvHierarchyNode`	`getFirstVisibleRow()` Returns the first visible row in the tree or `null` if no rows are visible.
`IlvHierarchyNode`	`getRootVisibleRow()` Deprecated. Beginning with Perforce JViews 8.5, use `getFirstVisibleRow()` instead.
`IlvHierarchyNode`	`getRow(int rowIndex)` Returns the row that is visible on the specified row index.
`int`	`getRowCount()` Return the number of rows that are currently visible.
`int`	`getRowIndex(IlvHierarchyNode row)` Return the row index that the specified row is displayed on.
`boolean`	`isExpanded(IlvHierarchyNode row)` Return whether the specified row is currently expanded.
`boolean`	`isRootRowVisible()` Returns `true` if the root row of the tree is visible, or `false` if the root row's children are the highest level visible rows.
`boolean`	`isVisible(IlvHierarchyNode row)` Return whether the specified row is visible.
`void`	`rowCollapsed(IlvHierarchyNode node)` Invoked by the Gantt configuration when a node has been collapsed in the data tree.
`void`	`rowExpanded(IlvHierarchyNode node)` Invoked by the Gantt configuration when a node has been expanded in the data tree.
`void`	`rowMoved(IlvHierarchyNode node, IlvHierarchyNode oldParent, int oldIndex, IlvHierarchyNode newParent, int newIndex)` Invoked by the Gantt configuration when a node has been moved within the data tree.
`void`	`rowsInserted(IlvHierarchyNode parent, IlvHierarchyNode[] children, int[] childIndices)` Invoked by the Gantt configuration when children have been inserted into a common parent node in the data tree.
`void`	`rowsRemoved(IlvHierarchyNode parent, IlvHierarchyNode[] children, int[] childIndices)` Invoked by the Gantt configuration when children have been removed from a common parent node in the data tree.
`void`	`setExpansionMasterGanttConfigurationImpl(IlvGanttConfiguration ganttConfig)` Set the Gantt configuration that this expansion master is coordinating with.
`void`	`setRootRowVisible(boolean rootVisible)` Sets whether the root row of the tree is visible, or whether the root row's children should be the highest level visible rows.

- Method Detail
  - setExpansionMasterGanttConfigurationImpl
```
void setExpansionMasterGanttConfigurationImpl(IlvGanttConfiguration ganttConfig)
```
    Set the Gantt configuration that this expansion master is coordinating with. This method is invoked when the expansion master is added to the configuration via its setVerticalExpansionMaster() method. The expansion master should initially synchronize its display with the Gantt configuration at this point. Note however, that the Gantt configuration may or may not have a valid data model at this time and this must be taken into account. The expansion master will be subsequently informed when a data model is set or replaced via the ganttModelChanged event.
    Warning: This method is considered to be part of an IlvVerticalExpansionMaster's internal implementation and is not a public API. Only the Gantt configuration should invoke this method.
    
    Parameters:
    
    ganttConfig - the Gantt configuration that this expansion master is being added to, or null if this expansion master is being removed from its Gantt configuration
    
    See Also:
    
    IlvGanttConfiguration.setVerticalExpansionMaster(ilog.views.gantt.IlvVerticalExpansionMaster)
  - getRootVisibleRow
```
@Deprecated
IlvHierarchyNode getRootVisibleRow()
```
    Deprecated. Beginning with Perforce JViews 8.5, use getFirstVisibleRow() instead.
    
    Returns the first visible row of the tree or null if no rows are visible.
    
    Returns:
    
    The first visible row.
  - getFirstVisibleRow
```
IlvHierarchyNode getFirstVisibleRow()
```
    Returns the first visible row in the tree or null if no rows are visible. If the data model contains at least a root row and the root row is set visible, then this method will return the root row. If the root row is set not visible, then this method will return the first child of the root row, if it exists in the data model. This method is equivalent to calling getRow(0).
    
    Returns:
    
    The first visible row.
    
    Since:
    
    JViews 8.5
    
    See Also:
    
    isRootRowVisible(), setRootRowVisible(boolean)
  - isRootRowVisible
```
boolean isRootRowVisible()
```
    Returns true if the root row of the tree is visible, or false if the root row's children are the highest level visible rows. This method returns the value of the rootRowVisible property and is independent of whether the data model has a root row to be displayed. The default value is true.
    
    Returns:
    
    true if the root row of the tree is visible, or false if the root row's children are the highest level visible rows.
    
    Since:
    
    JViews 8.5
    
    See Also:
    
    setRootRowVisible(boolean), getFirstVisibleRow()
  - setRootRowVisible
```
void setRootRowVisible(boolean rootVisible)
```
    Sets whether the root row of the tree is visible, or whether the root row's children should be the highest level visible rows. The root row will be expanded if necessary before it is hidden, in order to ensure that its children are visible. While the root row is hidden, it is inhibited from being collapsed.
    
    Parameters:
    
    rootVisible - true to make the root row of the tree visible, or false to make the root row's children the highest level visible rows.
    
    Since:
    
    JViews 8.5
    
    See Also:
    
    isRootRowVisible(), getFirstVisibleRow()
  - getRowCount
```
int getRowCount()
```
    Return the number of rows that are currently visible. A visible row is one that has all of its ancestors expanded. A visible row is not necessarily in the display area.
    
    Returns:
    
    the number of rows that are visible
  - getRow
```
IlvHierarchyNode getRow(int rowIndex)
```
    Returns the row that is visible on the specified row index. If the row index is not visible, then null is returned.
    
    Parameters:
    
    rowIndex - The rowIndex.
    
    Returns:
    
    The row on the the specified row index or null if rowIndex < 0 or rowIndex >= getRowCount().
  - getRowIndex
```
int getRowIndex(IlvHierarchyNode row)
```
    Return the row index that the specified row is displayed on. If the row is not visible, then -1 is returned.
    
    Parameters:
    
    row - the row
    
    Returns:
    
    the row index that row is visible on, where 0 is the first row, or -1 if row is not visible
  - isExpanded
```
boolean isExpanded(IlvHierarchyNode row)
```
    Return whether the specified row is currently expanded. If the row has no children, false is returned.
    
    Parameters:
    
    row - the row
    
    Returns:
    
    false if the row has no children, is collapsed, or any of its ancestors are collapsed. true if the row and all of its ancestors are expanded.
  - isVisible
```
boolean isVisible(IlvHierarchyNode row)
```
    Return whether the specified row is visible. This means that all of the row's ancestors are expanded.
    
    Parameters:
    
    row - the row
    
    Returns:
    
    true if the row is visible, otherwise false
  - ganttModelChanged
```
void ganttModelChanged(GanttModelChangedEvent event)
```
    Invoked by the Gantt configuration when the data model has been replaced. Logically, the root row has also changed as a result (unless both the old and new gantt data models have a null root node). However, separate rowsInserted or rowsRemoved events will not be invoked by the Gantt configuration as a result of the data model change being reported.
    
    Parameters:
    
    event - the event
  - rowsInserted
```
void rowsInserted(IlvHierarchyNode parent,
                  IlvHierarchyNode[] children,
                  int[] childIndices)
```
    Invoked by the Gantt configuration when children have been inserted into a common parent node in the data tree.
    
    Parameters:
    
    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.
  - rowsRemoved
```
void rowsRemoved(IlvHierarchyNode parent,
                 IlvHierarchyNode[] children,
                 int[] childIndices)
```
    Invoked by the Gantt configuration when children have been removed from a common parent node in the data tree.
    
    Parameters:
    
    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 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 removed. 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 original locations in the parent node where the children were removed.
  - rowMoved
```
void rowMoved(IlvHierarchyNode node,
              IlvHierarchyNode oldParent,
              int oldIndex,
              IlvHierarchyNode newParent,
              int newIndex)
```
    Invoked by the Gantt configuration when a node has been moved within the data tree.
    
    Parameters:
    
    node - the node that has been moved
    
    oldParent - node's previous parent
    
    oldIndex - node's index within oldParent before it was moved
    
    newParent - node's new parent
    
    newIndex - node's index within newParent after it has been moved
  - rowExpanded
```
void rowExpanded(IlvHierarchyNode node)
```
    Invoked by the Gantt configuration when a node has been expanded in the data tree.
    
    Parameters:
    
    node - the expanded node
  - rowCollapsed
```
void rowCollapsed(IlvHierarchyNode node)
```
    Invoked by the Gantt configuration when a node has been collapsed in the data tree.
    
    Parameters:
    
    node - the collapsed node

Interface IlvVerticalExpansionMaster

Method Summary

Method Detail

setExpansionMasterGanttConfigurationImpl

getRootVisibleRow

getFirstVisibleRow

isRootRowVisible

setRootRowVisible

getRowCount

getRow

getRowIndex

isExpanded

isVisible

ganttModelChanged

rowsInserted

rowsRemoved

rowMoved

rowExpanded

rowCollapsed