content: /* ===========================================================
   * JFreeChart : a free chart library for the Java(tm) platform
   * ===========================================================
   *
   * (C) Copyright 2000-2012, by Object Refinery Limited and Contributors.
   *
   * Project Info:  http://www.jfree.org/jfreechart/index.html
   *
   * This library is free software; you can redistribute it and/or modify it
   * under the terms of the GNU Lesser General Public License as published by
   * the Free Software Foundation; either version 2.1 of the License, or
   * (at your option) any later version.
   *
   * This library is distributed in the hope that it will be useful, but
   * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
   * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
   * License for more details.
   *
   * You should have received a copy of the GNU Lesser General Public
   * License along with this library; if not, write to the Free Software
   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
   * USA.
   *
   * [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
   * Other names may be trademarks of their respective owners.]
   *
   * ----------------------
   * StandardDialFrame.java
   * ----------------------
   * (C) Copyright 2006-2012, by Object Refinery Limited.
   *
   * Original Author:  David Gilbert (for Object Refinery Limited);
   * Contributor(s):   -;
   *
   * Changes
   * -------
   * 03-Nov-2006 : Version 1 (DG);
   * 08-Mar-2007 : Fix in hashCode() (DG);
   * 29-Oct-2007 : Renamed StandardDialFrame (DG);
   * 17-Jun-2012 : Removed JCommon dependencies (DG);
   *
   */
  
  package org.jfree.chart.plot.dial;
  
  import java.awt.BasicStroke;
  import java.awt.Color;
  import java.awt.Graphics2D;
  import java.awt.Paint;
  import java.awt.Shape;
  import java.awt.Stroke;
  import java.awt.geom.Area;
  import java.awt.geom.Ellipse2D;
  import java.awt.geom.Rectangle2D;
  import java.io.IOException;
  import java.io.ObjectInputStream;
  import java.io.ObjectOutputStream;
  import java.io.Serializable;
  
  import org.jfree.chart.HashUtilities;
  import org.jfree.chart.util.PaintUtilities;
  import org.jfree.chart.util.PublicCloneable;
  import org.jfree.chart.util.SerialUtilities;
  
  /**
   * A simple circular frame for the {@link DialPlot} class.
   *
   * @since 1.0.7
   */
  public class StandardDialFrame extends AbstractDialLayer implements DialFrame,
          Cloneable, PublicCloneable, Serializable {
  
      /** For serialization. */
      static final long serialVersionUID = 1016585407507121596L;
  
      /** The outer radius, relative to the framing rectangle. */
      private double radius;
  
      /**
       * The color used for the front of the panel.  This field is transient
       * because it requires special handling for serialization.
       */
      private transient Paint backgroundPaint;
  
      /**
       * The color used for the border around the window. This field is transient
       * because it requires special handling for serialization.
       */
      private transient Paint foregroundPaint;
  
      /**
       * The stroke for drawing the frame outline.  This field is transient
       * because it requires special handling for serialization.
       */
      private transient Stroke stroke;
  
      /**
       * Creates a new instance of <code>StandardDialFrame</code>.
       */
      public StandardDialFrame() {
          this.backgroundPaint = Color.GRAY;
          this.foregroundPaint = Color.BLACK;
          this.stroke = new BasicStroke(2.0f);
          this.radius = 0.95;
      }
  
      /**
       * Returns the radius, relative to the framing rectangle.
       *
       * @return The radius.
       *
       * @see #setRadius(double)
       */
      public double getRadius() {
          return this.radius;
      }
  
      /**
       * Sets the radius and sends a {@link DialLayerChangeEvent} to all
       * registered listeners.
       *
       * @param radius  the radius (must be positive).
       *
       * @see #getRadius()
       */
      public void setRadius(double radius) {
          if (radius <= 0) {
              throw new IllegalArgumentException(
                      "The 'radius' must be positive.");
          }
          this.radius = radius;
          notifyListeners(new DialLayerChangeEvent(this));
      }
  
      /**
       * Returns the background paint.
       *
       * @return The background paint (never <code>null</code>).
       *
       * @see #setBackgroundPaint(Paint)
       */
      public Paint getBackgroundPaint() {
          return this.backgroundPaint;
      }
  
      /**
       * Sets the background paint and sends a {@link DialLayerChangeEvent} to
       * all registered listeners.
       *
       * @param paint  the paint (<code>null</code> not permitted).
       *
       * @see #getBackgroundPaint()
       */
      public void setBackgroundPaint(Paint paint) {
          if (paint == null) {
              throw new IllegalArgumentException("Null 'paint' argument.");
          }
          this.backgroundPaint = paint;
          notifyListeners(new DialLayerChangeEvent(this));
      }
  
      /**
       * Returns the foreground paint.
       *
       * @return The foreground paint (never <code>null</code>).
       *
       * @see #setForegroundPaint(Paint)
       */
      public Paint getForegroundPaint() {
          return this.foregroundPaint;
      }
  
      /**
       * Sets the foreground paint and sends a {@link DialLayerChangeEvent} to
       * all registered listeners.
       *
       * @param paint  the paint (<code>null</code> not permitted).
       *
       * @see #getForegroundPaint()
       */
      public void setForegroundPaint(Paint paint) {
          if (paint == null) {
              throw new IllegalArgumentException("Null 'paint' argument.");
          }
          this.foregroundPaint = paint;
          notifyListeners(new DialLayerChangeEvent(this));
      }
  
      /**
       * Returns the stroke for the frame.
       *
       * @return The stroke (never <code>null</code>).
       *
       * @see #setStroke(Stroke)
       */
      public Stroke getStroke() {
          return this.stroke;
      }
  
      /**
       * Sets the stroke and sends a {@link DialLayerChangeEvent} to all
       * registered listeners.
       *
       * @param stroke  the stroke (<code>null</code> not permitted).
       *
       * @see #getStroke()
       */
      public void setStroke(Stroke stroke) {
          if (stroke == null) {
              throw new IllegalArgumentException("Null 'stroke' argument.");
          }
          this.stroke = stroke;
          notifyListeners(new DialLayerChangeEvent(this));
      }
  
      /**
       * Returns the shape for the window for this dial.  Some dial layers will
       * request that their drawing be clipped within this window.
       *
       * @param frame  the reference frame (<code>null</code> not permitted).
       *
       * @return The shape of the dial's window.
       */
      @Override
      public Shape getWindow(Rectangle2D frame) {
          Rectangle2D f = DialPlot.rectangleByRadius(frame, this.radius,
                  this.radius);
          return new Ellipse2D.Double(f.getX(), f.getY(), f.getWidth(),
                  f.getHeight());
      }
  
      /**
       * Returns <code>false</code> to indicate that this dial layer is not
       * clipped to the dial window.
       *
       * @return A boolean.
       */
      @Override
      public boolean isClippedToWindow() {
          return false;
      }
  
      /**
       * Draws the frame.  This method is called by the {@link DialPlot} class,
       * you shouldn't need to call it directly.
       *
       * @param g2  the graphics target (<code>null</code> not permitted).
       * @param plot  the plot (<code>null</code> not permitted).
       * @param frame  the frame (<code>null</code> not permitted).
       * @param view  the view (<code>null</code> not permitted).
       */
      @Override
      public void draw(Graphics2D g2, DialPlot plot, Rectangle2D frame,
              Rectangle2D view) {
  
          Shape window = getWindow(frame);
  
          Rectangle2D f = DialPlot.rectangleByRadius(frame, this.radius + 0.02,
                  this.radius + 0.02);
          Ellipse2D e = new Ellipse2D.Double(f.getX(), f.getY(), f.getWidth(),
                  f.getHeight());
  
          Area area = new Area(e);
          Area area2 = new Area(window);
          area.subtract(area2);
          g2.setPaint(this.backgroundPaint);
          g2.fill(area);
  
          g2.setStroke(this.stroke);
          g2.setPaint(this.foregroundPaint);
          g2.draw(window);
          g2.draw(e);
      }
  
      /**
       * Tests this instance for equality with an arbitrary object.
       *
       * @param obj  the object (<code>null</code> permitted).
       *
       * @return A boolean.
       */
      @Override
      public boolean equals(Object obj) {
          if (obj == this) {
              return true;
          }
          if (!(obj instanceof StandardDialFrame)) {
              return false;
          }
          StandardDialFrame that = (StandardDialFrame) obj;
          if (!PaintUtilities.equal(this.backgroundPaint, that.backgroundPaint)) {
              return false;
          }
          if (!PaintUtilities.equal(this.foregroundPaint, that.foregroundPaint)) {
              return false;
          }
          if (this.radius != that.radius) {
              return false;
          }
          if (!this.stroke.equals(that.stroke)) {
              return false;
          }
          return super.equals(obj);
      }
  
      /**
       * Returns a hash code for this instance.
       *
       * @return The hash code.
       */
      @Override
      public int hashCode() {
          int result = 193;
          long temp = Double.doubleToLongBits(this.radius);
          result = 37 * result + (int) (temp ^ (temp >>> 32));
          result = 37 * result + HashUtilities.hashCodeForPaint(
                  this.backgroundPaint);
          result = 37 * result + HashUtilities.hashCodeForPaint(
                  this.foregroundPaint);
          result = 37 * result + this.stroke.hashCode();
          return result;
      }
  
      /**
       * Returns a clone of this instance.
       *
       * @return A clone.
       *
       * @throws CloneNotSupportedException if any of the frame's attributes
       *     cannot be cloned.
       */
      @Override
      public Object clone() throws CloneNotSupportedException {
          return super.clone();
      }
  
      /**
       * Provides serialization support.
       *
       * @param stream  the output stream.
       *
       * @throws IOException  if there is an I/O error.
       */
      private void writeObject(ObjectOutputStream stream) throws IOException {
          stream.defaultWriteObject();
          SerialUtilities.writePaint(this.backgroundPaint, stream);
          SerialUtilities.writePaint(this.foregroundPaint, stream);
          SerialUtilities.writeStroke(this.stroke, stream);
      }
  
      /**
       * Provides serialization support.
       *
       * @param stream  the input stream.
       *
       * @throws IOException  if there is an I/O error.
       * @throws ClassNotFoundException  if there is a classpath problem.
       */
      private void readObject(ObjectInputStream stream)
              throws IOException, ClassNotFoundException {
          stream.defaultReadObject();
          this.backgroundPaint = SerialUtilities.readPaint(stream);
          this.foregroundPaint = SerialUtilities.readPaint(stream);
          this.stroke = SerialUtilities.readStroke(stream);
      }
  
  }
  