Class PngImagingParameters

java.lang.Object
org.apache.commons.imaging.ImagingParameters<PngImagingParameters>
org.apache.commons.imaging.common.XmpImagingParameters<PngImagingParameters>
org.apache.commons.imaging.formats.png.PngImagingParameters
public class PngImagingParameters extends XmpImagingParameters<PngImagingParameters>
PNG format parameters.
Since:
1.0-alpha3

  • Field Details

    • DEFAULT_BIT_DEPTH

      public static final byte DEFAULT_BIT_DEPTH
      See Also:

    • bitDepth

      private byte bitDepth
      Bit depth. Default value is 8.

    • forceIndexedColor

      private boolean forceIndexedColor

    • forceTrueColor

      private boolean forceTrueColor

    • predictorEnabled

      private boolean predictorEnabled

    • physicalScale

      private PhysicalScale physicalScale
      Used in write operations to indicate the Physical Scale - sCAL.

      Valid values: PhysicalScale

      See Also:

    • textChunks

      private List<? extends AbstractPngText> textChunks

      Only used when writing PNG images.

      Valid values: a list of WriteTexts.

  • Constructor Details

    • PngImagingParameters

      public PngImagingParameters()

  • Method Details

    • getBitDepth

      public byte getBitDepth()

    • getPhysicalScale

      public PhysicalScale getPhysicalScale()

    • getTextChunks

      public List<? extends AbstractPngText> getTextChunks()

    • isForceIndexedColor

      public boolean isForceIndexedColor()

    • isForceTrueColor

      public boolean isForceTrueColor()

    • isPredictorEnabled

      public boolean isPredictorEnabled()
      Indicates that the PNG write operation should enable the predictor.
      Returns:
      true if the predictor is enabled; otherwise, false.

    • setBitDepth

      public PngImagingParameters setBitDepth(byte bitDepth)

    • setForceIndexedColor

      public PngImagingParameters setForceIndexedColor(boolean forceIndexedColor)

    • setForceTrueColor

      public PngImagingParameters setForceTrueColor(boolean forceTrueColor)

    • setPhysicalScale

      public PngImagingParameters setPhysicalScale(PhysicalScale physicalScale)

    • setPredictorEnabled

      public PngImagingParameters setPredictorEnabled(boolean predictorEnabled)
      Sets the enabled status of the predictor. When performing data compression on an image, a PNG predictor often results in a reduced file size. Predictors are particularly effective on photographic images, but may also work on graphics. The specification of a predictor may result in an increased processing time when writing an image, but will not affect the time required to read an image.
      Parameters:
      predictorEnabled - true if a predictor is enabled; otherwise, false.
      Returns:
      this instance.

    • setTextChunks

      public PngImagingParameters setTextChunks(List<? extends AbstractPngText> textChunks)