Class PDLineDashPattern
- java.lang.Object
-
- com.tom_roush.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.
-
-
Constructor Summary
Constructors Constructor Description PDLineDashPattern()Creates a new line dash pattern, with no dashes and a phase of 0.PDLineDashPattern(COSArray array, int phase)Creates a new line dash pattern from a dash array and phase.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description COSBasegetCOSObject()Convert this standard java object to a COS object.float[]getDashArray()Returns the dash array.intgetPhase()Returns the dash phase.
-
-
-
Constructor Detail
-
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 arrayphase- the phase
-
-
Method Detail
-
getCOSObject
public COSBase getCOSObject()
Description copied from interface:COSObjectableConvert this standard java object to a COS object.- Specified by:
getCOSObjectin interfaceCOSObjectable- 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
-
-