com.jidesoft.docking.event
Class DockableFrameEvent

java.lang.Object
  java.util.EventObject
      java.awt.AWTEvent
          com.jidesoft.docking.event.DockableFrameEvent

All Implemented Interfaces:

Serializable

public class DockableFrameEvent
extends AWTEvent

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

See Also:

DockableFrame, DockableFrameListener, Serialized Form

Field Summary

static int	DOCKABLE_FRAME_ACTIVATED This event indicates that the DockableFrame becomes active.
static int	DOCKABLE_FRAME_ADDED This event is delivered when the DockableFrame is first added to DockingManager.
static int	DOCKABLE_FRAME_AUTOHIDDEN This event indicates that the DockableFrame has been changed from other states to the autohide state.
static int	DOCKABLE_FRAME_AUTOHIDESHOWING This event indicates that the DockableFrame has been changed from other states to the autohide-showing state.
static int	DOCKABLE_FRAME_DEACTIVATED This event indicates that the DockableFrame becomes inactive.
static int	DOCKABLE_FRAME_DOCKED This event indicates that the DockableFrame has been changed from other states to the docking state or position changed while in the docking state.
static int	DOCKABLE_FRAME_FIRST The first number in the range of IDs used for DockableFrame events.
static int	DOCKABLE_FRAME_FLOATING This event indicates that the DockableFrame has been changed from other states to the floating state or position changed while in the floating state.
static int	DOCKABLE_FRAME_HIDDEN This event is delivered when hideFrame is called on the DockableFrame.
static int	DOCKABLE_FRAME_LAST The last number in the range of IDs used for DockableFrame events.
static int	DOCKABLE_FRAME_MAXIMIZED This event indicates that the DockableFrame becomes maximized.
static int	DOCKABLE_FRAME_MOVED This event indicates that the DockableFrame was moved without dock mode change.
static int	DOCKABLE_FRAME_REMOVED This event is delivered when the DockableFrame is removed from DockingManager.
static int	DOCKABLE_FRAME_RESTORED This event indicates that the DockableFrame restored from maximized state.
static int	DOCKABLE_FRAME_SHOWN This event is delivered when showFrame is called on the DockableFrame .
static int	DOCKABLE_FRAME_TABHIDDEN This event indicates that the DockableFrame becomes invisible because its tab is deselected.
static int	DOCKABLE_FRAME_TABSHOWN This event indicates that the DockableFrame becomes visible because its tab is selected.
static int	DOCKABLE_FRAME_TRANSFERRED This event indicates that the DockableFrame was dragged from one DockingManager to another one.

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

DockableFrameEvent(DockableFrame source, int id)
Constructs an DockableFrameEvent object.

DockableFrameEvent(DockableFrame source, int id, DockableFrame opposite)
Constructs an DockableFrameEvent object.

DockableFrameEvent(DockableFrame source, int id, DockingManager opposite)
Constructs an DockableFrameEvent object.

Method Summary

DockableFrame	getDockableFrame() Returns the originator of the event.
DockableFrame	getOppositeDockableFrame() Gets the opposite dockable frame.
DockingManager	getOppositeDockingManger() Gets the opposite docking manager.
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_FRAME_FIRST

public static final int DOCKABLE_FRAME_FIRST

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

See Also:

Constant Field Values

DOCKABLE_FRAME_LAST

public static final int DOCKABLE_FRAME_LAST

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

See Also:

Constant Field Values

DOCKABLE_FRAME_ADDED

public static final int DOCKABLE_FRAME_ADDED

This event is delivered when the DockableFrame is first added to DockingManager.

See Also:

Constant Field Values

DOCKABLE_FRAME_REMOVED

public static final int DOCKABLE_FRAME_REMOVED

This event is delivered when the DockableFrame is removed from DockingManager.

See Also:

Constant Field Values

DOCKABLE_FRAME_SHOWN

public static final int DOCKABLE_FRAME_SHOWN

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

See Also:

Constant Field Values

DOCKABLE_FRAME_HIDDEN

public static final int DOCKABLE_FRAME_HIDDEN

This event is delivered when hideFrame is called on the DockableFrame. You can veto this event by overriding DockableFrame.shouldVetoHiding() method and return true.

See Also:

Constant Field Values

DOCKABLE_FRAME_DOCKED

public static final int DOCKABLE_FRAME_DOCKED

