public final class OnPathLabelStyle extends Object implements AutoCloseable
It can be used as parameter to the FeatureCanvas.LabelDrawCommand#onPath
method.
Modifier and Type | Class and Description |
---|---|
static class |
OnPathLabelStyle.Builder
A builder class for creating an
OnPathLabelStyle . |
Modifier and Type | Method and Description |
---|---|
OnPathLabelStyle.Builder |
asBuilder()
Returns a new builder that has all properties of this instance.
|
void |
close() |
protected void |
finalize() |
HorizontalAlignment |
getHorizontalAlignment() |
double |
getHorizontalOffset() |
Double |
getRelativeLocation() |
double |
getVerticalOffset() |
PathLabelPosition |
getVerticalPosition() |
static OnPathLabelStyle.Builder |
newBuilder()
Returns a new builder for creating a
OnPathLabelStyle . |
public void close()
close
in interface AutoCloseable
@NotNull public static OnPathLabelStyle.Builder newBuilder()
OnPathLabelStyle
.OnPathLabelStyle
.@Nullable public Double getRelativeLocation()
[0,1]
. A value of 0 represents the start of the curve and a value of 1 represents the end of the curve. If this value is null
, then the label can be placed anywhere along the path.public double getVerticalOffset()
public double getHorizontalOffset()
@NotNull public PathLabelPosition getVerticalPosition()
@NotNull public HorizontalAlignment getHorizontalAlignment()
@NotNull public OnPathLabelStyle.Builder asBuilder()