java.lang.Object
- mil.nga.mgrs.grid.Grids

```
public class Grids
extends Object
```
Grids

Author:

osbornb

Constructor Summary

Constructors
Constructor	Description
`Grids()`	Constructor, all grid types enabled per property configurations
`Grids(Collection<GridType> types)`	Constructor
`Grids(GridType... types)`	Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Grids`	`create()`	Create with all grid types enabled
`static Grids`	`create(Collection<GridType> types)`	Create with grids to enable
`static Grids`	`create(GridType... types)`	Create with grids to enable
`static Grids`	`createGZD()`	Create only Grid Zone Designator grids
`void`	`disable(Grid grid)`	Disable the grid
`void`	`disable(GridType type)`	Disable the grid type
`void`	`disableAllLabelers()`	Disable all grid labelers
`void`	`disableGrids(Collection<Grid> grids)`	Disable grids
`void`	`disableGrids(Grid... grids)`	Disable grids
`void`	`disableLabeler(GridType type)`	Disable the grid type labeler
`void`	`disableLabelers(Collection<GridType> types)`	Disable the labelers for the grid types
`void`	`disableLabelers(GridType... types)`	Disable the labelers for the grid types
`void`	`disableTypes(Collection<GridType> types)`	Disable grid types
`void`	`disableTypes(GridType... types)`	Disable grid types
`void`	`enable(Grid grid)`	Enable the grid
`void`	`enable(GridType type)`	Enable the grid type
`void`	`enableAllLabelers()`	Enable all grid labelers
`void`	`enableGrids(Collection<Grid> grids)`	Enable grids
`void`	`enableGrids(Grid... grids)`	Enable grids
`void`	`enableLabeler(GridType type)`	Enable the grid type labeler
`void`	`enableLabelers(Collection<GridType> types)`	Enable the labelers for the grid types
`void`	`enableLabelers(GridType... types)`	Enable the labelers for the grid types
`void`	`enableTypes(Collection<GridType> types)`	Enable grid types
`void`	`enableTypes(GridType... types)`	Enable grid types
`Grid`	`getGrid(GridType type)`	Get the grid
`ZoomGrids`	`getGrids(int zoom)`	Get the grids for the zoom level
`double`	`getLabelBuffer(GridType type)`	Get the label grid zone edge buffer
`Labeler`	`getLabeler(GridType type)`	Get the labeler for the grid type
`GridType`	`getPrecision(int zoom)`	Get the grid precision for the zoom level
`boolean`	`hasLabeler(GridType type)`	Has a labeler for the grid type
`boolean`	`isEnabled(GridType type)`	Is the grid type enabled
`boolean`	`isLabelerEnabled(GridType type)`	Is a labeler enabled for the grid type
`protected Grid`	`newGrid(GridType type)`	Create a new grid, override to create a specialized grid
`protected ZoomGrids`	`newZoomGrids(int zoom)`	Create a new zoom grids, override for specialized grids
`void`	`setAllColors(Color color)`	Set all grid line colors
`void`	`setAllLabelBuffers(double buffer)`	Set all label grid zone edge buffers
`void`	`setAllLabelColors(Color color)`	Set all label colors
`void`	`setAllLabelTextSizes(double textSize)`	Set all label text sizes
`void`	`setAllWidths(double width)`	Set all grid line widths
`void`	`setColor(Collection<GridType> types, Color color)`	Set the grid line color for the grid types
`void`	`setColor(Collection<GridType> types, GridType precisionType, Color color)`	Set the grid type precision line color for the grid types
`void`	`setColor(Color color, GridType... types)`	Set the grid line color for the grid types
`void`	`setColor(GridType type, Collection<GridType> precisionTypes, Color color)`	Set the grid type precision line colors for the grid type
`void`	`setColor(GridType type, Color color)`	Set the grid line color for the grid type
`void`	`setColor(GridType type, Color color, GridType... precisionTypes)`	Set the grid type precision line colors for the grid type
`void`	`setColor(GridType type, GridType precisionType, Color color)`	Set the grid type precision line color for the grid type
`void`	`setGrids(Collection<Grid> grids)`	Set the active grids
`void`	`setGrids(Grid... grids)`	Set the active grids
`void`	`setGrids(GridType... types)`	Set the active grid types
`void`	`setGridTypes(Collection<GridType> types)`	Set the active grid types
`void`	`setLabelBuffer(double buffer, GridType... types)`	Set the label grid zone edge buffer for the grid types
`void`	`setLabelBuffer(Collection<GridType> types, double buffer)`	Set the label grid zone edge buffer for the grid types
`void`	`setLabelBuffer(GridType type, double buffer)`	Set the label grid zone edge buffer
`void`	`setLabelColor(Collection<GridType> types, Color color)`	Set the label color for the grid types
`void`	`setLabelColor(Color color, GridType... types)`	Set the label color for the grid types
`void`	`setLabelColor(GridType type, Color color)`	Set the label color
`void`	`setLabeler(GridType type, Labeler labeler)`	Set the labeler for the grid type
`void`	`setLabelMaxZoom(GridType type, Integer maxZoom)`	Set the grid maximum zoom
`void`	`setLabelMinZoom(GridType type, int minZoom)`	Set the grid minimum zoom
`void`	`setLabelTextSize(double textSize, GridType... types)`	Set the label text size for the grid types
`void`	`setLabelTextSize(Collection<GridType> types, double textSize)`	Set the label text size for the grid types
`void`	`setLabelTextSize(GridType type, double textSize)`	Set the label text size
`void`	`setLabelZoomRange(GridType type, int minZoom, Integer maxZoom)`	Set the grid zoom range
`void`	`setLinesMaxZoom(GridType type, Integer maxZoom)`	Set the grid maximum level override for drawing grid lines
`void`	`setLinesMinZoom(GridType type, Integer minZoom)`	Set the grid minimum level override for drawing grid lines
`void`	`setMaxZoom(Grid grid, Integer maxZoom)`	Set the grid maximum zoom
`void`	`setMaxZoom(GridType type, Integer maxZoom)`	Set the grid maximum zoom
`void`	`setMinZoom(Grid grid, int minZoom)`	Set the grid minimum zoom
`void`	`setMinZoom(GridType type, int minZoom)`	Set the grid minimum zoom
`void`	`setWidth(double width, GridType... types)`	Set the grid line width for the grid types
`void`	`setWidth(Collection<GridType> types, double width)`	Set the grid line width for the grid types
`void`	`setWidth(Collection<GridType> types, GridType precisionType, double width)`	Set the grid type precision line width for the grid types
`void`	`setWidth(GridType type, double width)`	Set the grid line width for the grid type
`void`	`setWidth(GridType type, double width, GridType... precisionTypes)`	Set the grid type precision line widths for the grid type
`void`	`setWidth(GridType type, Collection<GridType> precisionTypes, double width)`	Set the grid type precision line widths for the grid type
`void`	`setWidth(GridType type, GridType precisionType, double width)`	Set the grid type precision line width for the grid type
`void`	`setZoomRange(Grid grid, int minZoom, Integer maxZoom)`	Set the grid zoom range
`void`	`setZoomRange(GridType type, int minZoom, Integer maxZoom)`	Set the grid zoom range

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Grids
```
public Grids()
```
    Constructor, all grid types enabled per property configurations
  - Grids
```
public Grids(GridType... types)
```
    Constructor
    
    Parameters:
    
    types - grid types to enable
  - Grids
```
public Grids(Collection<GridType> types)
```
    Constructor
    
    Parameters:
    
    types - grid types to enable
- Method Detail
  - create
```
public static Grids create()
```
    Create with all grid types enabled
    
    Returns:
    
    grids
  - create
```
public static Grids create(GridType... types)
```
    Create with grids to enable
    
    Parameters:
    
    types - grid types to enable
    
    Returns:
    
    grids
  - create
```
public static Grids create(Collection<GridType> types)
```
    Create with grids to enable
    
    Parameters:
    
    types - grid types to enable
    
    Returns:
    
    grids
  - createGZD
```
public static Grids createGZD()
```
    Create only Grid Zone Designator grids
    
    Returns:
    
    grids
  - newGrid
```
protected Grid newGrid(GridType type)
```
    Create a new grid, override to create a specialized grid
    
    Parameters:
    
    type - grid type
    
    Returns:
    
    grid
  - getGrid
```
public Grid getGrid(GridType type)
```
    Get the grid
    
    Parameters:
    
    type - grid type
    
    Returns:
    
    grid
  - getGrids
```
public ZoomGrids getGrids(int zoom)
```
    Get the grids for the zoom level
    
    Parameters:
    
    zoom - zoom level
    
    Returns:
    
    grids
  - newZoomGrids
```
protected ZoomGrids newZoomGrids(int zoom)
```
    Create a new zoom grids, override for specialized grids
    
    Parameters:
    
    zoom - zoom level
    
    Returns:
    
    zoom grids
  - getPrecision
```
public GridType getPrecision(int zoom)
```
    Get the grid precision for the zoom level
    
    Parameters:
    
    zoom - zoom level
    
    Returns:
    
    grid type precision
  - setGrids
```
public void setGrids(GridType... types)
```
    Set the active grid types
    
    Parameters:
    
    types - grid types
  - setGrids
```
public void setGrids(Grid... grids)
```
    Set the active grids
    
    Parameters:
    
    grids - grids
  - setGridTypes
```
public void setGridTypes(Collection<GridType> types)
```
    Set the active grid types
    
    Parameters:
    
    types - grid types
  - setGrids
```
public void setGrids(Collection<Grid> grids)
```
    Set the active grids
    
    Parameters:
    
    grids - grids
  - enableTypes
```
public void enableTypes(GridType... types)
```
    Enable grid types
    
    Parameters:
    
    types - grid types
  - enableGrids
```
public void enableGrids(Grid... grids)
```
    Enable grids
    
    Parameters:
    
    grids - grids
  - enableTypes
```
public void enableTypes(Collection<GridType> types)
```
    Enable grid types
    
    Parameters:
    
    types - grid types
  - enableGrids
```
public void enableGrids(Collection<Grid> grids)
```
    Enable grids
    
    Parameters:
    
    grids - grids
  - disableTypes
```
public void disableTypes(GridType... types)
```
    Disable grid types
    
    Parameters:
    
    types - grid types
  - disableGrids
```
public void disableGrids(Grid... grids)
```
    Disable grids
    
    Parameters:
    
    grids - grids
  - disableTypes
```
public void disableTypes(Collection<GridType> types)
```
    Disable grid types
    
    Parameters:
    
    types - grid types
  - disableGrids
```
public void disableGrids(Collection<Grid> grids)
```
    Disable grids
    
    Parameters:
    
    grids - grids
  - isEnabled
```
public boolean isEnabled(GridType type)
```
    Is the grid type enabled
    
    Parameters:
    
    type - grid type
    
    Returns:
    
    true if enabled
  - enable
```
public void enable(GridType type)
```
    Enable the grid type
    
    Parameters:
    
    type - grid type
  - enable
```
public void enable(Grid grid)
```
    Enable the grid
    
    Parameters:
    
    grid - grid
  - disable
```
public void disable(GridType type)
```
    Disable the grid type
    
    Parameters:
    
    type - grid type
  - disable
```
public void disable(Grid grid)
```
    Disable the grid
    
    Parameters:
    
    grid - grid
  - setMinZoom
```
public void setMinZoom(GridType type,
                       int minZoom)
