Module com.flexganttfx.model

Package com.flexganttfx.model.timeline

Class TimelineModel<T extends TemporalUnit>

java.lang.Object

com.flexganttfx.model.timeline.TimelineModel<T>

Type Parameters:

T - the temporal unit supported by the model (e.g. ChronoUnit).

Direct Known Subclasses:

ChronoUnitTimelineModel, SimpleUnitTimelineModel

public abstract class TimelineModel<T extends TemporalUnit>
extends Object

The timeline model stores the most important properties related to navigating within time (move forward and backward in time, zoom in and out).

• Now - the "current" time (e.g. system time).
• Start time - the first time point that will be visible to the user.
• Millis per pixel - how much time is represented by a single pixel (important for zooming).
• Horizon - the earliest and latest point in time to which the user can scroll.
• Lowest temporal unit - the lowest unit that the user will be able to see (e.g. MINUTES).
• Highest temporal unit - the highest unit that the user will be able to see (e.g. MONTHS).

This class is also responsible for calculating the location for a given time and vice versa.

Property Summary

Properties

Type	Property	Description
ObjectProperty<Instant>	horizonEndTime	Returns the object property used for storing the end time of the horizon.
ObjectProperty<Instant>	horizonStartTime	Returns the object property used for storing the start time of the horizon.
DoubleProperty	maximumMillisPerPixel	A property used to store the maximum number of milliseconds that will be represented by a single pixel on the screen.
DoubleProperty	millisPerPixel	Returns the property used to store the millis per pixel value.
DoubleProperty	minimumMillisPerPixel	A property used to store the minimum number of milliseconds that will be represented by a single pixel on the screen.
ReadOnlyDoubleProperty	nowLocation	Stores the location of the "now" time.
ObjectProperty<Instant>	now	Returns the property used to store "now", the current time, e.g.
DoubleProperty	offset
ReadOnlyObjectProperty<T>	smallestTemporalUnit	Stores the smallest temporal unit supported by the control.
ObjectProperty<Instant>	startTime	Returns the property used to store the first visible time point.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TimelineModel()	Constructs a new timeline model.

Method Summary

Modifier and Type	Method	Description
double	calculateLocationForTime(Instant time)	Returns the pixel location of the given time.
Instant	calculateTimeForLocation(double location)	Returns the time for the given location.
Instant	getHorizonEndTime()	Returns the value of horizonEndTimeProperty().
Instant	getHorizonStartTime()	Returns the value of horizonStartTimeProperty().
double	getMaximumMillisPerPixel()	Returns the value of maximumMillisPerPixelProperty().
double	getMillisPerPixel()	Returns the value of millisPerPixelProperty().
double	getMinimumMillisPerPixel()	Returns the value of minimumMillisPerPixelProperty().
Instant	getNow()	Returns the value of nowProperty().
double	getNowLocation()	Returns the value of nowLocationProperty().
double	getOffset()	Gets the value of the property offset.
T	getSmallestTemporalUnit()	Returns the value of smallestTemporalUnitProperty().
Instant	getStartTime()	Returns the value of startTimeProperty().
ObjectProperty<Instant>	horizonEndTimeProperty()	Returns the object property used for storing the end time of the horizon.
ObjectProperty<Instant>	horizonStartTimeProperty()	Returns the object property used for storing the start time of the horizon.
DoubleProperty	maximumMillisPerPixelProperty()	A property used to store the maximum number of milliseconds that will be represented by a single pixel on the screen.
DoubleProperty	millisPerPixelProperty()	Returns the property used to store the millis per pixel value.
DoubleProperty	minimumMillisPerPixelProperty()	A property used to store the minimum number of milliseconds that will be represented by a single pixel on the screen.
ReadOnlyDoubleProperty	nowLocationProperty()	Stores the location of the "now" time.
ObjectProperty<Instant>	nowProperty()	Returns the property used to store "now", the current time, e.g.
DoubleProperty	offsetProperty()
void	setHorizonEndTime(Instant time)	Sets the value of horizonEndTimeProperty().
void	setHorizonStartTime(Instant time)	Sets the value of horizonStartTimeProperty().
void	setMaximumMillisPerPixel(double max)	Sets the value of maximumMillisPerPixelProperty().
void	setMillisPerPixel(double millis)	Sets the value of the millisPerPixelProperty().
void	setMinimumMillisPerPixel(double min)	Sets the value of minimumMillisPerPixelProperty().
void	setNow(Instant now)	Sets the value of nowProperty().
void	setOffset(double offset)	Sets the value of the property offset.
void	setStartTime(Instant time)	Sets the value of startTimeProperty().
void	setZoomRange(T smallestUnit, int smallestUnitCount, double smallestUnitWidth, T largestUnit, int largestUnitCount, double largestUnitWidth)	Sets the range in which the user can zoom in and out of the timeline.
ReadOnlyObjectProperty<T>	smallestTemporalUnitProperty()	Stores the smallest temporal unit supported by the control.
ObjectProperty<Instant>	startTimeProperty()	Returns the property used to store the first visible time point.

