ilog.views.gantt

Class IlvVerticalDisplayController

java.lang.Object

ilog.views.gantt.IlvVerticalDisplayController

public class IlvVerticalDisplayController
extends Object

IlvVerticalDisplayController is a display controller that coordinates the vertical scrolling, row expand/collapse, and row visibility behavior between an IlvGanttConfiguration and 1 or more user interface components.

Components that will have their vertical scrolling coordinated must implement the IlvVerticalScrollable interface and are registered by calling the addScrollable method. The vertical display controller delegates responsibility for actual scrolling coordination to an IlvVerticalScrollController.

Components that will have their row expand/collapse and visibility behavior coordinated must implement the IlvVerticalExpandable interface and are registered by calling the addExpandable method. The vertical display controller delegates responsibility for tracking row expand/collapse and visibility state to an IlvVerticalExpansionMaster. The way this works is this:

1. The vertical display controller receives events from the Gantt configuration's event services, informing the controller about changes to the data model. The vertical display controller processes the activity and resource events in conjunction with its row organization. The controller then notifies the vertical expansion master by directly calling the following methods:
   • ganttModelChanged
   • rowsInserted
   • rowsRemoved
   • rowMoved
2. The vertical display controller also receives explicit requests to expand or collapse nodes. The controller similarly notifies the vertical expansion master by directly calling the following methods:
   • rowExpanded
   • rowCollapsed
3. The vertical expansion master handles the vertical controller's notifications by updating its internal state, calculating additional node visibility information, and then requesting the controller to republish the updated information as an event to all of the other expandable user interface components. The vertical expansion master is responsible for publishing the following events for each type of notification that it receives:
   • ganttModelChanged is republished as a GanttModelChangedEvent.
   • rowsInserted is republished as a RowsInsertedEvent.
   • rowsRemoved is republished as a RowsRemovedEvent.
   • rowMoved is republished as a RowMovedEvent.
   • rowExpanded is republished as a RowExpandedEvent.
   • rowCollapsed is republished as a RowCollapsedEvent.
   The vertical expansion master publishes these events to the other expandable user interface components by invoking the display controller's corresponding fireXXXEvent() method.
4. The vertical display controller directly handles requests to change the row height and does not route these to the expansion master. The controller publishes these as a RowHeightChangedEvent.

This behavior is summarized in the following table:

Origin	Display Controller Calls Vertical Expansion Master Method:	Vertical Expansion Master Republishes Event by Calling Display Controller Method:	Published Event
IlvGanttConfiguration.setGanttModel or IlvHierarchyChart.setGanttModel	ganttModelChanged	fireGanttModelChanged	IlvVerticalExpandable.ganttModelChanged
Activities or resources added to the Gantt data model	rowsInserted	fireNodesInserted	VerticalExpansionListener.rowsInserted
Activities or resources deleted from the Gantt data model	rowsRemoved	fireNodesRemoved	VerticalExpansionListener.rowsRemoved
An activity or resource moved within the Gantt \data model tree	rowMoved	fireNodeMoved	VerticalExpansionListener.rowMoved
IlvHierarchyChart.expandRow or IlvGanttConfiguration.expandRow	rowExpanded	fireNodeExpanded	VerticalExpansionListener.rowExpanded
IlvHierarchyChart.collapseRow or IlvGanttConfiguration.collapseRow	rowCollapsed	fireNodeCollapsed	VerticalExpansionListener.rowCollapsed
IlvHierarchyChart.setRowHeight or IlvGanttConfiguration.setRowHeight	n/a	n/a	VerticalExpansionListener.rowHeightChanged

The IlvVerticalDisplayController manages the following states of each node in the displayed data tree. An expanded node is one that displays its children. A collapsed node is one that hides them. A hidden node is one that is under a collapsed parent. A visible node is the opposite of hidden, it is under an expanded parent, but may or may not be displayed. A displayed node is both visible and in the display area, where it can be seen.

The IlvVerticalDisplayController must be connected to its Gantt configuration before any vertical expandables or scrollables can be added to it or before its expansion master can be set.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	IlvVerticalDisplayController.ActivityAdapter ActivityAdapter can adapt between a vertical controller and the activity tree of a Gantt data model.
class	IlvVerticalDisplayController.ResourceAdapter ResourceAdapter can adapt between a vertical controller and the resource tree of a Gantt data model.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTIVITY_ROWS Each row represents an activity.
static int	DEFAULT_ROW_HEIGHT The default row height.
static int	RESOURCE_ROWS Each row represents a resource.