```
    Set the grid minimum zoom
    
    Parameters:
    
    type - grid type
    
    minZoom - minimum zoom
  - setMinZoom
```
public void setMinZoom(Grid grid,
                       int minZoom)
```
    Set the grid minimum zoom
    
    Parameters:
    
    grid - grid
    
    minZoom - minimum zoom
  - setMaxZoom
```
public void setMaxZoom(GridType type,
                       Integer maxZoom)
```
    Set the grid maximum zoom
    
    Parameters:
    
    type - grid type
    
    maxZoom - maximum zoom
  - setMaxZoom
```
public void setMaxZoom(Grid grid,
                       Integer maxZoom)
```
    Set the grid maximum zoom
    
    Parameters:
    
    grid - grid
    
    maxZoom - maximum zoom
  - setZoomRange
```
public void setZoomRange(GridType type,
                         int minZoom,
                         Integer maxZoom)
```
    Set the grid zoom range
    
    Parameters:
    
    type - grid type
    
    minZoom - minimum zoom
    
    maxZoom - maximum zoom
  - setZoomRange
```
public void setZoomRange(Grid grid,
                         int minZoom,
                         Integer maxZoom)
```
    Set the grid zoom range
    
    Parameters:
    
    grid - grid
    
    minZoom - minimum zoom
    
    maxZoom - maximum zoom
  - setLinesMinZoom
```
public void setLinesMinZoom(GridType type,
                            Integer minZoom)
