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