Source for javax.swing.plaf.IconUIResource

   1: /* IconUIResource.java --
   2:    Copyright (C) 2002, 2003, 2004, 2006,  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> (never
  67:    * <code>null</code>).
  68:    */
  69:   private Icon delegate;
  70: 
  71: 
  72:   /**
  73:    * Constructs a <code>IconUIResource</code> that wraps another
  74:    * icon. All messages are forwarded to the delegate icon.
  75:    *
  76:    * @param delegate the icon that is wrapped by this
  77:    *        <code>IconUIResource</code> (<code>null</code> not permitted).
  78:    */
  79:   public IconUIResource(Icon delegate)
  80:   {
  81:     if (delegate == null)
  82:       throw new IllegalArgumentException("Null 'delegate' argument.");
  83:     this.delegate = delegate;
  84:   }
  85: 
  86: 
  87:   /**
  88:    * Paints the icon by asking the delegate icon to paint itself.
  89:    *
  90:    * @param c the Component whose icon is being painted. Some icons
  91:    *        use this argument to retrieve properties like the
  92:    *        background color.
  93:    *
  94:    * @param g the graphics into which the icon will be painted.
  95:    *
  96:    * @param x the horizontal position of the icon.
  97:    *
  98:    * @param y the vertical position of the icon.
  99:    */
 100:   public void paintIcon(Component c, Graphics g, int x, int y)
 101:   {
 102:     delegate.paintIcon(c, g, x, y);
 103:   }
 104: 
 105: 
 106:   /**
 107:    * Returns the width of the icon in pixels. The implementation
 108:    * determines and returns the width of the delegate icon.
 109:    */
 110:   public int getIconWidth()
 111:   {
 112:     return delegate.getIconWidth();
 113:   }
 114: 
 115: 
 116:   /**
 117:    * Returns the height of the icon in pixels. The implementation
 118:    * determines and returns the height of the delegate icon.
 119:    */
 120:   public int getIconHeight()
 121:   {
 122:     return delegate.getIconHeight();
 123:   }
 124: }