Class PDLineDashPattern
java.lang.Object
org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
- All Implemented Interfaces:
Cloneable
,COSObjectable
This class represents the line dash pattern for a graphics state. See PDF
Reference 1.5 section 4.3.2
- Version:
- $Revision: 1.7 $
- Author:
- Ben Litchfield
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a blank line dash pattern.Constructs a line dash pattern from an existing array.PDLineDashPattern
(COSArray ldp, int phase) Constructs a line dash pattern from an existing array. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Get the line dash pattern as a COS object.Convert this standard java object to a COS object.This will return a list of java.lang.Integer objects that represent the line dash pattern appearance.int
This will get the line dash pattern phase.boolean
Checks if the dashPattern is empty or all values equals 0.void
setDashPattern
(List dashPattern) This will replace the existing line dash pattern.void
setPhaseStart
(int phase) This will set the line dash pattern phase.
-
Constructor Details
-
PDLineDashPattern
public PDLineDashPattern()Creates a blank line dash pattern. With no dashes and a phase of 0. -
PDLineDashPattern
Constructs a line dash pattern from an existing array.- Parameters:
ldp
- The existing line dash pattern.
-
PDLineDashPattern
Constructs a line dash pattern from an existing array.- Parameters:
ldp
- The existing line dash pattern.phase
- The phase for the line dash pattern.
-
-
Method Details
-
clone
-
getCOSObject
Convert this standard java object to a COS object.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- The cos object that matches this Java object.
-
getPhaseStart
public int getPhaseStart()This will get the line dash pattern phase. The dash phase specifies the distance into the dash pattern at which to start the dash.- Returns:
- The line dash pattern phase.
-
setPhaseStart
public void setPhaseStart(int phase) This will set the line dash pattern phase.- Parameters:
phase
- The new line dash patter phase.
-
getDashPattern
This will return a list of java.lang.Integer objects that represent the line dash pattern appearance.- Returns:
- The line dash pattern.
-
getCOSDashPattern
Get the line dash pattern as a COS object.- Returns:
- The cos array line dash pattern.
-
setDashPattern
This will replace the existing line dash pattern.- Parameters:
dashPattern
- A list of java.lang.Integer objects.
-
isDashPatternEmpty
public boolean isDashPatternEmpty()Checks if the dashPattern is empty or all values equals 0.- Returns:
- true if the dashPattern is empty or all values equals 0
-