libjava/classpath/javax/swing/plaf/IconUIResource.java

   1 /* IconUIResource.java --
   2    Copyright (C) 2002, 2003, 2004  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
  39 package javax.swing.plaf;
  40
  41 import java.awt.Component;
  42 import java.awt.Graphics;
  43 import java.io.Serializable;
  44
  45 import javax.swing.Icon;
  46
  47 /**
  48  * An icon that is marked as <code>UIResource</code>, which
  49  * indicates that it has been installed by a pluggable
  50  * LookAndFeel. Such icons are replaced when the LookAndFeel
  51  * changes.
  52  *
  53  * @author Andrew Selkirk (aselkirk@sympatico.ca)
  54  * @author Sascha Brawer (brawer@dandelis.ch)
  55  */
  56 public class IconUIResource implements Icon, UIResource, Serializable
  57 {
  58   /**
  59    * Verified using the <code>serialver</code> tool of Sun JDK 1.4.1_01
  60    * on GNU/Linux 2.4.18.
  61    */
  62   static final long serialVersionUID = 3327049506004830542L;
  63
  64
  65   /**
  66    * The icon that is wrapped by this <code>IconUIResource</code>.
  67    */
  68   private Icon delegate;
  69
  70
  71   /**
  72    * Constructs a <code>IconUIResource</code> that wraps another
  73    * icon. All messages are forwarded to the delegate icon.
  74    *
  75    * @param delegate the icon that is wrapped by this
  76    *        <code>IconUIResource</code>.
  77    */
  78   public IconUIResource(Icon delegate)
  79   {
  80     this.delegate = delegate;
  81   }
  82
  83
  84   /**
  85    * Paints the icon by asking the delegate icon to paint itself.
  86    *
  87    * @param c the Component whose icon is being painted. Some icons
  88    *        use this argument to retrieve properties like the
  89    *        background color.
  90    *
  91    * @param g the graphics into which the icon will be painted.
  92    *
  93    * @param x the horizontal position of the icon.
  94    *
  95    * @param y the vertical position of the icon.
  96    */
  97   public void paintIcon(Component c, Graphics g, int x, int y)
  98   {
  99     delegate.paintIcon(c, g, x, y);
 100   }
 101
 102
 103   /**
 104    * Returns the width of the icon in pixels. The implementation
 105    * determines and returns the width of the delegate icon.
 106    */
 107   public int getIconWidth()
 108   {
 109     return delegate.getIconWidth();
 110   }
 111
 112
 113   /**
 114    * Returns the height of the icon in pixels. The implementation
 115    * determines and returns the height of the delegate icon.
 116    */
 117   public int getIconHeight()
 118   {
 119     return delegate.getIconHeight();
 120   }
 121 }