Class PDLineDashPattern

java.lang.Object
org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
All Implemented Interfaces:
COSObjectable

public final class PDLineDashPattern extends Object implements COSObjectable
A line dash pattern for stroking paths. Instances of PDLineDashPattern are immutable.
Author:
Ben Litchfield, John Hewson
  • Constructor Details

    • PDLineDashPattern

      public PDLineDashPattern()
      Creates a new line dash pattern, with no dashes and a phase of 0.
    • PDLineDashPattern

      public PDLineDashPattern(COSArray array, int phase)
      Creates a new line dash pattern from a dash array and phase.
      Parameters:
      array - the dash array
      phase - the phase
  • Method Details

    • getCOSObject

      public COSBase getCOSObject()
      Description copied from interface: COSObjectable
      Convert this standard java object to a COS object.
      Specified by:
      getCOSObject in interface COSObjectable
      Returns:
      The cos object that matches this Java object.
    • getPhase

      public int getPhase()
      Returns the dash phase. This specifies the distance into the dash pattern at which to start the dash.
      Returns:
      the dash phase
    • getDashArray

      public float[] getDashArray()
      Returns the dash array.
      Returns:
      the dash array, never null.
    • toString

      public String toString()
      Overrides:
      toString in class Object