```
    Set the grid minimum level override for drawing grid lines
    
    Parameters:
    
    type - grid type
    
    minZoom - minimum zoom level or null to remove
  - setLinesMaxZoom
```
public void setLinesMaxZoom(GridType type,
                            Integer maxZoom)
```
    Set the grid maximum level override for drawing grid lines
    
    Parameters:
    
    type - grid type
    
    maxZoom - maximum zoom level or null to remove
  - setAllColors
```
public void setAllColors(Color color)
```
    Set all grid line colors
    
    Parameters:
    
    color - grid line color
  - setColor
```
public void setColor(Color color,
                     GridType... types)
```
    Set the grid line color for the grid types
    
    Parameters:
    
    color - grid line color
    
    types - grid types
  - setColor
```
public void setColor(Collection<GridType> types,
                     Color color)
```
    Set the grid line color for the grid types
    
    Parameters:
    
    types - grid types
    
    color - grid line color
  - setColor
```
public void setColor(GridType type,
                     Color color)
```
    Set the grid line color for the grid type
    
    Parameters:
    
    type - grid type
    
    color - grid line color
  - setAllWidths
```
public void setAllWidths(double width)
```
    Set all grid line widths
    
    Parameters:
    
    width - grid line width
  - setWidth
```
public void setWidth(double width,
                     GridType... types)
