Package com.luciad.layers.styles.complexstrokes.builders

Class ParallelLinePatternBuilder

java.lang.Object
com.luciad.layers.styles.complexstrokes.builders.ParallelLinePatternBuilder
All Implemented Interfaces:
AutoCloseable
public final class ParallelLinePatternBuilder extends Object implements AutoCloseable
Creates a pattern with a line segment shape that is parallel to the base line.
Since:
2023.1
See Also:

  • Method Details

    • finalize

      protected void finalize()
      Overrides:
      finalize in class Object

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable

    • build

      @NotNull public ComplexStrokePattern build()
      Build the parallel line pattern as configured.
      Returns:
      the ComplexStrokePattern.

    • fixedLength

      @NotNull public ParallelLinePatternBuilder fixedLength(double fixedLength) throws IllegalArgumentException
      Set the length of the pattern in pixels.

      The length cannot be both fixed and relative, if both methods are used, only the last one affects the result.

      If no length is set, a 10 pixel fixed length will be used as default.

      Parameters:
      fixedLength - the length in pixels.
      Returns:
      this builder.
      Throws:
      IllegalArgumentException - fixedLength must be >=0.

    • relativeLength

      @NotNull public ParallelLinePatternBuilder relativeLength(double relativeLength) throws IllegalArgumentException
      Set the length of the pattern relative to the length of the entire line, as a value between 0 and 1.

      The length cannot be both fixed and relative, if both methods are used, only the last one affects the result.

      If no length is set, a 10 pixel fixed length will be used as default.

      Parameters:
      relativeLength - a value in [0,1].
      Returns:
      this builder.
      Throws:
      IllegalArgumentException - relativeLength must be in range [0,1].

    • offset

      @NotNull public ParallelLinePatternBuilder offset(double offset)
      Sets the offset of the line, relative to the base line, in pixels.
      Parameters:
      offset - the offset in pixels. Defaults to 0.
      Returns:
      this builder.

    • lineWidth

      @NotNull public ParallelLinePatternBuilder lineWidth(double lineWidth) throws IllegalArgumentException
      Sets the line width.
      Parameters:
      lineWidth - the line's width, defaults to 1.
      Returns:
      this builder.
      Throws:
      IllegalArgumentException - lineWidth must be >0.

    • lineColor

      @NotNull public ParallelLinePatternBuilder lineColor(@NotNull android.graphics.Color color)
      Sets the line color.
      Parameters:
      color - the line's color, defaults to black.
      Returns:
      this builder.