JavaFX 24 · com.sun.javafx.css.TransitionTimer · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
public static interface	TransitionTimer.CancellationToken A token that can be used to cancel a running timer.

Modifier and Type	Field and Description
private long	currentTime
private long	delay
private long	duration
private long	endTime
private final Interpolator	interpolator
private final TransitionMediator	mediator
private double	reversingShorteningFactor
private boolean	started
private long	startTime
private final Node	targetNode
private final String	targetPropertyName

Access	Constructor and Description
private	TransitionTimer(TransitionMediator mediator, TransitionDefinition definition, String targetPropertyName, long nanoNow)

Method Summary

Modifier and Type	Method and Description
private void	adjustReversingTimings(TransitionTimer the timer of the running transition existingTimer) If a running transition is interrupted by a new transition, we adjust the start time and end time of the new transition with the reversing shortening factor of the old transition.
public void	complete() Skips the rest of a running transition and updates the property to the target value.
private void	fireTransitionEvent(EventType<TransitionEvent> the event type eventType) Fires a `TransitionEvent` of the specified type.
public TransitionMediator	Returns: the `TransitionMediator` getMediator() Returns the `TransitionMediator` associated with this timer.
private double	Returns: the input progress, ranging from 0 to 1 getProgress() Gets the progress of this timer along the input progress axis.
public void	handle(long the timestamp of the current frame, in nanoseconds now) Implements abstract javafx.animation.AnimationTimer.handle. Called once per frame to update the `TransitionTimer`.
private void	interrupt() Stops this timer without invoking `TransitionMediator#onStop()`.
private static long	Returns: the duration in nanoseconds millisToNanos(double the duration in fractional milliseconds millis) Converts the specified duration in fractional milliseconds to nanoseconds.
private static double	Returns: the duration in fractional milliseconds nanosToMillis(long the duration in nanoseconds nanos) Converts the specified duration in nanoseconds to fractional milliseconds.
public static TransitionTimer.CancellationToken	Returns: a `CancellationToken` if the timer was started, `null` otherwise run(TransitionMediator the `TransitionMediator` for the targeted property mediator, TransitionDefinition the `TransitionDefinition` used to initialize the `timer` definition, String the name of the CSS property targeted by the transition targetPropertyName, long the current time in nanoseconds nanoNow) Starts the specified transition timer with the specified transition definition.
public void	start() Overrides javafx.animation.AnimationTimer.start. Starts this timer, and adds it to the list of running transitions.
public void	stop() Overrides javafx.animation.AnimationTimer.stop. Stops this timer without updating the property to the target value.
private void	stopTimer(EventType<TransitionEvent> the event type that is fired after the timer is stopped eventType) Stops the running timer and fires the specified event.
private void	update(double the input progress value progress) Updates the transition mediator by mapping the specified input progress to an output progress value using the timer's interpolator, and then calling `TransitionMediator#onUpdate(double)`} with the output progress value.

currentTime	back to summary
private long currentTime

delay	back to summary
private long delay

duration	back to summary
private long duration

endTime	back to summary
private long endTime

interpolator	back to summary
private final Interpolator interpolator

mediator	back to summary
private final TransitionMediator mediator

reversingShorteningFactor	back to summary
private double reversingShorteningFactor

started	back to summary
private boolean started

startTime	back to summary
private long startTime

targetNode	back to summary
private final Node targetNode

targetPropertyName	back to summary
private final String targetPropertyName

TransitionTimer	back to summary
private TransitionTimer(TransitionMediator mediator, TransitionDefinition definition, String targetPropertyName, long nanoNow)

Method Detail

adjustReversingTimings	back to summary
private void adjustReversingTimings(TransitionTimer existingTimer) If a running transition is interrupted by a new transition, we adjust the start time and end time of the new transition with the reversing shortening factor of the old transition. Note that the reversing shortening factor is computed in output progress space (value), not in input progress space (time). This algorithm fixes transition asymmetries that can happen when a transition is interrupted by a reverse transition. Consider a linear transition that animates a value over 4s, but is interrupted after 1s. When the transition is interrupted, the value has progressed one quarter of the value space in one quarter of the duration. However, the reverse transition now takes the entire duration (4s) to progress just one quarter of the original value space, which means that the transition speed is much slower than what would be expected. Parameters existingTimer:TransitionTimer the timer of the running transition See Also Faster reversing of interrupted transitions

adjustReversingTimings

back to summary

private void adjustReversingTimings(TransitionTimer existingTimer)

If a running transition is interrupted by a new transition, we adjust the start time and end time of the new transition with the reversing shortening factor of the old transition. Note that the reversing shortening factor is computed in output progress space (value), not in input progress space (time).

This algorithm fixes transition asymmetries that can happen when a transition is interrupted by a reverse transition. Consider a linear transition that animates a value over 4s, but is interrupted after 1s. When the transition is interrupted, the value has progressed one quarter of the value space in one quarter of the duration. However, the reverse transition now takes the entire duration (4s) to progress just one quarter of the original value space, which means that the transition speed is much slower than what would be expected.

Parameters

existingTimer:TransitionTimer: the timer of the running transition

complete	back to summary
public void complete() Skips the rest of a running transition and updates the property to the target value. This happens when the targeted node is removed from the scene graph or becomes invisible.

fireTransitionEvent back to summary

fireTransitionEvent	back to summary
private void fireTransitionEvent(EventType<TransitionEvent> eventType) Fires a `TransitionEvent` of the specified type. The elapsed time is computed according to the CSS Transitions specification. Parameters eventType:EventType<TransitionEvent> the event type

private void fireTransitionEvent(EventType<TransitionEvent> eventType)

Fires a TransitionEvent of the specified type. The elapsed time is computed according to the CSS Transitions specification.

