/* ===========================================================

 * JFreeChart : a free chart library for the Java(tm) platform

 * ===========================================================

 *

 * (C) Copyright 2000-2004, 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., 59 Temple Place, Suite 330,

 * Boston, MA 02111-1307, USA.

 *

 * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 

 * in the United States and other countries.]

 *

 * -------------------

 * PieLabelRecord.java

 * -------------------

 * (C) Copyright 2004, by Object Refinery Limited and Contributors.

 *

 * Original Author:  David Gilbert (for Object Refinery Limited);

 * Contributor(s):   -;

 *

 * $Id: PieLabelRecord.java,v 1.1 2004/08/31 14:39:21 mungady Exp $

 *

 * Changes

 * -------

 * 08-Mar-2004 : Version 1 (DG);

 *

 */



package org.jfree.chart.plot;



import org.jfree.text.TextBox;



/**

 * A structure that retains information about the label for a section in a pie chart.

 */

public class PieLabelRecord implements Comparable {

    

    /** The key. */

    private Comparable key;

    

    /** The angle. */

    private double angle;

    

    /** The base y-coordinate. */

    private double baseY;

    

    /** The allocated y-coordinate. */

    private double allocatedY;



    /** The label. */

    private TextBox label;

    

    /** The label height. */

    private double labelHeight;

    

    /** The gap. */

    private double gap;

    

    /** The link percent. */

    private double linkPercent;

    

    /**

     * Creates a new record.

     * 

     * @param key  the key.

     * @param angle  the angle.

     * @param baseY  the base y-coordinate.

     * @param label  the label.

     * @param labelHeight  the label height (in Java2D units).

     * @param gap  the gap.

     * @param linkPercent  the link percent.

     */

    public PieLabelRecord(Comparable key, double angle, double baseY, TextBox label, 

                          double labelHeight, double gap, double linkPercent) {

        this.key = key;

        this.angle = angle;

        this.baseY = baseY;

        this.allocatedY = baseY;

        this.label = label;

        this.labelHeight = labelHeight;

        this.gap = gap;

        this.linkPercent = linkPercent;

    }

    

    /**

     * Returns the base y-coordinate.  This is where the label will appear if there is no 

     * overlapping of labels.

     * 

     * @return the base y-coordinate.

     */

    public double getBaseY() {

        return this.baseY;   

    }

    

    /**

     * Sets the base y-coordinate.

     * 

     * @param base  the base y-coordinate.

     */

    public void setBaseY(double base) {

        this.baseY = base;   

    }

    

    /**

     * Returns the lower bound of the label.

     * 

     * @return the lower bound.

     */

    public double getLowerY() {

        return this.allocatedY - this.labelHeight / 2.0;   

    }

    

    /**

     * Returns the upper bound of the label.

     * 

     * @return the upper bound.

     */

    public double getUpperY() {

        return this.allocatedY + this.labelHeight / 2.0;   

    }

    

    /**

     * Returns the angle.

     * 

     * @return the angle.

     */

    public double getAngle() {

        return this.angle;   

    }

    

    /**

     * Returns the key for the section that the label applies to.

     * 

     * @return the key.

     */

    public Comparable getKey() {

        return this.key;   

    }

    

    /**

     * Returns the label.

     * 

     * @return the label.

     */

    public TextBox getLabel() {

        return this.label;   

    }

    

    /**

     * Returns the label height.

     * 

     * @return The label height (in Java2D units).

     */

    public double getLabelHeight() {

        return this.labelHeight;   

    }

    

    /**

     * Returns the allocated y-coordinate.

     * 

     * @return the allocated y-coordinate.

     */

    public double getAllocatedY() {

        return this.allocatedY;   

    }

    

    /**

     * Sets the allocated y-coordinate.

     * 

     * @param y  the y-coordinate.

     */

    public void setAllocatedY(double y) {

        this.allocatedY = y;   

    }

    

    /**

     * Returns the gap.

     * 

     * @return the gap.

     */

    public double getGap() {

        return this.gap;   

    }

    

    /**

     * Returns the link percent.

     * 

     * @return the link percent.

     */

    public double getLinkPercent() {

        return this.linkPercent;   

    }

    /**

     * Compares this object to an arbitrary object.

     * 

     * @param obj  the object to compare against.

     * 

     * @return an integer that specifies the relative order of the two objects.

     */

    public int compareTo(Object obj) {

        int result = 0;

        if (obj instanceof PieLabelRecord) {

            PieLabelRecord plr = (PieLabelRecord) obj;

            if (this.baseY < plr.baseY) {

                result = -1;   

            }

            else if (this.baseY > plr.baseY) {

                result = 1;   

            }

        }

        return result;

    }

    

    /**

     * Returns a string describing the object.  This is used for debugging only.

     * 

     * @return a string.

     */

    public String toString() {

        return this.baseY + ", " + this.key.toString();   

    }

}

