Package com.luciad.view.map

Class TLcdXYGridOverlayLabelBuilder

java.lang.Object

com.luciad.view.map.TLcdXYGridOverlayLabelBuilder

public final class TLcdXYGridOverlayLabelBuilder
extends Object

Builder that makes it possible to create XY grid overlay labels. These are text labels that are added to the view and show a grid coordinate. These labels can have a pre-defined content, and style. Note that overlay labels are not attached to grid lines, but are added to the view.

When all properties of TLcdXYGridOverlayLabelBuilder are set, it can be added to a TLcdXYGridLayer, which will build the overlay label, and paint it on the view.

An example of how to use this builder:

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

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

Since:

2016.0

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
TLcdXYGridOverlayLabelBuilder	all(TLcdXYGridOverlayLabelBuilder aBuilder)	Copies all properties from the given builder.
TLcdXYGridOverlayLabelBuilder	content(TLcdXYGridOverlayLabelBuilder.Content aContent)	The content which is being displayed.
static TLcdXYGridOverlayLabelBuilder	newBuilder()	Creates a new builder, capable of adding XY grid labels.
TLcdXYGridOverlayLabelBuilder	style(TLcdXYGridStyle aXYGridStyle)	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 TLcdXYGridOverlayLabelBuilder newBuilder()

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

Returns:

a new builder

content

public TLcdXYGridOverlayLabelBuilder content(TLcdXYGridOverlayLabelBuilder.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 TLcdXYGridOverlayLabelBuilder style(TLcdXYGridStyle aXYGridStyle)

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

This method is optional: when it is not called, a default style is used.

Parameters:

aXYGridStyle - the XY grid style.

Returns:

this builder.

all

public TLcdXYGridOverlayLabelBuilder all(TLcdXYGridOverlayLabelBuilder aBuilder)

Copies all properties from the given builder.

Parameters:

aBuilder - a builder

Returns:

this builder.