```
    Set the grid line width for the grid types
    
    Parameters:
    
    width - grid line width
    
    types - grid types
  - setWidth
```
public void setWidth(Collection<GridType> types,
                     double width)
```
    Set the grid line width for the grid types
    
    Parameters:
    
    types - grid types
    
    width - grid line width
  - setWidth
```
public void setWidth(GridType type,
                     double width)
```
    Set the grid line width for the grid type
    
    Parameters:
    
    type - grid type
    
    width - grid line width
  - setColor
```
public void setColor(Collection<GridType> types,
                     GridType precisionType,
                     Color color)
```
    Set the grid type precision line color for the grid types
    
    Parameters:
    
    types - grid types
    
    precisionType - precision grid type
    
    color - grid line color
  - setColor
```
public void setColor(GridType type,
                     Color color,
                     GridType... precisionTypes)
```
    Set the grid type precision line colors for the grid type
    
    Parameters:
    
    type - grid type
    
    color - grid line color
    
    precisionTypes - precision grid types
  - setColor
```
public void setColor(GridType type,
                     Collection<GridType> precisionTypes,
                     Color color)
```
    Set the grid type precision line colors for the grid type
    
    Parameters:
    
    type - grid type
    
    precisionTypes - precision grid types
    
    color - grid line color
  - setColor
```
public void setColor(GridType type,
                     GridType precisionType,
                     Color color)
