com.sencha.gxt.chart.client.draw.Gradient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gxt-chart Show documentation
The newest version!
/**
 * Sencha GXT 3.1.1 - Sencha for GWT
 * Copyright(c) 2007-2014, Sencha, Inc.
 * [email protected]
 *
 * http://www.sencha.com/products/gxt/license/
 */
package com.sencha.gxt.chart.client.draw;

import java.util.ArrayList;
import java.util.List;

/**
 * A color representing a linear gradient.
 */
public class Gradient extends Color {

  @Deprecated
  private String id = "";
  private double angle = 0;
  private List stops = new ArrayList();

  /**
   * Creates a gradient using the given id and angle.
   *
   * @deprecated use {@link Gradient#Gradient(double)} instead, id is unused and will be removed in a future version
   * @param id the gradient id
   * @param angle the angle of the gradient
   */
  @Deprecated
  public Gradient(String id, double angle) {
    super("url(#" + id + ")");
    this.id = id;
    this.angle = angle;
  }

  /**
   * Creates a linear gradient using the given angle.
   *
   * @param angle the angle of the gradient
   */
  public Gradient(double angle) {
    this.angle = angle;
  }

  /**
   * Adds a stop to the gradient using the given offset and color.
   * 
   * @param offset the offset of the stop
   * @param color the color of the stop
   */
  public void addStop(int offset, Color color) {
    stops.add(new Stop(offset, color));
  }

  /**
   * Adds the given stop to the gradient.
   * 
   * @param stop the stop to be added
   */
  public void addStop(Stop stop) {
    stops.add(stop);
  }

  /**
   * Removes all stops from the gradient.
   */
  public void clearStops() {
    stops.clear();
  }

  /**
   * Returns the angle of the gradient.
   * 
   * @return the angle of the gradient
   */
  public double getAngle() {
    return angle;
  }

  /**
   * Returns the id of the gradient.
   *
   * @deprecated the id property is unused and will be removed in a future release
   * @return the id of the gradient
   */
  @Deprecated
  public String getId() {
    return id;
  }

  /**
   * Returns the stops of the gradient.
   *
   * @return the stops of the gradient
   */
  public List getStops() {
    return stops;
  }

  /**
   * Sets the angle of the gradient.
   * 
   * @param angle the new angle of the gradient
   */
  public void setAngle(double angle) {
    this.angle = angle;
  }

  /**
   * Sets the id of the gradient. Updates the color string with the new id.
   *
   * @deprecated the id property is unused and will be removed in a future release
   * @param id the new id of the gradient
   */
  @Deprecated
  public void setId(String id) {
    this.id = id;
    setColor("url(#" + id + ")");
  }

}