public static java.lang.String findRegion​(java.awt.Component comp)

Returns the docking region within the current split docking layout containing the specified Component. If comp is null, then a null reference is returned. If comp is not in a split layout, then CENTER_REGION is returned.

This method resolves the associated Dockable and DockingPort for the specified Component and backtracks through the docking layout to find a split layout. If a split layout is found, then the region retured by this method is calculated relative to its sibling in the layout.

public boolean dock​(Dockable dockable,
                    DockingPort port,
                    java.lang.String region)

Docks the specified Dockable into the supplied region of the specified DockingPort. This method is meant for programmatic docking, as opposed to realtime, event-based docking operations. As such, it defers processing to dock(Dockable dockable, DockingPort port, String region, DragOperation token), passing a null argument for the DragOperation parameter. This implies that there is no event-based drag operation currently in progress to control the semantics of the docking operation, only that an attempt should be made to dock the specified Dockable into the specified DockingPort.

This method will return false if dockable or port are null, or if region is not a valid region according to the specified DockingPort. If a Dockable is currently docked within the specified DockingPort, then that Dockable's territorial properties are also checked and this method may return false if the territory is blocked. Finally, this method will return false if the specified Dockable is already docked within the supplied region of the specified

Specified by:

dock in interface DockingStrategy

Parameters:

dockable - the Dockable we wish to dock

port - the DockingPort into which we wish to dock

region - the region of the specified DockingPort into which we wish to dock.

Returns:

true if the docking operation was successful, false. otherwise.

See Also:

dock(Dockable, DockingPort, String, DragOperation), Dockable.getDockingProperties(), DockablePropertySet.isTerritoryBlocked(String)

public boolean dock​(Dockable dockable,
                    DockingPort port,
                    java.lang.String region,
                    DragOperation operation)

Docks the specified Dockable into the supplied region of the specified DockingPort. This method is meant for realtime, event-based docking based on an in-progress drag operation. It is not recommended for developers to call this method programmatically, except to pass in a null DragOperation argument. *

The DragOperation parameter, if present, will control the semantics of the docking operation based upon current mouse position, drag threshold, and a customizable drag context Map. For instance, the DragOperation may contain information regarding the Dockable over which the mouse is currently hovered, whether the user is attempting to drag a Dockable outside the bounds of any existing windows (perhaps in an attempt to float the Dockable), or whether the current distance offset from the original drag point sufficiently warrants a valid docking operation.

If the DragOperation is null, then this method will attempt to programmatically dock the specified Dockable into the supplied region of the specified DockingPort without regard to external event-based criteria. This is in accordance with the behavior specified by dock(Dockable dockable, DockingPort port, String region). This method will return false if dockable or port are null, or if region is not a valid region according to the specified DockingPort. If a Dockable is currently docked within the specified DockingPort, then that Dockable's territorial properties are also checked and this method may return false if the territory is blocked. If a DragOperation is present, then this method will return false if the required drag threshold has not been exceeded. Finally, this method will return false if the specified Dockable is already docked within the supplied region of the specified

Specified by:

dock in interface DockingStrategy

Parameters:

dockable - the Dockable we wish to dock

port - the DockingPort into which we wish to dock

region - the region of the specified DockingPort into which we wish to dock.

operation - the DragOperation describing the state of the application/mouse at the point in time in which we're attempting to dock.

Returns:

true if the docking operation was successful, false. otherwise.

See Also:

dock(Dockable, DockingPort, String, DragOperation), Dockable.getDockingProperties(), DockablePropertySet.isTerritoryBlocked(String)

public boolean undock​(Dockable dockable)

Undocks the specified Dockable from it's parent DockingPort. If dockable is null or is not currently docked within a DockingPort, then this method returns false.

public DockingPort createDockingPort​(DockingPort base)

Returns a new DefaultDockingPort with characteristics similar to the specified base DockingPort. If the base DockingPort is a DefaultDockingPort, then the returned DockingPort will share the base DockingPort's border manager and tabbed drag-source flag. The returned DockingPort's isRoot() method will return false.

public javax.swing.JSplitPane createSplitPane​(DockingPort base,
                                              java.lang.String region,
                                              float percent)

Returns a new DockingSplitPane based on the specified DockingPort. and region. Creation of the DockingSplitPane is deferred to an internal protected method to allow for overriding by subclasses. A client property is set on the returned split pane with the key DockingConstants.REGION to indicate the creation region of the split pane for non-DockingSplitPanes returned by overriding subclasses.

