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:

Nested Class Summary

Nested classes/interfaces declared in class Animation
Animation.Status

Modifier and Type

Class

Description

static enum

Animation.Status

The possible states for status.
Property Summary

Properties

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 Transition
interpolator

Type

Property

Description

final ObjectProperty<Interpolator>

interpolator

Controls the timing for acceleration and deceleration at each Transition cycle.

Properties declared in class Animation
autoReverse, currentRate, currentTime, cycleCount, cycleDuration, delay, onFinished, rate, status, totalDuration

Type

Property

Description

final BooleanProperty

autoReverse

Defines whether this Animation reverses direction on alternating cycles.

final ReadOnlyDoubleProperty

currentRate

Read-only variable to indicate current direction/speed at which the Animation is being played.

final ReadOnlyObjectProperty<Duration>

currentTime

Defines the Animation's play head position.

final IntegerProperty

cycleCount

Defines the number of cycles in this animation.

final ReadOnlyObjectProperty<Duration>

cycleDuration

Read-only variable to indicate the duration of one cycle of this Animation: the time it takes to play from time 0 to the end of the Animation (at the default rate of 1.0).

final ObjectProperty<Duration>

delay

Delays the start of an animation.

final ObjectProperty<EventHandler<ActionEvent>>

onFinished

The action to be executed at the conclusion of this Animation.

final DoubleProperty

rate

Defines the direction/speed at which the Animation is expected to be played.

final ReadOnlyObjectProperty<Animation.Status>

status

The status of the Animation.

final ReadOnlyObjectProperty<Duration>

totalDuration

Read-only variable to indicate the total duration of this Animation, including repeats.
Field Summary

Fields declared in class Animation
INDEFINITE

Modifier and Type

Field

Description

static final int

INDEFINITE

Used as a value for cycleCount to specify an animation that repeats indefinitely, until the stop() method is called.
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

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(double frac)

The method interpolate() has to be provided by implementations of Transition.

final void

setDuration(Duration value)

Sets the value of the duration property.

final void

setFromValue(Color value)

Sets the value of the fromValue property.

final void

setShape(Shape value)

Sets the value of the shape property.

final void

setToValue(Color value)

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 Transition
getCachedInterpolator, getInterpolator, getParentTargetNode, interpolatorProperty, setInterpolator

Modifier and Type

Method

Description

protected Interpolator

getCachedInterpolator()

Returns the Interpolator, that was set when the Transition was started.

final Interpolator

getInterpolator()

Gets the value of the interpolator property.

protected Node

getParentTargetNode()

Returns the first non-null target Node in the parent hierarchy of this Transition, or null if such a node is not found.

final ObjectProperty<Interpolator>

interpolatorProperty()

Controls the timing for acceleration and deceleration at each Transition cycle.

final void

setInterpolator(Interpolator value)

Sets the value of the interpolator property.

Methods declared in class 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

Modifier and Type

Method

Description

final BooleanProperty

autoReverseProperty()

Defines whether this Animation reverses direction on alternating cycles.

final ReadOnlyDoubleProperty

currentRateProperty()

Read-only variable to indicate current direction/speed at which the Animation is being played.

final ReadOnlyObjectProperty<Duration>

currentTimeProperty()

Defines the Animation's play head position.

final IntegerProperty

cycleCountProperty()

Defines the number of cycles in this animation.

final ReadOnlyObjectProperty<Duration>

cycleDurationProperty()

Read-only variable to indicate the duration of one cycle of this Animation: the time it takes to play from time 0 to the end of the Animation (at the default rate of 1.0).

final ObjectProperty<Duration>

delayProperty()

Delays the start of an animation.

final ObservableMap<String,Duration>

getCuePoints()

The cue points can be used to mark important positions of the Animation.

final double

getCurrentRate()

Gets the value of the currentRate property.

final Duration

getCurrentTime()

Gets the value of the currentTime property.

final int

getCycleCount()

Gets the value of the cycleCount property.

final Duration

getCycleDuration()

Gets the value of the cycleDuration property.

final Duration

getDelay()

Gets the value of the delay property.

final EventHandler<ActionEvent>

getOnFinished()

Gets the value of the onFinished property.

final double

getRate()

Gets the value of the rate property.

final Animation.Status

getStatus()

Gets the value of the status property.

final double

getTargetFramerate()

The target framerate is the maximum framerate at which this Animation will run, in frames per second.

final Duration

getTotalDuration()

Gets the value of the totalDuration property.

final boolean

isAutoReverse()

Gets the value of the autoReverse property.

void

jumpTo(String cuePoint)

Jumps to a predefined position in this Animation.

void

jumpTo(Duration time)

Jumps to a given position in this Animation.

final ObjectProperty<EventHandler<ActionEvent>>

onFinishedProperty()

The action to be executed at the conclusion of this Animation.

void

pause()

Pauses the animation.

void

play()

Plays Animation from current position in the direction indicated by rate.

void

playFrom(String cuePoint)

A convenience method to play this Animation from a predefined position.

void

playFrom(Duration time)

A convenience method to play this Animation from a specific position.

void

playFromStart()

Plays an Animation from initial position in forward direction.

final DoubleProperty

rateProperty()

Defines the direction/speed at which the Animation is expected to be played.

final void

setAutoReverse(boolean value)

Sets the value of the autoReverse property.

final void

