java.awt.event
Class PaintEvent

java.lang.Object
  extended by java.util.EventObject
      extended by java.awt.AWTEvent
          extended by java.awt.event.ComponentEvent
              extended by java.awt.event.PaintEvent
All Implemented Interfaces:
Serializable

public class PaintEvent
extends ComponentEvent

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.

Since:
1.1
See Also:
Serialized Form

Field Summary
static int PAINT
          This id is for paint event types.
static int PAINT_FIRST
          This is the first id in the range of event ids used by this class.
static int PAINT_LAST
          This is the last id in the range of event ids used by this class.
static int UPDATE
          This id is for update event types.
 
Fields inherited from class java.awt.event.ComponentEvent
COMPONENT_FIRST, COMPONENT_HIDDEN, COMPONENT_LAST, COMPONENT_MOVED, COMPONENT_RESIZED, COMPONENT_SHOWN
 
Fields inherited from class java.awt.AWTEvent
ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
PaintEvent(Component source, int id, Rectangle updateRect)
          Initializes a new instance of PaintEvent with the specified source, id, and update region.
 
Method Summary
 Rectangle getUpdateRect()
          Returns the rectange to be updated for this event.
 String paramString()
          Returns a string identifying this event.
 void setUpdateRect(Rectangle updateRect)
          Sets the rectangle to be updated for this event.
 
Methods inherited from class java.awt.event.ComponentEvent
getComponent
 
Methods inherited from class java.awt.AWTEvent
consume, getID, isConsumed, setSource, toString
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

PAINT_FIRST

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

See Also:
Constant Field Values

PAINT_LAST

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

See Also:
Constant Field Values

PAINT

public static final int PAINT
This id is for paint event types.

See Also:
Constant Field Values

UPDATE

public static final int UPDATE
This id is for update event types.

See Also:
Constant Field Values
Constructor Detail

PaintEvent

public PaintEvent(Component source,
                  int id,
                  Rectangle updateRect)
Initializes a new instance of PaintEvent with the specified source, id, and update region. Note that an invalid id leads to unspecified results.

Parameters:
source - the event source
id - the event id
updateRect - the rectangle to repaint
Throws:
IllegalArgumentException - if source is null
Method Detail

getUpdateRect

public Rectangle getUpdateRect()
Returns the rectange to be updated for this event.

Returns:
the rectangle to update

setUpdateRect

public void setUpdateRect(Rectangle updateRect)
Sets the rectangle to be updated for this event.

Parameters:
updateRect - the new update rectangle for this event

paramString

public String paramString()
Returns a string identifying this event.

Overrides:
paramString in class ComponentEvent
Returns:
a string identifying this event