Methods inherited from class java.lang.Object

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

Property Details

offset

public final DoubleProperty offsetProperty

See Also:

getOffset(), setOffset(double)

horizonStartTime

public final ObjectProperty<Instant> horizonStartTimeProperty

Returns the object property used for storing the start time of the horizon.

See Also:

getHorizonStartTime(), setHorizonStartTime(Instant)

horizonEndTime

public final ObjectProperty<Instant> horizonEndTimeProperty

Returns the object property used for storing the end time of the horizon.

See Also:

getHorizonEndTime(), setHorizonEndTime(Instant)

millisPerPixel

public final DoubleProperty millisPerPixelProperty

Returns the property used to store the millis per pixel value. This value determines how much time is represented by a single pixel in the user interface. Changing the value of this property will cause the control to show more or less time within the visible timeline area, meaning zooming can be controlled by this property.

See Also:

getMillisPerPixel(), setMillisPerPixel(double)

minimumMillisPerPixel

public final DoubleProperty minimumMillisPerPixelProperty

A property used to store the minimum number of milliseconds that will be represented by a single pixel on the screen. Zoom-In operations will be limited by this value.

Since:

1.4

See Also:

getMinimumMillisPerPixel(), setMinimumMillisPerPixel(double)

maximumMillisPerPixel

public final DoubleProperty maximumMillisPerPixelProperty

A property used to store the maximum number of milliseconds that will be represented by a single pixel on the screen. Zoom-Out operations will be limited by this value.

Since:

1.4

See Also:

getMaximumMillisPerPixel(), setMaximumMillisPerPixel(double)

startTime

public final ObjectProperty<Instant> startTimeProperty

Returns the property used to store the first visible time point.

See Also:

getStartTime(), setStartTime(Instant)

now

public final ObjectProperty<Instant> nowProperty

Returns the property used to store "now", the current time, e.g. the current system time.

See Also:

getNow(), setNow(Instant)

nowLocation

public final ReadOnlyDoubleProperty nowLocationProperty

Stores the location of the "now" time. The location can be computed based on the millis per pixel and the start time value.

See Also:

getNowLocation()

smallestTemporalUnit

public final ReadOnlyObjectProperty<T extends TemporalUnit> smallestTemporalUnitProperty

Stores the smallest temporal unit supported by the control.

See Also:

getSmallestTemporalUnit()

Constructor Details

TimelineModel

protected TimelineModel()

Constructs a new timeline model.

Method Details

getOffset

public final double getOffset()

Gets the value of the property offset.

Property description:

offsetProperty

public final DoubleProperty offsetProperty()

See Also:

getOffset(), setOffset(double)

setOffset

public final void setOffset(double offset)

Sets the value of the property offset.

Property description:

horizonStartTimeProperty

public final ObjectProperty<Instant> horizonStartTimeProperty()

Returns the object property used for storing the start time of the horizon.

See Also:

getHorizonStartTime(), setHorizonStartTime(Instant)

getHorizonStartTime

public final Instant getHorizonStartTime()

Returns the value of horizonStartTimeProperty().

Returns:

the horizon start time

setHorizonStartTime

public final void setHorizonStartTime(Instant time)

Sets the value of horizonStartTimeProperty().

Parameters:

time - the horizon start time

horizonEndTimeProperty

public final ObjectProperty<Instant> horizonEndTimeProperty()

Returns the object property used for storing the end time of the horizon.

See Also:

getHorizonEndTime(), setHorizonEndTime(Instant)

getHorizonEndTime

public final Instant getHorizonEndTime()

Returns the value of horizonEndTimeProperty().

Returns:

the horizon end time

setHorizonEndTime

public final void setHorizonEndTime(Instant time)

Sets the value of horizonEndTimeProperty().

Parameters:

time - the horizon end time

millisPerPixelProperty

public final DoubleProperty millisPerPixelProperty()

Returns the property used to store the millis per pixel value. This value determines how much time is represented by a single pixel in the user interface. Changing the value of this property will cause the control to show more or less time within the visible timeline area, meaning zooming can be controlled by this property.

See Also:

getMillisPerPixel(), setMillisPerPixel(double)

setMillisPerPixel

public final void setMillisPerPixel(double millis)

Sets the value of the millisPerPixelProperty().

Parameters:

millis - the millis represented by a pixel

getMillisPerPixel

