Package org.apache.pdfbox.filter
Class DecodeOptions.FinalDecodeOptions
- java.lang.Object
-
- org.apache.pdfbox.filter.DecodeOptions
-
- org.apache.pdfbox.filter.DecodeOptions.FinalDecodeOptions
-
- Enclosing class:
- DecodeOptions
private static class DecodeOptions.FinalDecodeOptions extends DecodeOptions
Helper class for reusable instances which may not be modified.
-
-
Field Summary
-
Fields inherited from class org.apache.pdfbox.filter.DecodeOptions
DEFAULT
-
-
Constructor Summary
Constructors Constructor Description FinalDecodeOptions(boolean filterSubsampled)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description (package private) void
setFilterSubsampled(boolean filterSubsampled)
Used internally by filters to signal they have applied subsampling as requested by this options instance.void
setSourceRegion(java.awt.Rectangle sourceRegion)
Sets the region of the source image that should be decoded.void
setSubsamplingOffsetX(int ssOffsetX)
Sets the horizontal subsampling offset for decoding imagesvoid
setSubsamplingOffsetY(int ssOffsetY)
Sets the vertical subsampling offset for decoding imagesvoid
setSubsamplingX(int ssX)
Sets the number of columns to advance in the source for every pixel decodedvoid
setSubsamplingY(int ssY)
Sets the number of rows to advance in the source for every pixel decoded-
Methods inherited from class org.apache.pdfbox.filter.DecodeOptions
getSourceRegion, getSubsamplingOffsetX, getSubsamplingOffsetY, getSubsamplingX, getSubsamplingY, isFilterSubsampled
-
-
-
-
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 classDecodeOptions
- 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 classDecodeOptions
- 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 classDecodeOptions
- 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 classDecodeOptions
- 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 classDecodeOptions
- 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 classDecodeOptions
- Parameters:
filterSubsampled
- Value specifying if the filter could meet the requested options. Usually a filter will only call this with the valuetrue
, as the default value for the flag isfalse
.
-
-