Package com.mxgraph.util.png

Class mxPngEncodeParam.Gray

java.lang.Object

com.mxgraph.util.png.mxPngEncodeParam

com.mxgraph.util.png.mxPngEncodeParam.Gray

Enclosing class:

mxPngEncodeParam

public static class mxPngEncodeParam.Gray
extends mxPngEncodeParam

Nested Class Summary

Nested classes/interfaces inherited from class com.mxgraph.util.png.mxPngEncodeParam

mxPngEncodeParam.Gray, mxPngEncodeParam.Palette, mxPngEncodeParam.RGB

Field Summary

Fields inherited from class com.mxgraph.util.png.mxPngEncodeParam

bitDepth, bitDepthSet, INTENT_ABSOLUTE, INTENT_PERCEPTUAL, INTENT_RELATIVE, INTENT_SATURATION, PNG_FILTER_AVERAGE, PNG_FILTER_NONE, PNG_FILTER_PAETH, PNG_FILTER_SUB, PNG_FILTER_UP

Constructor Summary

Constructors

Constructor	Description
Gray()	Constructs an instance of PNGEncodeParam.Gray.

Method Summary

Modifier and Type	Method	Description
int	getBackgroundGray()	Returns the suggested gray level of the background.
int	getBitShift()	Returns the desired bit shift for a grayscale image.
int	getTransparentGray()	Returns the gray value to be used to denote transparency.
boolean	isBackgroundSet()	Returns true if a 'bKGD' chunk will be output.
boolean	isBitDepthSet()	Returns true if the bit depth has been set.
boolean	isBitShiftSet()	Returns true if the bit shift has been set.
void	setBackgroundGray(int gray)	Sets the suggested gray level of the background.
void	setBitDepth(int bitDepth)	Sets the desired bit depth for a grayscale image.
void	setBitShift(int bitShift)	Sets the desired bit shift for a grayscale image.
void	setTransparentGray(int transparentGray)	Sets the gray value to be used to denote transparency.
void	unsetBackground()	Suppresses the 'bKGD' chunk from being output.
void	unsetBitShift()	Suppresses the setting of the bit shift of a grayscale image.

Methods inherited from class com.mxgraph.util.png.mxPngEncodeParam

addPrivateChunk, filterRow, getBitDepth, getChromaticity, getCompressedText, getDefaultEncodeParam, getGamma, getICCProfileData, getInterlacing, getModificationTime, getNumPrivateChunks, getPaletteHistogram, getPhysicalDimension, getPrivateChunkData, getPrivateChunkType, getSignificantBits, getSRGBIntent, getText, isChromaticitySet, isCompressedTextSet, isGammaSet, isICCProfileDataSet, isModificationTimeSet, isPaletteHistogramSet, isPhysicalDimensionSet, isSignificantBitsSet, isSRGBIntentSet, isSuggestedPaletteSet, isTextSet, isTransparencySet, paethPredictor, removeAllPrivateChunks, removeUnsafeToCopyPrivateChunks, setChromaticity, setChromaticity, setCompressedText, setGamma, setICCProfileData, setInterlacing, setModificationTime, setPaletteHistogram, setPhysicalDimension, setPhysicalDimension, setSignificantBits, setSRGBIntent, setSuggestedPalette, setText, unsetBitDepth, unsetChromaticity, unsetCompressedText, unsetGamma, unsetICCProfileData, unsetModificationTime, unsetPaletteHistogram, unsetPhysicalDimension, unsetSignificantBits, unsetSRGBIntent, unsetSuggestedPalette, unsetText, unsetTransparency

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Gray

public Gray()

Constructs an instance of PNGEncodeParam.Gray.

Method Detail

unsetBackground

public void unsetBackground()

Suppresses the 'bKGD' chunk from being output.

Overrides:

unsetBackground in class mxPngEncodeParam

isBackgroundSet

public boolean isBackgroundSet()

Returns true if a 'bKGD' chunk will be output.

Overrides:

isBackgroundSet in class mxPngEncodeParam

setBitDepth

public void setBitDepth(int bitDepth)

Sets the desired bit depth for a grayscale image. The bit depth must be one of 1, 2, 4, 8, or 16.

When encoding a source image of a greater bit depth, pixel values will be clamped to the smaller range after shifting by the value given by getBitShift(). When encoding a source image of a smaller bit depth, pixel values will be shifted and left-filled with zeroes.

Specified by:

setBitDepth in class mxPngEncodeParam

setBackgroundGray

public void setBackgroundGray(int gray)

Sets the suggested gray level of the background.

The 'bKGD' chunk will encode this information.

getBackgroundGray

public int getBackgroundGray()

Returns the suggested gray level of the background.

If the background gray level has not previously been set, or has been unset, an IllegalStateException will be thrown.

Throws:

java.lang.IllegalStateException - if the background gray level is not set.

setTransparentGray

public void setTransparentGray(int transparentGray)

Sets the gray value to be used to denote transparency.

Setting this attribute will cause the alpha channel of the input image to be ignored.

The 'tRNS' chunk will encode this information.

getTransparentGray

public int getTransparentGray()

Returns the gray value to be used to denote transparency.

If the transparent gray value has not previously been set, or has been unset, an IllegalStateException will be thrown.

Throws:

java.lang.IllegalStateException - if the transparent gray value is not set.

setBitShift

public void setBitShift(int bitShift)

Sets the desired bit shift for a grayscale image. Pixels in the source image will be shifted right by the given amount prior to being clamped to the maximum value given by the encoded image's bit depth.

getBitShift

public int getBitShift()

Returns the desired bit shift for a grayscale image.

If the bit shift has not previously been set, or has been unset, an IllegalStateException will be thrown.

Throws:

java.lang.IllegalStateException - if the bit shift is not set.

unsetBitShift

public void unsetBitShift()

Suppresses the setting of the bit shift of a grayscale image. Pixels in the source image will not be shifted prior to encoding.

isBitShiftSet

public boolean isBitShiftSet()

Returns true if the bit shift has been set.

isBitDepthSet

public boolean isBitDepthSet()

Returns true if the bit depth has been set.