com.jidesoft.dashboard
Class GadgetEvent

java.lang.Object
  java.util.EventObject
      java.awt.AWTEvent
          com.jidesoft.dashboard.GadgetEvent

All Implemented Interfaces:

Serializable

public class GadgetEvent
extends AWTEvent

An AWTEvent that adds support for Gadget objects as the event source.

See Also:

Gadget, GadgetListener, Serialized Form

Field Summary

static int	GADGET_ADDED This event is delivered when the Gadget is first added to GadgetManager.
static int	GADGET_COMPONENT_CREATED This event is delivered when gadget component is created by the gadget when Gadget.createGadgetComponent() is called.
static int	GADGET_COMPONENT_DISPOSED This event is delivered when gadget component is disposed by the gadget when Gadget.disposeGadgetComponent(GadgetComponent) is called.
static int	GADGET_COMPONENT_HIDDEN This event is delivered when gadget component is hidden from the Dashboard
static int	GADGET_COMPONENT_MAXIMIZED This event is delivered when gadget component is disposed by the gadget when Gadget.disposeGadgetComponent(GadgetComponent) is called.
static int	GADGET_COMPONENT_RESIZED This event is delivered when gadget component is disposed by the gadget when Gadget.disposeGadgetComponent(GadgetComponent) is called.
static int	GADGET_COMPONENT_RESTORED This event is delivered when gadget component is disposed by the gadget when Gadget.disposeGadgetComponent(GadgetComponent) is called.
static int	GADGET_COMPONENT_SHOWN This event is delivered when gadget component is shown on a Dashboard
static int	GADGET_FIRST The first number in the range of IDs used for Gadget events.
static int	GADGET_LAST The last number in the range of IDs used for Gadget events.
static int	GADGET_REMOVED This event is delivered when the Gadget is removed from GadgetManager.

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

GadgetEvent(Gadget source, int id)
Constructs an GadgetEvent object.

GadgetEvent(Object source, int id, GadgetComponent gadgetComponent)

Method Summary

Gadget	getGadget() Returns the originator of the event.
GadgetComponent	getGadgetComponent()
String	paramString() Returns a parameter string identifying this event.

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

GADGET_FIRST

public static final int GADGET_FIRST

The first number in the range of IDs used for Gadget events.

See Also:

Constant Field Values

GADGET_LAST

public static final int GADGET_LAST

The last number in the range of IDs used for Gadget events.

See Also:

Constant Field Values

GADGET_ADDED

public static final int GADGET_ADDED

This event is delivered when the Gadget is first added to GadgetManager.

See Also:

Constant Field Values

GADGET_REMOVED

public static final int GADGET_REMOVED

This event is delivered when the Gadget is removed from GadgetManager.

See Also:

Constant Field Values

GADGET_COMPONENT_SHOWN

public static final int GADGET_COMPONENT_SHOWN

This event is delivered when gadget component is shown on a Dashboard

See Also:

Constant Field Values

GADGET_COMPONENT_HIDDEN

public static final int GADGET_COMPONENT_HIDDEN

This event is delivered when gadget component is hidden from the Dashboard

See Also:

Constant Field Values

GADGET_COMPONENT_CREATED

public static final int GADGET_COMPONENT_CREATED

This event is delivered when gadget component is created by the gadget when Gadget.createGadgetComponent() is called.

See Also:

Constant Field Values

GADGET_COMPONENT_DISPOSED

public static final int GADGET_COMPONENT_DISPOSED

This event is delivered when gadget component is disposed by the gadget when Gadget.disposeGadgetComponent(GadgetComponent) is called.

See Also:

Constant Field Values

GADGET_COMPONENT_MAXIMIZED

public static final int GADGET_COMPONENT_MAXIMIZED

This event is delivered when gadget component is disposed by the gadget when Gadget.disposeGadgetComponent(GadgetComponent) is called.

See Also:

Constant Field Values

GADGET_COMPONENT_RESTORED

public static final int GADGET_COMPONENT_RESTORED

This event is delivered when gadget component is disposed by the gadget when Gadget.disposeGadgetComponent(GadgetComponent) is called.

See Also:

Constant Field Values

GADGET_COMPONENT_RESIZED

public static final int GADGET_COMPONENT_RESIZED

This event is delivered when gadget component is disposed by the gadget when Gadget.disposeGadgetComponent(GadgetComponent) is called.

See Also:

Constant Field Values

Constructor Detail

GadgetEvent

public GadgetEvent(Gadget source,
                   int id)

Constructs an GadgetEvent object.

Parameters:

source - the Gadget object that originated the event

id - an integer indicating the type of event

GadgetEvent

public GadgetEvent(Object source,
                   int id,
                   GadgetComponent gadgetComponent)

Method Detail

paramString

public String paramString()

Returns a parameter string identifying this event. This method is useful for event logging and for debugging.

Overrides:

paramString in class AWTEvent

Returns:

a string identifying the event and its attributes

getGadget

public Gadget getGadget()

Returns the originator of the event.

Returns:

the Gadget object that originated the event

getGadgetComponent

public GadgetComponent getGadgetComponent()