Class OnPathLabelStyle

java.lang.Object
com.luciad.layers.styles.OnPathLabelStyle
All Implemented Interfaces:
AutoCloseable

public final class OnPathLabelStyle extends Object implements 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.

  • Method Details Link icon

    • finalize Link icon

      protected void finalize()
      Overrides:
      finalize in class Object
    • close Link icon

      public void close()
      Specified by:
      close in interface AutoCloseable
    • newBuilder Link icon

      @NotNull public static OnPathLabelStyle.Builder newBuilder()
      Returns a new builder for creating a OnPathLabelStyle.
      Returns:
      a new builder for creating a OnPathLabelStyle.
    • getRelativeLocation Link icon

      @Nullable public Double 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 Link icon

      public double getVerticalOffset()
      Returns the vertical offset in device independent pixels.
      Returns:
      the vertical offset in device independent pixels.
    • getHorizontalOffset Link icon

      public double getHorizontalOffset()
      Returns the horizontal offset in device independent pixels.
      Returns:
      the horizontal offset in device independent pixels.
    • getVerticalPosition Link icon

      @NotNull public PathLabelPosition getVerticalPosition()
      Returns the vertical position of the label relative to the curve.
      Returns:
      the vertical position of the label relative to the curve.
    • getHorizontalAlignment Link icon

      @NotNull public HorizontalAlignment getHorizontalAlignment()
      Returns the horizontal alignment of the label relative to the curve.
      Returns:
      the horizontal alignment of the label relative to the curve.
    • asBuilder Link icon

      @NotNull public OnPathLabelStyle.Builder asBuilder()
      Returns a new builder that has all properties of this instance.
      Returns:
      a new builder that has all properties of this instance.