ilog.views.gantt

Class IlvBasicTimeScrollController

java.lang.Object

ilog.views.gantt.IlvBasicTimeScrollSupport

ilog.views.gantt.IlvBasicTimeScrollController

All Implemented Interfaces:

IlvTimeScrollable, Serializable

Direct Known Subclasses:

IlvTimeScrollController

public class IlvBasicTimeScrollController
extends IlvBasicTimeScrollSupport
implements IlvTimeScrollable

An IlvBasicTimeScrollController coordinates the time scrolling of one or more IlvTimeScrollable objects. In addition, the controller itself exports the IlvTimeScrollable interface. Two scrolling modes are supported by the controller and its associated scrollable objects:

1. Bounded scrolling mode: in this mode, time scrolling is constrained by the minimum visible time and the maximum visible time. Both values must be valid and non null. In bounded scrolling mode there are four interrelated time properties:
   • minVisibleTime
   • maxVisibleTime
   • visibleTime
   • visibleDuration
   These four values define two nested ranges:

   minVisibleTime <= visibleTime <= visibleTime+visibleDuration <= maxVisibleTime

   The controller enforces this relationship by correcting or trimming properties as follows:
   • The setMinVisibleTime(Date) and setMaxVisibleTime(Date) methods validate that:

      minVisibleTime <= maxVisibleTime

     If this is not true, an IllegalArgumentException is thrown.

   • The visible time and visible duration properties may be trimmed (in that order), to fit within the new min-max interval.
   • The setVisibleTime(Date) and setVisibleDuration(IlvDuration) methods trim their argument to fit within the limits defined by the other three properties. For example, if maxVisibleTime.equals(visibleTime.add(IlvDuration.ONE_DAY)), then setVisibleDuration(IlvDuration.ONE_WEEK) would change the duration to IlvDuration.ONE_DAY.

   The controller uses the IlvTimeScrollUtil.trimInterval(ilog.views.gantt.IlvTimeInterval, java.util.Date, java.util.Date, ilog.views.gantt.IlvDuration) method to perform consistent validation and trimming of the time value arguments.

2. Unbounded scrolling mode: in this mode, the minimum visible time and the maximum visible time are undefined and are set to null.

   In unbounded scrolling mode, there is an inherent limitation on the minimum and maximum times that can be scrolled to. As with bounded scrolling mode, this is enforced by having the controller use the IlvTimeScrollUtil.trimInterval(ilog.views.gantt.IlvTimeInterval, java.util.Date, java.util.Date, ilog.views.gantt.IlvDuration) method to perform validation and trimming of the time value arguments.

Note: a time scroll controller does not propagate duration changes that are fired by a resized user interface component to the other registered time scrollables. However, such VisibleDurationChangedEvents are propagated to all registered listeners. This is because each time scrollable component is responsible for updating its own duration value in order to maintain a constant zoom factor when it is resized. Swing resizes user interface components with indeterminate timing and this avoids potential time interval desynchronization across multiple components in the same interface.

Since:

JViews 6.0

See Also:

Serialized Form

Field Summary

Fields inherited from interface ilog.views.gantt.IlvTimeScrollable

DEFAULT_MINIMUM_DURATION

Constructor Summary

Constructors

Constructor and Description
IlvBasicTimeScrollController() Creates a new IlvBasicTimeScrollController.

Method Summary

Modifier and Type	Method and Description
void	addTimeScrollable(IlvTimeScrollable ts) Adds an IlvTimeScrollable object to be coordinated by this controller.
void	addTimeScrollListener(TimeScrollListener listener) Adds the specified listener to receive time scroll events from this controller.
protected void	fireMaxVisibleTimeChanged() Call this method to fire a maxVisibleTimeChanged event to all registered listeners.
protected void	fireMinVisibleDurationChanged() Call this method to fire a minVisibleDurationChanged event to all registered listeners.
protected void	fireMinVisibleTimeChanged() Call this method to fire a minVisibleTimeChanged event to all registered listeners.
protected void	fireVisibleDurationChanged() Call this method to fire a visibleDurationChanged event to all registered listeners.
protected void	fireVisibleTimeChanged(boolean adjusting) Call this method to fire a visibleTimeChanged event to all registered listeners.
IlvTimeScrollable	getOwner() Returns the owner of the controller.
void	removeTimeScrollable(IlvTimeScrollable ts) Removes an IlvTimeScrollable object so that it is no longer coordinated by this controller.
void	removeTimeScrollListener(TimeScrollListener listener) Removes the specified listener so that it will no longer receive time scroll events from this controller.
void	setMaxVisibleTime(Date max) Sets the maximum time that the controller and its associated time scrollable objects can show in bounded scrolling mode.
void	setMinVisibleDuration(IlvDuration duration) Sets the minimum duration that the controller and its associated time scrollable objects can show.
void	setMinVisibleTime(Date min) Sets the minimum time that the controller and its associated time scrollable objects can show in bounded scrolling mode.
void	setOwner(IlvTimeScrollable owner) Sets the owner of the controller.
void	setVisibleDuration(IlvDuration duration) Sets the duration of the time interval displayed by the controller and its associated time scrollable objects.
void	setVisibleInterval(Date time, IlvDuration duration) Sets the time interval displayed by the controller and its associated time scrollable objects.
void	setVisibleTime(Date time) Sets the beginning of the time interval displayed by the controller and its associated time scrollable objects.

