java::awt::event::PaintEvent Class Reference

Inheritance diagram for java::awt::event::PaintEvent:

Inheritance graph
java::awt::event::ComponentEventjava::awt::AWTEventjava::util::EventObjectjava::lang::Object
[legend]
Collaboration diagram for java::awt::event::PaintEvent:

Collaboration graph
java::awt::event::ComponentEventjava::awt::AWTEventjava::util::EventObjectjava::lang::Objectjava::lang::ObjectRefjava::lang::Interfacejava::lang::Comparable
[legend]

List of all members.


Detailed Description

The component-level paint event.

This event is a special type which is used to ensure that paint/update method calls are serialized along with the other events delivered from the event queue. This event is not designed to be used with the Event Listener model; programs should continue to override paint/update methods in order render themselves properly.

Author:
Amy Fowler
Version:
1.18, 01/23/03
Since:
1.1

Public Types

enum  PAINT_EVENT_ID { PAINT_FIRST = 800, PAINT = PAINT_FIRST, UPDATE, PAINT_LAST = UPDATE }

Public Member Functions

 PaintEvent (const Ref< Component > &source=0, jint id=PAINT, const Ref< Graphics > &graphics=0)
 Constructs a PaintEvent object with the specified source component and type.
virtual Ref< GraphicsgetGraphics ()
 Returns the graphics representing the graphics context which needs to be repainted in response to this event.
virtual String paramString () const
 Returns a parameter string identifying this event.

Protected Attributes

Ref< Graphicsgraphics
 This is the graphics that represents the graphics context on the source component that requires a repaint.

Member Enumeration Documentation

enum java::awt::event::PaintEvent::PAINT_EVENT_ID

Enumerator:
PAINT_FIRST  Marks the first integer id for the range of paint event ids.
PAINT  The paint event type.
UPDATE  The update event type.
PAINT_LAST  Marks the last integer id for the range of paint event ids.


Constructor & Destructor Documentation

java::awt::event::PaintEvent::PaintEvent ( const Ref< Component > &  source = 0,
jint  id = PAINT,
const Ref< Graphics > &  graphics = 0 
)

Constructs a PaintEvent object with the specified source component and type.

Note that passing in an invalid id results in unspecified behavior.

Parameters:
source the object where the event originated
id the event type
graphics the graphics area which needs to be repainted


Member Function Documentation

virtual Ref<Graphics> java::awt::event::PaintEvent::getGraphics (  )  [virtual]

Returns the graphics representing the graphics context which needs to be repainted in response to this event.

virtual String java::awt::event::PaintEvent::paramString (  )  const [virtual]

Returns a parameter string identifying this event.

This method is useful for event-logging and for debugging.

Returns:
a string identifying the event and its attributes

Reimplemented from java::awt::event::ComponentEvent.


Member Data Documentation

Ref<Graphics> java::awt::event::PaintEvent::graphics [protected]

This is the graphics that represents the graphics context on the source component that requires a repaint.

This graphics should be non null.


The documentation for this class was generated from the following file:
Generated on Fri May 16 11:56:19 2008 for CrossPlatformJavaLikeC++API by  doxygen 1.5.3