Package com.datalogics.PDFL

Class DrawParams

java.lang.Object
com.datalogics.PDFL.DrawParams
public class DrawParams extends Object
Settings for rendering PDF pages as images. This is used for rendering PDF pages to images, such as PNG or JPG files, to export to separate files or to send to a printer.

  • Constructor Details

    • DrawParams

      public DrawParams()

    • DrawParams

      public DrawParams(DrawParams rhs)

  • Method Details

    • delete

      public void delete()

    • setFlags

      public void setFlags(EnumSet<DrawFlags> value)
      Drawing flags.

    • getFlags

      public EnumSet<DrawFlags> getFlags()
      Drawing flags.

    • getUpdateRect

      public Rect getUpdateRect()
      A rectangle represented by the coordinates of its four sides, which specifies the area to draw.

    • setUpdateRect

      public void setUpdateRect(Rect rect)
      A rectangle represented by the coordinates of its four sides, which specifies the area to draw.

    • getDestRect

      public Rect getDestRect()
      The rectangle of the bitmap. It is defined in device space coordinates. Only used when drawing to a bitmap.

    • setDestRect

      public void setDestRect(Rect rect)
      The rectangle of the bitmap. It is defined in device space coordinates. Only used when drawing to a bitmap.

    • getMatrix

      public Matrix getMatrix()
      A pointer to the matrix to concatenate onto the default page matrix. It is useful for converting from page to window coordinates and for scaling.

    • setMatrix

      public void setMatrix(Matrix matrix)
      A pointer to the matrix to concatenate onto the default page matrix. It is useful for converting from page to window coordinates and for scaling.

    • setCancelProc

      public void setCancelProc(CancelProc cancelProc)
      Set the cancel callback.
      Parameters:
      cancelProc - a CancelProc, which can return true to cancel the operation, may be null.

    • getCancelProc

      public CancelProc getCancelProc()
      Get the cancel callback.

    • setProgressProc

      public void setProgressProc(RenderProgressProc progressProc)
      Set the progress callback.
      Parameters:
      progressProc - a RenderProgressProc, that can receive updates regarding rendering progress, may be null.

    • getProgressProc

      public RenderProgressProc getProgressProc()
      Get the progress callback.

    • setColorSpace

      public void setColorSpace(ColorSpace colorSpace)
      The color space in which the bitmap data is represented. It must be one of DeviceGray, DeviceRGB, DeviceRGBA, DeviceCMYK, Lab, or LabA. Only used when drawing to a bitmap.

    • getColorSpace

      public ColorSpace getColorSpace()
      The color space in which the bitmap data is represented. It must be one of DeviceGray, DeviceRGB, DeviceRGBA, DeviceCMYK, Lab, or LabA. Only used when drawing to a bitmap.

    • setSmoothFlags

      public void setSmoothFlags(EnumSet<SmoothFlags> value)
      Smoothing flags. Only used when drawing to a bitmap.

    • getSmoothFlags

      public EnumSet<SmoothFlags> getSmoothFlags()
      Smoothing flags. Only used when drawing to a bitmap.

    • setBypassCopyPerm

      public void setBypassCopyPerm(boolean value)
      Bypass copy permissions. Only used when drawing to a bitmap.

    • getBypassCopyPerm

      public boolean getBypassCopyPerm()
      Bypass copy permissions. Only used when drawing to a bitmap.

    • setEnableBlackPointCompensation

      public void setEnableBlackPointCompensation(boolean value)
      Enable/disable black point compensation.

    • getEnableBlackPointCompensation

      public boolean getEnableBlackPointCompensation()
      Enable/disable black point compensation.

    • setEnableThinLineHeuristics

      public void setEnableThinLineHeuristics(boolean value)
      Enable/disable thin line adjustments when drawing rectangles

    • getEnableThinLineHeuristics

      public boolean getEnableThinLineHeuristics()
      Enable/disable thin line adjustments when drawing rectangles

    • setRenderIntent

      public void setRenderIntent(RenderIntent value)
      Default rendering intent is RelColorimetric (relative colorimetric). Only used when drawing to a bitmap.

    • getRenderIntent

      public RenderIntent getRenderIntent()
      Default rendering intent is RelColorimetric (relative colorimetric). Only used when drawing to a bitmap.

    • setOptionalContentContext

      public void setOptionalContentContext(OptionalContentContext context)
      The optional-content context to use for visibility state information, or NULL to use the document's current states in the default context.

    • getOptionalContentContext

      public OptionalContentContext getOptionalContentContext()
      The optional-content context to use for visibility state information, or NULL to use the document's current states in the default context.

    • getICCProfile

      public ColorProfile getICCProfile()
      Gets the ICC Profile of the colorspace to be used for rendering from a known value.

      NOTE: The ICCProfileCustomPath must not be set for this property to be used. The profile must be compatible with the ColorSpace property value, which can't be set to ICCBased either.

    • setICCProfile

      public void setICCProfile(ColorProfile colorProfile)
      Sets the ICC Profile of the colorspace to be used for rendering to a known value.

      NOTE: The ICCProfileCustomPath must not be set for this property to be used. The profile must be compatible with the ColorSpace property value, which can't be set to ICCBased either.

    • getICCProfileCustomPath

      public String getICCProfileCustomPath()
      Gets the ICC Profile of the colorspace to be used for rendering from a custom file path.

      NOTE: The ICCProfile is ignored when this property is a non-empty string. The profile must be compatible with the ColorSpace property value, which can't be set to ICCBased either.

    • setICCProfileCustomPath

      public void setICCProfileCustomPath(String colorProfilePath)
      Sets the ICC Profile of the colorspace to be used for rendering from a custom file path.

      NOTE: The ICCProfile is ignored when this property is a non-empty string. The profile must be compatible with the ColorSpace property value, which can't be set to ICCBased either.