com.flexganttfx.view.timeline

Class TimeTracker

java.lang.Object

com.flexganttfx.view.timeline.TimeTracker

public class TimeTracker
extends Object

A time tracker is used to update the property TimelineModel.nowProperty(). In most cases the time "now" will be equivalent to the system time but in simulations this might not be the case. The time tracker is used by the timeline and can be replaced by calling Timeline.setTimeTracker(TimeTracker). However, a default tracker is already installed and can be started by calling Timeline.startTimeTracking().

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
TimeTracker() Constructs a new tracker.

Method Summary

Modifier and Type	Method and Description
long	getDelay() Returns the delay in milliseconds between updates of TimelineModel.nowProperty().
protected Instant	getNow() Override to return the instant that will be set as "now" on the timeline model.
TimelineModel<?>	getTimelineModel()
void	setDelay(long millis) Sets the delay between updates of TimelineModel.nowProperty().
void	setTimelineModel(TimelineModel<?> model)
void	startTracking() Starts the tracking of the time.
void	stopTracking() Stops the tracking of the time.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeTracker

public TimeTracker()

Constructs a new tracker.

Since:

1.0

Method Detail

setTimelineModel

public final void setTimelineModel(TimelineModel<?> model)

getTimelineModel

public final TimelineModel<?> getTimelineModel()

getDelay

public final long getDelay()

Returns the delay in milliseconds between updates of TimelineModel.nowProperty(). The default is 1000 millis.

Returns:

the default delay between update calls

Since:

1.0

setDelay

public final void setDelay(long millis)

Sets the delay between updates of TimelineModel.nowProperty(). The default is 1000 millis.

Parameters:

millis - the new delay

Throws:

IllegalArgumentException - if the delay is zero or smaller

Since:

1.0

startTracking

public final void startTracking()

Starts the tracking of the time.

Since:

1.0

See Also:

Timeline.startTimeTracking()

stopTracking

public final void stopTracking()

Stops the tracking of the time.

Since:

1.0

See Also:

Timeline.stopTimeTracking()

getNow

protected Instant getNow()

Override to return the instant that will be set as "now" on the timeline model. The default implementation uses Instant.now().

Returns:

the "now" instant

See Also:

TimelineModel.setNow(Instant)