This method determines the "elder" component of the split pane by checking whether the new creation region is in the TOP or LEFT (NORTH_REGION or WEST_REGION). If the creation region, representing where the new Dockable will be docked, is not in the top or left, then the elder Component in the split pane must be. This information is used to initialize the resize weight of the split pane, setting resize weight to 1 if the elder is in the top or left of the split pane and 0 if not. This gives the elder Component in the resulting split pane priority in the layout with resizing the split pane.

If the creation region is NORTH_REGION or SOUTH_REGION, the returned split pane is initialized with a VERTICAL_SPLIT orientation; otherwise a HORIZONTAL_SPLIT orientation is used.

Before returning, the border is removed from the split pane, its divider size is set to 3, and if possible the border is removed from the split pane divider. This is to avoid an excessive compound border effect for embedded Components within the split pane that may have their own borders.

public javax.swing.JSplitPane createSplitPane​(DockingPort base,
                                              java.lang.String region)

Returns a new DockingSplitPane based on the specified DockingPort. and region. Creation of the DockingSplitPane is deferred to an internal protected method to allow for overriding by subclasses. A client property is set on the returned split pane with the key DockingConstants.REGION to indicate the creation region of the split pane for non-DockingSplitPanes returned by overriding subclasses.

This method determines the "elder" component of the split pane by checking whether the new creation region is in the TOP or LEFT (NORTH_REGION or WEST_REGION). If the creation region, representing where the new Dockable will be docked, is not in the top or left, then the elder Component in the split pane must be. This information is used to initialize the resize weight of the split pane, setting resize weight to 1 if the elder is in the top or left of the split pane and 0 if not. This gives the elder Component in the resulting split pane priority in the layout with resizing the split pane.

If the creation region is NORTH_REGION or SOUTH_REGION, the returned split pane is initialized with a VERTICAL_SPLIT orientation; otherwise a HORIZONTAL_SPLIT orientation is used.

Before returning, the border is removed from the split pane, its divider size is set to 3, and if possible the border is removed from the split pane divider. This is to avoid an excessive compound border effect for embedded Components within the split pane that may have their own borders.

public int getInitialDividerLocation​(DockingPort port,
                                     javax.swing.JSplitPane splitPane)

Returns the initial divider location to be used by the specified JSplitPane when it is embedded within the specified DockingPort. It is assumed that the JSplitPane parameter is embedded within the specified DockingPort, is validated, visible, and its dimensions are non-zero.

This method gets the "size" of the specified DockingPort based on the orientation of the split pane (width for horizontal split, height for vertical split) minus the DockingPort's insets. It then dispatches to getDividerProportion(DockingPort port, JSplitPane splitPane) to determine the preferred proportion of the split pane divider. The returned value for this method is the product of the DockingPort size and the split proportion.

If either port or splitPane parameters are null, then this method returns 0.

public double getDividerProportion​(DockingPort port,
                                   javax.swing.JSplitPane splitPane)

Returns the desired divider proportion of the specified JSplitPane after rendering. This method assumes that the JSplitPane parameter is, or will be embedded within the specified DockingPort. This method does not assume that the JSplitPane has been validated and that it's current dimensions are non-zero.

If either port or splitPane parameters are null, then this method returns the default value of RegionChecker.DEFAULT_SIBLING_SIZE. Otherwise the "elder" component within the JSplitPane is determined to see if it is contained within a sub-DockingPort. If the "elder" Component cannot be determined, or it is not contained within a sub-DockingPort, then the default value of RegionChecker.DEFAULT_SIBLING_SIZE is returned.

If the "elder" Component is successfully resolved inside a sub-DockingPort, then a check is done on the sub-port for the client property DefaultDockingStrategy.PREFERRED_PROPORTION. If this value is found, then the primitive float version of it is returned.

Failing these checks, the Dockable is resolved for the "elder" Component in the specified JSplitPane via DockingManager.getDockable(Component comp). If no Dockable can be found, then RegionChecker.DEFAULT_SIBLING_SIZE is returned.

Otherwise, the DockingPortPropertySet is retrieved from the specified DockingPort and its getRegionChecker() method is called. getSiblingSize(Component c, String region) is invoked on the returned RegionChecker passing the "elder" Component in the split pane and the creation region resolved for the specified JSplitPane. This resolves the preferred sibling size for the elder Dockable component. If the elder Component is in the top/left of the split pane, then 1F-prefSize is returned. Otherwise, the preferred sibling size is returned.