ilog.views.gantt

Class IlvTimeScrollSupport

java.lang.Object

ilog.views.gantt.IlvBasicTimeScrollSupport

ilog.views.gantt.IlvBasicTimeScrollController

ilog.views.gantt.IlvTimeScrollController

ilog.views.gantt.IlvTimeScrollSupport

All Implemented Interfaces:

IlvTimeScrollable, Serializable

public class IlvTimeScrollSupport
extends IlvTimeScrollController

IlvTimeScrollSupport provides calculation support for IlvTimeScrollable implementations. IlvTimeScrollSupport converts bidirectionally between dates and screen coordinates in two phases:

1. Dates are converted to world coordinates using an IlvTimeConverter.
2. World coordinates are converted to screen coordinates based upon the mapping between a time interval and the view dimensions.

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
IlvTimeScrollSupport() Creates a new IlvTimeScrollSupport.
IlvTimeScrollSupport(IlvTimeScrollable owner) Creates a new IlvTimeScrollSupport for the specified owner.
IlvTimeScrollSupport(IlvTimeScrollSupport support) Creates a new IlvTimeScrollSupport that has the same time interval, minimum time, maximum time, minimum duration, time converter, view width, and owner as the specified support instance.

Method Summary

Modifier and Type	Method and Description
Date	computeVisibleTimeScroll(long x0, long x1) Computes the beginning of the visible interval that will cause the time at position x0 to scroll to position x1.
long	getLocation(Date time) Returns the screen coordinate position that corresponds to the specified time.
double	getOffset() Returns the offset used to transform a position in world coordinates to its corresponding position in pixel screen coordinates.
Date	getTime(long x) Returns the time that corresponds to the specified position in screen coordinates.
IlvTimeConverter	getTimeConverter() Returns the converter between time and world coordinates.
int	getViewStart() Returns the beginning of the view in screen coordinates.
int	getViewWidth() Returns the width of the view in screen coordinates.
double	getZoomFactor() Returns the scaling factor used to transform a position in world coordinates to its corresponding position in pixel screen coordinates, expressed as the ratio of screen to world coordinates.
boolean	isConstantZoomFactorOnWidthChange() Returns whether the duration will be modified when the view width changes in order to maintain a constant zoomFactor.
boolean	isLeftToRight() Returns whether time increases left-to-right in the view.
void	setConstantZoomFactorOnWidthChange(boolean enabled) Sets whether the duration will be modified when the view width changes in order to maintain a constant zoomFactor.
void	setLeftToRight(boolean ltr) Sets whether time increases left-to-right in the view.
void	setTimeConverter(IlvTimeConverter timeConverter) Sets the converter between time and world coordinates.
void	setViewStart(int start) Sets the beginning of the view in screen coordinates.
void	setViewWidth(int width) Sets the width of the view in screen coordinates.
void	setViewWidth(int width, boolean componentResizing) Sets the width of the view in screen coordinates.
protected void	timeConverterChanged(IlvTimeConverter oldTimeConverter, IlvTimeConverter newTimeConverter) This method is automatically invoked when the time converter has changed.

Methods inherited from class ilog.views.gantt.IlvTimeScrollController

getAnimationSteps, setAnimationSteps

Methods inherited from class ilog.views.gantt.IlvBasicTimeScrollController

addTimeScrollable, addTimeScrollListener, fireMaxVisibleTimeChanged, fireMinVisibleDurationChanged, fireMinVisibleTimeChanged, fireVisibleDurationChanged, fireVisibleTimeChanged, getOwner, removeTimeScrollable, removeTimeScrollListener, setMaxVisibleTime, setMinVisibleDuration, setMinVisibleTime, setOwner, setVisibleDuration, setVisibleInterval, setVisibleTime

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

IlvTimeScrollSupport

public IlvTimeScrollSupport(IlvTimeScrollable owner)

Creates a new IlvTimeScrollSupport for the specified owner. 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.

IlvTimeScrollSupport

public IlvTimeScrollSupport()

Creates a new IlvTimeScrollSupport.

IlvTimeScrollSupport

public IlvTimeScrollSupport(IlvTimeScrollSupport support)

Creates a new IlvTimeScrollSupport that has the same time interval, minimum time, maximum time, minimum duration, time converter, view width, and owner as the specified support instance.

Parameters:

support - The template support instance.

Method Detail

getTimeConverter

public IlvTimeConverter getTimeConverter()

Returns the converter between time and world coordinates.

Returns:

The time converter.

See Also:

setTimeConverter(ilog.views.gantt.graphic.IlvTimeConverter)

setTimeConverter

public void setTimeConverter(IlvTimeConverter timeConverter)

Sets the converter between time and world coordinates.

Parameters:

timeConverter - The new time converter.

timeConverterChanged

protected void timeConverterChanged(IlvTimeConverter oldTimeConverter,
                                    IlvTimeConverter newTimeConverter)

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

Parameters:

oldTimeConverter - The previous time converter.

newTimeConverter - The new time converter.

See Also:

setTimeConverter(ilog.views.gantt.graphic.IlvTimeConverter)

getViewStart

public int getViewStart()

Returns the beginning of the view in screen coordinates.

Returns:

The starting coordinate of the view.

See Also:

setViewStart(int)

setViewStart

public void setViewStart(int start)

Sets the beginning of the view in screen coordinates.

Parameters:

start - The beginning of the view.

See Also:

getViewStart()

getViewWidth

public int getViewWidth()

Returns the width of the view in screen coordinates.

Returns:

The view width.

See Also:

setViewWidth(int)

setLeftToRight

public void setLeftToRight(boolean ltr)

Sets whether time increases left-to-right in the view.

Parameters:

ltr - Indicates whether time increases left-to-right in the view.

Since:

JViews 8.7

See Also:

isLeftToRight()

isLeftToRight

public boolean isLeftToRight()

Returns whether time increases left-to-right in the view. If false, then time increases right-to-left in the view.

Returns:

Whether time increases left-to-right in the view. false indicates that time increases right-to-left.

Since:

JViews 8.7

See Also:

setLeftToRight(boolean)

isConstantZoomFactorOnWidthChange

public boolean isConstantZoomFactorOnWidthChange()

Returns whether the duration will be modified when the view width changes in order to maintain a constant zoomFactor. If false, the duration stays the same and the zoomFactor is modified when the view width changes. The default value is true.

Note: When multiple IlvTimeScrollable user interface components have their time scrolling synchronized through an IlvBasicTimeScrollController or one of its subclasses, all of the scrollable components should be placed in a container that ensures that they maintain equal widths and their constantZoomFactorOnWidthChange properties must be set to the same value. When the GUI resizes, each scrollable component is responsible for computing its own duration change.

Returns:

Whether the duration will be modified when the view width changes in order to maintain a constant zoomFactor.

See Also:

setConstantZoomFactorOnWidthChange(boolean)

setConstantZoomFactorOnWidthChange

public void setConstantZoomFactorOnWidthChange(boolean enabled)

Sets whether the duration will be modified when the view width changes in order to maintain a constant zoomFactor. If disabled, the duration stays the same and the zoomFactor is modified when the view width changes. The default value is true.

Note: When multiple IlvTimeScrollable user interface components have their time scrolling synchronized through an IlvBasicTimeScrollController or one of its subclasses, all of the scrollable components should be placed in a container that ensures that they maintain equal widths and their constantZoomFactorOnWidthChange properties must be set to the same value. When the GUI resizes, each scrollable component is responsible for computing its own duration change.

Parameters:

enabled - Indicates whether the zoomFactor stays the same and the duration changes when the view resizes. If false, the duration stays the same and the zoomFactor changes.

See Also:

isConstantZoomFactorOnWidthChange()

setViewWidth

public void setViewWidth(int width,
                         boolean componentResizing)

Sets the width of the view in screen coordinates.

Parameters:

width - The view width.

componentResizing - Indicates whether the owner is a GUI component that is being resized.

See Also:

getViewWidth()

setViewWidth

public void setViewWidth(int width)

Sets the width of the view in screen coordinates.

Parameters:

width - The view width.

See Also:

getViewWidth()

getZoomFactor

public double getZoomFactor()

Returns the scaling factor used to transform a position in world coordinates to its corresponding position in pixel screen coordinates, expressed as the ratio of screen to world coordinates.

Returns:

The transform zoom factor.

getOffset

public double getOffset()

Returns the offset used to transform a position in world coordinates to its corresponding position in pixel screen coordinates. This is expressed as the screen coordinate offset to be added to the transformed beginning of the time interval in order to make it correspond with a screen position of viewStart.

Returns:

The transform offset.

getTime

public Date getTime(long x)

Returns the time that corresponds to the specified position in screen coordinates.

Parameters:

x - The position specified in screen coordinates.

Returns:

The time that corresponds to x.

getLocation

public long getLocation(Date time)

Returns the screen coordinate position that corresponds to the specified time.

Parameters:

time - The time.

Returns:

The screen coordinate that corresponds to time.

computeVisibleTimeScroll

public Date computeVisibleTimeScroll(long x0,
                                     long x1)

Computes the beginning of the visible interval that will cause the time at position x0 to scroll to position x1. If the current time converter is non-linear, then this method makes a best attempt to converge on the correct result, while keeping the processing time reasonable.

Parameters:

x0 - The reference screen coordinate position.

x1 - The new screen coordinate position.

Returns:

The visible time that will cause the time that corresponds with x0 to scroll to x1.

Since:

JViews 6.5