Methods inherited from class ilog.views.gantt.IlvBasicTimeScrollSupport

durationChanged, getMaxVisibleTime, getMinVisibleDuration, getMinVisibleTime, getVisibleDuration, getVisibleInterval, getVisibleTime, maxTimeChanged, minDurationChanged, minTimeChanged, startTimeChanged, timeIntervalChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface ilog.views.gantt.IlvTimeScrollable

getMaxVisibleTime, getMinVisibleDuration, getMinVisibleTime, getVisibleDuration, getVisibleInterval, getVisibleTime

Constructor Detail

IlvBasicTimeScrollController

public IlvBasicTimeScrollController()

Creates a new IlvBasicTimeScrollController.

Method Detail

setMinVisibleTime

public void setMinVisibleTime(Date min)

Sets the minimum time that the controller and its associated time scrollable objects can show in bounded scrolling mode. The current visible time and duration are trimmed to fit the new min-max interval by calling the IlvTimeScrollUtil.trimInterval(ilog.views.gantt.IlvTimeInterval, java.util.Date, java.util.Date, ilog.views.gantt.IlvDuration) method. A minVisibleTimeChanged event is then fired to all registered listeners. If min > maxVisibleTime an IllegalArgumentException will be thrown.

Specified by:

setMinVisibleTime in interface IlvTimeScrollable

Overrides:

setMinVisibleTime in class IlvBasicTimeScrollSupport

Parameters:

min - The minimum visible time or null to set the controller to unbounded scrolling mode.

See Also:

IlvBasicTimeScrollSupport.getMinVisibleTime()

setMaxVisibleTime

public void setMaxVisibleTime(Date max)

Sets the maximum time that the controller and its associated time scrollable objects can show in bounded scrolling mode. The current visible time and duration are trimmed to fit the new min-max interval by calling the IlvTimeScrollUtil.trimInterval(ilog.views.gantt.IlvTimeInterval, java.util.Date, java.util.Date, ilog.views.gantt.IlvDuration) method. A maxVisibleTimeChanged event is then fired to all registered listeners. If max < minVisibleTime an IllegalArgumentException will be thrown.

Specified by:

setMaxVisibleTime in interface IlvTimeScrollable

Overrides:

setMaxVisibleTime in class IlvBasicTimeScrollSupport

Parameters:

max - The maximum visible time or null to set the controller to unbounded scrolling mode.

See Also:

IlvBasicTimeScrollSupport.getMaxVisibleTime()

setMinVisibleDuration

public void setMinVisibleDuration(IlvDuration duration)

Sets the minimum duration that the controller and its associated time scrollable objects can show. The duration parameter specifies the maximum zoom level that can be displayed. An minVisibleDurationChanged event is fired to all registered listeners.

Specified by:

setMinVisibleDuration in interface IlvTimeScrollable

Overrides:

setMinVisibleDuration in class IlvBasicTimeScrollSupport

Parameters:

duration - The minimum visible duration.

Since:

JViews 8.5

See Also:

IlvBasicTimeScrollSupport.getMinVisibleDuration()

setVisibleTime

public void setVisibleTime(Date time)

Sets the beginning of the time interval displayed by the controller and its associated time scrollable objects. The specified time value is compared against the min and max visible times and is trimmed if necessary by calling the IlvTimeScrollUtil.trimInterval(ilog.views.gantt.IlvTimeInterval, java.util.Date, java.util.Date, ilog.views.gantt.IlvDuration) method. A VisibleTimeChangedEvent is then fired to all registered listeners. If you are changing both the visible time and duration, it is preferable to use the setVisibleInterval(Date, IlvDuration) method instead.

