Class Stop

java.lang.Object
javafx.scene.paint.Stop
All Implemented Interfaces:
Interpolatable<Stop>
public final class Stop extends Object implements Interpolatable<Stop>
Defines one element of the ramp of colors to use on a gradient. For more information see javafx.scene.paint.LinearGradient and javafx.scene.paint.RadialGradient.

Example:


 // object bounding box relative (proportional:true, default)
 Stop[] stops = { new Stop(0, Color.WHITE), new Stop(1, Color.BLACK)};
 LinearGradient lg = new LinearGradient(0, 0, 1, 0, true, CycleMethod.NO_CYCLE, stops);
 Rectangle r = new Rectangle();
 r.setFill(lg);
Since:
JavaFX 2.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    Stop(double offset, Color color)
    Creates a new instance of Stop.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
    Indicates whether some other object is "equal to" this one.
    final Color
    getColor()
    Gets the color of the gradient at this offset.
    final double
    getOffset()
    Gets a number ranging from 0 to 1 that indicates where this gradient stop is placed.
    int
    hashCode()
    Returns a hash code for this Stop object.
    Stop
    interpolate(Stop endValue, double t)
    Returns an intermediate value between the value of this Interpolatable and the specified endValue using the linear interpolation factor t, ranging from 0 (inclusive) to 1 (inclusive).
    String
    toString()
    Returns a string representation of this Stop object.

    Methods declared in class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Stop

      public Stop(double offset, Color color)
      Creates a new instance of Stop.
      Parameters:
      offset - Stop's position (ranging from 0 to 1
      color - Stop's color

  • Method Details

    • getOffset

      public final double getOffset()
      Gets a number ranging from 0 to 1 that indicates where this gradient stop is placed. For linear gradients, the offset variable represents a location along the gradient vector. For radial gradients, it represents a percentage distance from the focus point to the edge of the outermost/largest circle.
      Interpolation Type:
      linear
      Returns:
      position of the Stop within the gradient (ranging from 0 to 1)

    • getColor

      public final Color getColor()
      Gets the color of the gradient at this offset.
      Interpolation Type:
      linear
      Returns:
      the color of the gradient at this offset

    • interpolate

      public Stop interpolate(Stop endValue, double t)
      Returns an intermediate value between the value of this Interpolatable and the specified endValue using the linear interpolation factor t, ranging from 0 (inclusive) to 1 (inclusive).

      The returned value might not be a new instance; the implementation might also return one of the two existing instances if the intermediate value would be equal to one of the existing values. However, this is an optimization and applications should not assume any particular identity of the returned value.

      Specified by:
      interpolate in interface Interpolatable<Stop>
      Parameters:
      endValue - the target value
      t - the interpolation factor
      Returns:
      the intermediate value
      Throws:
      NullPointerException - if endValue is null
      Since:
      24

    • equals

      public boolean equals(Object obj)
      Indicates whether some other object is "equal to" this one.
      Overrides:
      equals in class Object
      Parameters:
      obj - the reference object with which to compare.
      Returns:
      true if this object is equal to the obj argument; false otherwise.

    • hashCode

      public int hashCode()
      Returns a hash code for this Stop object.
      Overrides:
      hashCode in class Object
      Returns:
      a hash code for this Stop object.

    • toString

      public String toString()
      Returns a string representation of this Stop object.
      Overrides:
      toString in class Object
      Returns:
      a string representation of this Stop object.