001: /* ===========================================================
002: * JFreeChart : a free chart library for the Java(tm) platform
003: * ===========================================================
004: *
005: * (C) Copyright 2000-2007, by Object Refinery Limited and Contributors.
006: *
007: * Project Info: http://www.jfree.org/jfreechart/index.html
008: *
009: * This library is free software; you can redistribute it and/or modify it
010: * under the terms of the GNU Lesser General Public License as published by
011: * the Free Software Foundation; either version 2.1 of the License, or
012: * (at your option) any later version.
013: *
014: * This library is distributed in the hope that it will be useful, but
015: * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
016: * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
017: * License for more details.
018: *
019: * You should have received a copy of the GNU Lesser General Public
020: * License along with this library; if not, write to the Free Software
021: * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
022: * USA.
023: *
024: * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
025: * in the United States and other countries.]
026: *
027: * --------------------------------
028: * AbstractPieLabelDistributor.java
029: * --------------------------------
030: * (C) Copyright 2007, by Object Refinery Limited and Contributors.
031: *
032: * Original Author: David Gilbert (for Object Refinery Limited);
033: * Contributor(s): -;
034: *
035: * $Id: AbstractPieLabelDistributor.java,v 1.1.2.1 2007/06/14 15:04:21 mungady Exp $
036: *
037: * Changes
038: * -------
039: * 14-Jun-2007 : Version 1 (DG);
040: *
041: */
042:
043: package org.jfree.chart.plot;
044:
045: import java.io.Serializable;
046: import java.util.List;
047:
048: /**
049: * A base class for handling the distribution of pie section labels. Create
050: * your own subclass and set it using the
051: * {@link PiePlot#setLabelDistributor(AbstractPieLabelDistributor)} method
052: * if you want to customise the label distribution.
053: */
054: public abstract class AbstractPieLabelDistributor implements
055: Serializable {
056:
057: /** The label records. */
058: protected List labels;
059:
060: /**
061: * Creates a new instance.
062: */
063: public AbstractPieLabelDistributor() {
064: this .labels = new java.util.ArrayList();
065: }
066:
067: /**
068: * Returns a label record from the list.
069: *
070: * @param index the index.
071: *
072: * @return The label record.
073: */
074: public PieLabelRecord getPieLabelRecord(int index) {
075: return (PieLabelRecord) this .labels.get(index);
076: }
077:
078: /**
079: * Adds a label record.
080: *
081: * @param record the label record (<code>null</code> not permitted).
082: */
083: public void addPieLabelRecord(PieLabelRecord record) {
084: if (record == null) {
085: throw new IllegalArgumentException(
086: "Null 'record' argument.");
087: }
088: this .labels.add(record);
089: }
090:
091: /**
092: * Returns the number of items in the list.
093: *
094: * @return The item count.
095: */
096: public int getItemCount() {
097: return this .labels.size();
098: }
099:
100: /**
101: * Clears the list of labels.
102: */
103: public void clear() {
104: this .labels.clear();
105: }
106:
107: /**
108: * Called by the {@link PiePlot} class. Implementations should distribute
109: * the labels in this.labels then return.
110: *
111: * @param minY the y-coordinate for the top of the label area.
112: * @param height the height of the label area.
113: */
114: public abstract void distributeLabels(double minY, double height);
115:
116: }
|