Source for org.jfree.ui.ExtendedDrawable

   1: /* ========================================================================
   2:  * JCommon : a free general purpose class library for the Java(tm) platform
   3:  * ========================================================================
   4:  *
   5:  * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
   6:  * 
   7:  * Project Info:  http://www.jfree.org/jcommon/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:  * ExtendedDrawable.java
  29:  * ---------------------
  30:  * (C) Copyright 2002-2005, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  Thomas Morgner;
  33:  * Contributor(s):   -;
  34:  *
  35:  * $Id: ExtendedDrawable.java,v 1.4 2005/10/18 13:18:34 mungady Exp $
  36:  *
  37:  * Changes
  38:  * -------
  39:  * 27-Apr-2005: Initial version.
  40:  *
  41:  */
  42: package org.jfree.ui;
  43: 
  44: import java.awt.Dimension;
  45: 
  46: /**
  47:  * A drawable that has a preferred size and aspect ratio. Implement this interface to gain
  48:  * some control over the rendering and layouting process for the drawable.
  49:  *
  50:  * @author Thomas Morgner
  51:  */
  52: public interface ExtendedDrawable extends Drawable
  53: {
  54:   /**
  55:    * Returns the preferred size of the drawable. If the drawable is aspect ratio aware,
  56:    * these bounds should be used to compute the preferred aspect ratio for this drawable.
  57:    *
  58:    * @return the preferred size.
  59:    */
  60:   public Dimension getPreferredSize ();
  61: 
  62:   /**
  63:    * Returns true, if this drawable will preserve an aspect ratio during the drawing.
  64:    *
  65:    * @return true, if an aspect ratio is preserved, false otherwise.
  66:    */
  67:   public boolean isPreserveAspectRatio ();
  68: }