ilog.views.gantt

Class IlvBasicTimeScrollSupport

java.lang.Object

ilog.views.gantt.IlvBasicTimeScrollSupport

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IlvBasicTimeScrollController

public class IlvBasicTimeScrollSupport
extends Object
implements Serializable

IlvBasicTimeScrollSupport provides basic support for IlvTimeScrollable implementations. IlvBasicTimeScrollSupport does not directly support TimeScrollListeners and does not implement the IlvTimeScrollable interface. Instead, it provides various xxxChanged template methods that can be overridden in subclasses.

Since:

JViews 6.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvBasicTimeScrollSupport() Creates a new IlvBasicTimeScrollSupport.
IlvBasicTimeScrollSupport(IlvBasicTimeScrollSupport support) Creates a new IlvBasicTimeScrollSupport that has the same time interval, minimum time, maximum time, and minimum duration as the specified support instance.

Method Summary

Modifier and Type	Method and Description
protected void	durationChanged(IlvDuration oldDuration, IlvDuration newDuration) This method is automatically invoked when the duration of the time interval has changed, but the start time has remained the same.
Date	getMaxVisibleTime() Returns the maximum time in bounded scrolling mode.
IlvDuration	getMinVisibleDuration() Returns the minimum duration of the time interval.
Date	getMinVisibleTime() Returns the minimum time in bounded scrolling mode.
IlvDuration	getVisibleDuration() Returns the duration of the time interval.
IlvTimeInterval	getVisibleInterval() Returns the time interval.
Date	getVisibleTime() Returns the beginning of the time interval.
protected void	maxTimeChanged(Date oldMax, Date newMax) This method is automatically invoked when the maximum time has changed.
protected void	minDurationChanged(IlvDuration oldMin, IlvDuration newMin) This method is automatically invoked when the minimum duration has changed.
protected void	minTimeChanged(Date oldMin, Date newMin) This method is automatically invoked when the minimum time has changed.
void	setMaxVisibleTime(Date max) Sets the maximum time in bounded scrolling mode.
void	setMinVisibleDuration(IlvDuration duration) Sets the minimum duration of the time interval.
void	setMinVisibleTime(Date min) Sets the minimum time in bounded scrolling mode.
void	setVisibleDuration(IlvDuration duration) Sets the duration of the time interval.
void	setVisibleInterval(Date time, IlvDuration duration) Sets the time interval.
void	setVisibleTime(Date time) Sets the beginning of the time interval.
protected void	startTimeChanged(Date oldTime, Date newTime) This method is automatically invoked when the start of the time interval has changed, but the duration has remained the same.
protected void	timeIntervalChanged(Date oldTime, IlvDuration oldDuration, Date newTime, IlvDuration newDuration) This method is automatically invoked when both the start time and the duration of the time interval have changed.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvBasicTimeScrollSupport

public IlvBasicTimeScrollSupport()

Creates a new IlvBasicTimeScrollSupport.

IlvBasicTimeScrollSupport

public IlvBasicTimeScrollSupport(IlvBasicTimeScrollSupport support)

Creates a new IlvBasicTimeScrollSupport that has the same time interval, minimum time, maximum time, and minimum duration as the specified support instance.

Parameters:

support - The template support instance.

Method Detail

getMinVisibleTime

public Date getMinVisibleTime()

Returns the minimum time in bounded scrolling mode.

Returns:

The minimum time or null if we are in unbounded scrolling mode.

See Also:

setMinVisibleTime(java.util.Date)

setMinVisibleTime

public void setMinVisibleTime(Date min)

Sets the minimum time in bounded scrolling mode. The current 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. If min > maxTime an IllegalArgumentException will be thrown.

Parameters:

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

See Also:

getMinVisibleTime()

getMaxVisibleTime

public Date getMaxVisibleTime()

Returns the maximum time in bounded scrolling mode.

Returns:

The maximum time or null if we are in unbounded scrolling mode.

See Also:

setMaxVisibleTime(java.util.Date)

setMaxVisibleTime

public void setMaxVisibleTime(Date max)

Sets the maximum time in bounded scrolling mode. The current 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. If max < minTime an IllegalArgumentException will be thrown.

Parameters:

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

See Also:

getMaxVisibleTime()

getMinVisibleDuration

public IlvDuration getMinVisibleDuration()

Returns the minimum duration of the time interval. This value indicates the maximum zoom level that can be displayed. The default value is 1 minute.

Returns:

The minimum duration.

Since:

JViews 8.5

See Also:

setMinVisibleDuration(ilog.views.gantt.IlvDuration)