Specified by:

setVisibleTime in interface IlvTimeScrollable

Overrides:

setVisibleTime in class IlvBasicTimeScrollSupport

Parameters:

time - The new time value.

See Also:

IlvBasicTimeScrollSupport.getVisibleTime()

setVisibleDuration

public void setVisibleDuration(IlvDuration duration)

Sets the duration of the time interval displayed by the controller and its associated time scrollable objects. The specified duration is compared against the min and max visible times and is trimmed if necessary by calling the IlvTimeScrollUtil.trimInterval(ilog.views.gantt.IlvTimeInterval, java.util.Date, java.util.Date, ilog.views.gantt.IlvDuration) method. A VisibleDurationChangedEvent is then fired to all registered listeners. If you are changing both the visible time and duration, it is preferable to use the setVisibleInterval(Date, IlvDuration) method instead.

Specified by:

setVisibleDuration in interface IlvTimeScrollable

Overrides:

setVisibleDuration in class IlvBasicTimeScrollSupport

Parameters:

duration - The new duration value.

See Also:

IlvBasicTimeScrollSupport.getVisibleDuration()

setVisibleInterval

public void setVisibleInterval(Date time,
                               IlvDuration duration)

Sets the time interval displayed by the controller and its associated time scrollable objects. The specified interval is compared against the min and max visible times and is trimmed if necessary by calling the IlvTimeScrollUtil.trimInterval(ilog.views.gantt.IlvTimeInterval, java.util.Date, java.util.Date, ilog.views.gantt.IlvDuration) method. This method then fires an adjusting VisibleTimeChangedEvent followed by a VisibleDurationChangedEvent to all registered listeners.

Specified by:

setVisibleInterval in interface IlvTimeScrollable

Overrides:

setVisibleInterval in class IlvBasicTimeScrollSupport

Parameters:

time - The new time value.

duration - The new duration value.

See Also:

IlvBasicTimeScrollSupport.getVisibleInterval()

addTimeScrollListener

public void addTimeScrollListener(TimeScrollListener listener)

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

Specified by:

addTimeScrollListener in interface IlvTimeScrollable

Parameters:

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

See Also:

removeTimeScrollListener(ilog.views.gantt.event.TimeScrollListener)

removeTimeScrollListener

public void removeTimeScrollListener(TimeScrollListener listener)

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

Specified by:

removeTimeScrollListener in interface IlvTimeScrollable

Parameters:

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

See Also:

addTimeScrollListener(ilog.views.gantt.event.TimeScrollListener)

addTimeScrollable

public void addTimeScrollable(IlvTimeScrollable ts)

Adds an IlvTimeScrollable object to be coordinated by this controller.

Parameters:

ts - The time scrollable.

See Also:

removeTimeScrollable(ilog.views.gantt.IlvTimeScrollable)

removeTimeScrollable

public void removeTimeScrollable(IlvTimeScrollable ts)

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

Parameters:

ts - The time scrollable.

See Also:

addTimeScrollable(ilog.views.gantt.IlvTimeScrollable)

getOwner

public IlvTimeScrollable getOwner()

Returns the owner of the controller. The owner is used as the source of all events fired by the controller. The default value is the controller itself.

setOwner

public void setOwner(IlvTimeScrollable owner)

Sets the owner of the controller. The owner will be used as the source of all events fired by the controller.

Parameters:

owner - The owner of the controller or null if the controller has no owner.

fireMinVisibleTimeChanged

protected void fireMinVisibleTimeChanged()

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

See Also:

setMinVisibleTime(Date)

fireMaxVisibleTimeChanged

protected void fireMaxVisibleTimeChanged()

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

See Also:

setMaxVisibleTime(Date)

fireMinVisibleDurationChanged

protected void fireMinVisibleDurationChanged()

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

Since:

JViews 8.5

See Also:

setMinVisibleDuration(IlvDuration)

fireVisibleTimeChanged

protected void fireVisibleTimeChanged(boolean adjusting)

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

See Also:

setVisibleTime(Date)

fireVisibleDurationChanged

protected void fireVisibleDurationChanged()

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

See Also:

setVisibleDuration(IlvDuration)