Save This Page
Home » pdfbox-1.1.0-src » org.apache.pdfbox.pdmodel.graphics » [javadoc | source]
org.apache.pdfbox.pdmodel.graphics
public class: PDLineDashPattern [javadoc | source]
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
Constructor:
 public PDLineDashPattern() 
 public PDLineDashPattern(COSArray ldp) 
    Constructs a line dash pattern from an existing array.
    Parameters:
    ldp - The existing line dash pattern.
 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 from org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern Summary:
clone,   getCOSDashPattern,   getCOSObject,   getDashPattern,   getPhaseStart,   isDashPatternEmpty,   setDashPattern,   setPhaseStart
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern Detail:
 public Object clone() 
    {@inheritDoc}
 public COSArray getCOSDashPattern() 
    Get the line dash pattern as a COS object.
 public COSBase getCOSObject() 
    {@inheritDoc}
 public List getDashPattern() 
    This will return a list of java.lang.Integer objects that represent the line dash pattern appearance.
 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.
 public boolean isDashPatternEmpty() 
    Checks if the dashPattern is empty or all values equals 0.
 public  void setDashPattern(List dashPattern) 
    This will replace the existing line dash pattern.
 public  void setPhaseStart(int phase) 
    This will set the line dash pattern phase.