Constructor Summary

Constructors

Constructor and Description
IlvVerticalDisplayController(int rowType) Construct a new IlvVerticalDisplayController that will coordinate the vertical scrolling, expand/collapse, and visibility behavior of the specified type of rows.

Method Summary

Modifier and Type	Method and Description
void	addExpandable(IlvVerticalExpandable expandable) Adds the specified expandable UI component to be coordinated with this controller.
void	addExpansionListener(VerticalExpansionListener listener) Adds the specified listener to receive expansion events from this controller.
void	addScrollable(IlvVerticalScrollable scrollable) Adds the specified scrollable UI component to be coordinated with this controller.
void	addScrollListener(VerticalScrollListener listener) Adds the specified listener to receive vertical scroll events from this controller.
void	collapseNode(IlvHierarchyNode node) Ensures that the specified node is collapsed.
int	computeScrollPosition(int rowDelta) Returns the position that will cause the controller and its associated vertically scrollable components to scroll by the specified number of rows, up or down.
void	expandNode(IlvHierarchyNode node) Ensures that the specified node is expanded and visible.
void	fireGanttModelChanged(GanttModelChangedEvent event) Fires a GanttModelChangedEvent to all registered expandable UI components.
void	fireNodeCollapsed(RowCollapsedEvent event) Fires a RowCollapsedEvent to all registered expandable UI components.
void	fireNodeExpanded(RowExpandedEvent event) Fires a RowExpandedEvent to all registered expandable UI components.
void	fireNodeMoved(RowMovedEvent event) Fires a RowMovedEvent to all registered expandable UI components.
void	fireNodesInserted(RowsInsertedEvent event) Fires a RowsInsertedEvent to all registered expandable UI components.
void	fireNodesRemoved(RowsRemovedEvent event) Fires a RowsRemovedEvent to all registered expandable UI components.
void	fireRootRowVisibilityChanged(RootRowVisibilityChangedEvent event) Fires a RootRowVisibilityChangedEvent to all registered expandable UI components.
IlvHierarchyNode	getDisplayedNodeAtPosition(int position) Returns the node at the specified vertical position relative to the display area.
int	getDisplayedRowAtPosition(int position) Returns the row at the specified vertical position relative to the display area.
int	getExtent() Returns the extent of the vertical range displayed by the controller and its associated vertically scrollable components.
IlvHierarchyNode	getFirstNode() Returns the first visible node in the displayed tree or null if no nodes are visible.
IlvGanttConfiguration	getGanttConfiguration() Returns the Gantt configuration that is being displayed by the user interface components of this controller.
int	getMaxPosition() Returns the maximum position that the controller and its associated vertically scrollable components can display.
IlvHierarchyNode	getNodeAtPosition(int position) Returns the node at the specified vertical position, relative to the first visible node at position = 0.
Rectangle	getNodeBounds(IlvHierarchyNode node) Returns the vertical bounds of the specified node as the y and height fields of a rectangle.
IlvHierarchyNode	getNodeForRow(int row) Returns the node for the specified row.
int	getPosition() Returns the beginning of the vertical range displayed by the controller and its associated vertically scrollable components.
IlvHierarchyNode	getRootDataNode() Returns the root node of the Gantt configuration and its data model.
IlvHierarchyNode	getRootNode() Deprecated. Beginning with Rogue Wave JViews 8.5, use getFirstNode() instead.
int	getRowAtPosition(int position) Returns the row at the specified vertical position, relative to the first visible row at position = 0.
Rectangle	getRowBounds(int row) Returns the vertical bounds of the specified row as the y and height fields of a rectangle.
int	getRowCount() Returns the number of rows that are visible.
int	getRowForNode(IlvHierarchyNode node) Returns the row that the specified node is displayed on.
int	getRowHeight() Returns the row height used when all rows are set to have the same height.
int	getRowHeight(IlvHierarchyNode row) Returns the height of the specified row.
int	getRowType() Returns an int that represents the row organization of this vertical display controller.
void	inform(GanttModelChangedEvent event) Invoked through the event demultiplexer when the entire data model has been replaced.
boolean	isExpanded(IlvHierarchyNode node) Returns whether the specified node and all of its ancestors are currently expanded.
boolean	isFixedRowHeight() Returns whether all rows are set to have the same fixed height.
boolean	isRootNodeVisible() Returns true if the root node of the tree is visible, or false if the root node's children are the highest level visible nodes.
boolean	isVisible(IlvHierarchyNode node) Returns whether the specified node is visible.
void	makeDisplayed(IlvHierarchyNode node) Ensures that the specified node is displayed.
void	makeVisible(IlvHierarchyNode node) Ensures that the specified node is visible.
void	removeExpandable(IlvVerticalExpandable expandable) Removes the specified expandable UI component so that it will no longer be coordinated with this controller.
void	removeExpansionListener(VerticalExpansionListener listener) Removes the specified listener so that it will no longer receive expansion events from this controller.
void	removeScrollable(IlvVerticalScrollable scrollable) Removes the specified scrollable UI component so that it will no longer be coordinated with this controller.
void	removeScrollListener(VerticalScrollListener listener) Removes the specified listener so that it will no longer receive vertical scroll events from this controller.
void	scrollBoundsToDisplay(Rectangle bounds) Scrolls the vertical bounds specified by the y and height fields of the given rectangle into the display area.
void	setExtent(int extent) Sets the extent of the vertical range displayed by the controller and its associated vertically scrollable components.
protected void	setGanttConfigurationImpl(IlvGanttConfiguration ganttConfig) Sets the Gantt configuration that will be displayed by the user interface components of this controller.
void	setMaxPosition(int max) Sets the maximum position that the controller and its associated vertically scrollable components can display.
void	setPosition(int position) Sets the beginning of the vertical range displayed by the controller and its associated vertically scrollable components.
void	setRootNodeVisible(boolean rootVisible) Sets whether the root node of the tree is visible, or whether the root node's children should be the highest level visible nodes.
void	setRowHeight(IlvHierarchyNode row, int rowHeight) Sets the height of the specified row.
void	setRowHeight(int rowHeight) Sets all rows to have the same height.
void	setVerticalExpansionMaster(IlvVerticalExpansionMaster expansionMaster) Sets the object that will track the expand/collapse status of the hierarchical tree and the corresponding rows that each node is displayed on.
void	validateRowHeights() Validates the heights of all rows, that is, ensures that they are all up-to-date.
Iterator<IlvHierarchyNode>	visibleNodesIterator() Returns an iterator that traverses all of the visible nodes.
Iterator<IlvHierarchyNode>	visibleNodesIterator(IlvHierarchyNode root) Returns an iterator that traverses only the visible nodes in the specified subtree.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ACTIVITY_ROWS

