TLspMGRSGridStyle.Builder (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.view.lightspeed.painter.grid.mgrs.TLspMGRSGridStyle.Builder<B>

Enclosing class:: TLspMGRSGridStyle

public static class TLspMGRSGridStyle.Builder<B extends TLspMGRSGridStyle.Builder<B>>
extends Object

Builder for MGRS styles.

Since:: 2012.1

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`B`	`all(TLspMGRSGridStyle aMGRSStyle)` Sets all parameters on the builder based on the given MGRS style.
`B`	`axes(EnumSet<TLspMGRSGridStyle.Axis> aAxes)` This method specifies to which axes the subsequent calls, related to styling, are applied.
`B`	`body()` After calling this method, all subsequent `interval()`, `styles()`, `customizableStyles()`, … calls will apply to all grid lines.
`B`	`body(TLspMGRSGridStyle.MGRSLevel aMGRSLevel)` After calling this method, all subsequent `interval()`, `styles()`, `customizableStyles()`, … calls will apply to all grid lines of the given level.
`B`	`body(TLspMGRSGridStyle.MGRSType aMgrsType)` After calling this method, all subsequent `interval()`, `styles()`, `customizableStyles()`, … calls will apply to all grid lines of the given type (UTM or UPS).
`B`	`body(TLspMGRSGridStyle.MGRSType aMgrsType, TLspMGRSGridStyle.MGRSLevel aMGRSLevel)` After calling this method, all subsequent `interval()`, `styles()`, `customizableStyles()`, … calls will apply to all grid lines of the given type/level combination.
`TLspMGRSGridStyle`	`build()` Creates a new `TLspMGRSGridStyle` from this builder.
`B`	`customizableStyles(Collection<TLspCustomizableStyle> aStyles)` This method specifies the customizable styles to use for the current MGRS type/level/interval combination.
`B`	`customizableStyles(TLspCustomizableStyle... aStyles)` This method specifies the customizable styles to use for the current MGRS type/level/interval combination.
`B`	`defaultMGRSGridStyle()` Returns a default `TLspMGRSGridStyle` that uses MGRS label formatting.
`B`	`defaultUtmUpsGridStyle()` Returns a default `TLspMGRSGridStyle` that uses UTM/UPS label formatting.
`B`	`format(String aCoordinatePattern)` This method specifies the format pattern to use for the labels of the current MGRS type/level/interval combination.
`B`	`interval(double aMin, double aMax)` After calling this method, all subsequent `styles()`, `customizableStyles()`, … calls will only apply to the given scale interval.
`B`	`keepLabelsInView(boolean aKeepLabelsInView)` This method specifies that the labeling algorithm attempts to keep all labels inside the view.
`B`	`label()` After calling this method, all subsequent `interval()`, `styles()`, `customizableStyles()`, … calls will apply to all grid labels.
`B`	`label(TLspMGRSGridStyle.MGRSLevel aMGRSLevel)` After calling this method, all subsequent `interval()`, `styles()`, `customizableStyles()`, … calls will apply to all grid labels of the given level.
`B`	`label(TLspMGRSGridStyle.MGRSType aMgrsType)` After calling this method, all subsequent `interval()`, `styles()`, `customizableStyles()`, … calls will apply to all grid labels of the given type (UTM or UPS).
`B`	`label(TLspMGRSGridStyle.MGRSType aMgrsType, TLspMGRSGridStyle.MGRSLevel aMGRSLevel)` After calling this method, all subsequent `interval()`, `styles()`, `customizableStyles()`, … calls will apply to all grid labels of the given type/level combination.
`B`	`labelEdgeOffset(double aEdgeOffset)` This method specifies the offset of the label, away from the edge of the view.
`B`	`labelEdgeOffset(double aEdgeOffsetLeft, double aEdgeOffsetRight, double aEdgeOffsetBottom, double aEdgeOffsetTop)` This method specifies the offsets of the label, away from the edges of the view, one offset for each side of the view.
`B`	`labelGridOffset(double aGridOffset)` This method specifies the offset of the label, away from the grid line to which it is attached.
`B`	`labelLinePosition(TLspMGRSGridStyle.LinePosition aLinePosition)` This method specifies the position of the line labels of the current spacing/interval combination with respect to the line.
`B`	`labelOrientation(TLspMGRSGridStyle.Orientation aOrientation)` This method specifies the orientation to use for the labels of the current MGRS type/level/interval combination.
`B`	`labelPosition(TLspMGRSGridStyle.LabelPosition aLabelPosition)` This method specifies the position of the line labels of the current spacing/interval combination with respect to the view.
`B`	`overlay()` After calling this method, all subsequent `interval()`, `styles()`, `customizableStyles()`, … calls will only apply to all overlay labels.
`B`	`styles(ALspStyle... aStyles)` This method specifies the styles to use for the current MGRS type/level/interval combination.
`B`	`styles(Collection<ALspStyle> aStyles)` This method specifies the styles to use for the current MGRS type/level/interval combination.

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

- Method Detail
  - defaultMGRSGridStyle
```
public B defaultMGRSGridStyle()
```
    Returns a default TLspMGRSGridStyle that uses MGRS label formatting.
    
    Returns:
    
    a default TLspMGRSGridStyle that uses MGRS label formatting.
  - defaultUtmUpsGridStyle
```
public B defaultUtmUpsGridStyle()
```
    Returns a default TLspMGRSGridStyle that uses UTM/UPS label formatting.
    
    Returns:
    
    a default TLspMGRSGridStyle that uses UTM/UPS label formatting.
  - body
```
public B body()
```
    After calling this method, all subsequent interval(), styles(), customizableStyles(), … calls will apply to all grid lines. I.e. UTM as well as UPS, and all grid levels.
    When no subsequent interval() or styles() call is done, a default interval and default styles are chosen. Note that the default interval might not be a good default. See interval for more information.
    For an example of how to use this method, see TLspMGRSGridStyle.
    
    Returns:
    
    this builder
  - body
```
public B body(TLspMGRSGridStyle.MGRSType aMgrsType)
```
    After calling this method, all subsequent interval(), styles(), customizableStyles(), … calls will apply to all grid lines of the given type (UTM or UPS).
    When no subsequent interval() or styles() call is done, a default interval and default styles are chosen. Note that the default interval might not be a good default. See interval for more information.
    For an example of how to use this method, see TLspMGRSGridStyle.
    
    Parameters:
    
    aMgrsType - the MGRS type (UPS or UTM)
    
    Returns:
    
    this builder
  - body
```
public B body(TLspMGRSGridStyle.MGRSLevel aMGRSLevel)
```
    After calling this method, all subsequent interval(), styles(), customizableStyles(), … calls will apply to all grid lines of the given level. E.g. to all UTM 100K lines, and to all UPS 100K lines.
    When no subsequent interval() or styles() call is done, a default interval and default styles are chosen. Note that the default interval might not be a good default. See interval for more information.
    For an example of how to use this method, see TLspMGRSGridStyle.
    
    Parameters:
    
    aMGRSLevel - the MGRS level
    
    Returns:
    
    this builder
  - body
```
public B body(TLspMGRSGridStyle.MGRSType aMgrsType,
              TLspMGRSGridStyle.MGRSLevel aMGRSLevel)
```
    After calling this method, all subsequent interval(), styles(), customizableStyles(), … calls will apply to all grid lines of the given type/level combination. E.g. to all UTM 100K lines.
    When no subsequent interval() or styles() call is done, a default interval and default styles are chosen. Note that the default interval might not be a good default. See interval for more information.
    For an example of how to use this method, see TLspMGRSGridStyle.
    
    Parameters:
    
    aMgrsType - the MGRS type (UTM or UPS)
    
    aMGRSLevel - the MGRS level
    
    Returns:
    
    this builder
  - label
```
public B label()
```
    After calling this method, all subsequent interval(), styles(), customizableStyles(), … calls will apply to all grid labels. I.e. UTM as well as UPS, and all grid levels.
    When no subsequent interval() or styles() call is done, a default interval and default styles are chosen. Note that the default interval might not be a good default. See interval for more information.
    For an example of how to use this method, see TLspMGRSGridStyle.
    
    Returns:
    
    this builder
  - label
```
public B label(TLspMGRSGridStyle.MGRSType aMgrsType)
```
    After calling this method, all subsequent interval(), styles(), customizableStyles(), … calls will apply to all grid labels of the given type (UTM or UPS).
    When no subsequent interval() or styles() call is done, a default interval and default styles are chosen. Note that the default interval might not be a good default. See interval for more information.
    For an example of how to use this method, see TLspMGRSGridStyle.
    
    Parameters:
    
    aMgrsType - the MGRS type (UPS or UTM)
    
    Returns:
    
    this builder
  - label
```
public B label(TLspMGRSGridStyle.MGRSLevel aMGRSLevel)
```
    After calling this method, all subsequent interval(), styles(), customizableStyles(), … calls will apply to all grid labels of the given level. E.g. to all UTM 100K labels, and to all UPS 100K labels.
    When no subsequent interval() or styles() call is done, a default interval and default styles are chosen. Note that the default interval might not be a good default. See interval for more information.
    For an example of how to use this method, see TLspMGRSGridStyle.
    
    Parameters:
    
    aMGRSLevel - the MGRS level
    
    Returns:
    
    this builder
  - label
```
public B label(TLspMGRSGridStyle.MGRSType aMgrsType,
               TLspMGRSGridStyle.MGRSLevel aMGRSLevel)
```
    After calling this method, all subsequent interval(), styles(), customizableStyles(), … calls will apply to all grid labels of the given type/level combination. E.g. to all UTM 100K labels.
    When no subsequent interval() or styles() call is done, a default interval and default styles are chosen. Note that the default interval might not be a good default. See interval for more information.
    For an example of how to use this method, see TLspMGRSGridStyle.
    
    Parameters:
    
    aMgrsType - the MGRS type (UTM or UPS)
    
    aMGRSLevel - the MGRS level
    
    Returns:
    
    this builder
  - overlay
```
public B overlay()
```
    After calling this method, all subsequent interval(), styles(), customizableStyles(), … calls will only apply to all overlay labels. See also TLspMGRSGridOverlayLabelBuilder.
    When no subsequent interval() or styles() call is done, a default interval and default styles are chosen.
    For an example of how to use this method, see TLspMGRSGridStyle.
    
    Returns:
    
    this builder
  - interval
```
public B interval(double aMin,
                  double aMax)
```
    After calling this method, all subsequent styles(), customizableStyles(), … calls will only apply to the given scale interval. It is possible to define multiple scale intervals for every line or label type/level. In order to do this, the interval method (and its subsequent calls) can be called multiple times.
    When not calling this method after calling one of the body or label methods, an interval from 0 (completely zoomed out) to Double.MAX_VALUE (completely zoomed in) is used. So if you want to use the same styles for every scale, this method should not be called.
    Note that it is important to choose realistic scales for each level. Not doing so may cause the grid to switch to a less detailed level. For example when specifying an interval from 0 (completely zoomed out) to Double.MAX_VALUE (completely zoomed in) for the 1 meter square level, too much geometry would need to be generated when zoomed out. To prevent this, the grid layer may switch to a less detailed level. This problem should be prevented by choosing a higher minimum scale.
    When specifying overlapping intervals, it's not specified, which styles will be used. It is advised to only specify non-overlapping intervals for the same (mgrs type/level/body or label) combination.
    For an example of how to use this method, see TLspMGRSGridStyle.
    
    Parameters:
    
    aMin - the minimum scale
    
    aMax - the maximum scale
    
    Returns:
    
    this builder
  - axes
```
public B axes(EnumSet<TLspMGRSGridStyle.Axis> aAxes)
```
    This method specifies to which axes the subsequent calls, related to styling, are applied. It can be used to specify different styles, label formats, ... for each axis. This method only affects calls that are done after this method call.
    
    Examples:
```
   // For the X axis, the labels will be formatted and styled differently from the Y axis.
   TLspMGRSGridStyle.Builder builder = TLspMGRSGridStyle.newBuilder();
   builder.label(SQUARES_10000M).interval(interval);
   builder.axis(EnumSet.of(Axis.X)).styles(styles1).format(formatX);
   builder.axis(EnumSet.of(Axis.Y)).styles(styles2).format(formatY);
 
```
```
   // For the X axis, the labels will be formatted differently from the Y axis labels.
   // Both axes will use the same styles.
   TLspMGRSGridStyle.Builder builder = TLspMGRSGridStyle.newBuilder();
   builder.label(SQUARES_10000M).interval(interval);
   builder.styles(style1, style2);
   builder.axis(EnumSet.of(Axis.X)).format(formatX);
   builder.axis(EnumSet.of(Axis.Y)).format(formatY);
 
```
    Parameters:
    
    aAxes - the axes for which the subsequent calls are applied.
    
    Returns:
    
    this builder.
    
    Since:
    
    2018.0
  - styles
```
public B styles(Collection<ALspStyle> aStyles)
```
    This method specifies the styles to use for the current MGRS type/level/interval combination. Keep in mind that not all styles are supported (see TLspMGRSGridStyle for more information).
    For an example of how to use this method, see TLspMGRSGridStyle.
    Either this method or the customizableStyles method should be called at least once after calling one of the body, label or interval methods. Otherwise, default styling is used.
    The difference between the styles() and customizableStyles() method is that the latter accepts TLspCustomizableStyle instances which will be exposed through the ILspStyler which is set on the resulting layer. That styler will implement the ILspCustomizableStyler interface and expose those customizable styles. The styles passed in the styles() method will not be exposed. The benefit of the customizableStyles() method is that it is possible to customize the styles later on (for example through a user interface). If no customization is needed afterwards, the styles() method has the advantage to skip the overhead of creating TLspCustomizableStyle instances.
    
    Parameters:
    
    aStyles - the styles to use.
    
    Returns:
    
    this builder
  - styles
```
public B styles(ALspStyle... aStyles)
```
    This method specifies the styles to use for the current MGRS type/level/interval combination. For more information, see styles(Collection).
    
    Parameters:
    
    aStyles - the styles to use
    
    Returns:
    
    this builder
  - customizableStyles
```
public B customizableStyles(Collection<TLspCustomizableStyle> aStyles)
```
    This method specifies the customizable styles to use for the current MGRS type/level/interval combination. Keep in mind that not all styles are supported (see TLspMGRSGridStyle for more information).
    For an example of how to use this method, see TLspMGRSGridStyle.
    Either this method or the styles method should be called at least once after calling one of the body, label or interval methods. Otherwise, default styling is used.
    The difference between the styles() and customizableStyles() method is that the latter accepts TLspCustomizableStyle instances which will be exposed through the ILspStyler which is set on the resulting layer. That styler will implement the ILspCustomizableStyler interface and expose those customizable styles. The styles passed in the styles() method will not be exposed. The benefit of the customizableStyles() method is that it is possible to customize the styles later on (for example through a user interface). If no customization is needed afterwards, the styles() method has the advantage to skip the overhead of creating TLspCustomizableStyle instances.
    
    Parameters:
    
    aStyles - the styles to use.
    
    Returns:
    
    this builder
  - customizableStyles
```
public B customizableStyles(TLspCustomizableStyle... aStyles)
```
    This method specifies the customizable styles to use for the current MGRS type/level/interval combination. For more information, see customizableStyles(Collection).
    
    Parameters:
    
    aStyles - the styles to use
    
    Returns:
    
    this builder
  - format
```
public B format(String aCoordinatePattern)
```
    This method specifies the format pattern to use for the labels of the current MGRS type/level/interval combination. This method has no effect for bodies. This pattern can be used to specify MGRS coordinates or UTM/UPS coordinates.
    If this method is not called, a default format is used.
    The format in BNF notation (expressions enclosed in [] brackets are optional, expressions enclosed in {} brackets may be omitted or repeated):
```
 <pattern>          ::= [<zone>] [<separator> <band>] [<coordinates>]
 <zone>             ::= "Z"
 <band>             ::= "B"
 <coordinates>      ::= <mgrs_coordinates> | <utm_coordinates>
 <mgrs_coordinates> ::= [<separator> <id100k>] [<separator> <x> <separator> <y>]
 <utm_coordinates>  ::= [<separator> <u> <separator> <v>]
 <id100k>           ::= "S"
 <x>                ::= "X" <mgrs_precision>
 <y>                ::= "Y" <mgrs_precision>
 <mgrs_precision>   ::= "0" | "1" | "2" | "3" | "4" | "5"
 <u>                ::= "U" <utm_precision>
 <v>                ::= "V" <utm_precision>
 <utm_precision>    ::= "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7"
 <separator>        ::= { ? any character ? }
 
```
    For example:
    - "33UES 12345 54321" has format "ZBS X5 Y5"
    - "33U 123456 7654321" has format "ZB U6 V7"
    Depending on the label, only some parts of the format string will be used. For example, when displaying grid line labels, only the X or Y part of the format string will be used (e.g. it can be used to specify if "12345" or "1234" is displayed).
    Parameters:
    
    aCoordinatePattern - the pattern used to format the label text
    
    Returns:
    
    this builder.
  - labelOrientation
```
public B labelOrientation(TLspMGRSGridStyle.Orientation aOrientation)
```
    This method specifies the orientation to use for the labels of the current MGRS type/level/interval combination. This method will only work when it is called after one of the label() methods. It will throw an exception otherwise.
    If this method is not called, a default orientation is used, ALONG_LINE.
    
    Parameters:
    
    aOrientation - the orientation to use.
    
    Returns:
    
    this builder.
  - labelPosition
```
public B labelPosition(TLspMGRSGridStyle.LabelPosition aLabelPosition)
```
    This method specifies the position of the line labels of the current spacing/interval combination with respect to the view. They can for example be placed at the left or at the right edge of the view, or both. For example, when a label is placed at the east or south side of a line, it will be placed at the left or lower edge of the view when using a rectangular projection like mercator.
    
    If this method is not called, a default label position is used, WEST_AND_SOUTH.
    
    Parameters:
    
    aLabelPosition - the label position to use.
    
    Returns:
    
    this builder
    
    Since:
    
    2017.0
  - labelLinePosition
```
public B labelLinePosition(TLspMGRSGridStyle.LinePosition aLinePosition)
```
    This method specifies the position of the line labels of the current spacing/interval combination with respect to the line. They can for example be placed at the left or at the right of the line.
    
    If this method is not called, a default label position is used, ABOVE_OR_LEFT.
    
    Parameters:
    
    aLinePosition - the line position to use.
    
    Returns:
    
    this builder
    
    Since:
    
    2017.0
  - labelGridOffset
```
public B labelGridOffset(double aGridOffset)
```
    This method specifies the offset of the label, away from the grid line to which it is attached. It is applied for the labels of the current MGRS type/level/interval combination. This method will only work when it is called after one of the label() methods. It will throw an exception otherwise.
    If this method is not called, a default offset is used, 3.0.
    
    Parameters:
    
    aGridOffset - the line offset to use.
    
    Returns:
    
    this builder
  - labelEdgeOffset
```
public B labelEdgeOffset(double aEdgeOffset)
```
    This method specifies the offset of the label, away from the edge of the view. It is applied for the labels of the current MGRS type/level/interval combination. This method will only work when it is called after one of the label() methods. It will throw an exception otherwise.
    If this method is not called, a default offset is used, 6.0.
    
    Parameters:
    
    aEdgeOffset - the border offset to use.
    
    Returns:
    
    this builder
  - labelEdgeOffset
```
public B labelEdgeOffset(double aEdgeOffsetLeft,
                         double aEdgeOffsetRight,
                         double aEdgeOffsetBottom,
                         double aEdgeOffsetTop)
```
    This method specifies the offsets of the label, away from the edges of the view, one offset for each side of the view. It is applied for the labels of the current MGRS type/level/interval combination. This method will only work when it is called after one of the label() methods. It will throw an exception otherwise.
    If this method is not called, a default offset is used, 6.0.
    
    Parameters:
    
    aEdgeOffsetLeft - the offset of the label from the left edge of the view.
    
    aEdgeOffsetRight - the offset of the label from the right edge of the view.
    
    aEdgeOffsetBottom - the offset of the label from the bottom edge of the view.
    
    aEdgeOffsetTop - the offset of the label from the top edge of the view.
    
    Returns:
    
    this builder
    
    Since:
    
    2018.0
  - keepLabelsInView
```
public B keepLabelsInView(boolean aKeepLabelsInView)
```
    This method specifies that the labeling algorithm attempts to keep all labels inside the view. This happens automatically for many labels, but not for some. For example: by default, the 100k labels are placed in the middle of their square. If the middle of the square is outside the view, its label is not visible. By passing true to this method, the 100k square labels will be placed inside the square, and inside the view.
    
    By default, this parameter is set to false.
    
    Parameters:
    
    aKeepLabelsInView - to keep all labels inside the view.
    
    Returns:
    
    this builder
    
    Since:
    
    2018.0
  - all
```
public B all(TLspMGRSGridStyle aMGRSStyle)
```
    Sets all parameters on the builder based on the given MGRS style.
    This is useful for example to create a new style that has almost all properties equal to another style.
    
    Parameters:
    
    aMGRSStyle - the MGRS style to copy
    
    Returns:
    
    this styler
  - build
```
public TLspMGRSGridStyle build()
```
    Creates a new TLspMGRSGridStyle from this builder.
    
    Returns:
    
    a new TLspMGRSGridStyle

Defense SymbologyClass TLspMGRSGridStyle.Builder<B extends TLspMGRSGridStyle.Builder<B>>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

defaultMGRSGridStyle

defaultUtmUpsGridStyle

body

body

body

body

label

label

label

label

overlay

interval

axes

styles

styles

customizableStyles

customizableStyles

format

labelOrientation

labelPosition

labelLinePosition

labelGridOffset

labelEdgeOffset

labelEdgeOffset

keepLabelsInView

all

build