This event indicates that the DockableFrame has been changed from other states to the docking state or position changed while in the docking state.

See Also:

Constant Field Values

DOCKABLE_FRAME_FLOATING

public static final int DOCKABLE_FRAME_FLOATING

This event indicates that the DockableFrame has been changed from other states to the floating state or position changed while in the floating state.

See Also:

Constant Field Values

DOCKABLE_FRAME_AUTOHIDDEN

public static final int DOCKABLE_FRAME_AUTOHIDDEN

This event indicates that the DockableFrame has been changed from other states to the autohide state.

See Also:

Component.show(), Constant Field Values

DOCKABLE_FRAME_AUTOHIDESHOWING

public static final int DOCKABLE_FRAME_AUTOHIDESHOWING

This event indicates that the DockableFrame has been changed from other states to the autohide-showing state.

See Also:

Component.show(), Constant Field Values

DOCKABLE_FRAME_ACTIVATED

public static final int DOCKABLE_FRAME_ACTIVATED

This event indicates that the DockableFrame becomes active.

See Also:

Constant Field Values

DOCKABLE_FRAME_DEACTIVATED

public static final int DOCKABLE_FRAME_DEACTIVATED

This event indicates that the DockableFrame becomes inactive.

See Also:

Constant Field Values

DOCKABLE_FRAME_TABSHOWN

public static final int DOCKABLE_FRAME_TABSHOWN

This event indicates that the DockableFrame becomes visible because its tab is selected.

See Also:

Constant Field Values

DOCKABLE_FRAME_TABHIDDEN

public static final int DOCKABLE_FRAME_TABHIDDEN

This event indicates that the DockableFrame becomes invisible because its tab is deselected.

See Also:

Constant Field Values

DOCKABLE_FRAME_MAXIMIZED

public static final int DOCKABLE_FRAME_MAXIMIZED

This event indicates that the DockableFrame becomes maximized.

See Also:

Constant Field Values

DOCKABLE_FRAME_RESTORED

public static final int DOCKABLE_FRAME_RESTORED

This event indicates that the DockableFrame restored from maximized state.

See Also:

Constant Field Values

DOCKABLE_FRAME_TRANSFERRED

public static final int DOCKABLE_FRAME_TRANSFERRED

This event indicates that the DockableFrame was dragged from one DockingManager to another one.

See Also:

Constant Field Values

DOCKABLE_FRAME_MOVED

public static final int DOCKABLE_FRAME_MOVED

This event indicates that the DockableFrame was moved without dock mode change.

See Also:

Constant Field Values

Constructor Detail

DockableFrameEvent

public DockableFrameEvent(DockableFrame source,
                          int id)

Constructs an DockableFrameEvent object.

Parameters:

source - the DockableFrame object that originated the event

id - an integer indicating the type of event

DockableFrameEvent

public DockableFrameEvent(DockableFrame source,
                          int id,
                          DockableFrame opposite)

Constructs an DockableFrameEvent object.

Parameters:

source - the DockableFrame object that originated the event

id - an integer indicating the type of event

opposite - the opposite DockableFrame. This is only used by activated and deactivated event.

DockableFrameEvent

public DockableFrameEvent(DockableFrame source,
                          int id,
                          DockingManager opposite)

Constructs an DockableFrameEvent object.

Parameters:

source - the DockableFrame object that originated the event

id - an integer indicating the type of event

opposite - the opposite DockingManager. This is only used by transfer 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

getDockableFrame

public DockableFrame getDockableFrame()

Returns the originator of the event.

Returns:

the DockableFrame object that originated the event

getOppositeDockableFrame

public DockableFrame getOppositeDockableFrame()

Gets the opposite dockable frame. It is set only when the event id is DOCKABLE_FRAME_ACTIVATED or DOCKABLE_FRAME_DEACTIVATED. When a frame is activated, opposite dockable frame is the one that is deactivated if there is one.

Returns:

the opposite dockable frame. It could return null if there is no opposite dockable frame.

getOppositeDockingManger

public DockingManager getOppositeDockingManger()

Gets the opposite docking manager. It is set only when the event id is DOCKABLE_FRAME_TRANSFERRED. When a frame is dragged between docking managers, opposite docking manager is the one that originally holds the frame. The new docking manager could be obtained by frame.getDockingManager().

Returns:

the opposite docking manager.