public static final int ACTIVITY_ROWS

Each row represents an activity. This is equal to IlvGanttConfiguration.ACTIVITY_ROWS.

See Also:

Constant Field Values

RESOURCE_ROWS

public static final int RESOURCE_ROWS

Each row represents a resource. This is equal to IlvGanttConfiguration.RESOURCE_ROWS.

See Also:

Constant Field Values

DEFAULT_ROW_HEIGHT

public static final int DEFAULT_ROW_HEIGHT

The default row height. The default value is 20.

Since:

JViews 3.5

See Also:

Constant Field Values

Constructor Detail

IlvVerticalDisplayController

public IlvVerticalDisplayController(int rowType)

Construct a new IlvVerticalDisplayController that will coordinate the vertical scrolling, expand/collapse, and visibility behavior of the specified type of rows.

Parameters:

rowType - The type of rows being displayed. The value must be either ACTIVITY_ROWS or RESOURCE_ROWS.

Method Detail

getRowType

public int getRowType()

Returns an int that represents the row organization of this vertical display controller. This will be one of of the constants ACTIVITY_ROWS or RESOURCE_ROWS.

Returns:

Either ACTIVITY_ROWS or RESOURCE_ROWS.

getGanttConfiguration

public IlvGanttConfiguration getGanttConfiguration()

Returns the Gantt configuration that is being displayed by the user interface components of this controller.

Returns:

The Gantt configuration or null if this controller is not currently associated with a Gantt configuration.

setGanttConfigurationImpl

protected void setGanttConfigurationImpl(IlvGanttConfiguration ganttConfig)

Sets the Gantt configuration that will be displayed by the user interface components of this controller.

Warning: This method is considered to be part of an IlvVerticalDisplayController's internal implementation and is not a public API. Only the Gantt configuration should invoke this method.

Parameters:

ganttConfig - The Gantt configuration.

getRootDataNode

public IlvHierarchyNode getRootDataNode()

