Package org.apache.pdfbox.pdmodel.graphics.state

Class PDSoftMask

java.lang.Object
org.apache.pdfbox.pdmodel.graphics.state.PDSoftMask
All Implemented Interfaces:
COSObjectable
public final class PDSoftMask extends Object implements COSObjectable
Soft mask.

  • Field Details

    • LOG

      private static final org.apache.commons.logging.Log LOG

    • dictionary

      private final COSDictionary dictionary

    • subType

      private COSName subType

    • group

      private PDTransparencyGroup group

    • backdropColor

      private COSArray backdropColor

    • transferFunction

      private PDFunction transferFunction

    • ctm

      private Matrix ctm
      To allow a soft mask to know the CTM at the time of activation of the ExtGState.

  • Constructor Details

    • PDSoftMask

      public PDSoftMask(COSDictionary dictionary)
      Creates a new soft mask.
      Parameters:
      dictionary - The soft mask dictionary.

  • Method Details

    • create

      public static PDSoftMask create(COSBase dictionary)
      Creates a new soft mask.
      Parameters:
      dictionary - SMask

    • getCOSObject

      public COSDictionary getCOSObject()
      Description copied from interface: COSObjectable
      Convert this standard java object to a COS object.
      Specified by:
      getCOSObject in interface COSObjectable
      Returns:
      The cos object that matches this Java object.

    • getSubType

      public COSName getSubType()
      Returns the subtype of the soft mask (Alpha, Luminosity) - S entry

    • getGroup

      public PDTransparencyGroup getGroup() throws IOException
      Returns the G entry of the soft mask object
      Returns:
      form containing the transparency group
      Throws:
      IOException

    • getBackdropColor

      public COSArray getBackdropColor()
      Returns the backdrop color.

    • getTransferFunction

      public PDFunction getTransferFunction() throws IOException
      Returns the transfer function.
      Throws:
      IOException - If we are unable to create the PDFunction object.

    • setInitialTransformationMatrix

      void setInitialTransformationMatrix(Matrix ctm)
      Set the CTM that is valid at the time the ExtGState was activated.
      Parameters:
      ctm -

    • getInitialTransformationMatrix

      public Matrix getInitialTransformationMatrix()
      Returns the CTM at the time the ExtGState was activated.
      Returns:
      the CTM at the time the ExtGState was activated.