Package com.luciad.layers.styles

Enum Class PathLabelPosition

java.lang.Object
java.lang.Enum<PathLabelPosition>
com.luciad.layers.styles.PathLabelPosition
All Implemented Interfaces:
Serializable, Comparable<PathLabelPosition>, Constable
public enum PathLabelPosition extends Enum<PathLabelPosition>
An enumeration describing the position of a label wrt a path.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Above
    Vertically align the position of the label such that it is always positioned above the path.
    Below
    Vertically align the position of the label such that it is always positioned below the path.
    Center
    Vertically align the position of the label such that it is positioned on the path.
    Port
    Align the position of the label such that it is always at the left side of the path when the path is followed from start to end.
    Starboard
    Align the position of the label such that it is always at the right side of the path when the path is followed from start to end.

  • Method Summary

    Modifier and Type
    Method
    Description
    static PathLabelPosition
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static PathLabelPosition[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • Above

      public static final PathLabelPosition Above
      Vertically align the position of the label such that it is always positioned above the path.

    • Port

      public static final PathLabelPosition Port
      Align the position of the label such that it is always at the left side of the path when the path is followed from start to end.

    • Below

      public static final PathLabelPosition Below
      Vertically align the position of the label such that it is always positioned below the path.

    • Starboard

      public static final PathLabelPosition Starboard
      Align the position of the label such that it is always at the right side of the path when the path is followed from start to end.

    • Center

      public static final PathLabelPosition Center
      Vertically align the position of the label such that it is positioned on the path.

  • Method Details

    • values

      public static PathLabelPosition[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static PathLabelPosition valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null