Package com.smartgwt.client.widgets.drawing

Class Gradient

java.lang.Object
com.smartgwt.client.core.JsObject
com.smartgwt.client.core.DataClass
com.smartgwt.client.widgets.drawing.Gradient
All Implemented Interfaces:
HasHandlers
Direct Known Subclasses:
LinearGradient, RadialGradient, SimpleGradient
public class Gradient extends DataClass
Defines a simple gradient vertical gradient between two colors, or using colorStops. See SimpleGradient, LinearGradient and RadialGradient for further properties to define more advanced gradients.

  • Constructor Details

    • Gradient

      public Gradient()

    • Gradient

      public Gradient(JavaScriptObject jsObj)

  • Method Details

    • getOrCreateRef

      public static Gradient getOrCreateRef(JavaScriptObject jsObj)

    • setColorStops

      public Gradient setColorStops(ColorStop... colorStops)
      An array of color stops for this gradient.
      Parameters:
      colorStops - New colorStops value. Default value is null
      Returns:
      Gradient instance, for chaining setter calls

    • getColorStops

      public ColorStop[] getColorStops()
      An array of color stops for this gradient.
      Returns:
      Current colorStops value. Default value is null

    • setDirection

      public Gradient setDirection(double direction)
      For a SimpleGradient, the angle of the direction vector in degrees. The default of 0.0 causes the gradient to sweep from the start color on the left to the end color on the right. Positive direction angles correspond to clockwise rotations of the default gradient.

      This property is only applicable when using startColor and endColor (not colorStops).

      Parameters:
      direction - New direction value. Default value is 0.0
      Returns:
      Gradient instance, for chaining setter calls

    • getDirection

      public double getDirection()
      For a SimpleGradient, the angle of the direction vector in degrees. The default of 0.0 causes the gradient to sweep from the start color on the left to the end color on the right. Positive direction angles correspond to clockwise rotations of the default gradient.

      This property is only applicable when using startColor and endColor (not colorStops).

      Returns:
      Current direction value. Default value is 0.0

    • setEndColor

      public Gradient setEndColor(String endColor)
      An end color for the gradient. If both startColor and endColor are set then colorStops is ignored.
      Parameters:
      endColor - New endColor value. Default value is null
      Returns:
      Gradient instance, for chaining setter calls
      See Also:

    • getEndColor

      public String getEndColor()
      An end color for the gradient. If both startColor and endColor are set then colorStops is ignored.
      Returns:
      Current endColor value. Default value is null
      See Also:

    • setId

      public Gradient setId(String id)
      Identifier which can be used by one or more DrawItems when gradient is assigned to DrawPane.gradients. The ID property is optional when gradient is assigned directly to a DrawItem.

      The ID must be unique within DrawPane.gradients if defined.

      Parameters:
      id - New id value. Default value is null
      Returns:
      Gradient instance, for chaining setter calls
      See Also:

    • getId

      public String getId()
      Identifier which can be used by one or more DrawItems when gradient is assigned to DrawPane.gradients. The ID property is optional when gradient is assigned directly to a DrawItem.

      The ID must be unique within DrawPane.gradients if defined.

      Returns:
      Current id value. Default value is null
      See Also:

    • setStartColor

      public Gradient setStartColor(String startColor)
      A start color for the gradient. If both startColor and endColor are set then colorStops is ignored.
      Parameters:
      startColor - New startColor value. Default value is null
      Returns:
      Gradient instance, for chaining setter calls
      See Also:

    • getStartColor

      public String getStartColor()
      A start color for the gradient. If both startColor and endColor are set then colorStops is ignored.
      Returns:
      Current startColor value. Default value is null
      See Also: