com.jidesoft.action.event
Class DockableBarEvent

java.lang.Object
  java.util.EventObject
      java.awt.AWTEvent
          com.jidesoft.action.event.DockableBarEvent

All Implemented Interfaces:

Serializable

public class DockableBarEvent
extends AWTEvent

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

See Also:

DockableBar, DockableBarListener, Serialized Form

Field Summary

static int	DOCKABLE_BAR_ADDED This event is delivered when the DockableBar is first added to DockableBarManager.
static int	DOCKABLE_BAR_FIRST The first number in the range of IDs used for DockableBar events.
static int	DOCKABLE_BAR_FLOATING This event indicates that the DockableBar has been changed from other state to floating state.
static int	DOCKABLE_BAR_HIDDEN This event is delivered when hideFrame is called on the DockableBar.
static int	DOCKABLE_BAR_HORI_DOCKED This event indicates that the DockableBar has been changed from other state to horizontal state.
static int	DOCKABLE_BAR_LAST The last number in the range of IDs used for DockableBar events.
static int	DOCKABLE_BAR_REMOVED This event is delivered when the DockableBar is removed from DockableBarManager.
static int	DOCKABLE_BAR_SHOWN This event is delivered when showFrame is called on the DockableBar .
static int	DOCKABLE_BAR_VERT_DOCKED This event indicates that the DockableBar has been changed from other state to vertical docking state.

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

DockableBarEvent(DockableBar source, int id)
Constructs an DockableBarEvent object.

Method Summary

DockableBar	getDockableBar() Returns the originator of the event.
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

DOCKABLE_BAR_FIRST

public static final int DOCKABLE_BAR_FIRST

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

See Also:

Constant Field Values

DOCKABLE_BAR_LAST

public static final int DOCKABLE_BAR_LAST

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

See Also:

Constant Field Values

DOCKABLE_BAR_ADDED

public static final int DOCKABLE_BAR_ADDED

This event is delivered when the DockableBar is first added to DockableBarManager.

See Also:

Constant Field Values

DOCKABLE_BAR_REMOVED

public static final int DOCKABLE_BAR_REMOVED

This event is delivered when the DockableBar is removed from DockableBarManager.

See Also:

Constant Field Values

DOCKABLE_BAR_SHOWN

public static final int DOCKABLE_BAR_SHOWN

This event is delivered when showFrame is called on the DockableBar .

See Also:

Component.show(), Constant Field Values

DOCKABLE_BAR_HIDDEN

public static final int DOCKABLE_BAR_HIDDEN

This event is delivered when hideFrame is called on the DockableBar.

See Also:

Constant Field Values

DOCKABLE_BAR_HORI_DOCKED

public static final int DOCKABLE_BAR_HORI_DOCKED

This event indicates that the DockableBar has been changed from other state to horizontal state.

See Also:

Constant Field Values

DOCKABLE_BAR_VERT_DOCKED

public static final int DOCKABLE_BAR_VERT_DOCKED

This event indicates that the DockableBar has been changed from other state to vertical docking state.

See Also:

Constant Field Values

DOCKABLE_BAR_FLOATING

public static final int DOCKABLE_BAR_FLOATING

This event indicates that the DockableBar has been changed from other state to floating state.

See Also:

Constant Field Values

Constructor Detail

DockableBarEvent

public DockableBarEvent(DockableBar source,
                        int id)

Constructs an DockableBarEvent object.

Parameters:

source - the DockableBar object that originated the event

id - an integer indicating the type of event

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

getDockableBar

public DockableBar getDockableBar()

Returns the originator of the event.

Returns:

the DockableBar object that originated the event