public class TLspGARSGridLayerBuilder extends ALspLayerBuilder
Builder for creating ILspLayer
instances that visualize Global Area Reference System (GARS) grid data.
The styling of the GARS grid and its labels can be done by creating a TLspGARSGridStyle
and passing it to the style
builder method.
An example of how to use this builder:
ILcdModel model = TLspGARSGridLayerBuilder.createModel("GARS Grid");
// See TLspGARSGridStyle for more information on configuring the grid style
ILspLayer layer = TLspGARSGridLayerBuilder.newBuilder()
.model(model)
.label("GARS Grid")
.build();
Modifier and Type | Method and Description |
---|---|
ILspStyledLayer |
build()
Creates a new layer instance.
|
static ILcdModel |
createModel(String aModelName)
Creates a model that can be used by this builder.
|
TLspGARSGridLayerBuilder |
label(String aLabel)
Sets the label of the layer.
|
TLspGARSGridLayerBuilder |
layerStyle(TLspLayerStyle aLayerStyle)
Set a layer style to be used during the rendering of the layer.
|
TLspGARSGridLayerBuilder |
layerType(ILspLayer.LayerType aLayerType)
This method is not supported for GARS grid layers
|
TLspGARSGridLayerBuilder |
model(ILcdModel aModel)
Sets the model of the layer.
|
static TLspGARSGridLayerBuilder |
newBuilder()
Returns a new GARS grid layer builder
|
TLspGARSGridLayerBuilder |
overlayLabel(TLspGARSGridOverlayLabelBuilder aOverlayLabelBuilder,
Object aConstraint)
Adds an overlay label to be used.
|
TLspGARSGridLayerBuilder |
style(TLspGARSGridStyle aGARSGridStyle)
Sets the style to be used by this layer.
|
getIcon, getLabel, getLayerStyle, getLayerType, getModel, icon
public static TLspGARSGridLayerBuilder newBuilder()
public static ILcdModel createModel(String aModelName)
Creates a model that can be used by this builder. When no model is set on the builder, a default model is used instead. It is possible to customize the model name, which is used as a default display name for the layer created by this builder.
aModelName
- The desired model namepublic TLspGARSGridLayerBuilder 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 TLspGARSGridLayerBuilder label(String aLabel)
""GARS Grid""
.label
in class ALspLayerBuilder
aLabel
- the labelILcdLayer.getLabel()
public TLspGARSGridLayerBuilder layerType(ILspLayer.LayerType aLayerType)
layerType
in class ALspLayerBuilder
aLayerType
- the layer typeUnsupportedOperationException
- this method is not supported for GARS grid layersILspLayer.getLayerType()
public TLspGARSGridLayerBuilder 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 TLspGARSGridLayerBuilder style(TLspGARSGridStyle aGARSGridStyle)
aGARSGridStyle
- the GARS grid style to use.public TLspGARSGridLayerBuilder overlayLabel(TLspGARSGridOverlayLabelBuilder aOverlayLabelBuilder, Object aConstraint)
aOverlayLabelBuilder
- the overlay label builder used to create an overlay component. It
is not needed to call the TLspGARSGridOverlayLabelBuilder.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