```
    Set the grid type precision line color for the grid type
    
    Parameters:
    
    type - grid type
    
    precisionType - precision grid type
    
    color - grid line color
  - setWidth
```
public void setWidth(Collection<GridType> types,
                     GridType precisionType,
                     double width)
```
    Set the grid type precision line width for the grid types
    
    Parameters:
    
    types - grid types
    
    precisionType - precision grid type
    
    width - grid line width
  - setWidth
```
public void setWidth(GridType type,
                     double width,
                     GridType... precisionTypes)
```
    Set the grid type precision line widths for the grid type
    
    Parameters:
    
    type - grid type
    
    width - grid line width
    
    precisionTypes - precision grid types
  - setWidth
```
public void setWidth(GridType type,
                     Collection<GridType> precisionTypes,
                     double width)
```
    Set the grid type precision line widths for the grid type
    
    Parameters:
    
    type - grid type
    
    precisionTypes - precision grid types
    
    width - grid line width
  - setWidth
```
public void setWidth(GridType type,
                     GridType precisionType,
                     double width)
```
    Set the grid type precision line width for the grid type
    
    Parameters:
    
    type - grid type
    
    precisionType - precision grid type
    
    width - grid line width
  - getLabeler
```
public Labeler getLabeler(GridType type)
```
    Get the labeler for the grid type
    
    Parameters:
    
    type - grid type
    
    Returns:
    
    labeler or null
  - hasLabeler
```
public boolean hasLabeler(GridType type)
```
    Has a labeler for the grid type
    
    Parameters:
    
    type - grid type
    
    Returns:
    
    true if has labeler
  - setLabeler
```
public void setLabeler(GridType type,
                       Labeler labeler)
```
    Set the labeler for the grid type
    
    Parameters:
    
    type - grid type
    
    labeler - labeler
  - enableAllLabelers
```
public void enableAllLabelers()
```
    Enable all grid labelers
  - disableAllLabelers
```
public void disableAllLabelers()
```
    Disable all grid labelers
  - enableLabelers
```
public void enableLabelers(GridType... types)
```
    Enable the labelers for the grid types
    
    Parameters:
    
    types - grid types
  - enableLabelers
```
public void enableLabelers(Collection<GridType> types)
```
    Enable the labelers for the grid types
    
    Parameters:
    
    types - grid types
  - disableLabelers
```
public void disableLabelers(GridType... types)
```
    Disable the labelers for the grid types
    
    Parameters:
    
    types - grid types
  - disableLabelers
```
public void disableLabelers(Collection<GridType> types)
```
    Disable the labelers for the grid types
    
    Parameters:
    
    types - grid types
  - isLabelerEnabled
```
public boolean isLabelerEnabled(GridType type)
```
    Is a labeler enabled for the grid type
    
    Parameters:
    
    type - grid type
    
    Returns:
    
    true if labeler enabled
  - enableLabeler
```
public void enableLabeler(GridType type)
```
    Enable the grid type labeler
    
    Parameters:
    
    type - grid type
  - disableLabeler
```
public void disableLabeler(GridType type)
```
    Disable the grid type labeler
    
    Parameters:
    
    type - grid type
  - setLabelMinZoom
```
public void setLabelMinZoom(GridType type,
                            int minZoom)
```
    Set the grid minimum zoom
    
    Parameters:
    
    type - grid type
    
    minZoom - minimum zoom
  - setLabelMaxZoom
```
public void setLabelMaxZoom(GridType type,
                            Integer maxZoom)
```
    Set the grid maximum zoom
    
    Parameters:
    
    type - grid type
    
    maxZoom - maximum zoom
  - setLabelZoomRange
```
public void setLabelZoomRange(GridType type,
                              int minZoom,
                              Integer maxZoom)
