/* PaintEvent.java -- an area of the screen needs to be repainted
   Copyright (C) 1999, 2002, 2005  Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package java.awt.event;

import java.awt.Component;
import java.awt.Rectangle;

/**
 * This event is generated when an area of the screen needs to be painted.
 * This event is not meant for users, but exists to allow proper serialization
 * behavior in the EventQueue with user-accessible events.
 *
 * @author Aaron M. Renn (arenn@urbanophile.com)
 * @since 1.1
 * @status updated to 1.4
 */
public class PaintEvent extends ComponentEvent
{
  /**
   * Compatible with JDK 1.1+.
   */
  private static final long serialVersionUID = 1267492026433337593L;

  /** This is the first id in the range of event ids used by this class. */
  public static final int PAINT_FIRST = 800;

  /** This is the last id in the range of event ids used by this class. */
  public static final int PAINT_LAST = 801;

  /** This id is for paint event types. */
  public static final int PAINT = 800;

  /** This id is for update event types. */
  public static final int UPDATE = 801;

  /**
   * This is the rectange to be painted or updated.
   *
   * @see #getUpdateRect()
   * @see #setUpdateRect(Rectangle)
   * @serial the non-null rectangle to be painted
   */
  private Rectangle updateRect;

  /**
   * Initializes a new instance of <code>PaintEvent</code> with the specified
   * source, id, and update region. Note that an invalid id leads to
   * unspecified results.
   *
   * @param source the event source
   * @param id the event id
   * @param updateRect the rectangle to repaint
   * @throws IllegalArgumentException if source is null
   */
  public PaintEvent(Component source, int id, Rectangle updateRect)
  {
    super(source, id);
    this.updateRect = updateRect;
  }

  /**
   * Returns the rectange to be updated for this event.
   *
   * @return the rectangle to update
   */
  public Rectangle getUpdateRect()
  {
    return updateRect;
  }

  /**
   * Sets the rectangle to be updated for this event.
   *
   * @param updateRect the new update rectangle for this event
   */
  public void setUpdateRect(Rectangle updateRect)
  {
    this.updateRect = updateRect;
  }

  /**
   * Returns a string identifying this event.
   *
   * @return a string identifying this event
   */
  public String paramString()
  {
    return (id == PAINT ? "PAINT,updateRect=" : id == UPDATE
            ? "UPDATE,updateRect=" : "unknown type,updateRect=") + updateRect;
  }
} // class PaintEvent