setCycleCount(int value)

Sets the value of the cycleCount property.

protected final void

setCycleDuration(Duration value)

Sets the value of the cycleDuration property.

final void

setDelay(Duration value)

Sets the value of the delay property.

final void

setOnFinished(EventHandler<ActionEvent> value)

Sets the value of the onFinished property.

final void

setRate(double value)

Sets the value of the rate property.

protected final void

setStatus(Animation.Status value)

Sets the value of the status property.

final ReadOnlyObjectProperty<Animation.Status>

statusProperty()

The status of the Animation.

void

stop()

Stops the animation and resets the play head to its initial position.

final ReadOnlyObjectProperty<Duration>

totalDurationProperty()

Read-only variable to indicate the total duration of this Animation, including repeats.

Methods declared in class 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)
  
  shapeProperty()
- 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)
  
  durationProperty()
- 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)
  
  fromValueProperty()
- 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)
  
  toValueProperty()
Constructor Details
- StrokeTransition
  
  public StrokeTransition(Duration duration, Shape shape, Color fromValue, Color toValue)
  
  The constructor of StrokeTransition
  
  Parameters:
  
  duration - The duration of the StrokeTransition
  
  shape - The shape which 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)
  
  The constructor of StrokeTransition
  
  Parameters:
  
  duration - The duration of the StrokeTransition
  
  fromValue - The start value of the color-animation
  
  toValue - The end value of the color-animation
- StrokeTransition
  
  public StrokeTransition(Duration duration, Shape shape)
  
  The constructor of StrokeTransition
  
  Parameters:
  
  duration - The duration of the StrokeTransition
  
  shape - The shape which stroke paint will be animated
- StrokeTransition
  
  public StrokeTransition(Duration duration)
  
  The constructor of StrokeTransition
  
  Parameters:
  
  duration - The duration of the StrokeTransition
- StrokeTransition
  
  public StrokeTransition()
  
  The constructor of StrokeTransition
Method Details
- setShape
  public final void setShape(Shape value)
  
  Sets the value of the shape property.
  
  Property description:
  
  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.
  
  Parameters:
  
  value - the value for the shape property
  
  See Also:
  
  getShape()
  
  shapeProperty()
- getShape
  public final Shape getShape()
  
  Gets the value of the shape property.
  
  Property description:
  
  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.
  
  Returns:
  
  the value of the shape property
  
  See Also:
  
  setShape(Shape)
  
  shapeProperty()
- shapeProperty
  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.
  
  Returns:
  
  the shape property
  
  See Also:
  
  getShape()
  
  setShape(Shape)
- setDuration
  public final void setDuration(Duration value)
  
  Sets the value of the duration property.
  
  Property description:
  
  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
  
  Parameters:
  
  value - the value for the duration property
  
  See Also:
  
  getDuration()
  
  durationProperty()
- getDuration
  public final Duration getDuration()
  
  Gets the value of the duration property.
  
  Property description:
  
  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
  
  Returns:
  
  the value of the duration property
  
  See Also:
  
  setDuration(Duration)
  
  durationProperty()
- durationProperty
  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
  
  Returns:
  
  the duration property
  
  See Also:
  
  getDuration()
  
  setDuration(Duration)
- setFromValue
  public final void setFromValue(Color value)
  
  Sets the value of the fromValue property.
  
  Property description:
  
  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
  
  Parameters:
  
  value - the value for the fromValue property
  
  See Also:
  
  getFromValue()
  
  fromValueProperty()
- getFromValue
  public final Color getFromValue()
  
  Gets the value of the fromValue property.
  
  Property description:
  
  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
  
  Returns:
  
  the value of the fromValue property
  
  See Also:
  
  setFromValue(Color)
  
  fromValueProperty()
- fromValueProperty
  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
  
  Returns:
  
  the fromValue property
  
  See Also:
  
  getFromValue()
  
  setFromValue(Color)
- setToValue
  public final void setToValue(Color value)
  
  Sets the value of the toValue property.
  
  Property description:
  
  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
  
  Parameters:
  
  value - the value for the toValue property
  
  See Also:
  
  getToValue()
  
  toValueProperty()
- getToValue
  public final Color getToValue()
  
  Gets the value of the toValue property.
  
  Property description:
  
  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
  
  Returns:
  
  the value of the toValue property
  
  See Also:
  
  setToValue(Color)
  
  toValueProperty()
- toValueProperty
  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
  
  Returns:
  
  the toValue property
  
  See Also:
  
  getToValue()
  
  setToValue(Color)
- interpolate
  
  protected void interpolate(double frac)
  
  The method 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:
  
  interpolate in class Transition
  
  Parameters:
  
  frac - The relative position

Class StrokeTransition

Nested Class Summary

Nested classes/interfaces declared in class Animation

Property Summary

Properties declared in class Transition

Properties declared in class Animation

Field Summary

Fields declared in class Animation

Constructor Summary

Method Summary

Methods declared in class Transition

Methods declared in class Animation

Methods declared in class Object

Property Details

shape

duration

fromValue

toValue

Constructor Details

StrokeTransition

StrokeTransition

StrokeTransition

StrokeTransition

StrokeTransition

Method Details

setShape

getShape

shapeProperty

setDuration

getDuration

durationProperty

setFromValue

getFromValue

fromValueProperty

setToValue

getToValue

toValueProperty

interpolate