```
    Set the grid zoom range
    
    Parameters:
    
    type - grid type
    
    minZoom - minimum zoom
    
    maxZoom - maximum zoom
  - setAllLabelBuffers
```
public void setAllLabelBuffers(double buffer)
```
    Set all label grid zone edge buffers
    
    Parameters:
    
    buffer - label buffer (greater than or equal to 0.0 and less than 0.5)
  - setLabelBuffer
```
public void setLabelBuffer(double buffer,
                           GridType... types)
```
    Set the label grid zone edge buffer for the grid types
    
    Parameters:
    
    buffer - label buffer (greater than or equal to 0.0 and less than 0.5)
    
    types - grid types
  - setLabelBuffer
```
public void setLabelBuffer(Collection<GridType> types,
                           double buffer)
```
    Set the label grid zone edge buffer for the grid types
    
    Parameters:
    
    types - grid types
    
    buffer - label buffer (greater than or equal to 0.0 and less than 0.5)
  - getLabelBuffer
```
public double getLabelBuffer(GridType type)
```
    Get the label grid zone edge buffer
    
    Parameters:
    
    type - grid type
    
    Returns:
    
    label buffer (greater than or equal to 0.0 and less than 0.5)
  - setLabelBuffer
```
public void setLabelBuffer(GridType type,
                           double buffer)
```
    Set the label grid zone edge buffer
    
    Parameters:
    
    type - grid type
    
    buffer - label buffer (greater than or equal to 0.0 and less than 0.5)
  - setAllLabelColors
```
public void setAllLabelColors(Color color)
```
    Set all label colors
    
    Parameters:
    
    color - label color
  - setLabelColor
```
public void setLabelColor(Color color,
                          GridType... types)
```
    Set the label color for the grid types
    
    Parameters:
    
    color - label color
    
    types - grid types
  - setLabelColor
```
public void setLabelColor(Collection<GridType> types,
                          Color color)
```
    Set the label color for the grid types
    
    Parameters:
    
    types - grid types
    
    color - label color
  - setLabelColor
```
public void setLabelColor(GridType type,
                          Color color)
```
    Set the label color
    
    Parameters:
    
    type - grid type
    
    color - label color
  - setAllLabelTextSizes
```
public void setAllLabelTextSizes(double textSize)
```
    Set all label text sizes
    
    Parameters:
    
    textSize - label text size
  - setLabelTextSize
```
public void setLabelTextSize(double textSize,
                             GridType... types)
```
    Set the label text size for the grid types
    
    Parameters:
    
    textSize - label text size
    
    types - grid types
  - setLabelTextSize
```
public void setLabelTextSize(Collection<GridType> types,
                             double textSize)
```
    Set the label text size for the grid types
    
    Parameters:
    
    types - grid types
    
    textSize - label text size
  - setLabelTextSize
```
public void setLabelTextSize(GridType type,
                             double textSize)
```
    Set the label text size
    
    Parameters:
    
    type - grid type
    
    textSize - label text size

Class Grids

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Grids

Grids

Grids

Method Detail

create

create

create

createGZD

newGrid

getGrid

getGrids

newZoomGrids

getPrecision

setGrids

setGrids

setGridTypes

setGrids

enableTypes

enableGrids

enableTypes

enableGrids

disableTypes

disableGrids

disableTypes

disableGrids

isEnabled

enable

enable

disable

disable

setMinZoom

setMinZoom

setMaxZoom

setMaxZoom

setZoomRange

setZoomRange

setLinesMinZoom

setLinesMaxZoom

setAllColors

setColor

setColor

setColor

setAllWidths

setWidth

setWidth

setWidth

setColor

setColor

setColor

setColor

setWidth

setWidth

setWidth

setWidth

getLabeler

hasLabeler

setLabeler

enableAllLabelers

disableAllLabelers

enableLabelers

enableLabelers

disableLabelers

disableLabelers

isLabelerEnabled

enableLabeler

disableLabeler

setLabelMinZoom

setLabelMaxZoom

setLabelZoomRange

setAllLabelBuffers

setLabelBuffer

setLabelBuffer

getLabelBuffer

setLabelBuffer

setAllLabelColors