Package org.flexdock.docking.floating.frames

Class FloatingDockingPort

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
org.flexdock.docking.defaults.DefaultDockingPort
org.flexdock.docking.floating.frames.FloatingDockingPort
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, EventListener, Accessible, DockingConstants, DockingPort, DockingListener, DockingMonitor
public class FloatingDockingPort extends DefaultDockingPort
Author:
Christopher Butler
See Also:

  • Field Details

  • Constructor Details

    • FloatingDockingPort

      public FloatingDockingPort(DockingFrame frame, String persistentId)

  • Method Details

    • getRegion

      public String getRegion(Point p)
      Description copied from class: DefaultDockingPort
      Returns the docking region within this DockingPort that contains the specified Point. Valid return values are those regions defined in DockingConstants and include NORTH_REGION, SOUTH_REGION, EAST_REGION, WEST_REGION, CENTER_REGION, and UNKNOWN_REGION.

      If location is null, then UNKNOWN_REGION is returned.

      This method gets the RegionChecker for this DockingPort by calling getRegionChecker(). It then attempts to locate the Dockable at the specified location by calling getDockableAt(Point location).

      This method defers processing to getRegion(Component c, Point p) for the current RegionChecker. If a Dockable was found at the specified Point, then the location of the Point is translated to the coordinate system of the Component for the embedded Dockable and that Component and modified Point are passed into getRegion(Component c, Point p)} for the current RegionChecker. If no Dockable was found, then the specified Point is left unmodified and this DockingPort and the supplied Point are passed to getRegion(Component c, Point p)} for the current RegionChecker.

      Specified by:
      getRegion in interface DockingPort
      Overrides:
      getRegion in class DefaultDockingPort
      Parameters:
      p - the location within this DockingPort to examine for a docking region.
      Returns:
      the docking region within this DockingPort that contains the specified Point
      See Also:

    • isDockingAllowed

      public boolean isDockingAllowed(String region, Component comp)

    • dock

      public boolean dock(Dockable dockable, String region)
      Description copied from class: DefaultDockingPort
      Docks the specified Dockable within the specified region. The Component used for docking is returned by calling getComponent() on the specified Dockable. This method returns false immediately if the specified Dockable is null or if isDockingAllowed(Component comp, String region) returns false.

      If this DockingPort is currently empty, then the Dockable is docked into the CENTER_REGION, regardless of the supplied region parameter's value.

      If isSingleTabAllowed() returns false and the DockingPort is emtpy, then the Dockable will be added directly to the DockingPort and will take up all available space within the DockingPort. In this case, subsequent calls to getDockedComponent() will return the dockable Component.

      If isSingleTabAllowed() returns true and the DockingPort is emtpy, then a JTabbedPane will be added directly to the DockingPort and will take up all available space within the DockingPort. The dockable Component will be added as a tab within the tabbed pane. In this case, subsequent calls to getDockedComponent() will return the JTabbedPane.

      If the DockingPort is not empty, and the specified region is CENTER_REGION, then the dockable Component will be added to the JTabbedPane returned by getDockedComponent(). If this DockingPort only contained a single dockable Component without a tabbed pane, then the currently docked Component is removed, a JTabbedPane is created and added, and both the old Component and the new one are added to the JTabbedPane. In this case, subsequent calls to getDockedComponent() will return the JTabbedPane.

      If the DockingPort is not empty, and the specified region is NORTH_REGION, SOUTH_REGION, EAST_REGION, or WEST_REGION, then the currently docked Component is removed and replaced with a JSplitPane. Two new DefaultDockingPorts are created as sub-ports and are added to each side of the JSplitPane. The previously docked Component is docked to the CENTER_REGION of one of the sub-ports and the new Component is added to the other. In this case, subsequent calls to getDockedComponent() will return the JSplitPane. In this fasion, the sub-ports will now be capable of handling further sub-docking within the layout.

      JSplitPane and sub-DockingPort creation are delegated to the DockingStrategy returned by getDockingStrategy(). Initial splitpane divider location is also controlled by this DockingStrategy.

      Specified by:
      dock in interface DockingPort
      Overrides:
      dock in class DefaultDockingPort
      Parameters:
      dockable - the Dockable to be docked within this DockingPort
      region - the region within this DockingPort to dock the specified Dockable
      Returns:
      true if the docking operation was successful, false otherwise.
      See Also:

    • undock

      public boolean undock(Component comp)
      Description copied from class: DefaultDockingPort
      Undocks the specified Component and returns a boolean indicating the success of the operation.

      Since DefaultDockingPort may only contain one child component, there i s a container hierarchy to manage tabbed interfaces, split layouts, and sub-docking. As components are removed from this hierarchy, the hierarchy itself must be reevaluated. Removing a component from a child code>DefaultDockingPort} within a JSplitPane renders the child DefaultDockingPort unnecessary, which, in turn, renders the notion of splitting the layout with a JSplitPane unnecessary (since there are no longer two components to split the layout between). Likewise, removing a child component from a JTabbedPane such that there is only one child left within the JTabbedPane removes the need for a tabbed interface to begin with.

      This method automatically handles the reevaluation of the container hierarchy to keep wrapper-container usage at a minimum. Since DockingManager makes this callback automatic, developers normally will not need to call this method explicitly. However, when removing a component from a DefaultDockingPort using application code, developers should keep in mind to use this method instead of remove().

      Specified by:
      undock in interface DockingPort
      Overrides:
      undock in class DefaultDockingPort
      Parameters:
      comp - the Component to be undocked.
      Returns:
      a boolean indicating the success of the operation
      See Also:

    • dragStarted

      public void dragStarted(DockingEvent evt)
      Description copied from class: DefaultDockingPort
      No operation. Provided as a method stub to fulfull the DockingListener interface contract.
      Specified by:
      dragStarted in interface DockingListener
      Overrides:
      dragStarted in class DefaultDockingPort
      Parameters:
      evt - the DockingEvent to respond to.
      See Also:

    • undockingComplete

      public void undockingComplete(DockingEvent evt)
      Description copied from class: DefaultDockingPort
      No operation. Provided as a method stub to fulfull the DockingListener interface contract.
      Specified by:
      undockingComplete in interface DockingListener
      Overrides:
      undockingComplete in class DefaultDockingPort
      Parameters:
      evt - the DockingEvent to respond to.
      See Also:

    • toggleListeners

      protected void toggleListeners(Component comp, boolean add)

    • installListeners

      protected void installListeners(Dockable dockable)

    • uninstallListeners

      protected void uninstallListeners(Dockable dockable)

    • getDockableCount

      public int getDockableCount()

    • getFrameDragSources

      protected Set getFrameDragSources(Dockable dockable)