Returns the root node of the Gantt configuration and its data model. Return null if the Gantt configuration has no nodes. This method does not account for processing of the data model by this controller's vertical expansion master, as getFirstNode() does.

Warning: This method is considered to be part of an IlvVerticalDisplayController's internal implementation and is not a public API. Only the controller's vertical expansion master should invoke this method.

Returns:

The root node.

getRootNode

@Deprecated
public IlvHierarchyNode getRootNode()

Deprecated. Beginning with Rogue Wave JViews 8.5, use getFirstNode() instead.

Returns the first visible node of the displayed tree or null if no nodes are visible.

Returns:

The root node.

getFirstNode

public IlvHierarchyNode getFirstNode()

Returns the first visible node in the displayed tree or null if no nodes are visible. If the data model contains at least a root node and the root node is set visible, then this method will return the root node. If the root node is set not visible, then this method will return the first child of the root node, if it exists in the data model. This method is equivalent to calling getNodeForRow(0).

Returns:

The first visible node.

Since:

JViews 8.5

getNodeForRow

public IlvHierarchyNode getNodeForRow(int row)

Returns the node for the specified row. If the row is not visible, null is returned.

Parameters:

row - The row.

Returns:

The node on the specified row or null if row < 0 or row >= getRowCount().

getRowForNode

public int getRowForNode(IlvHierarchyNode node)

Returns the row that the specified node is displayed on. If the node is not visible, then -1 is returned.

Parameters:

node - The node.

Returns:

The row that node is displayed on, where 0 is the first row, or -1 if node is not visible.

getRowCount

public int getRowCount()

Returns the number of rows that are visible.

Returns:

The number of visible rows.

validateRowHeights

public void validateRowHeights()

Validates the heights of all rows, that is, ensures that they are all up-to-date.

Since:

JViews 8.8

isFixedRowHeight

public boolean isFixedRowHeight()

Returns whether all rows are set to have the same fixed height.

Returns:

true if all rows are set to the same height, false otherwise.

Since:

JViews 6.0

See Also:

setRowHeight(int), setRowHeight(IlvHierarchyNode, int)

getRowHeight

public int getRowHeight()

Returns the row height used when all rows are set to have the same height. If some rows have had specific heights set by calling the setRowHeight(IlvHierarchyNode, int) method, then this value will be the height of those rows whose height has not been specifically set. The default value is 20.

Returns:

The row height.

Since:

JViews 3.5

See Also:

setRowHeight(int), setRowHeight(IlvHierarchyNode, int)

getRowHeight

public int getRowHeight(IlvHierarchyNode row)

Returns the height of the specified row.

Parameters:

row - The row.

Returns:

The row height.

Since:

JViews 6.0

See Also:

setRowHeight(int), setRowHeight(IlvHierarchyNode,int)

setRowHeight

public void setRowHeight(int rowHeight)

Sets all rows to have the same height. If you subsequently set some rows to have a specific height by calling the setRowHeight(IlvHierarchyNode, int) method, then this value will be used as the height for those rows whose height has not been specifically set.

Parameters:

rowHeight - The row height.

Since:

JViews 3.5

See Also:

getRowHeight(), getRowHeight(IlvHierarchyNode)

setRowHeight

public void setRowHeight(IlvHierarchyNode row,
                         int rowHeight)

Sets the height of the specified row.

Parameters:

row - The row.

rowHeight - The row height.

Since:

JViews 6.0

See Also:

getRowHeight(), getRowHeight(IlvHierarchyNode), setRowHeight(int)

getRowAtPosition

public int getRowAtPosition(int position)

Returns the row at the specified vertical position, relative to the first visible row at position = 0. This method does not take the current vertical scroll position into account and returns -1 if the row < 0 or row >= getRowCount().

Parameters:

position - The vertical position of interest.

Returns:

The index of the row that position lies in, or -1 if the result is out of range.

Since:

JViews 3.5

See Also:

getNodeAtPosition(int), getDisplayedRowAtPosition(int), getDisplayedNodeAtPosition(int)

getDisplayedRowAtPosition

public int getDisplayedRowAtPosition(int position)

Returns the row at the specified vertical position relative to the display area. This method returns -1 if the row < 0 or row >= getRowCount().

Parameters:

position - The vertical position of interest, relative to the display area.

Returns:

The index of the displayed row that position lies in, or -1 if the result is out of range.

Since:

JViews 3.5

See Also:

