Class StrokeTransition
public final class StrokeTransition extends Transition
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:
Property Summary
| Type | Property | Description |
|---|---|---|
final ObjectProperty<Duration> |
duration |
The duration of this StrokeTransition. |
final ObjectProperty<Color> |
fromValue |
Specifies the start color value for this StrokeTransition. |
final ObjectProperty<Shape> |
shape |
The target shape of this StrokeTransition. |
final 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
| Constructor | Description |
|---|---|
StrokeTransition() |
The constructor of StrokeTransition
|
StrokeTransition |
The constructor of StrokeTransition
|
StrokeTransition |
The constructor of StrokeTransition
|
StrokeTransition |
The constructor of StrokeTransition
|
StrokeTransition |
The constructor of StrokeTransition
|
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
final ObjectProperty<Duration> |
durationProperty() |
The duration of this StrokeTransition. |
final ObjectProperty<Color> |
fromValueProperty() |
Specifies the start color value for this StrokeTransition. |
final Duration |
getDuration() |
Gets the value of the duration property. |
final Color |
getFromValue() |
Gets the value of the fromValue property. |
final Shape |
getShape() |
Gets the value of the shape property. |
final Color |
getToValue() |
Gets the value of the toValue property. |
protected void |
interpolate |
The method interpolate() has to be provided by implementations of Transition. |
final void |
setDuration |
Sets the value of the duration property. |
final void |
setFromValue |
Sets the value of the fromValue property. |
final void |
setShape |
Sets the value of the shape property. |
final void |
setToValue |
Sets the value of the toValue property. |
final ObjectProperty<Shape> |
shapeProperty() |
The target shape of this StrokeTransition. |
final ObjectProperty<Color> |
toValueProperty() |
Specifies the stop color value for this StrokeTransition. |
Methods declared in class javafx.animation.Transition
getCachedInterpolator, getInterpolator, getParentTargetNode, 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
Property Details
shape
public final ObjectProperty<Shape> shapeProperty
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:
duration
public final ObjectProperty<Duration> durationProperty
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:
fromValue
public final ObjectProperty<Color> fromValueProperty
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:
toValue
public final ObjectProperty<Color> toValueProperty
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:
Constructor Details
StrokeTransition
public StrokeTransition(Duration duration, Shape shape, Color fromValue, Color toValue)
StrokeTransition
- Parameters:
-
duration- The duration of theStrokeTransition -
shape- Theshapewhich filling will be animated -
fromValue- The start value of the color-animation -
toValue- The end value of the color-animation
StrokeTransition
public StrokeTransition(Duration duration, Color fromValue, Color toValue)
StrokeTransition
- Parameters:
-
duration- The duration of theStrokeTransition -
fromValue- The start value of the color-animation -
toValue- The end value of the color-animation
StrokeTransition
public StrokeTransition(Duration duration, Shape shape)
StrokeTransition
- Parameters:
-
duration- The duration of theStrokeTransition -
shape- Theshapewhich stroke paint will be animated
StrokeTransition
public StrokeTransition(Duration duration)
StrokeTransition
- Parameters:
-
duration- The duration of theStrokeTransition
StrokeTransition
public StrokeTransition()
StrokeTransition
Method Details
setShape
public final void setShape(Shape value)
shape property.- Property description:
- The target shape of this
StrokeTransition.It is not possible to change the target
shapeof a runningStrokeTransition. If the value ofshapeis changed for a runningStrokeTransition, the animation has to be stopped and started again to pick up the new value. - Parameters:
-
value- the value for theshapeproperty - See Also:
getShape
public final Shape getShape()
shape property.- Property description:
- The target shape of this
StrokeTransition.It is not possible to change the target
shapeof a runningStrokeTransition. If the value ofshapeis changed for a runningStrokeTransition, the animation has to be stopped and started again to pick up the new value. - Returns:
- the value of the
shapeproperty - See Also:
shapeProperty
public final ObjectProperty<Shape> shapeProperty()
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.
- Returns:
- the
shapeproperty - See Also:
setDuration
public final void setDuration(Duration value)
duration property.- Property description:
- The duration of this
StrokeTransition.It is not possible to change the
durationof a runningStrokeTransition. If the value ofdurationis changed for a runningStrokeTransition, the animation has to be stopped and started again to pick up the new value.Note: While the unit of
durationis 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 thanDuration.ZEROwill result inIllegalArgumentException. - Default value:
- 400ms
- Parameters:
-
value- the value for thedurationproperty - See Also:
getDuration
public final Duration getDuration()
duration property.- Property description:
- The duration of this
StrokeTransition.It is not possible to change the
durationof a runningStrokeTransition. If the value ofdurationis changed for a runningStrokeTransition, the animation has to be stopped and started again to pick up the new value.Note: While the unit of
durationis 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 thanDuration.ZEROwill result inIllegalArgumentException. - Default value:
- 400ms
- Returns:
- the value of the
durationproperty - See Also:
durationProperty
public final ObjectProperty<Duration> durationProperty()
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
- Returns:
- the
durationproperty - See Also:
setFromValue
public final void setFromValue(Color value)
fromValue property.- Property description:
- Specifies the start color value for this
StrokeTransition.It is not possible to change
fromValueof a runningStrokeTransition. If the value offromValueis changed for a runningStrokeTransition, the animation has to be stopped and started again to pick up the new value. - Default value:
null- Parameters:
-
value- the value for thefromValueproperty - See Also:
getFromValue
public final Color getFromValue()
fromValue property.- Property description:
- Specifies the start color value for this
StrokeTransition.It is not possible to change
fromValueof a runningStrokeTransition. If the value offromValueis changed for a runningStrokeTransition, the animation has to be stopped and started again to pick up the new value. - Default value:
null- Returns:
- the value of the
fromValueproperty - See Also:
fromValueProperty
public final ObjectProperty<Color> fromValueProperty()
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- Returns:
- the
fromValueproperty - See Also:
setToValue
public final void setToValue(Color value)
toValue property.- Property description:
- Specifies the stop color value for this
StrokeTransition.It is not possible to change
toValueof a runningStrokeTransition. If the value oftoValueis changed for a runningStrokeTransition, the animation has to be stopped and started again to pick up the new value. - Default value:
null- Parameters:
-
value- the value for thetoValueproperty - See Also:
getToValue
public final Color getToValue()
toValue property.- Property description:
- Specifies the stop color value for this
StrokeTransition.It is not possible to change
toValueof a runningStrokeTransition. If the value oftoValueis changed for a runningStrokeTransition, the animation has to be stopped and started again to pick up the new value. - Default value:
null- Returns:
- the value of the
toValueproperty - See Also:
toValueProperty
public final ObjectProperty<Color> toValueProperty()
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- Returns:
- the
toValueproperty - See Also:
interpolate
protected void interpolate(double frac)
interpolate() has to be provided by implementations of Transition. While a Transition is running, this method is called in every frame. The parameter defines the current position with the animation. At the start, the fraction will be 0.0 and at the end it will be 1.0. How the parameter increases, depends on the interpolator, e.g. if the interpolator is Interpolator.LINEAR, the fraction will increase linear. This method must not be called by the user directly.- Specified by:
-
interpolatein classTransition - Parameters:
-
frac- The relative position
© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.