Class PDPatternResources

java.lang.Object
org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
All Implemented Interfaces:
COSObjectable
Direct Known Subclasses:
PDShadingPatternResources, PDTilingPatternResources

public abstract class PDPatternResources extends Object implements COSObjectable
This represents the resources for a pattern colorspace.
Version:
$Revision: 1.0 $
  • Field Details

  • Constructor Details

    • PDPatternResources

      public PDPatternResources()
      Default constructor.
    • PDPatternResources

      public PDPatternResources(COSDictionary resourceDictionary)
      Prepopulated pattern resources.
      Parameters:
      resourceDictionary - The COSDictionary for this pattern resource.
  • Method Details

    • getCOSDictionary

      public COSDictionary getCOSDictionary()
      This will get the underlying dictionary.
      Returns:
      The dictionary for these pattern resources.
    • getCOSObject

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

      public void setFilter(String filter)
      Sets the filter entry of the encryption dictionary.
      Parameters:
      filter - The filter name.
    • getFilter

      public String getFilter()
      Get the name of the filter.
      Returns:
      The filter name contained in this encryption dictionary.
    • setLength

      public void setLength(int length)
      This will set the length of the content stream.
      Parameters:
      length - The new stream length.
    • getLength

      public int getLength()
      This will return the length of the content stream.
      Returns:
      The length of the content stream
    • setPaintType

      public void setPaintType(int paintType)
      This will set the paint type.
      Parameters:
      paintType - The new paint type.
    • getType

      public String getType()
      This will return the paint type.
      Returns:
      The type of object that this is.
    • setPatternType

      public void setPatternType(int patternType)
      This will set the pattern type.
      Parameters:
      patternType - The new pattern type.
    • getPatternType

      public abstract int getPatternType()
      This will return the pattern type.
      Returns:
      The pattern type
    • create

      public static PDPatternResources create(COSDictionary resourceDictionary) throws IOException
      Create the correct PD Model pattern based on the COS base pattern.
      Parameters:
      resourceDictionary - the COS pattern dictionary
      Returns:
      the newly created pattern resources object
      Throws:
      IOException - If we are unable to create the PDPattern object.
    • getPaint

      public abstract Paint getPaint(int pageHeight) throws IOException
      This will return the paint of the pattern.
      Parameters:
      pageHeight - the height of the current page
      Returns:
      the paint of the pattern
      Throws:
      IOException