public final double getMillisPerPixel()

Returns the value of millisPerPixelProperty().

Returns:

the millis represented by a pixel

minimumMillisPerPixelProperty

public final DoubleProperty minimumMillisPerPixelProperty()

A property used to store the minimum number of milliseconds that will be represented by a single pixel on the screen. Zoom-In operations will be limited by this value.

Since:

1.4

See Also:

getMinimumMillisPerPixel(), setMinimumMillisPerPixel(double)

setMinimumMillisPerPixel

public final void setMinimumMillisPerPixel(double min)

Sets the value of minimumMillisPerPixelProperty().

Parameters:

min - the minimum MPP value

Since:

1.4

See Also:

setZoomRange(TemporalUnit, int, double, TemporalUnit, int, double)

getMinimumMillisPerPixel

public final double getMinimumMillisPerPixel()

Returns the value of minimumMillisPerPixelProperty().

Returns:

the minimum MPP value

Since:

1.4

See Also:

setZoomRange(TemporalUnit, int, double, TemporalUnit, int, double)

maximumMillisPerPixelProperty

public final DoubleProperty maximumMillisPerPixelProperty()

A property used to store the maximum number of milliseconds that will be represented by a single pixel on the screen. Zoom-Out operations will be limited by this value.

Since:

1.4

See Also:

getMaximumMillisPerPixel(), setMaximumMillisPerPixel(double)

setMaximumMillisPerPixel

public final void setMaximumMillisPerPixel(double max)

Sets the value of maximumMillisPerPixelProperty().

Parameters:

max - the maximum MPP value

Since:

1.4

See Also:

setZoomRange(TemporalUnit, int, double, TemporalUnit, int, double)

getMaximumMillisPerPixel

public final double getMaximumMillisPerPixel()

Returns the value of maximumMillisPerPixelProperty().

Returns:

the maximum MPP value

Since:

1.4

See Also:

setZoomRange(TemporalUnit, int, double, TemporalUnit, int, double)

setZoomRange

public final void setZoomRange(T smallestUnit,
int smallestUnitCount,
double smallestUnitWidth,
T largestUnit,
int largestUnitCount,
double largestUnitWidth)

Sets the range in which the user can zoom in and out of the timeline.

Parameters:

smallestUnit - the smallest unit to which the user can zoom (e.g. "MINUTES")

smallestUnitCount - the number of smallest units (e.g. "5" MINUTES)

smallestUnitWidth - the width of the unit in pixels, must be larger than 10 (e.g. "30")

largestUnit - the largest unit to which the user can zoom (e.g. "YEARS")

largestUnitCount - the number of largest units (e.g. "1" YEAR)

largestUnitWidth - the width of the unit in pixels, must be larger than 10 (e.g. "30")

Since:

1.4

See Also:

setMinimumMillisPerPixel(double), setMaximumMillisPerPixel(double)

startTimeProperty

public final ObjectProperty<Instant> startTimeProperty()

Returns the property used to store the first visible time point.

See Also:

getStartTime(), setStartTime(Instant)

setStartTime

public final void setStartTime(Instant time)

Sets the value of startTimeProperty().

Parameters:

time - the start time

getStartTime

public final Instant getStartTime()

Returns the value of startTimeProperty().

Returns:

the start time

nowProperty

public final ObjectProperty<Instant> nowProperty()

Returns the property used to store "now", the current time, e.g. the current system time.

See Also:

getNow(), setNow(Instant)

setNow

public final void setNow(Instant now)

Sets the value of nowProperty().

Parameters:

now - the "now" time

getNow

public final Instant getNow()

Returns the value of nowProperty().

Returns:

the "now" time

nowLocationProperty

public final ReadOnlyDoubleProperty nowLocationProperty()

Stores the location of the "now" time. The location can be computed based on the millis per pixel and the start time value.

See Also:

getNowLocation()

getNowLocation

public final double getNowLocation()

Returns the value of nowLocationProperty().

Returns:

the pixel location of "now"

smallestTemporalUnitProperty

public final ReadOnlyObjectProperty<T> smallestTemporalUnitProperty()

Stores the smallest temporal unit supported by the control.

See Also:

getSmallestTemporalUnit()

getSmallestTemporalUnit

public final T getSmallestTemporalUnit()

Returns the value of smallestTemporalUnitProperty().

Returns:

the smallest temporal unit

calculateLocationForTime

public final double calculateLocationForTime(Instant time)

Returns the pixel location of the given time.

Parameters:

time - the time for which to return the pixel location

Returns:

the location of the given time

calculateTimeForLocation

public final Instant calculateTimeForLocation(double location)

Returns the time for the given location.

Parameters:

location - the location in pixels

Returns:

the location time