com.jidesoft.dashboard
Class DashboardEvent

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

All Implemented Interfaces:

Serializable

public class DashboardEvent
extends AWTEvent

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

See Also:

Gadget, GadgetListener, Serialized Form

Field Summary

static int	DASHBOARD_ACTIVATED This event is delivered when the Dashboard is activated.
static int	DASHBOARD_ADDED This event is delivered when the Dashboard is first added to DashboardManager.
static int	DASHBOARD_DEACTIVATED This event is delivered when the Dashboard is deactivated.
static int	DASHBOARD_FIRST The first number in the range of IDs used for Dashboard events.
static int	DASHBOARD_LAST The last number in the range of IDs used for Dashboard events.
static int	DASHBOARD_MOVED This event is delivered when the Dashboard is moved in DashboardManager.
static int	DASHBOARD_REMOVED This event is delivered when the Dashboard is removed from DashboardManager.

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

DashboardEvent(Dashboard source, int id, int index)
Constructs an DashboardEvent object.

Method Summary

Dashboard	getDashboard() Returns the originator of the event.
int	getIndex() Gets the dashboard index.
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

DASHBOARD_FIRST

public static final int DASHBOARD_FIRST

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

See Also:

Constant Field Values

DASHBOARD_LAST

public static final int DASHBOARD_LAST

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

See Also:

Constant Field Values

DASHBOARD_ADDED

public static final int DASHBOARD_ADDED

This event is delivered when the Dashboard is first added to DashboardManager.

See Also:

Constant Field Values

DASHBOARD_REMOVED

public static final int DASHBOARD_REMOVED

This event is delivered when the Dashboard is removed from DashboardManager.

See Also:

Constant Field Values

DASHBOARD_MOVED

public static final int DASHBOARD_MOVED

This event is delivered when the Dashboard is moved in DashboardManager.

See Also:

Constant Field Values

DASHBOARD_ACTIVATED

public static final int DASHBOARD_ACTIVATED

This event is delivered when the Dashboard is activated.

See Also:

Constant Field Values

DASHBOARD_DEACTIVATED

public static final int DASHBOARD_DEACTIVATED

This event is delivered when the Dashboard is deactivated.

See Also:

Constant Field Values

Constructor Detail

DashboardEvent

public DashboardEvent(Dashboard source,
                      int id,
                      int index)

Constructs an DashboardEvent object.

Parameters:

source - the Dashboard object that originated the event

id - an integer indicating the type of event

index - the index of the dashboard in its parent.

Method Detail

getIndex

public int getIndex()

Gets the dashboard index. If the dashboard is removed, the index will be the index before it was removed. In the case of DashboardTabbedPane, this will be the tab index.

Returns:

the dashboard index.

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

getDashboard

public Dashboard getDashboard()

Returns the originator of the event.

Returns:

the Dashboard object that originated the event