Source for javax.swing.Icon

   1: /* Icon.java --
   2:    Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package javax.swing;
  39: 
  40: import java.awt.Component;
  41: import java.awt.Graphics;
  42: 
  43: /**
  44:  * Defines the methods that an object must implement if it should be used
  45:  * as an icon in Swing.
  46:  */
  47: public interface Icon
  48: {
  49:   /**
  50:    * Returns the height of the icon.
  51:    *
  52:    * @return The height of the icon.
  53:    */
  54:   int getIconHeight();
  55: 
  56:   /**
  57:    * Returns the width of the icon.
  58:    *
  59:    * @return The width of the icon.
  60:    */
  61:   int getIconWidth();
  62: 
  63:   /**
  64:    * Draws the icon at the location (x, y) on the specified graphics device.
  65:    *
  66:    * @param c  a component related to the icon in some way (can be ignored by
  67:                some implementing classes).
  68:    * @param g  the graphics device.
  69:    * @param x  the x-coordinate.
  70:    * @param y  the y-coordinate.
  71:    */
  72:   void paintIcon(Component c, Graphics g, int x, int y);
  73: }