Package hec.map

Interface WorldRegionHolder

public interface WorldRegionHolder

  • Method Summary

    Modifier and Type
    Method
    Description
    WorldRegion
    getRegion(int idx)
    get the region for the specified region idx
    Color
    getRegionColor(int idx)
    get the region color for the specified region idx
    int
    getRegionCount()
    get the number of regions this WorldRegionHolder has
    String
    getRegionDescription(int idx)
    get the region description for the specified region idx
    String
    getRegionName(int idx)
    get the region name for the specified region idx

  • Method Details

    • getRegionCount

      int getRegionCount()
      get the number of regions this WorldRegionHolder has
      Returns:
      the number of regions

    • getRegionName

      String getRegionName(int idx)
      get the region name for the specified region idx
      Parameters:
      idx - the region idx, starting at 0
      Returns:
      the region name

    • getRegionDescription

      String getRegionDescription(int idx)
      get the region description for the specified region idx
      Parameters:
      idx - the region idx, starting at 0
      Returns:
      the region description

    • getRegionColor

      Color getRegionColor(int idx)
      get the region color for the specified region idx
      Parameters:
      idx - the region idx, starting at 0
      Returns:
      the region color

    • getRegion

      WorldRegion getRegion(int idx)
      get the region for the specified region idx
      Parameters:
      idx - the region idx, starting at 0
      Returns:
      the region