Source for org.jfree.chart.block.BlockFrame

   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:  * BlockFrame.java
  29:  * ---------------
  30:  * (C) Copyright 2007, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * Changes:
  36:  * --------
  37:  * 16-Mar-2007 : Version 1 (DG);
  38:  * 
  39:  */
  40: 
  41: package org.jfree.chart.block;
  42: 
  43: import java.awt.Graphics2D;
  44: import java.awt.geom.Rectangle2D;
  45: 
  46: import org.jfree.ui.RectangleInsets;
  47: import org.jfree.util.PublicCloneable;
  48: 
  49: /**
  50:  * A block frame is a type of border that can be drawn around the outside of 
  51:  * any {@link AbstractBlock}.  Classes that implement this interface should
  52:  * implement {@link PublicCloneable} OR be immutable.
  53:  * 
  54:  * @since 1.0.5
  55:  */
  56: public interface BlockFrame {
  57:     
  58:     /**
  59:      * Returns the space reserved for the border.
  60:      * 
  61:      * @return The space (never <code>null</code>).
  62:      */
  63:     public RectangleInsets getInsets();
  64:     
  65:     /**
  66:      * Draws the border by filling in the reserved space (in black).
  67:      * 
  68:      * @param g2  the graphics device.
  69:      * @param area  the area.
  70:      */
  71:     public void draw(Graphics2D g2, Rectangle2D area);
  72: 
  73: }