Package com.luciad.view.map.mgrs

Class TLcdMGRSGridOverlayLabelBuilder

java.lang.Object

com.luciad.view.map.mgrs.TLcdMGRSGridOverlayLabelBuilder

public final class TLcdMGRSGridOverlayLabelBuilder
extends Object

Builder that makes it possible to create MGRS overlay labels. These labels are painted on the view and show (part of) an MGRS coordinate. These labels can have a pre-defined content, and style.

An example of how to use this builder:

   TLcdMGRSGridOverlayLabelBuilder overlayLabelBuilder =
       TLcdMGRSGridOverlayLabelBuilder.newBuilder()
                                      .content(TLcdMGRSGridOverlayLabelBuilder.Content.COORDINATE_AT_CENTER)
                                      .style(gridStyle);

   TLcdMGRSGridLayer gridLayer = ...;
   gridLayer.addOverlayLabel(overlayLabelBuilder, TLcdOverlayLayout.Location.NORTH);
 

Since:

2015.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TLcdMGRSGridOverlayLabelBuilder.Content	The content that is displayed in the label.

Method Summary

Modifier and Type	Method	Description
TLcdMGRSGridOverlayLabelBuilder	all(TLcdMGRSGridOverlayLabelBuilder aBuilder)	Copies all properties from the given builder.
TLcdMGRSGridOverlayLabelBuilder	content(TLcdMGRSGridOverlayLabelBuilder.Content aContent)	The content which is being displayed.
static TLcdMGRSGridOverlayLabelBuilder	newBuilder()	Creates a new builder, capable of adding MGRS grid labels.
TLcdMGRSGridOverlayLabelBuilder	style(TLcdMGRSGridStyle aMGRSGridStyle)	The style with which the overlay label is being displayed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

newBuilder

public static TLcdMGRSGridOverlayLabelBuilder newBuilder()

Creates a new builder, capable of adding MGRS grid labels.

Returns:

a new builder

content

public TLcdMGRSGridOverlayLabelBuilder content(TLcdMGRSGridOverlayLabelBuilder.Content aContent)

The content which is being displayed.

By default, the content is COORDINATE_AT_CENTER.

Parameters:

aContent - coordinate which is being displayed.

Returns:

this builder

style

public TLcdMGRSGridOverlayLabelBuilder style(TLcdMGRSGridStyle aMGRSGridStyle)

The style with which the overlay label is being displayed. When using this method, only styles and formats set after using the TLspMGRSGridStyle.Builder.overlay() are used.

When setting a format, it is ignored when using COMMON_VIEW_COORDINATE.

Parameters:

aMGRSGridStyle - the MGRS grid style.

Returns:

this builder.

all

public TLcdMGRSGridOverlayLabelBuilder all(TLcdMGRSGridOverlayLabelBuilder aBuilder)

Copies all properties from the given builder.

Parameters:

aBuilder - a builder

Returns:

this builder.