APIdia Launch Partner
Top Fields Constructors Methods
com.sun.imageio.plugins.png

pack-priv final Class PNGImageWriteParam

Located in compilation unit of com.sun.imageio.plugins.png.PNGImageWriter.

extends ImageWriteParam
Class Inheritance

Field Summary

Modifier and TypeField and Description
private static final String[]
compressionNames

private static final float
DEFAULT_QUALITY

Default quality level = 0.5 ie medium compression

private static final String[]
qualityDescs

private static final float[]
qualityVals

Inherited from javax.imageio.ImageWriteParam:
canOffsetTilescanWriteCompressedcanWriteProgressivecanWriteTilescompressionModecompressionQualitycompressionTypecompressionTypeslocaleMODE_COPY_FROM_METADATAMODE_DEFAULTMODE_DISABLEDMODE_EXPLICITpreferredTileSizesprogressiveModetileGridXOffsettileGridYOffsettileHeighttileWidthtilingModetilingSet

Constructor Summary

AccessConstructor and Description
pack-priv
PNGImageWriteParam(Locale locale)

Method Summary

Modifier and TypeMethod and Description
public String[]
getCompressionQualityDescriptions()

Overrides javax.imageio.ImageWriteParam.getCompressionQualityDescriptions.

Returns an array of Strings that may be used along with getCompressionQualityValues as part of a user interface for setting or displaying the compression quality level.

public float[]
getCompressionQualityValues()

Overrides javax.imageio.ImageWriteParam.getCompressionQualityValues.

Returns an array of floats that may be used along with getCompressionQualityDescriptions as part of a user interface for setting or displaying the compression quality level.

public boolean

Returns:

true.
isCompressionLossless()

Overrides javax.imageio.ImageWriteParam.isCompressionLossless.

Returns true since the PNG plug-in only supports lossless compression.

public void
unsetCompression()

Overrides javax.imageio.ImageWriteParam.unsetCompression.

Removes any previous compression quality setting.

Inherited from javax.imageio.ImageWriteParam:
canOffsetTilescanWriteCompressedcanWriteProgressivecanWriteTilesgetBitRategetCompressionModegetCompressionQualitygetCompressionTypegetCompressionTypesgetLocalegetLocalizedCompressionTypeNamegetPreferredTileSizesgetProgressiveModegetTileGridXOffsetgetTileGridYOffsetgetTileHeightgetTileWidthgetTilingModesetCompressionModesetCompressionQualitysetCompressionTypesetProgressiveModesetTilingsetTilingModeunsetTiling

Field Detail

compressionNamesback to summary
private static final String[] compressionNames
DEFAULT_QUALITYback to summary
private static final float DEFAULT_QUALITY

Default quality level = 0.5 ie medium compression

qualityDescsback to summary
private static final String[] qualityDescs
qualityValsback to summary
private static final float[] qualityVals

Constructor Detail

PNGImageWriteParamback to summary
pack-priv PNGImageWriteParam(Locale locale)

Method Detail

getCompressionQualityDescriptionsback to summary
public String[] getCompressionQualityDescriptions()

Overrides javax.imageio.ImageWriteParam.getCompressionQualityDescriptions.

Doc from javax.imageio.ImageWriteParam.getCompressionQualityDescriptions.

Returns an array of Strings that may be used along with getCompressionQualityValues as part of a user interface for setting or displaying the compression quality level. The String with index i provides a description of the range of quality levels between getCompressionQualityValues[i] and getCompressionQualityValues[i + 1]. Note that the length of the array returned from getCompressionQualityValues will always be one greater than that returned from getCompressionQualityDescriptions.

As an example, the strings "Good", "Better", and "Best" could be associated with the ranges [0, .33), [.33, .66), and [.66, 1.0]. In this case, getCompressionQualityDescriptions would return { "Good", "Better", "Best" } and getCompressionQualityValues would return { 0.0F, .33F, .66F, 1.0F }.

If no descriptions are available, null is returned. If null is returned from getCompressionQualityValues, this method must also return null.

The descriptions should be localized for the Locale returned by getLocale, if it is non-null.

If there are multiple compression types but none has been set, an IllegalStateException is thrown.

The default implementation checks that compression is supported and that the compression mode is MODE_EXPLICIT. If so, if getCompressionTypes() is null or getCompressionType() is non-null, it returns null.

Annotations
@Override
getCompressionQualityValuesback to summary
public float[] getCompressionQualityValues()

Overrides javax.imageio.ImageWriteParam.getCompressionQualityValues.

Doc from javax.imageio.ImageWriteParam.getCompressionQualityValues.

Returns an array of floats that may be used along with getCompressionQualityDescriptions as part of a user interface for setting or displaying the compression quality level. See getCompressionQualityDescriptions for more information.

If no descriptions are available, null is returned. If null is returned from getCompressionQualityDescriptions, this method must also return null.

If there are multiple compression types but none has been set, an IllegalStateException is thrown.

The default implementation checks that compression is supported and that the compression mode is MODE_EXPLICIT. If so, if getCompressionTypes() is null or getCompressionType() is non-null, it returns null.

Annotations
@Override
isCompressionLosslessback to summary
public boolean isCompressionLossless()

Overrides javax.imageio.ImageWriteParam.isCompressionLossless.

Returns true since the PNG plug-in only supports lossless compression.

Returns:boolean

true.

Annotations
@Override
unsetCompressionback to summary
public void unsetCompression()

Overrides javax.imageio.ImageWriteParam.unsetCompression.

Removes any previous compression quality setting.

The default implementation resets the compression quality to 0.5F.

Annotations
@Override
Exceptions
IllegalStateException:
if the compression mode is not MODE_EXPLICIT.