setMinVisibleDuration

public void setMinVisibleDuration(IlvDuration duration)

Sets the minimum duration of the time interval. This specifies the maximum zoom level that can be displayed.

Parameters:

duration - The minimum visible duration.

Since:

JViews 8.5

See Also:

getMinVisibleDuration()

getVisibleTime

public Date getVisibleTime()

Returns the beginning of the time interval.

Returns:

The beginning of the time interval.

See Also:

setVisibleTime(java.util.Date)

setVisibleTime

public void setVisibleTime(Date time)

Sets the beginning of the time interval. The specified time value is compared against the min and max 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. If you are changing both the time and duration, it is preferable to use the setVisibleInterval(java.util.Date, ilog.views.gantt.IlvDuration) method instead.

Parameters:

time - The new time value.

See Also:

getVisibleTime()

getVisibleDuration

public IlvDuration getVisibleDuration()

Returns the duration of the time interval.

Returns:

The duration of the time interval.

See Also:

setVisibleDuration(ilog.views.gantt.IlvDuration)

setVisibleDuration

public void setVisibleDuration(IlvDuration duration)

Sets the duration of the time interval. The specified duration is compared against the min and max 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. If you are changing both the time and duration, it is preferable to use the setVisibleInterval(java.util.Date, ilog.views.gantt.IlvDuration) method instead.

Parameters:

duration - The new duration value.

See Also:

getVisibleDuration()

getVisibleInterval

public IlvTimeInterval getVisibleInterval()

Returns the time interval.

Returns:

The time interval.

See Also:

setVisibleInterval(java.util.Date, ilog.views.gantt.IlvDuration)

setVisibleInterval

public void setVisibleInterval(Date time,
                               IlvDuration duration)

Sets the time interval. The specified interval is compared against the min and max 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.

Parameters:

time - The new time value.

duration - The new duration value.

See Also:

getVisibleInterval()

minTimeChanged

protected void minTimeChanged(Date oldMin,
                              Date newMin)

This method is automatically invoked when the minimum time has changed. This implementation does nothing. Subclasses can override this method as needed.

Parameters:

oldMin - The previous minimum time or null if this support instance was in unbounded scrolling mode.

newMin - The new minimum time or null if this support instance is in unbounded scrolling mode.

See Also:

setMinVisibleTime(java.util.Date)

maxTimeChanged

protected void maxTimeChanged(Date oldMax,
                              Date newMax)

This method is automatically invoked when the maximum time has changed. This implementation does nothing. Subclasses can override this method as needed.

Parameters:

oldMax - The previous maximum time or null if this support instance was in unbounded scrolling mode.

newMax - The new maximum time or null if this support instance is in unbounded scrolling mode.

See Also:

setMaxVisibleTime(java.util.Date)

minDurationChanged

protected void minDurationChanged(IlvDuration oldMin,
                                  IlvDuration newMin)

This method is automatically invoked when the minimum duration has changed. This implementation does nothing. Subclasses can override this method as needed.

Parameters:

oldMin - The previous minimum duration.

newMin - The new minimum duration.

Since:

JViews 8.5

See Also:

setMinVisibleDuration(ilog.views.gantt.IlvDuration)

timeIntervalChanged

protected void timeIntervalChanged(Date oldTime,
                                   IlvDuration oldDuration,
                                   Date newTime,
                                   IlvDuration newDuration)

This method is automatically invoked when both the start time and the duration of the time interval have changed. This implementation does nothing. Subclasses can override this method as needed.

Parameters:

oldTime - The beginning of the previous time interval.

oldDuration - The duration of the previous time interval.

newTime - The beginning of the new time interval.

newDuration - The duration of the new time interval.

See Also:

setVisibleInterval(java.util.Date, ilog.views.gantt.IlvDuration)

startTimeChanged

protected void startTimeChanged(Date oldTime,
                                Date newTime)

This method is automatically invoked when the start of the time interval has changed, but the duration has remained the same. This implementation does nothing. Subclasses can override this method as needed.

Parameters:

oldTime - The beginning of the previous time interval.

newTime - The beginning of the new time interval.

See Also:

setVisibleTime(java.util.Date)

durationChanged

protected void durationChanged(IlvDuration oldDuration,
                               IlvDuration newDuration)

This method is automatically invoked when the duration of the time interval has changed, but the start time has remained the same. This implementation does nothing. Subclasses can override this method as needed.

Parameters:

oldDuration - The duration of the previous time interval.

newDuration - The duration of the new time interval.

See Also:

setVisibleDuration(ilog.views.gantt.IlvDuration)