ilog.views.gantt

Class IlvVerticalScrollController

java.lang.Object

ilog.views.gantt.IlvVerticalScrollController

All Implemented Interfaces:

IlvVerticalScrollable

public class IlvVerticalScrollController
extends Object
implements IlvVerticalScrollable

An IlvVerticalScrollController coordinates the vertical scrolling of 1 or more IlvVerticalScrollable objects. In addition, the controller itself exports the IlvVerticalScrollable interface. Scrolling is determined by three interrelated integer properties: maxVerticalPosition, verticalPosition, and verticalExtent. These three values define two nested ranges like this:

  0 <= verticalPosition <= verticalPosition+verticalExtent <= maxVerticalPosition

The controller enforces this relationship by correcting or trimming properties according to the following rules:

• The setMaxVerticalPosition(int) method first validates that:

    0 <= maxVisibleTime 

  If not, an IllegalArgumentException is thrown. Next, the vertical position and extent properties may be trimmed (in that order), to fit within the new 0-max range.

• The setVerticalPosition(int) and setVerticalExtent(int) methods trim their argument to fit within the limits defined by the other two properties.

Since:

JViews 3.5

Constructor Summary

Constructors

Constructor and Description
IlvVerticalScrollController() Creates a new IlvVerticalScrollController.

Method Summary

Modifier and Type	Method and Description
void	addVerticalScrollable(IlvVerticalScrollable vs) Adds an IlvVerticalScrollable object to be coordinated by this controller.
void	addVerticalScrollListener(VerticalScrollListener listener) Adds the specified listener to receive vertical scroll events from this controller.
protected void	fireMaxVerticalPositionChanged() Call this method to fire a maxVerticalPositionChanged event to all registered listeners.
protected void	fireVerticalExtentChanged() Call this method to fire a verticalExtentChanged event to all registered listeners.
protected void	fireVerticalPositionChanged() Call this method to fire a verticalPositionChanged event to all registered listeners.
int	getMaxVerticalPosition() Returns the maximum vertical position that the controller and its associated vertically scrollable objects can display.
int	getVerticalExtent() Returns the extent of the vertical range displayed by the controller and its associated vertically scrollable objects.
int	getVerticalPosition() Returns the beginning of the vertical range displayed by the controller and its associated vertically scrollable objects.
void	removeVerticalScrollable(IlvVerticalScrollable vs) Removes an IlvVerticalScrollable object so that it is no longer coordinated by this controller.
void	removeVerticalScrollListener(VerticalScrollListener listener) Removes the specified listener so that it will no longer receive vertical scroll events from this controller.
void	setMaxVerticalPosition(int max) Sets the maximum vertical position that the controller and its associated vertically scrollable objects can display.
void	setVerticalExtent(int extent) Sets the extent of the vertical range displayed by the controller and its associated vertically scrollable objects.
void	setVerticalPosition(int position) Sets the beginning of the vertical range displayed by the controller and its associated vertically scrollable objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvVerticalScrollController

public IlvVerticalScrollController()

Creates a new IlvVerticalScrollController.

Method Detail

addVerticalScrollable

public void addVerticalScrollable(IlvVerticalScrollable vs)

Adds an IlvVerticalScrollable object to be coordinated by this controller.

See Also:

removeVerticalScrollable(ilog.views.gantt.IlvVerticalScrollable)

removeVerticalScrollable

public void removeVerticalScrollable(IlvVerticalScrollable vs)

Removes an IlvVerticalScrollable object so that it is no longer coordinated by this controller.

See Also:

addVerticalScrollable(ilog.views.gantt.IlvVerticalScrollable)

getMaxVerticalPosition

public int getMaxVerticalPosition()

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

Specified by:

getMaxVerticalPosition in interface IlvVerticalScrollable

Returns:

The maximum position.

See Also:

setMaxVerticalPosition(int)

setMaxVerticalPosition

public void setMaxVerticalPosition(int max)

Sets the maximum vertical position that the controller and its associated vertically scrollable objects 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.

Specified by:

setMaxVerticalPosition in interface IlvVerticalScrollable

Parameters:

max - The maximum position.

See Also:

getMaxVerticalPosition()

getVerticalPosition

public int getVerticalPosition()

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

Specified by:

getVerticalPosition in interface IlvVerticalScrollable

See Also:

setVerticalPosition(int)

setVerticalPosition

public void setVerticalPosition(int position)

Sets the beginning of the vertical range displayed by the controller and its associated vertically scrollable objects. 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.

Specified by:

setVerticalPosition in interface IlvVerticalScrollable

Parameters:

position - The new position.

See Also:

getVerticalPosition()

getVerticalExtent

public int getVerticalExtent()

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

Specified by:

getVerticalExtent in interface IlvVerticalScrollable

See Also:

setVerticalExtent(int)

setVerticalExtent

public void setVerticalExtent(int extent)

Sets the extent of the vertical range displayed by the controller and its associated vertically scrollable objects. 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.

Specified by:

setVerticalExtent in interface IlvVerticalScrollable

Parameters:

extent - The new extent.

See Also:

getVerticalExtent()

addVerticalScrollListener

public void addVerticalScrollListener(VerticalScrollListener listener)

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

Specified by:

addVerticalScrollListener in interface IlvVerticalScrollable

Parameters:

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

See Also:

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

removeVerticalScrollListener

public void removeVerticalScrollListener(VerticalScrollListener listener)

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

Specified by:

removeVerticalScrollListener in interface IlvVerticalScrollable

Parameters:

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

See Also:

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

fireMaxVerticalPositionChanged

protected void fireMaxVerticalPositionChanged()

Call this method to fire a maxVerticalPositionChanged event to all registered listeners.

See Also:

setMaxVerticalPosition(int)

fireVerticalPositionChanged

protected void fireVerticalPositionChanged()

Call this method to fire a verticalPositionChanged event to all registered listeners.

See Also:

setVerticalPosition(int)

fireVerticalExtentChanged

protected void fireVerticalExtentChanged()

Call this method to fire a verticalExtentChanged event to all registered listeners.

See Also:

setVerticalExtent(int)