org.pdfbox.pdmodel.graphics

Class PDLineDashPattern

Implemented Interfaces:
COSObjectable

public class PDLineDashPattern
extends java.lang.Object
implements COSObjectable

This class represents the line dash pattern for a graphics state. See PDF Reference 1.5 section 4.3.2
Version:
$Revision: 1.6 $
Author:
Ben Litchfield

Constructor Summary

PDLineDashPattern()
Creates a blank line dash pattern.
PDLineDashPattern(COSArray ldp)
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

COSArray
getCOSDashPattern()
Get the line dash pattern as a COS object.
COSBase
getCOSObject()
List
getDashPattern()
This will return a list of java.lang.Integer objects that represent the line dash pattern appearance.
int
getPhaseStart()
This will get the line dash pattern phase.
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

public PDLineDashPattern(COSArray ldp)
Constructs a line dash pattern from an existing array.
Parameters:
ldp - The existing line dash pattern.

PDLineDashPattern

public PDLineDashPattern(COSArray ldp,
                         int phase)
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

getCOSDashPattern

public COSArray getCOSDashPattern()
Get the line dash pattern as a COS object.
Returns:
The cos array line dash pattern.

getCOSObject

public COSBase getCOSObject()
Specified by:
getCOSObject in interface COSObjectable

getDashPattern

public List getDashPattern()
This will return a list of java.lang.Integer objects that represent the line dash pattern appearance.
Returns:
The line dash pattern.

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.

setDashPattern

public void setDashPattern(List dashPattern)
This will replace the existing line dash pattern.
Parameters:
dashPattern - A list of java.lang.Integer objects.

setPhaseStart

public void setPhaseStart(int phase)
This will set the line dash pattern phase.
Parameters:
phase - The new line dash patter phase.