Package org.flexdock.docking.event
Class DockingEvent
java.lang.Object
java.util.EventObject
org.flexdock.event.Event
org.flexdock.docking.event.DockingEvent
- All Implemented Interfaces:
Serializable
,DockingConstants
- Author:
- Kevin Duffey, Christopher Butler
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
Fields inherited from class java.util.EventObject
source
Fields inherited from interface org.flexdock.docking.DockingConstants
ACTIVE_WINDOW, BOTTOM, CENTER, CENTER_REGION, CLOSE_ACTION, DEFAULT_PERSISTENCE_KEY, DOCKING_ID, EAST_REGION, HEAVYWEIGHT_DOCKABLES, HORIZONTAL, LEFT, MOUSE_PRESSED, NORTH_REGION, PERMANENT_FOCUS_OWNER, PIN_ACTION, REGION, RIGHT, SOUTH_REGION, TOP, UNINITIALIZED, UNINITIALIZED_RATIO, UNKNOWN_REGION, UNSPECIFIED_SIBLING_PREF, VERTICAL, WEST_REGION
-
Constructor Summary
ConstructorsConstructorDescriptionDockingEvent
(Dockable source, DockingPort oldPort, DockingPort newPort, int eventType, AWTEvent trigger, Map context) Constructor to create a DockingEvent object with the provided Dockable, the originating docking part, the destination docking port and whether the dock is completed or canceled.DockingEvent
(Dockable source, DockingPort oldPort, DockingPort newPort, int eventType, Map context) Constructor to create a DockingEvent object with the provided Dockable, the originating docking part, the destination docking port and whether the dock is completed or canceled. -
Method Summary
Modifier and TypeMethodDescriptionvoid
consume()
Returns the new docking port the sourceDockable
has been docked to.Returns the old docking port which the sourceDockable
was originally docked to.boolean
boolean
void
setOverWindow
(boolean overWindow) void
void
setTrigger
(AWTEvent trigger) Methods inherited from class org.flexdock.event.Event
getEventType
Methods inherited from class java.util.EventObject
getSource, toString
-
Field Details
-
DRAG_STARTED
public static final int DRAG_STARTED- See Also:
-
DROP_STARTED
public static final int DROP_STARTED- See Also:
-
DOCKING_COMPLETE
public static final int DOCKING_COMPLETE- See Also:
-
DOCKING_CANCELED
public static final int DOCKING_CANCELED- See Also:
-
UNDOCKING_COMPLETE
public static final int UNDOCKING_COMPLETE- See Also:
-
UNDOCKING_STARTED
public static final int UNDOCKING_STARTED- See Also:
-
-
Constructor Details
-
DockingEvent
public DockingEvent(Dockable source, DockingPort oldPort, DockingPort newPort, int eventType, Map context) Constructor to create a DockingEvent object with the provided Dockable, the originating docking part, the destination docking port and whether the dock is completed or canceled. -
DockingEvent
public DockingEvent(Dockable source, DockingPort oldPort, DockingPort newPort, int eventType, AWTEvent trigger, Map context) Constructor to create a DockingEvent object with the provided Dockable, the originating docking part, the destination docking port and whether the dock is completed or canceled.
-
-
Method Details
-
getOldDockingPort
Returns the old docking port which the sourceDockable
was originally docked to.- Returns:
- DockingPort the old docking port
-
getNewDockingPort
Returns the new docking port the sourceDockable
has been docked to.- Returns:
- DockingPort the new docking port
-
isConsumed
public boolean isConsumed() -
consume
public void consume() -
getTrigger
-
setTrigger
-
getTriggerSource
-
getRegion
-
setRegion
-
isOverWindow
public boolean isOverWindow() -
setOverWindow
public void setOverWindow(boolean overWindow) -
getDockable
-
getComponent
-
getDragContext
-