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

Class TLspCGRSGridOverlayLabelBuilder

java.lang.Object

com.luciad.view.lightspeed.painter.grid.cgrs.TLspCGRSGridOverlayLabelBuilder

public class TLspCGRSGridOverlayLabelBuilder
extends Object

Builder that makes it possible to create Common Grid Reference System (CGRS) overlay labels. These labels are added to the view and show (part of) a CGRS coordinate. The 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 TLspCGRSGridLayerBuilder. 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:

    JComponent component = TLspCGRSGridOverlayLabelBuilder
        .newBuilder()
        .view(view)
        .model(model)
        .content(TLspCGRSGridOverlayLabelBuilder.Content.COORDINATE_AT_CENTER)
        .style(gridStyle)
        .build();

Since:

2021.1

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
TLspCGRSGridOverlayLabelBuilder	all(TLspCGRSGridOverlayLabelBuilder aBuilder)	Copies all properties from the given builder.
JComponent	build()	Creates an CGRS grid label.
TLspCGRSGridOverlayLabelBuilder	content(TLspCGRSGridOverlayLabelBuilder.Content aContent)	The content which is being displayed.
TLspCGRSGridOverlayLabelBuilder	model(ILcdModel aModel)	The model containing a CGRSGrid.
static TLspCGRSGridOverlayLabelBuilder	newBuilder()	Creates a new builder, capable of adding CGRS grid labels.
TLspCGRSGridOverlayLabelBuilder	style(TLspCGRSGridStyle aCGRSGridStyle)	The style with which the overlay label is being displayed.
TLspCGRSGridOverlayLabelBuilder	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 TLspCGRSGridOverlayLabelBuilder newBuilder()

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

Returns:

a new builder

view

public TLspCGRSGridOverlayLabelBuilder view(ILspView aView)

The view for which the overlay labels should be added.

Parameters:

aView - the view.

Returns:

this builder.

model

public TLspCGRSGridOverlayLabelBuilder model(ILcdModel aModel)

The model containing a CGRSGrid. The model is used to get the grid bounds and the geodetic reference.

Parameters:

aModel - the model.

Returns:

this builder

content

public TLspCGRSGridOverlayLabelBuilder content(TLspCGRSGridOverlayLabelBuilder.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 TLspCGRSGridOverlayLabelBuilder style(TLspCGRSGridStyle aCGRSGridStyle)

The style with which the overlay label is being displayed. When using this method, only styles and formats set after using the TLspCGRSGridStyle.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:

aCGRSGridStyle - the CGRS grid style.

Returns:

this builder.

all

public TLspCGRSGridOverlayLabelBuilder all(TLspCGRSGridOverlayLabelBuilder aBuilder)

Copies all properties from the given builder.

Parameters:

aBuilder - a builder

Returns:

this builder.

build

public JComponent build()

Creates an CGRS grid label.

Returns:

the created label.