getRowAtPosition(int), getNodeAtPosition(int), getDisplayedNodeAtPosition(int)

getNodeAtPosition

public IlvHierarchyNode getNodeAtPosition(int position)

Returns the node at the specified vertical position, relative to the first visible node at position = 0. This method does not take the current vertical scroll position into account and returns null if the position does not correspond to a visible row.

Parameters:

position - The vertical position of interest.

Returns:

The node that position lies in, or null if the position is out of range.

Since:

JViews 3.5

See Also:

getRowAtPosition(int), getDisplayedRowAtPosition(int), getDisplayedNodeAtPosition(int)

getDisplayedNodeAtPosition

public IlvHierarchyNode getDisplayedNodeAtPosition(int position)

Returns the node at the specified vertical position relative to the display area. This method returns null if the position does not correspond to a visible row.

Parameters:

position - The vertical position of interest, relative to the display area.

Returns:

The displayed node that position lies in, or null if the position is out of range.

Since:

JViews 3.5

See Also:

getRowAtPosition(int), getNodeAtPosition(int), getDisplayedRowAtPosition(int)

getRowBounds

public Rectangle getRowBounds(int row)

Returns the vertical bounds of the specified row as the y and height fields of a rectangle. The x and width fields of the returned rectangle are set to 0 and can be ignored. The vertical bounds are relative to the first visible row at y = 0 and do not take the current vertical scroll position into account. If the row is not visible, then null is returned.

Parameters:

row - The row.

Returns:

The vertical bounds of the specified row or null if the row < 0 or row >= getRowCount().

Since:

JViews 3.5

getNodeBounds

public Rectangle getNodeBounds(IlvHierarchyNode node)

Returns the vertical bounds of the specified node as the y and height fields of a rectangle. The x and width fields of the returned rectangle are set to 0 and can be ignored. The vertical bounds are relative to the root node at y = 0 and do not take the current vertical scroll position into account. If the node is not visible, then null is returned.

Parameters:

node - The node.

Returns:

The vertical bounds of the specified node or null if node is not visible.

Since:

JViews 3.5

isRootNodeVisible

public boolean isRootNodeVisible()

Returns true if the root node of the tree is visible, or false if the root node's children are the highest level visible nodes. This method returns the value of the rootNodeVisible property and is independent of whether the data model has a root node to be displayed. The default value is true.

Returns:

true if the root node of the tree is visible, or false if the root node's children are the highest level visible nodes.

Since:

JViews 8.5

See Also:

setRootNodeVisible(boolean), getFirstNode(), getRootDataNode()

setRootNodeVisible

public void setRootNodeVisible(boolean rootVisible)

Sets whether the root node of the tree is visible, or whether the root node's children should be the highest level visible nodes. The root node will be expanded if necessary before it is hidden, in order to ensure that it's children are visible. While the root node is hidden, it is inhibited from being collapsed.

Parameters:

rootVisible - true to make the root node of the tree visible, or false to make the root node's children the highest level visible node.

Since:

JViews 8.5

See Also:

isRootNodeVisible(), getFirstNode(), getRootDataNode()

isExpanded

public boolean isExpanded(IlvHierarchyNode node)

Returns whether the specified node and all of its ancestors are currently expanded. A value of true implies that the node has children that are visible. If the node has no children or it, or any of its ancestors, are not expanded then this method returns false. This implies that the node has no visible children.

Parameters:

node - The node.

Returns:

true if the node has children and it, and all of its ancestors, are expanded. Otherwise, this method returns false.

isVisible

public boolean isVisible(IlvHierarchyNode node)

Returns whether the specified node is visible. This means that all of the node's ancestors are expanded.

Parameters:

node - The node.

Returns:

true if the node is visible, and false otherwise.

visibleNodesIterator

public Iterator<IlvHierarchyNode> visibleNodesIterator(IlvHierarchyNode root)

Returns an iterator that traverses only the visible nodes in the specified subtree.

Parameters:

root - The root node of the subtree.

Returns:

An iterator for traversing the subtree of visible nodes.

See Also:

visibleNodesIterator()

visibleNodesIterator

public Iterator<IlvHierarchyNode> visibleNodesIterator()

Returns an iterator that traverses all of the visible nodes.

Returns:

An iterator for traversing the visible nodes.

Since:

JViews 8.5

See Also:

visibleNodesIterator(IlvHierarchyNode)

makeVisible

public void makeVisible(IlvHierarchyNode node)

