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);
Modifier and Type | Class and Description |
---|---|
static class |
TLcdXYGridOverlayLabelBuilder.Content
The content that is displayed in the label.
|
Modifier and Type | Method and 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.
|
public static TLcdXYGridOverlayLabelBuilder newBuilder()
public TLcdXYGridOverlayLabelBuilder content(TLcdXYGridOverlayLabelBuilder.Content aContent)
COORDINATE_AT_CENTER
.aContent
- coordinate which is being displayed.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.
aXYGridStyle
- the XY grid style.public TLcdXYGridOverlayLabelBuilder all(TLcdXYGridOverlayLabelBuilder aBuilder)
aBuilder
- a builder