Package com.luciad.view.lightspeed.painter.grid.mgrs

Class TLspMGRSGridOverlayLabelBuilder

java.lang.Object

com.luciad.view.lightspeed.painter.grid.mgrs.TLspMGRSGridOverlayLabelBuilder

public final class TLspMGRSGridOverlayLabelBuilder
extends Object

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

The overlay label builder can be used in 2 ways:

• To build a JComponent that contains a coordinate readout. This component can be used as any Swing component. It can for example be added to the overlay panel or to a UI panel.
• To add to TLspXYGridLayerBuilder, see TLspXYGridLayerBuilder#overlayLabel. When using this method, the overlay label will be added to the overlay panel of the view. On top of that, the visibility of the overlay label will be synchronized with the visibility of the layer.

An example of how to use this builder:

    // See TLspMGRSGridStyle for more information on configuring the grid style
    JComponent component = TLspMGRSGridOverlayLabelBuilder
        .newBuilder()
        .view(view)
        .content(TLspMGRSGridOverlayLabelBuilder.Content.COORDINATE_AT_CENTER)
        .build();

Since:

2012.1

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
TLspMGRSGridOverlayLabelBuilder	all(TLspMGRSGridOverlayLabelBuilder aBuilder)	Copies all properties from the given builder.
JComponent	build()	Creates an MGRS grid label.
TLspMGRSGridOverlayLabelBuilder	content(TLspMGRSGridOverlayLabelBuilder.Content aContent)	The content which is being displayed.
static TLspMGRSGridOverlayLabelBuilder	newBuilder()	Creates a new builder, capable of adding MGRS grid labels.
TLspMGRSGridOverlayLabelBuilder	style(TLspMGRSGridStyle aMGRSGridStyle)	The style with which the overlay label is being displayed.
TLspMGRSGridOverlayLabelBuilder	view(ILspView aView)	The view for which the overlay labels should be added.

Methods inherited from class java.lang.Object

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

Method Details

newBuilder

public static TLspMGRSGridOverlayLabelBuilder newBuilder()

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

Returns:

a new builder

view

public TLspMGRSGridOverlayLabelBuilder view(ILspView aView)

The view for which the overlay labels should be added.

Parameters:

aView - the view.

Returns:

this builder.

content

public TLspMGRSGridOverlayLabelBuilder content(TLspMGRSGridOverlayLabelBuilder.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 TLspMGRSGridOverlayLabelBuilder style(TLspMGRSGridStyle 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. Only the following styles are supported:

• TLspLabelOpacityStyle
• TLspLabelBoxStyle
• TLspTextStyle

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

Parameters:

aMGRSGridStyle - the MGRS grid style.

Returns:

this builder.

all

public TLspMGRSGridOverlayLabelBuilder all(TLspMGRSGridOverlayLabelBuilder aBuilder)

Copies all properties from the given builder.

Parameters:

aBuilder - a builder

Returns:

this builder.

build

public JComponent build()

Creates an MGRS grid label.

Returns:

the created label.