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

Class TLspGeorefGridOverlayLabelBuilder

java.lang.Object

com.luciad.view.lightspeed.painter.grid.TLspGeorefGridOverlayLabelBuilder

public class TLspGeorefGridOverlayLabelBuilder
extends Object

Builder that makes it possible to create Georef overlay labels. These labels are added to the view and show (part of) a georef 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 TLspGeorefGridLayerBuilder. 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 = TLspGeorefGridOverlayLabelBuilder.newBuilder(view)
       .content(TLspGeorefGridOverlayLabelBuilder.Content.COORDINATE_AT_CENTER)
       .style(gridStyle)
       .build();
 

Since:

2015.0

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
TLspGeorefGridOverlayLabelBuilder	all(TLspGeorefGridOverlayLabelBuilder aBuilder)	Copies all properties from the given builder.
JComponent	build()	Creates an Georef grid label.
TLspGeorefGridOverlayLabelBuilder	content(TLspGeorefGridOverlayLabelBuilder.Content aContent)	The content which is being displayed.
static TLspGeorefGridOverlayLabelBuilder	newBuilder()	Creates a new builder, capable of adding Georef grid labels.
TLspGeorefGridOverlayLabelBuilder	style(TLspGeorefGridStyle aGeorefGridStyle)	The style with which the overlay label is being displayed.
TLspGeorefGridOverlayLabelBuilder	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 TLspGeorefGridOverlayLabelBuilder newBuilder()

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

Returns:

a new builder

view

public TLspGeorefGridOverlayLabelBuilder view(ILspView aView)

The view for which the overlay labels should be added.

Parameters:

aView - the view.

Returns:

this builder.

content

public TLspGeorefGridOverlayLabelBuilder content(TLspGeorefGridOverlayLabelBuilder.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 TLspGeorefGridOverlayLabelBuilder style(TLspGeorefGridStyle aGeorefGridStyle)

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

aGeorefGridStyle - the Georef grid style.

Returns:

this builder.

all

public TLspGeorefGridOverlayLabelBuilder all(TLspGeorefGridOverlayLabelBuilder aBuilder)

Copies all properties from the given builder.

Parameters:

aBuilder - a builder

Returns:

this builder.

build

public JComponent build()

Creates an Georef grid label.

Returns:

the created label.