Parameters

eventType:EventType<TransitionEvent>: the event type

getMediator back to summary

getMediator	back to summary
public TransitionMediator getMediator() Returns the `TransitionMediator` associated with this timer. Returns:TransitionMediator the `TransitionMediator`

public TransitionMediator getMediator()

Returns the TransitionMediator associated with this timer.

Returns:TransitionMediator: the TransitionMediator

getProgress	back to summary
private double getProgress() Gets the progress of this timer along the input progress axis. Returns:double the input progress, ranging from 0 to 1

getProgress

back to summary

private double getProgress()

Gets the progress of this timer along the input progress axis.

Returns:double: the input progress, ranging from 0 to 1

handle back to summary

handle	back to summary
public void handle(long now) Implements abstract javafx.animation.AnimationTimer.handle. Called once per frame to update the `TransitionTimer`. This method fires `TransitionEvent#START` when the timer enters its active interval, and `TransitionEvent#END` event when the timer has reached the end of its active interval. Parameters now:long the timestamp of the current frame, in nanoseconds Annotations @Override

public void handle(long now)

Implements abstract javafx.animation.AnimationTimer.handle.

Called once per frame to update the TransitionTimer.

This method fires TransitionEvent#START when the timer enters its active interval, and TransitionEvent#END event when the timer has reached the end of its active interval.

Parameters

now:long: the timestamp of the current frame, in nanoseconds

Annotations

@Override

interrupt	back to summary
private void interrupt() Stops this timer without invoking `TransitionMediator#onStop()`. This form of completion only happens when a timer is interrupted by a reversing timer.

millisToNanos	back to summary
private static long millisToNanos(double millis) Converts the specified duration in fractional milliseconds to nanoseconds. Parameters millis:double the duration in fractional milliseconds Returns:long the duration in nanoseconds

millisToNanos

back to summary

private static long millisToNanos(double millis)

Converts the specified duration in fractional milliseconds to nanoseconds.

Parameters

millis:double: the duration in fractional milliseconds

Returns:long

the duration in nanoseconds

nanosToMillis	back to summary
private static double nanosToMillis(long nanos) Converts the specified duration in nanoseconds to fractional milliseconds. Parameters nanos:long the duration in nanoseconds Returns:double the duration in fractional milliseconds

nanosToMillis

back to summary

private static double nanosToMillis(long nanos)

Converts the specified duration in nanoseconds to fractional milliseconds.

Parameters

nanos:long: the duration in nanoseconds

Returns:double

the duration in fractional milliseconds

run back to summary

run	back to summary
public static TransitionTimer.CancellationToken run(TransitionMediator mediator, TransitionDefinition definition, String targetPropertyName, long nanoNow) Starts the specified transition timer with the specified transition definition. If the combined duration of the transition is zero or if the targeted node is not showing, no transition timer is started, no events are dispatched, and this method returns `null`. Parameters mediator:TransitionMediator the `TransitionMediator` for the targeted property definition:TransitionDefinition the `TransitionDefinition` used to initialize the `timer` targetPropertyName:String the name of the CSS property targeted by the transition nanoNow:long the current time in nanoseconds Returns:TransitionTimer.CancellationToken a `CancellationToken` if the timer was started, `null` otherwise

public static TransitionTimer.CancellationToken run(TransitionMediator mediator, TransitionDefinition definition, String targetPropertyName, long nanoNow)

Starts the specified transition timer with the specified transition definition. If the combined duration of the transition is zero or if the targeted node is not showing, no transition timer is started, no events are dispatched, and this method returns null.

Parameters

mediator:TransitionMediator: the TransitionMediator for the targeted property
definition:TransitionDefinition: the TransitionDefinition used to initialize the timer
targetPropertyName:String: the name of the CSS property targeted by the transition
nanoNow:long: the current time in nanoseconds

Returns:TransitionTimer.CancellationToken

a CancellationToken if the timer was started, null otherwise

start	back to summary
public void start() Overrides javafx.animation.AnimationTimer.start. Starts this timer, and adds it to the list of running transitions. Annotations @Override

start

back to summary

public void start()

Overrides javafx.animation.AnimationTimer.start.

Starts this timer, and adds it to the list of running transitions.

Annotations

@Override

stop	back to summary
public void stop() Overrides javafx.animation.AnimationTimer.stop. Stops this timer without updating the property to the target value. This happens when the value of the styleable property is changed by the user, or when a running timer is cancelled by a transition with zero duration. Annotations @Override

stop

back to summary

public void stop()

Overrides javafx.animation.AnimationTimer.stop.

Stops this timer without updating the property to the target value. This happens when the value of the styleable property is changed by the user, or when a running timer is cancelled by a transition with zero duration.

Annotations

@Override

stopTimer	back to summary
private void stopTimer(EventType<TransitionEvent> eventType) Stops the running timer and fires the specified event. Parameters eventType:EventType<TransitionEvent> the event type that is fired after the timer is stopped

stopTimer

back to summary

private void stopTimer(EventType<TransitionEvent> eventType)

Stops the running timer and fires the specified event.

Parameters

eventType:EventType<TransitionEvent>: the event type that is fired after the timer is stopped

update back to summary

update	back to summary
private void update(double progress) Updates the transition mediator by mapping the specified input progress to an output progress value using the timer's interpolator, and then calling `TransitionMediator#onUpdate(double)`} with the output progress value. Parameters progress:double the input progress value

private void update(double progress)

Updates the transition mediator by mapping the specified input progress to an output progress value using the timer's interpolator, and then calling TransitionMediator#onUpdate(double)} with the output progress value.

Parameters

progress:double: the input progress value

public final Class TransitionTimer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface TransitionTimer.CancellationToken

Method Summary

Method Detail