Class StrokeTransition

javafx.animation.StrokeTransition

public final class StrokeTransition
extends Transition

This Transition creates an animation, that changes the stroke color of a shape over a duration. This is done by updating the stroke variable of the shape at regular intervals.

It starts from the fromValue if provided else uses the shape 's stroke value. (The stroke value has to be a Color in this case).

It stops at the toValue value.

Code Segment Example:

 
 import javafx.scene.shape.*;
 import javafx.animation.*;

 ...

     Rectangle rect = new Rectangle (100, 40, 100, 100);
     rect.setArcHeight(50);
     rect.setArcWidth(50);
     rect.setFill(null);

     StrokeTransition st = new StrokeTransition(Duration.millis(3000), rect, Color.RED, Color.BLUE);
     st.setCycleCount(4);
     st.setAutoReverse(true);

     st.play();

 ...

Since:: JavaFX 2.0
See Also:: Transition, Animation

Property Summary

Properties
Type	Property	Description
`ObjectProperty<Duration>`	`duration`	The duration of this `StrokeTransition`.
`ObjectProperty<Color>`	`fromValue`	Specifies the start color value for this `StrokeTransition`.
`ObjectProperty<Shape>`	`shape`	The target shape of this `StrokeTransition`.
`ObjectProperty<Color>`	`toValue`	Specifies the stop color value for this `StrokeTransition`.

Properties declared in class javafx.animation.Transition

interpolator

Properties declared in class javafx.animation.Animation

autoReverse, currentRate, currentTime, cycleCount, cycleDuration, delay, onFinished, rate, status, totalDuration

Nested Class Summary

Nested classes/interfaces declared in class javafx.animation.Animation

Animation.Status

Field Summary

Fields declared in class javafx.animation.Animation

INDEFINITE

Constructor Summary

Constructors
Constructor	Description
`StrokeTransition()`	The constructor of `StrokeTransition`
`StrokeTransition(Duration duration)`	The constructor of `StrokeTransition`
`StrokeTransition(Duration duration, Color fromValue, Color toValue)`	The constructor of `StrokeTransition`
`StrokeTransition(Duration duration, Shape shape)`	The constructor of `StrokeTransition`
`StrokeTransition(Duration duration, Shape shape, Color fromValue, Color toValue)`	The constructor of `StrokeTransition`

Method Summary

Modifier and Type	Method	Description
`ObjectProperty<Duration>`	`durationProperty()`	The duration of this `StrokeTransition`.
`ObjectProperty<Color>`	`fromValueProperty()`	Specifies the start color value for this `StrokeTransition`.
`Duration`	`getDuration()`	Gets the value of the property duration.
`Color`	`getFromValue()`	Gets the value of the property fromValue.
`Shape`	`getShape()`	Gets the value of the property shape.
`Color`	`getToValue()`	Gets the value of the property toValue.
`void`	`setDuration(Duration value)`	Sets the value of the property duration.
`void`	`setFromValue(Color value)`	Sets the value of the property fromValue.
`void`	`setShape(Shape value)`	Sets the value of the property shape.
`void`	`setToValue(Color value)`	Sets the value of the property toValue.
`ObjectProperty<Shape>`	`shapeProperty()`	The target shape of this `StrokeTransition`.
`ObjectProperty<Color>`	`toValueProperty()`	Specifies the stop color value for this `StrokeTransition`.

Methods declared in class javafx.animation.Transition

getCachedInterpolator, getInterpolator, getParentTargetNode, interpolate, interpolatorProperty, setInterpolator

Methods declared in class javafx.animation.Animation

autoReverseProperty, currentRateProperty, currentTimeProperty, cycleCountProperty, cycleDurationProperty, delayProperty, getCuePoints, getCurrentRate, getCurrentTime, getCycleCount, getCycleDuration, getDelay, getOnFinished, getRate, getStatus, getTargetFramerate, getTotalDuration, isAutoReverse, jumpTo, jumpTo, onFinishedProperty, pause, play, playFrom, playFrom, playFromStart, rateProperty, setAutoReverse, setCycleCount, setCycleDuration, setDelay, setOnFinished, setRate, setStatus, statusProperty, stop, totalDurationProperty

Methods declared in class java.lang.Object

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

Property Details

shape

public final ObjectProperty<Shape> shapeProperty

The target shape of this StrokeTransition.

It is not possible to change the target shape of a running StrokeTransition. If the value of shape is changed for a running StrokeTransition, the animation has to be stopped and started again to pick up the new value.

See Also:: getShape(), setShape(Shape)

duration

public final ObjectProperty<Duration> durationProperty

The duration of this StrokeTransition.

It is not possible to change the duration of a running StrokeTransition. If the value of duration is changed for a running StrokeTransition, the animation has to be stopped and started again to pick up the new value.

Note: While the unit of duration is a millisecond, the granularity depends on the underlying operating system and will in general be larger. For example animations on desktop systems usually run with a maximum of 60fps which gives a granularity of ~17 ms. Setting duration to value lower than Duration.ZERO will result in IllegalArgumentException.

Default value:: 400ms
See Also:: getDuration(), setDuration(Duration)

fromValue

public final ObjectProperty<Color> fromValueProperty

Specifies the start color value for this StrokeTransition.

It is not possible to change fromValue of a running StrokeTransition. If the value of fromValue is changed for a running StrokeTransition, the animation has to be stopped and started again to pick up the new value.

Default value:: null
See Also:: getFromValue(), setFromValue(Color)

toValue

public final ObjectProperty<Color> toValueProperty

Specifies the stop color value for this StrokeTransition.

It is not possible to change toValue of a running StrokeTransition. If the value of toValue is changed for a running StrokeTransition, the animation has to be stopped and started again to pick up the new value.

Default value:: null
See Also:: getToValue(), setToValue(Color)