Ensures that the specified node is visible. In other words, this method ensures that the node's parent is expanded.

Parameters:

node - The node.

Since:

JViews 3.5

expandNode

public void expandNode(IlvHierarchyNode node)

Ensures that the specified node is expanded and visible.

Parameters:

node - The node.

See Also:

collapseNode(ilog.views.gantt.IlvHierarchyNode)

collapseNode

public void collapseNode(IlvHierarchyNode node)

Ensures that the specified node is collapsed.

Parameters:

node - The node.

See Also:

expandNode(ilog.views.gantt.IlvHierarchyNode)

addExpandable

public void addExpandable(IlvVerticalExpandable expandable)

Adds the specified expandable UI component to be coordinated with this controller. The display controller must be already associated with a Gantt configuration. Otherwise, an exception is thrown.

Parameters:

expandable - The UI component.

Throws:

IllegalStateException - if the display controller is not part of a Gantt configuration.

See Also:

setVerticalExpansionMaster(ilog.views.gantt.IlvVerticalExpansionMaster)

removeExpandable

public void removeExpandable(IlvVerticalExpandable expandable)

Removes the specified expandable UI component so that it will no longer be coordinated with this controller.

Parameters:

expandable - The UI component to remove.

setVerticalExpansionMaster

public void setVerticalExpansionMaster(IlvVerticalExpansionMaster expansionMaster)

Sets the object that will track the expand/collapse status of the hierarchical tree and the corresponding rows that each node is displayed on. The display controller must be already associated with a Gantt configuration. Otherwise, an exception is thrown.

Parameters:

expansionMaster - The vertical expansion master.

Throws:

IllegalStateException - if the display controller is not part of a Gantt configuration.

addExpansionListener

public void addExpansionListener(VerticalExpansionListener listener)

Adds the specified listener to receive expansion events from this controller.

Parameters:

listener - The listener that will be subscribed to subsequent expansion events.

removeExpansionListener

public void removeExpansionListener(VerticalExpansionListener listener)

Removes the specified listener so that it will no longer receive expansion events from this controller.

Parameters:

listener - The listener that will be unsubscribed from receiving expansion events.

getMaxPosition

public int getMaxPosition()

Returns the maximum position that the controller and its associated vertically scrollable components can display.

Returns:

The maximum position.

Since:

JViews 3.5

See Also:

setMaxPosition(int)

setMaxPosition

public void setMaxPosition(int max)

Sets the maximum position that the controller and its associated vertically scrollable components can display. The current vertical position and extent are trimmed to fit the new 0-max range. A maxVerticalPositionChanged event is then fired to all registered listeners. If max < 0 an IllegalArgumentException will be thrown.

Parameters:

max - The maximum position.

Since:

JViews 3.5

See Also:

getMaxPosition()

getPosition

public int getPosition()

Returns the beginning of the vertical range displayed by the controller and its associated vertically scrollable components.

Since:

JViews 3.5

See Also:

setPosition(int)

setPosition

public void setPosition(int position)

Sets the beginning of the vertical range displayed by the controller and its associated vertically scrollable components. The specified value is compared against the max displayable value and is trimmed if necessary. A verticalPositionChanged event is then fired to all registered listeners.

Parameters:

position - The new position.

Since:

JViews 3.5

See Also:

getPosition(), computeScrollPosition(int)

getExtent

public int getExtent()

Returns the extent of the vertical range displayed by the controller and its associated vertically scrollable components.

Since:

JViews 3.5

See Also:

setExtent(int)

setExtent

public void setExtent(int extent)

Sets the extent of the vertical range displayed by the controller and its associated vertically scrollable components. The specified value is compared against the max displayable value and is trimmed if necessary. A verticalExtentChanged event is then fired to all registered listeners.

Parameters:

extent - The new extent.

Since:

JViews 3.5

See Also:

getExtent()

addScrollable

public void addScrollable(IlvVerticalScrollable scrollable)

Adds the specified scrollable UI component to be coordinated with this controller.

Parameters:

scrollable - The scrollable UI component.

See Also:

removeScrollable(ilog.views.gantt.IlvVerticalScrollable)

removeScrollable

public void removeScrollable(IlvVerticalScrollable scrollable)

Removes the specified scrollable UI component so that it will no longer be coordinated with this controller.

Parameters:

scrollable - The scrollable UI component to remove.

See Also:

addScrollable(ilog.views.gantt.IlvVerticalScrollable)

