Package org.apache.pdfbox.filter

Class DecodeOptions.FinalDecodeOptions

  • Enclosing class:
    DecodeOptions
    private static class DecodeOptions.FinalDecodeOptions
extends DecodeOptions
    Helper class for reusable instances which may not be modified.

    • Constructor Detail

      • FinalDecodeOptions

        FinalDecodeOptions​(boolean filterSubsampled)

    • Method Detail

      • setSourceRegion

        public void setSourceRegion​(java.awt.Rectangle sourceRegion)
        Description copied from class: DecodeOptions
        Sets the region of the source image that should be decoded. The region will be clipped to the dimensions of the source image. Setting this value to null will result in the entire image being decoded.
        Overrides:
        setSourceRegion in class DecodeOptions
        Parameters:
        sourceRegion - The source region to decode, or null if the entire image should be decoded.

      • setSubsamplingX

        public void setSubsamplingX​(int ssX)
        Description copied from class: DecodeOptions
        Sets the number of columns to advance in the source for every pixel decoded
        Overrides:
        setSubsamplingX in class DecodeOptions
        Parameters:
        ssX - The x-axis subsampling value

      • setSubsamplingY

        public void setSubsamplingY​(int ssY)
        Description copied from class: DecodeOptions
        Sets the number of rows to advance in the source for every pixel decoded
        Overrides:
        setSubsamplingY in class DecodeOptions
        Parameters:
        ssY - The y-axis subsampling value

      • setSubsamplingOffsetX

        public void setSubsamplingOffsetX​(int ssOffsetX)
        Description copied from class: DecodeOptions
        Sets the horizontal subsampling offset for decoding images
        Overrides:
        setSubsamplingOffsetX in class DecodeOptions
        Parameters:
        ssOffsetX - The x-axis subsampling offset

      • setSubsamplingOffsetY

        public void setSubsamplingOffsetY​(int ssOffsetY)
        Description copied from class: DecodeOptions
        Sets the vertical subsampling offset for decoding images
        Overrides:
        setSubsamplingOffsetY in class DecodeOptions
        Parameters:
        ssOffsetY - The y-axis subsampling offset

      • setFilterSubsampled

        void setFilterSubsampled​(boolean filterSubsampled)
        Description copied from class: DecodeOptions
        Used internally by filters to signal they have applied subsampling as requested by this options instance.
        Overrides:
        setFilterSubsampled in class DecodeOptions
        Parameters:
        filterSubsampled - Value specifying if the filter could meet the requested options. Usually a filter will only call this with the value true, as the default value for the flag is false.