Class MGRSGraticuleLayer

    • Field Detail

      • GRATICULE_UTM_GRID

        public static final java.lang.String GRATICULE_UTM_GRID
        Graticule for the UTM grid.
        See Also:
        Constant Field Values
      • GRATICULE_100000M

        public static final java.lang.String GRATICULE_100000M
        Graticule for the 100,000 meter grid, nested inside the UTM grid.
        See Also:
        Constant Field Values
      • GRATICULE_10000M

        public static final java.lang.String GRATICULE_10000M
        Graticule for the 10,000 meter grid, nested inside the UTM grid.
        See Also:
        Constant Field Values
      • GRATICULE_1000M

        public static final java.lang.String GRATICULE_1000M
        Graticule for the 1,000 meter grid, nested inside the UTM grid.
        See Also:
        Constant Field Values
      • GRATICULE_100M

        public static final java.lang.String GRATICULE_100M
        Graticule for the 100 meter grid, nested inside the UTM grid.
        See Also:
        Constant Field Values
      • GRATICULE_10M

        public static final java.lang.String GRATICULE_10M
        Graticule for the 10 meter grid, nested inside the UTM grid.
        See Also:
        Constant Field Values
      • GRATICULE_1M

        public static final java.lang.String GRATICULE_1M
        Graticule for the 1 meter grid, nested inside the UTM grid.
        See Also:
        Constant Field Values
    • Constructor Detail

      • MGRSGraticuleLayer

        public MGRSGraticuleLayer()
        Creates a new MGRSGraticuleLayer, with default graticule attributes.
    • Method Detail

      • getMaximumGraticuleResolution

        public java.lang.String getMaximumGraticuleResolution()
        Returns the maxiumum resolution graticule that will be rendered, or null if no graticules will be rendered. By default, all graticules are rendered, and this will return GRATICULE_1M.
        Returns:
        maximum resolution rendered.
      • setMaximumGraticuleResolution

        public void setMaximumGraticuleResolution​(java.lang.String graticuleType)
        Sets the maxiumum resolution graticule that will be rendered.
        Parameters:
        graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
        Throws:
        java.lang.IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.
      • getGraticuleLineColor

        public java.awt.Color getGraticuleLineColor​(java.lang.String graticuleType)
        Returns the line color of the specified graticule.
        Overrides:
        getGraticuleLineColor in class AbstractGraticuleLayer
        Parameters:
        graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
        Returns:
        Color of the the graticule line.
        Throws:
        java.lang.IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.
      • setGraticuleLineColor

        public void setGraticuleLineColor​(java.awt.Color color,
                                          java.lang.String graticuleType)
        Sets the line rendering color for the specified graticule.
        Overrides:
        setGraticuleLineColor in class AbstractGraticuleLayer
        Parameters:
        color - the line color for the specified graticule.
        graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
        Throws:
        java.lang.IllegalArgumentException - ifcolor is null, if graticuleType is null, or if graticuleType is not a valid type.
      • setGraticuleLineColor

        public void setGraticuleLineColor​(java.awt.Color color,
                                          java.lang.Iterable<java.lang.String> graticuleType)
        Sets the line rendering color for the specified graticules.
        Parameters:
        color - the line color for the specified graticules.
        graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
        Throws:
        java.lang.IllegalArgumentException - ifcolor is null, if graticuleType is null, or if graticuleType is not a valid type.
      • setGraticuleLineColor

        public void setGraticuleLineColor​(java.awt.Color color)
        Sets the line rendering color for all graticules.
        Overrides:
        setGraticuleLineColor in class UTMBaseGraticuleLayer
        Parameters:
        color - the line color.
        Throws:
        java.lang.IllegalArgumentException - if color is null.
      • getGraticuleLineWidth

        public double getGraticuleLineWidth​(java.lang.String graticuleType)
        Returns the line width of the specified graticule.
        Overrides:
        getGraticuleLineWidth in class AbstractGraticuleLayer
        Parameters:
        graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
        Returns:
        width of the graticule line.
        Throws:
        java.lang.IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.
      • setGraticuleLineWidth

        public void setGraticuleLineWidth​(double lineWidth,
                                          java.lang.String graticuleType)
        Sets the line rendering width for the specified graticule.
        Overrides:
        setGraticuleLineWidth in class AbstractGraticuleLayer
        Parameters:
        lineWidth - the line rendering width for the specified graticule.
        graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
        Throws:
        java.lang.IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.
      • setGraticuleLineWidth

        public void setGraticuleLineWidth​(double lineWidth,
                                          java.lang.Iterable<java.lang.String> graticuleType)
        Sets the line rendering width for the specified graticules.
        Parameters:
        lineWidth - the line rendering width for the specified graticules.
        graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
        Throws:
        java.lang.IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.
      • setGraticuleLineWidth

        public void setGraticuleLineWidth​(double lineWidth)
        Sets the line rendering width for all graticules.
        Overrides:
        setGraticuleLineWidth in class UTMBaseGraticuleLayer
        Parameters:
        lineWidth - the line rendering width.
      • getGraticuleLineStyle

        public java.lang.String getGraticuleLineStyle​(java.lang.String graticuleType)
        Returns the line rendering style of the specified graticule.
        Overrides:
        getGraticuleLineStyle in class AbstractGraticuleLayer
        Parameters:
        graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
        Returns:
        line rendering style of the graticule.
        Throws:
        java.lang.IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.
      • setGraticuleLineStyle

        public void setGraticuleLineStyle​(java.lang.String lineStyle,
                                          java.lang.String graticuleType)
        Sets the line rendering style for the specified graticule.
        Overrides:
        setGraticuleLineStyle in class AbstractGraticuleLayer
        Parameters:
        lineStyle - the line rendering style for the specified graticule. One of LINE_STYLE_PLAIN, LINE_STYLE_DASHED, or LINE_STYLE_DOTTED.
        graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M
        Throws:
        java.lang.IllegalArgumentException - if lineStyle is null, if graticuleType is null, or if graticuleType is not a valid type.
      • setGraticuleLineStyle

        public void setGraticuleLineStyle​(java.lang.String lineStyle,
                                          java.lang.Iterable<java.lang.String> graticuleType)
        Sets the line rendering style for the specified graticules.
        Parameters:
        lineStyle - the line rendering style for the specified graticules. One of LINE_STYLE_PLAIN, LINE_STYLE_DASHED, or LINE_STYLE_DOTTED.
        graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M
        Throws:
        java.lang.IllegalArgumentException - if lineStyle is null, if graticuleType is null, or if graticuleType is not a valid type.
      • setGraticuleLineStyle

        public void setGraticuleLineStyle​(java.lang.String lineStyle)
        Sets the line rendering style for all graticules.
        Overrides:
        setGraticuleLineStyle in class UTMBaseGraticuleLayer
        Parameters:
        lineStyle - the line rendering style. One of LINE_STYLE_PLAIN, LINE_STYLE_DASHED, or LINE_STYLE_DOTTED.
        Throws:
        java.lang.IllegalArgumentException - if lineStyle is null.
      • isDrawLabels

        public boolean isDrawLabels​(java.lang.String graticuleType)
        Returns whether specified graticule labels will be rendered.
        Overrides:
        isDrawLabels in class AbstractGraticuleLayer
        Parameters:
        graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
        Returns:
        true if graticule labels are will be rendered; false otherwise.
        Throws:
        java.lang.IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.
      • setDrawLabels

        public void setDrawLabels​(boolean drawLabels,
                                  java.lang.String graticuleType)
        Sets whether the specified graticule labels will be rendered. If true, the graticule labels will be rendered. Otherwise, the graticule labels will not be rendered, but other graticules will not be affected.
        Overrides:
        setDrawLabels in class AbstractGraticuleLayer
        Parameters:
        drawLabels - true to render graticule labels; false to disable rendering.
        graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
        Throws:
        java.lang.IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.
      • setDrawLabels

        public void setDrawLabels​(boolean drawLabels,
                                  java.lang.Iterable<java.lang.String> graticuleType)
        Sets whether the specified graticule labels will be rendered. If true, the graticule labels will be rendered. Otherwise, the graticule labels will not be rendered, but other graticules will not be affected.
        Parameters:
        drawLabels - true to render graticule labels; false to disable rendering.
        graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
        Throws:
        java.lang.IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.
      • setDrawLabels

        public void setDrawLabels​(boolean drawLabels)
        Sets whether all graticule labels will be rendered. If true, all graticule labels will be rendered. Otherwise, all graticule labels will not be rendered.
        Overrides:
        setDrawLabels in class UTMBaseGraticuleLayer
        Parameters:
        drawLabels - true to render all graticule labels; false to disable rendering.
      • getLabelColor

        public java.awt.Color getLabelColor​(java.lang.String graticuleType)
        Returns the label color of the specified graticule.
        Overrides:
        getLabelColor in class AbstractGraticuleLayer
        Parameters:
        graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
        Returns:
        Color of the the graticule label.
        Throws:
        java.lang.IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.
      • setLabelColor

        public void setLabelColor​(java.awt.Color color,
                                  java.lang.String graticuleType)
        Sets the label rendering color for the specified graticule.
        Overrides:
        setLabelColor in class AbstractGraticuleLayer
        Parameters:
        color - the label color for the specified graticule.
        graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
        Throws:
        java.lang.IllegalArgumentException - ifcolor is null, if graticuleType is null, or if graticuleType is not a valid type.
      • setLabelColor

        public void setLabelColor​(java.awt.Color color,
                                  java.lang.Iterable<java.lang.String> graticuleType)
        Sets the label rendering color for the specified graticules.
        Parameters:
        color - the label color for the specified graticules.
        graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
        Throws:
        java.lang.IllegalArgumentException - ifcolor is null, if graticuleType is null, or if graticuleType is not a valid type.
      • setLabelColor

        public void setLabelColor​(java.awt.Color color)
        Sets the label rendering color for all graticules.
        Overrides:
        setLabelColor in class UTMBaseGraticuleLayer
        Parameters:
        color - the label color.
        Throws:
        java.lang.IllegalArgumentException - if color is null.
      • getLabelFont

        public java.awt.Font getLabelFont​(java.lang.String graticuleType)
        Returns the label font of the specified graticule.
        Overrides:
        getLabelFont in class AbstractGraticuleLayer
        Parameters:
        graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
        Returns:
        Font of the graticule label.
        Throws:
        java.lang.IllegalArgumentException - if graticuleType is null, or if graticuleType is not a valid type.
      • setLabelFont

        public void setLabelFont​(java.awt.Font font,
                                 java.lang.String graticuleType)
        Sets the label rendering font for the specified graticule.
        Overrides:
        setLabelFont in class AbstractGraticuleLayer
        Parameters:
        font - the label font for the specified graticule.
        graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
        Throws:
        java.lang.IllegalArgumentException - iffont is null, if graticuleType is null, or if graticuleType is not a valid type.
      • setLabelFont

        public void setLabelFont​(java.awt.Font font,
                                 java.lang.Iterable<java.lang.String> graticuleType)
        Sets the label rendering font for the specified graticules.
        Parameters:
        font - the label font for the specified graticules.
        graticuleType - one of GRATICULE_UTM, GRATICULE_UTM_GRID, GRATICULE_100000M, GRATICULE_10000M, GRATICULE_1000M, GRATICULE_100M, GRATICULE_10M, or GRATICULE_1M.
        Throws:
        java.lang.IllegalArgumentException - iffont is null, if graticuleType is null, or if graticuleType is not a valid type.
      • setLabelFont

        public void setLabelFont​(java.awt.Font font)
        Sets the label rendering font for all graticules.
        Overrides:
        setLabelFont in class UTMBaseGraticuleLayer
        Parameters:
        font - the label font.
        Throws:
        java.lang.IllegalArgumentException - if font is null.
      • getOrderedTypes

        protected java.lang.String[] getOrderedTypes()
      • selectMGRSRenderables

        protected void selectMGRSRenderables​(DrawContext dc,
                                             Sector vs)