Package com.luciad.layers.styles
Class OnPathLabelStyle
java.lang.Object
com.luciad.layers.styles.OnPathLabelStyle
- All Implemented Interfaces:
AutoCloseable
This class contains styling properties to determine how a label is placed on a path.
It can be used as parameter to the FeatureCanvas.LabelDrawCommand#onPath
method.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A builder class for creating anOnPathLabelStyle
. -
Method Summary
Modifier and TypeMethodDescriptionReturns a new builder that has all properties of this instance.void
close()
protected void
finalize()
Returns the horizontal alignment of the label relative to the curve.double
Returns the horizontal offset in device independent pixels.Returns the relative location on the curve.double
Returns the vertical offset in device independent pixels.Returns the vertical position of the label relative to the curve.static OnPathLabelStyle.Builder
Returns a new builder for creating aOnPathLabelStyle
.
-
Method Details
-
finalize
protected void finalize() -
close
public void close()- Specified by:
close
in interfaceAutoCloseable
-
newBuilder
Returns a new builder for creating aOnPathLabelStyle
.- Returns:
- a new builder for creating a
OnPathLabelStyle
.
-
getRelativeLocation
Returns the relative location on the curve.This value is in the interval
[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.- Returns:
- the relative location on the curve.
-
getVerticalOffset
public double getVerticalOffset()Returns the vertical offset in device independent pixels.- Returns:
- the vertical offset in device independent pixels.
-
getHorizontalOffset
public double getHorizontalOffset()Returns the horizontal offset in device independent pixels.- Returns:
- the horizontal offset in device independent pixels.
-
getVerticalPosition
Returns the vertical position of the label relative to the curve.- Returns:
- the vertical position of the label relative to the curve.
-
getHorizontalAlignment
Returns the horizontal alignment of the label relative to the curve.- Returns:
- the horizontal alignment of the label relative to the curve.
-
asBuilder
Returns a new builder that has all properties of this instance.- Returns:
- a new builder that has all properties of this instance.
-