public class TLcyGXYLabelPlacementHint extends Object
ILcyGXYLabelPlacementHintProvider
.
A label placement group represents a group of layers. All layers of the same label placement group are labeled together. Also label placement groups place their labels completely independent from other label placement groups. Because of this, it is possible that labels from different groups overlap. The advantage of label placement groups is that slow layers can be labeled separately, and without blocking the labeling process of the other layers.
Note : The returned obstacle provider only returns obstacles for labels of the returned label placement group. It will not provide obstacles for labels of layers from an other label placement group.
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_LABEL_PLACEMENT_GROUP
This is the default labeling group used when the labeling group of a label placement
hint is
null . |
Constructor and Description |
---|
TLcyGXYLabelPlacementHint(ILcdGXYLabelLabelingAlgorithmProvider<ILcdGXYLabelingAlgorithm> aLabelingAlgorithmProvider,
ILcdGXYLabelObstacleProvider aLabelObstacleProvider,
String aLabelPlacementGroup)
Deprecated.
use the constructor without the label algorithm provider
|
TLcyGXYLabelPlacementHint(ILcdGXYLabelObstacleProvider aLabelObstacleProvider,
String aLabelPlacementGroup)
Creates a new label placement hint with the given parameters.
|
Modifier and Type | Method and Description |
---|---|
ILcdGXYLabelLabelingAlgorithmProvider<ILcdGXYLabelingAlgorithm> |
getLabelingAlgorithmProvider()
Deprecated.
label algorithms should be retrieved from the layer
|
ILcdGXYLabelObstacleProvider |
getLabelObstacleProvider()
Returns the label obstacle provider.
|
String |
getLabelPlacementGroup()
Returns the label placement group.
|
public static final String DEFAULT_LABEL_PLACEMENT_GROUP
null
.public TLcyGXYLabelPlacementHint(ILcdGXYLabelObstacleProvider aLabelObstacleProvider, String aLabelPlacementGroup)
aLabelObstacleProvider
- the label obstacle provider for a layer. If this parameter is
null
, no obstacles will be provided for the layer.aLabelPlacementGroup
- the label placement group for a layer. If this parameter is
null
, the background label placement group will be
used (DEFAULT_LABEL_PLACEMENT_GROUP
) for the layer.@Deprecated public TLcyGXYLabelPlacementHint(ILcdGXYLabelLabelingAlgorithmProvider<ILcdGXYLabelingAlgorithm> aLabelingAlgorithmProvider, ILcdGXYLabelObstacleProvider aLabelObstacleProvider, String aLabelPlacementGroup)
aLabelingAlgorithmProvider
- the labeling algorithm provider used for labels of a layer.
If the parameter is null
, an algorithm provider
that always returns a default labeling algorithm will be used.aLabelObstacleProvider
- the label obstacle provider for a layer. If this parameter is
null
, no obstacles will be provided for the layer.aLabelPlacementGroup
- the label placement group for a layer. If this parameter is
null
, the background label placement group will be
used (DEFAULT_LABEL_PLACEMENT_GROUP
) for the layer.@Deprecated public ILcdGXYLabelLabelingAlgorithmProvider<ILcdGXYLabelingAlgorithm> getLabelingAlgorithmProvider()
null
, and the layer does not
provide an algorithm,
it will by default be interpreted as an algorithm provider that returns the same
TLcdGXYLabelPainterLocationLabelingAlgorithm
for every
label.null
.public ILcdGXYLabelObstacleProvider getLabelObstacleProvider()
getLabelPlacementGroup()
. If it is
null
, it will by default be interpreted as an obstacle provider that returns
no obstacles.
It should be possible to retrieve obstacles from the returned label obstacles provider without
a valid Graphics
argument (null
).
null
.public String getLabelPlacementGroup()
null
, it will by default be
interpreted as DEFAULT_LABEL_PLACEMENT_GROUP
. See the class doc for more information
on label placement groups.null
.