001 /* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2008, 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 * DialFrame.java
029 * --------------
030 * (C) Copyright 2006-2008, by Object Refinery Limited.
031 *
032 * Original Author: David Gilbert (for Object Refinery Limited);
033 * Contributor(s): -;
034 *
035 * Changes
036 * -------
037 * 03-Nov-2006 : Version 1 (DG);
038 *
039 */
040
041 package org.jfree.chart.plot.dial;
042
043 import java.awt.Shape;
044 import java.awt.geom.Rectangle2D;
045 import java.io.Serializable;
046
047 /**
048 * A dial frame is the face plate for a dial plot - it is always drawn last.
049 * JFreeChart includes a couple of implementations of this interface
050 * ({@link StandardDialFrame} and {@link ArcDialFrame}).
051 * <br><br>
052 * Classes that implement this interface should be {@link Serializable},
053 * otherwise chart serialization may fail.
054 *
055 * @since 1.0.7
056 */
057 public interface DialFrame extends DialLayer {
058
059 /**
060 * Returns the shape of the viewing window for the dial, or
061 * <code>null</code> if the dial is completely open. Other layers in the
062 * plot will rely on their drawing to be clipped within this window.
063 *
064 * @param frame the reference frame for the dial.
065 *
066 * @return The window.
067 */
068 public Shape getWindow(Rectangle2D frame);
069
070 }