Package org.flexdock.docking.defaults

Class DefaultRegionChecker

java.lang.Object
org.flexdock.docking.defaults.DefaultRegionChecker
All Implemented Interfaces:
DockingConstants, RegionChecker
public class DefaultRegionChecker extends Object implements RegionChecker, DockingConstants
Author:
Christopher Butler

  • Constructor Details

    • DefaultRegionChecker

      public DefaultRegionChecker()

  • Method Details

    • getRegion

      public String getRegion(Component comp, Point point)
      Returns the docking region of the supplied Component that contains the coordinates of the specified Point. If either comp or point is null, then UNKNOWN_REGION is returned. If the specified Component bounds do not contain the supplied Point, then UNKNOWN_REGION is returned.

      This implementation assumes that comp is a Component embedded within a DockingPort. If comp is itself a DockingPort, then CENTER_REGION is returned. Otherwise, the returned region is based upon a section of the bounds of the specified Component relative to the containing DockingPort.

      This method divides the specified Component's bounds into four Rectangles determined by getNorthRegion(Component c), getSouthRegion(Component c), getEastRegion(Component c), and getWestRegion(Component c), respectively. Each Rectangle is then checked to see if it contains the specified Point. The order of precedence is NORTH, SOUTH, EAST, and then WEST. If the specified Point is contained by the Component bounds but none of the sub-Rectangles, then CENTER_REGION is returned.

      For NORTH and SOUTH Rectangles, the distance is checked between the top/bottom and left or right edge of the regional bounds. If the horizontal distance to the regional edge is smaller than the vertical distance, then EAST or WEST takes precendence of NORTH or SOUTH. This allows for proper determination between "northeast", "northwest", "southeast", and "southwest" cases.

      Specified by:
      getRegion in interface RegionChecker
      Parameters:
      comp - the Component whose region is to be examined.
      point - the coordinates whose region is to be determined.
      Returns:
      the docking region containing the specified Point.
      See Also:

    • getNorthRegion

      public Rectangle getNorthRegion(Component c)
      Returns the rectangular bounds within the specified component that represent it's DockingConstants.NORTH_REGION. This method dispatches to getRegionBounds(Component c, String region), passing an argument of DockingConstants.NORTH_REGION for the region parameter. If the specified Component is null, then a null reference is returned.
      Specified by:
      getNorthRegion in interface RegionChecker
      Parameters:
      c - the Component whose north region is to be returned.
      Returns:
      the bounds containing the north region of the specified Component.
      See Also:

    • getSouthRegion

      public Rectangle getSouthRegion(Component c)
      Returns the rectangular bounds within the specified component that represent it's DockingConstants.SOUTH_REGION. This method dispatches to getRegionBounds(Component c, String region), passing an argument of DockingConstants.SOUTH_REGION for the region parameter. If the specified Component is null, then a null reference is returned.
      Specified by:
      getSouthRegion in interface RegionChecker
      Parameters:
      c - the Component whose south region is to be returned.
      Returns:
      the bounds containing the north region of the specified Component.
      See Also:

    • getEastRegion

      public Rectangle getEastRegion(Component c)
      Returns the rectangular bounds within the specified component that represent it's DockingConstants.EAST_REGION. This method dispatches to getRegionBounds(Component c, String region), passing an argument of DockingConstants.EAST_REGION for the region parameter. If the specified Component is null, then a null reference is returned.
      Specified by:
      getEastRegion in interface RegionChecker
      Parameters:
      c - the Component whose east region is to be returned.
      Returns:
      the bounds containing the north region of the specified Component.
      See Also:

    • getWestRegion

      public Rectangle getWestRegion(Component c)
      Returns the rectangular bounds within the specified component that represent it's DockingConstants.WEST_REGION. This method dispatches to getRegionBounds(Component c, String region), passing an argument of DockingConstants.WEST_REGION for the region parameter. If the specified Component is null, then a null reference is returned.
      Specified by:
      getWestRegion in interface RegionChecker
      Parameters:
      c - the Component whose west region is to be returned.
      Returns:
      the bounds containing the north region of the specified Component.
      See Also:

    • getRegionBounds

      public Rectangle getRegionBounds(Component c, String region)
      Returns the bounding Rectangle within the specified component that represents the specified region. If c or region are null, then this method returns a null reference.

      This method dispatches to getRegionSize(Component c, String region) to determine the proportional size of the specified Component dedicated to the specified region. It then multiplies this value by the relevant Component dimension (width for east/west, height for north/south) and returns a Rectangle with the resulting dimension, spanning the Component edge for the specified region.

      Specified by:
      getRegionBounds in interface RegionChecker
      Parameters:
      c - the Component whose region bounds are to be returned.
      region - the specified region that is to be examined.
      Returns:
      the bounds containing the supplied region of the specified Component.
      See Also:

    • getSiblingBounds

      public Rectangle getSiblingBounds(Component c, String region)
      Returns the bounding Rectangle within the specified component that represents the desired area to be allotted for sibling Components in the specified region. If c or region are null, then this method returns a null reference.

      This method dispatches to getSiblingSize(Component c, String region) to determine the proportional size of the specified Component dedicated to siblings in the specified region. It then multiplies this value by the relevant Component dimension (width for east/west, height for north/south) and returns a Rectangle with the resulting dimension, spanning the Component edge for the specified region.

      Specified by:
      getSiblingBounds in interface RegionChecker
      Parameters:
      c - the Component whose sibling bounds are to be returned.
      region - the specified region that is to be examined.
      Returns:
      the bounds representing the allotted sibling area for the supplied region of the specified Component.
      See Also:

    • calculateRegionalBounds

      protected Rectangle calculateRegionalBounds(Component c, String region, float size)

    • getRegionSize

      public float getRegionSize(Component c, String region)
      Returns a percentage (0.0F through 1.0F) representing the amount of space allotted for the specified region within the specified Component.

      This method resolves the Dockable associated with the specified Component and dispatches to getRegionPreference(Dockable d, String region). getRegionPreference(Dockable d, String region) attempts to invoke getDockingProperties() on the Dockable to resolve a DockablePropertySet instance and return from its getRegionInset(String region) method.

      If the specified Component is null, no Dockable can be resolved, or no value is specified in the Dockable's associated DockingProps instance, then the default value of RegionChecker.DEFAULT_REGION_SIZE is returned.

      Specified by:
      getRegionSize in interface RegionChecker
      Parameters:
      c - the Component whose region is to be examined.
      region - the specified region that is to be examined.
      Returns:
      the percentage of the specified Component allotted for the specified region.
      See Also:

    • getSiblingSize

      public float getSiblingSize(Component c, String region)
      Returns a percentage (0.0F through 1.0F) representing the amount of space allotted for sibling Component docked to the specified region within the specified Component.

      This method resolves the Dockable associated with the specified Component and dispatches to getSiblingPreference(Dockable d, String region). getSiblingPreference(Dockable d, String region) attempts to invoke getDockingProperties() on the Dockable to resolve a DockablePropertySet instance and return from its getSiblingSize(String region) method.

      If the specified Component is null, no Dockable can be resolved, or no value is specified in the Dockable's associated DockingProps instance, then the default value of RegionChecker.DEFAULT_SIBLING_SIZE is returned.

      Specified by:
      getSiblingSize in interface RegionChecker
      Parameters:
      c - the Component whose sibling size is to be examined.
      region - the specified region that is to be examined.
      Returns:
      the percentage of the specified Component allotted for the siblings within the specified region.
      See Also:

    • getDockingInset

      protected static float getDockingInset(Float value, float defaultVal, float max, float min)

    • checkBounds

      protected static float checkBounds(float val, float max, float min)

    • validateRegionSize

      public static float validateRegionSize(float size)
      Returns size if it is between the values RegionChecker.MIN_REGION_SIZE and RegionChecker.MAX_REGION_SIZE. If size is less than RegionChecker.MIN_REGION_SIZE, then RegionChecker.MIN_REGION_SIZE is returned. If size is greater than RegionChecker.MAX_REGION_SIZE, then RegionChecker.MAX_REGION_SIZE is returned.
      Returns:
      a valid size value between RegionChecker.MIN_REGION_SIZE and RegionChecker.MAX_REGION_SIZE, inclusive.

    • validateSiblingSize

      public static float validateSiblingSize(float size)
      Returns size if it is between the values RegionChecker.MIN_SIBILNG_SIZE and RegionChecker.MAX_SIBILNG_SIZE. If size is less than RegionChecker.MIN_SIBILNG_SIZE, then RegionChecker.MIN_SIBILNG_SIZE is returned. If size is greater than RegionChecker.MAX_SIBILNG_SIZE, then RegionChecker.MAX_SIBILNG_SIZE is returned.
      Returns:
      a valid size value between RegionChecker.MIN_SIBILNG_SIZE and RegionChecker.MAX_SIBILNG_SIZE, inclusive.

    • getRegionPreference

      public static float getRegionPreference(Dockable d, String region)
      Returns a percentage (0.0F through 1.0F) representing the amount of space allotted for the specified region within the specified Dockable.

      This method calls getDockingProperties() on the Dockable to resolve a DockablePropertySet instance. It then invokes getRegionInset(String region) on the DockablePropertySet to retrieve the preferred region size. If the Dockable is null or no region preference can be found, then the default value of RegionChecker.DEFAULT_REGION_SIZE is returned. Otherwise, the retrieved region preference is passed through validateRegionSize(float size) and returned.

      Parameters:
      d - the Dockable whose region is to be checked
      region - the region of the specified Dockable to be checked
      Returns:
      a percentage (0.0F through 1.0F) representing the amount of space allotted for the specified region within the specified Dockable.
      See Also:

    • getSiblingPreference

      public static float getSiblingPreference(Dockable d, String region)
      Returns a percentage (0.0F through 1.0F) representing the amount of space allotted for sibling Components docked to the specified region within the specified Dockable.

      This method calls getDockingProperties() on the Dockable to resolve a DockablePropertySet instance. It then invokes getSiblingSize(String region) on the DockablePropertySet to retrieve the preferred sibling size. If the Dockable is null or no sibling preference can be found, then the default value of RegionChecker.DEFAULT_SIBLING_SIZE is returned. Otherwise, the retrieved region preference is passed through validateSiblingSize(float size) and returned.

      Parameters:
      d - the Dockable whose sibling size is to be checked
      region - the region of the specified Dockable to be checked
      Returns:
      a percentage (0.0F through 1.0F) representing the amount of space allotted for sibling Components docked to the specified region within the specified Dockable.
      See Also: