oracle.ide.docking
Class DockableEvent

java.lang.Object
  oracle.ide.docking.DockableEvent

public final class DockableEvent
extends java.lang.Object

The class describes events on Dockable objects.
Although it might seem similar to a ComponentListener on the UI, it is different because when two dockable are tabbed together, ComponentListener considers the visibility of the windows (the selected page is visible and the others are hidden) while the DockableEvent will be sent for each Dockable corresponding to a tab in the tab pane.

See Also:

DockableListener

Field Summary

static int	CONTEXT_DRAG Context of the event. This indicates that the event was initiated by a drag/drop operation.
static int	CONTEXT_LAYOUT_CHANGE Context of the event. This indicates the the event was initiated by a layout change
static int	CONTEXT_LAYOUT_INSTALL Context of the event. This context is used when a DockableFactory is installed in a layout.
static int	CONTEXT_TOGGLE Context of the event. This indicates that the event was initiated by a visibility toggle operation.
static int	CONTEXT_USER_ACTION Context of the event. This indicates the the event was initiated by a user action, for example; pressing the close button or a drag drop.
static int	ID_DOCKABLE_HIDDEN Event ID.
static int	ID_DOCKABLE_SHOWN Event ID.

Constructor Summary

DockableEvent(Dockable dockable, int nID)
Deprecated.

DockableEvent(Dockable dockable, int nID, int flags)
Full featured constructor.
Note:The event context is set by DockStation.fireDockableEvent

Method Summary

int	getContext() Gets the context of the event.
int	getID() Gets the event ID.
Dockable	getSource()
void	setContext(int nContext) Sets the context of the event.
void	setID(int nID) Sets the event ID.
void	setSource(Dockable src)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ID_DOCKABLE_SHOWN

public static final int ID_DOCKABLE_SHOWN

Event ID. corresponds to DockableListener.dockableShown

See Also:

Constant Field Values

ID_DOCKABLE_HIDDEN

public static final int ID_DOCKABLE_HIDDEN

Event ID. corresponds to DockableListener.dockableShown

See Also:

Constant Field Values

CONTEXT_LAYOUT_CHANGE

public static final int CONTEXT_LAYOUT_CHANGE

Context of the event.
This indicates the the event was initiated by a layout change

See Also:

Constant Field Values

CONTEXT_LAYOUT_INSTALL

public static final int CONTEXT_LAYOUT_INSTALL

Context of the event.
This context is used when a DockableFactory is installed in a layout.

See Also:

DockableFactory.install, Constant Field Values

CONTEXT_USER_ACTION

public static final int CONTEXT_USER_ACTION

Context of the event.
This indicates the the event was initiated by a user action, for example; pressing the close button or a drag drop.

See Also:

Constant Field Values

CONTEXT_DRAG

public static final int CONTEXT_DRAG

Context of the event.
This indicates that the event was initiated by a drag/drop operation.

See Also:

Constant Field Values

CONTEXT_TOGGLE

public static final int CONTEXT_TOGGLE

Context of the event.
This indicates that the event was initiated by a visibility toggle operation.

See Also:

Constant Field Values

Constructor Detail

DockableEvent

public DockableEvent(Dockable dockable,
                     int nID)

Deprecated.

Full featured constructor.
Note:The event context is set by DockStation.fireDockableEvent

DockableEvent

public DockableEvent(Dockable dockable,
                     int nID,
                     int flags)

Full featured constructor.
Note:The event context is set by DockStation.fireDockableEvent

Method Detail

getID

public int getID()

Gets the event ID. Valid values are ID_* constants

setID

public void setID(int nID)

Sets the event ID. Valid values are ID_* constants

setSource

public void setSource(Dockable src)

getSource

public Dockable getSource()

getContext

public int getContext()

Gets the context of the event. Valid values are CONTEXT_* constants

setContext

public void setContext(int nContext)

Sets the context of the event. Valid values are CONTEXT_* constants

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object