Source for org.jfree.chart.plot.dial.DialFrame

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2007, by Object Refinery Limited and Contributors.
   6:  *
   7:  * Project Info:  http://www.jfree.org/jfreechart/index.html
   8:  *
   9:  * This library is free software; you can redistribute it and/or modify it 
  10:  * under the terms of the GNU Lesser General Public License as published by 
  11:  * the Free Software Foundation; either version 2.1 of the License, or 
  12:  * (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but 
  15:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
  16:  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
  17:  * License for more details.
  18:  *
  19:  * You should have received a copy of the GNU Lesser General Public
  20:  * License along with this library; if not, write to the Free Software
  21:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
  22:  * USA.  
  23:  *
  24:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
  25:  * in the United States and other countries.]
  26:  *
  27:  * --------------
  28:  * DialFrame.java
  29:  * --------------
  30:  * (C) Copyright 2006-2007, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * Changes
  36:  * -------
  37:  * 03-Nov-2006 : Version 1 (DG);
  38:  * 
  39:  */
  40: 
  41: package org.jfree.chart.plot.dial;
  42: 
  43: import java.awt.Shape;
  44: import java.awt.geom.Rectangle2D;
  45: import java.io.Serializable;
  46: 
  47: /**
  48:  * A dial frame is the face plate for a dial plot - it is always drawn last.
  49:  * JFreeChart includes a couple of implementations of this interface 
  50:  * ({@link StandardDialFrame} and {@link ArcDialFrame}).
  51:  * <br><br>
  52:  * Classes that implement this interface should be {@link Serializable}, 
  53:  * otherwise chart serialization may fail.
  54:  * 
  55:  * @since 1.0.7
  56:  */
  57: public interface DialFrame extends DialLayer {
  58:     
  59:     /**
  60:      * Returns the shape of the viewing window for the dial, or 
  61:      * <code>null</code> if the dial is completely open.  Other layers in the
  62:      * plot will rely on their drawing to be clipped within this window.
  63:      * 
  64:      * @param frame  the reference frame for the dial.
  65:      * 
  66:      * @return The window.
  67:      */
  68:     public Shape getWindow(Rectangle2D frame);
  69: 
  70: }