public class TLspCGRSGridLayerBuilder extends ALspLayerBuilder
Builder for creating ILspLayer
instances that visualize Common Grid Reference System (CGRS) grid data.
The bounds used for the CGRS grid are defined by the model,
which can be set by calling the model
builder method.
The styling of the CGRS grid and its labels can be done by creating a TLspCGRSGridStyle
and passing it to the style
builder method.
An example of how to use this builder:
TLspCGRSGridStyle gridStyle = TLspCGRSGridStyle.newBuilder().defaultCGRSGridStyle().build();
ILcdModel model = TLspCGRSGridLayerBuilder.createModel("CGRS Grid", TLcdEllipsoid.DEFAULT, new TLcdLonLatBounds(0, 40, 15, 15));
ILspLayer layer = TLspCGRSGridLayerBuilder.newBuilder()
.model(model)
.label("CGRS Grid")
.style(gridStyle)
.build();
Modifier and Type | Method and Description |
---|---|
ILspStyledLayer |
build()
Creates a new layer instance.
|
static ILcdModel |
createModel(String aModelName,
ILcdEllipsoid aEllipsoid,
ILcdBounds aBounds)
Creates a model that can be used by this builder.
|
TLspCGRSGridLayerBuilder |
label(String aLabel)
Sets the label of the layer.
|
TLspCGRSGridLayerBuilder |
layerStyle(TLspLayerStyle aLayerStyle)
Set a layer style to be used during the rendering of the layer.
|
TLspCGRSGridLayerBuilder |
layerType(ILspLayer.LayerType aLayerType)
This method is not supported for CGRS grid layers
|
TLspCGRSGridLayerBuilder |
model(ILcdModel aModel)
Sets the model of the layer.
|
static TLspCGRSGridLayerBuilder |
newBuilder()
Returns a new CGRS grid layer builder
|
TLspCGRSGridLayerBuilder |
overlayLabel(TLspCGRSGridOverlayLabelBuilder aOverlayLabelBuilder,
Object aConstraint)
Adds an overlay label to be used.
|
TLspCGRSGridLayerBuilder |
style(TLspCGRSGridStyle aCGRSGridStyle)
Sets the style to be used by this layer.
|
getIcon, getLabel, getLayerStyle, getLayerType, getModel, icon
public static TLspCGRSGridLayerBuilder newBuilder()
public static ILcdModel createModel(String aModelName, ILcdEllipsoid aEllipsoid, ILcdBounds aBounds)
Creates a model that can be used by this builder. When no model is set on the builder, a default model is used instead. When using this method, it is possible to customize the used ellipsoid and the model name. The model name is used as a default display name for the layer created by this builder.
aModelName
- The desired model nameaBounds
- The bounds of the CGRS gridaEllipsoid
- The ellipsoid on which the CGRS grid is defined.public TLspCGRSGridLayerBuilder model(ILcdModel aModel)
Sets the model of the layer. This model should be created using the createModel
method of this class. If not, an IllegalArgumentException
is thrown.
Calling this method is optional. If not called, a default model is used.
model
in class ALspLayerBuilder
aModel
- a modelIllegalArgumentException
- if the given model is not created using the createModel
method.ILcdLayer.getModel()
public TLspCGRSGridLayerBuilder label(String aLabel)
""CGRS Grid""
.label
in class ALspLayerBuilder
aLabel
- the labelILcdLayer.getLabel()
public TLspCGRSGridLayerBuilder layerType(ILspLayer.LayerType aLayerType)
layerType
in class ALspLayerBuilder
aLayerType
- the layer typeUnsupportedOperationException
- this method is not supported for CGRS grid layersILspLayer.getLayerType()
public TLspCGRSGridLayerBuilder layerStyle(TLspLayerStyle aLayerStyle)
ALspLayerBuilder
TLspLayerStyle
is used to style the layer as a whole. Layer style can for example modify the
transparency of a layer. Also, layer style can be modified after building the layer by calling
ILspLayer.setLayerStyle(TLspLayerStyle)
.layerStyle
in class ALspLayerBuilder
aLayerStyle
- the layer style. Must not be null
. If you want to set the default layer style, set TLspLayerStyle.newBuilder().build()
ILspLayer.getLayerStyle()
,
ILspLayer.setLayerStyle(TLspLayerStyle)
public TLspCGRSGridLayerBuilder style(TLspCGRSGridStyle aCGRSGridStyle)
aCGRSGridStyle
- the CGRS grid style to use.public TLspCGRSGridLayerBuilder overlayLabel(TLspCGRSGridOverlayLabelBuilder aOverlayLabelBuilder, Object aConstraint)
aOverlayLabelBuilder
- the overlay label builder used to create an overlay component. It
is not needed to call the TLspCGRSGridOverlayLabelBuilder.view()
method before calling this
method.aConstraint
- an object expressing layout constraints for this component, usually
one of these location
constants.public ILspStyledLayer build()
Creates a new layer instance.
This builder returns an ILspStyledLayer
that contains ILspCustomizableStyler
instances.
build
in class ALspLayerBuilder