libjava/java/awt/event/PaintEvent.java

   1 /* PaintEvent.java -- an area of the screen needs to be repainted
   2    Copyright (C) 1999, 2002, 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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 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 java.awt.event;
  40
  41 import java.awt.Component;
  42 import java.awt.Rectangle;
  43
  44 /**
  45  * This event is generated when an area of the screen needs to be painted.
  46  * This event is not meant for users, but exists to allow proper serialization
  47  * behavior in the EventQueue with user-accessible events.
  48  *
  49  * @author Aaron M. Renn (arenn@urbanophile.com)
  50  * @since 1.1
  51  * @status updated to 1.4
  52  */
  53 public class PaintEvent extends ComponentEvent
  54 {
  55   /**
  56    * Compatible with JDK 1.1+.
  57    */
  58   private static final long serialVersionUID = 1267492026433337593L;
  59
  60   /** This is the first id in the range of event ids used by this class. */
  61   public static final int PAINT_FIRST = 800;
  62
  63   /** This is the last id in the range of event ids used by this class. */
  64   public static final int PAINT_LAST = 801;
  65
  66   /** This id is for paint event types. */
  67   public static final int PAINT = 800;
  68
  69   /** This id is for update event types. */
  70   public static final int UPDATE = 801;
  71
  72   /**
  73    * This is the rectange to be painted or updated.
  74    *
  75    * @see #getUpdateRect()
  76    * @see #setUpdateRect(Rectangle)
  77    * @serial the non-null rectangle to be painted
  78    */
  79   private Rectangle updateRect;
  80
  81   /**
  82    * Initializes a new instance of <code>PaintEvent</code> with the specified
  83    * source, id, and update region. Note that an invalid id leads to
  84    * unspecified results.
  85    *
  86    * @param source the event source
  87    * @param id the event id
  88    * @param updateRect the rectangle to repaint
  89    * @throws IllegalArgumentException if source is null
  90    */
  91   public PaintEvent(Component source, int id, Rectangle updateRect)
  92   {
  93     super(source, id);
  94     this.updateRect = updateRect;
  95   }
  96
  97   /**
  98    * Returns the rectange to be updated for this event.
  99    *
 100    * @return the rectangle to update
 101    */
 102   public Rectangle getUpdateRect()
 103   {
 104     return updateRect;
 105   }
 106
 107   /**
 108    * Sets the rectangle to be updated for this event.
 109    *
 110    * @param updateRect the new update rectangle for this event
 111    */
 112   public void setUpdateRect(Rectangle updateRect)
 113   {
 114     this.updateRect = updateRect;
 115   }
 116
 117   /**
 118    * Returns a string identifying this event.
 119    *
 120    * @return a string identifying this event
 121    */
 122   public String paramString()
 123   {
 124     return (id == PAINT ? "PAINT,updateRect=" : id == UPDATE
 125             ? "UPDATE,updateRect=" : "unknown type,updateRect=") + updateRect;
 126   }
 127 } // class PaintEvent