Class DockingEvent

java.lang.Object
java.util.EventObject
org.flexdock.event.Event
org.flexdock.docking.event.DockingEvent
All Implemented Interfaces:
Serializable, DockingConstants

public class DockingEvent extends Event
Author:
Kevin Duffey, Christopher Butler
See Also:
  • Field Details

  • 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

      public DockingPort getOldDockingPort()
      Returns the old docking port which the source Dockable was originally docked to.
      Returns:
      DockingPort the old docking port
    • getNewDockingPort

      public DockingPort getNewDockingPort()
      Returns the new docking port the source Dockable has been docked to.
      Returns:
      DockingPort the new docking port
    • isConsumed

      public boolean isConsumed()
    • consume

      public void consume()
    • getTrigger

      public AWTEvent getTrigger()
    • setTrigger

      public void setTrigger(AWTEvent trigger)
    • getTriggerSource

      public Object getTriggerSource()
    • getRegion

      public String getRegion()
    • setRegion

      public void setRegion(String region)
    • isOverWindow

      public boolean isOverWindow()
    • setOverWindow

      public void setOverWindow(boolean overWindow)
    • getDockable

      public Dockable getDockable()
    • getComponent

      public Component getComponent()
    • getDragContext

      public Map getDragContext()