public class ImageWriteParam extends IIOParam
Modifier and Type | Field and Description |
---|---|
protected boolean |
canOffsetTiles
True if tiling grid offset parameters can be set.
|
protected boolean |
canWriteCompressed
True if this writer can write images using compression.
|
protected boolean |
canWriteProgressive
True if images can be written as a progressive sequence
of increasing quality.
|
protected boolean |
canWriteTiles
True if tile width and height parameters can be set.
|
protected int |
compressionMode
Controls compression settings, which must be set to one of the four
MODE_* values.
|
protected float |
compressionQuality
Contains the current compression quality setting.
|
protected String |
compressionType
Contains the name of the current compression type.
|
protected String[] |
compressionTypes
Array of the names of the available compression types.
|
protected Locale |
locale
Localizes compression type names and quality descriptions,
or null to use default Locale.
|
static int |
MODE_COPY_FROM_METADATA
Can be passed to setTilingMode, setProgressiveMode and
setCompressionMode to enable feature.
|
static int |
MODE_DEFAULT
Can be passed to setTilingMode, setProgressiveMode and
setCompressionMode to enable feature.
|
static int |
MODE_DISABLED
Can be passed to setTilingMode, setProgressiveMode and
setCompressionMode to disable feature.
|
static int |
MODE_EXPLICIT
Can be passed to setTilingMode, setCompressionMode to disable feature.
|
protected Dimension[] |
preferredTileSizes
Preferred tile size range pairs.
|
protected int |
progressiveMode
The mode controlling progressive encoding, which must
be set to one of the four MODE_* values, except
MODE_EXPLICIT.
|
protected int |
tileGridXOffset
The amount by which the tile grid origin should be offset
horizontally from the image origin if tiling has been set.
|
protected int |
tileGridYOffset
The amount by which the tile grid origin should be offset
vertically from the image origin if tiling has been set.
|
protected int |
tileHeight
The height of each tile if tiling has been set.
|
protected int |
tileWidth
The width of each tile if tiling has been set.
|
protected int |
tilingMode
The mode controlling tiling settings, which must be
set to one of the four MODE_* values.
|
protected boolean |
tilingSet
True if the tiling parameters have been specified.
|
controller, defaultController, destinationOffset, destinationType, sourceBands, sourceRegion, sourceXSubsampling, sourceYSubsampling, subsamplingXOffset, subsamplingYOffset
Modifier | Constructor and Description |
---|---|
protected |
ImageWriteParam()
Creates an empty
ImageWriteParam object. |
|
ImageWriteParam(Locale locale)
Creates an
ImageWriteParam object with the given locale. |
Modifier and Type | Method and Description |
---|---|
boolean |
canOffsetTiles() |
boolean |
canWriteCompressed() |
boolean |
canWriteProgressive() |
boolean |
canWriteTiles() |
float |
getBitRate(float quality) |
int |
getCompressionMode() |
float |
getCompressionQuality() |
String[] |
getCompressionQualityDescriptions() |
float[] |
getCompressionQualityValues() |
String |
getCompressionType() |
String[] |
getCompressionTypes() |
Locale |
getLocale() |
String |
getLocalizedCompressionTypeName() |
Dimension[] |
getPreferredTileSizes() |
int |
getProgressiveMode() |
int |
getTileGridXOffset() |
int |
getTileGridYOffset() |
int |
getTileHeight() |
int |
getTileWidth() |
int |
getTilingMode() |
boolean |
isCompressionLossless() |
void |
setCompressionMode(int mode) |
void |
setCompressionQuality(float quality) |
void |
setCompressionType(String compressionType) |
void |
setProgressiveMode(int mode) |
void |
setTiling(int tileWidth,
int tileHeight,
int tileGridXOffset,
int tileGridYOffset) |
void |
setTilingMode(int mode) |
void |
unsetCompression() |
void |
unsetTiling() |
activateController, getController, getDefaultController, getDestinationOffset, getDestinationType, getSourceBands, getSourceRegion, getSourceXSubsampling, getSourceYSubsampling, getSubsamplingXOffset, getSubsamplingYOffset, hasController, setController, setDestinationOffset, setDestinationType, setSourceBands, setSourceRegion, setSourceSubsampling
public static final int MODE_DISABLED
public static final int MODE_DEFAULT
public static final int MODE_EXPLICIT
public static final int MODE_COPY_FROM_METADATA
protected boolean canOffsetTiles
protected boolean canWriteCompressed
protected boolean canWriteProgressive
protected boolean canWriteTiles
protected int compressionMode
protected float compressionQuality
protected String compressionType
protected String[] compressionTypes
protected Locale locale
protected Dimension[] preferredTileSizes
protected int progressiveMode
protected int tileGridXOffset
protected int tileGridYOffset
protected int tileHeight
protected int tileWidth
protected int tilingMode
protected boolean tilingSet
protected ImageWriteParam()
ImageWriteParam
object.
The subclass is responsible to initialize all fields.public ImageWriteParam(Locale locale)
ImageWriteParam
object with the given locale.locale
- the locale to use for user visible stringspublic float getBitRate(float quality)
public boolean canOffsetTiles()
public boolean canWriteCompressed()
public boolean canWriteProgressive()
public boolean canWriteTiles()
public int getCompressionMode()
public float getCompressionQuality()
public String[] getCompressionQualityDescriptions()
public float[] getCompressionQualityValues()
public String getCompressionType()
public String[] getCompressionTypes()
public String getLocalizedCompressionTypeName()
public Dimension[] getPreferredTileSizes()
public int getProgressiveMode()
public int getTileGridXOffset()
public int getTileGridYOffset()
public int getTileHeight()
public int getTileWidth()
public int getTilingMode()
public boolean isCompressionLossless()
public void setCompressionMode(int mode)
public void setCompressionQuality(float quality)
public void setCompressionType(String compressionType)
public void setProgressiveMode(int mode)
public void setTiling(int tileWidth, int tileHeight, int tileGridXOffset, int tileGridYOffset)
public void setTilingMode(int mode)
public void unsetCompression()
public void unsetTiling()