addScrollListener

public void addScrollListener(VerticalScrollListener listener)

Adds the specified listener to receive vertical scroll events from this controller.

Parameters:

listener - The listener that will be subscribed to subsequent scroll events.

See Also:

removeScrollListener(ilog.views.gantt.event.VerticalScrollListener)

removeScrollListener

public void removeScrollListener(VerticalScrollListener listener)

Removes the specified listener so that it will no longer receive vertical scroll events from this controller.

Parameters:

listener - The listener that will be unsubscribed from receiving vertical scroll events.

See Also:

addScrollListener(ilog.views.gantt.event.VerticalScrollListener)

makeDisplayed

public void makeDisplayed(IlvHierarchyNode node)

Ensures that the specified node is displayed. In other words, this method ensures that the node is visible and is scrolled into the display area.

Parameters:

node - The node.

Since:

JViews 3.5

scrollBoundsToDisplay

public void scrollBoundsToDisplay(Rectangle bounds)

Scrolls the vertical bounds specified by the y and height fields of the given rectangle into the display area.

Parameters:

bounds - The vertical region to scroll into the display area, specified by the y and height fields.

Since:

JViews 3.5

computeScrollPosition

public int computeScrollPosition(int rowDelta)

Returns the position that will cause the controller and its associated vertically scrollable components to scroll by the specified number of rows, up or down. The value returned by this method can then be applied using the setPosition(int) method to effect the scroll.

Parameters:

rowDelta - The number of rows to scroll. Negative values indicate to scroll up, while positive numbers indicate to scroll down.

Returns:

The vertical position that will result in scrolling by the specified number of rows, up or down.

Since:

JViews 7.5

inform

public void inform(GanttModelChangedEvent event)

Invoked through the event demultiplexer when the entire data model has been replaced. The event is forwarded to the vertical expansion master's IlvVerticalExpansionMaster.ganttModelChanged(ilog.views.gantt.event.GanttModelChangedEvent) method for handling.

Parameters:

event - The event.

fireGanttModelChanged

public void fireGanttModelChanged(GanttModelChangedEvent event)

Fires a GanttModelChangedEvent to all registered expandable UI components.

Warning: This method is considered to be part of an IlvVerticalDisplayController's internal implementation and is not a public API. Only the controller's vertical expansion master should invoke this method.

Parameters:

event - The event.

fireNodesInserted

public void fireNodesInserted(RowsInsertedEvent event)

Fires a RowsInsertedEvent to all registered expandable UI components.

Warning: This method is considered to be part of an IlvVerticalDisplayController's internal implementation and is not a public API. Only the controller's vertical expansion master should invoke this method.

Parameters:

event - The event.

fireNodesRemoved

public void fireNodesRemoved(RowsRemovedEvent event)

Fires a RowsRemovedEvent to all registered expandable UI components.

Warning: This method is considered to be part of an IlvVerticalDisplayController's internal implementation and is not a public API. Only the controller's vertical expansion master should invoke this method.

Parameters:

event - The event.

fireNodeMoved

public void fireNodeMoved(RowMovedEvent event)

Fires a RowMovedEvent to all registered expandable UI components.

Warning: This method is considered to be part of an IlvVerticalDisplayController's internal implementation and is not a public API. Only the controller's vertical expansion master should invoke this method.

Parameters:

event - The event.

fireNodeExpanded

public void fireNodeExpanded(RowExpandedEvent event)

Fires a RowExpandedEvent to all registered expandable UI components.

Warning: This method is considered to be part of an IlvVerticalDisplayController's internal implementation and is not a public API. Only the controller's vertical expansion master should invoke this method.

Parameters:

event - The event.

fireNodeCollapsed

public void fireNodeCollapsed(RowCollapsedEvent event)

Fires a RowCollapsedEvent to all registered expandable UI components.

Warning: This method is considered to be part of an IlvVerticalDisplayController's internal implementation and is not a public API. Only the controller's vertical expansion master should invoke this method.

Parameters:

event - The event.

fireRootRowVisibilityChanged

public void fireRootRowVisibilityChanged(RootRowVisibilityChangedEvent event)

Fires a RootRowVisibilityChangedEvent to all registered expandable UI components.

Warning: This method is considered to be part of an IlvVerticalDisplayController's internal implementation and is not a public API. Only the controller's vertical expansion master should invoke this method.

Parameters:

event - The event.

Since:

JViews 8.5