Package com.mxgraph.util.png
Class mxPngEncodeParam.Palette
java.lang.Object
com.mxgraph.util.png.mxPngEncodeParam
com.mxgraph.util.png.mxPngEncodeParam.Palette
- Enclosing class:
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 -
Method Summary
Modifier and TypeMethodDescriptionint
Returns the palette index of the suggested background color.int[]
Returns the current RGB palette.byte[]
Returns the alpha values associated with each palette entry.boolean
Returns true if a 'bKGD' chunk will be output.boolean
Returns true if a 'PLTE' chunk will be output.void
setBackgroundPaletteIndex
(int index) Sets the palette index of the suggested background color.void
setBitDepth
(int bitDepth) Sets the desired bit depth for a palette image.void
setPalette
(int[] rgb) Sets the RGB palette of the image to be encoded.void
setPaletteTransparency
(byte[] alpha) Sets the alpha values associated with each palette entry.void
Suppresses the 'bKGD' chunk from being output.void
Suppresses the 'PLTE' chunk from being output.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
-
Constructor Details
-
Palette
public Palette()Constructs an instance ofPNGEncodeParam.Palette
.
-
-
Method Details
-
unsetBackground
public void unsetBackground()Suppresses the 'bKGD' chunk from being output.- Overrides:
unsetBackground
in classmxPngEncodeParam
-
isBackgroundSet
public boolean isBackgroundSet()Returns true if a 'bKGD' chunk will be output.- Overrides:
isBackgroundSet
in classmxPngEncodeParam
-
setBitDepth
public void setBitDepth(int bitDepth) Sets the desired bit depth for a palette image. The bit depth must be one of 1, 2, 4, or 8, or else anIllegalArgumentException
will be thrown.- Specified by:
setBitDepth
in classmxPngEncodeParam
-
setPalette
public void setPalette(int[] rgb) Sets the RGB palette of the image to be encoded. Thergb
parameter contains alternating R, G, B values for each color index used in the image. The number of elements must be a multiple of 3 between 3 and 3*256.The 'PLTE' chunk will encode this information.
- Parameters:
rgb
- An array ofint
s.
-
getPalette
public int[] getPalette()Returns the current RGB palette.If the palette has not previously been set, or has been unset, an
IllegalStateException
will be thrown.- Returns:
- An array of
int
s. - Throws:
IllegalStateException
- if the palette is not set.
-
unsetPalette
public void unsetPalette()Suppresses the 'PLTE' chunk from being output. -
isPaletteSet
public boolean isPaletteSet()Returns true if a 'PLTE' chunk will be output. -
setBackgroundPaletteIndex
public void setBackgroundPaletteIndex(int index) Sets the palette index of the suggested background color.The 'bKGD' chunk will encode this information.
-
getBackgroundPaletteIndex
public int getBackgroundPaletteIndex()Returns the palette index of the suggested background color.If the background palette index has not previously been set, or has been unset, an
IllegalStateException
will be thrown.- Throws:
IllegalStateException
- if the palette index is not set.
-
setPaletteTransparency
public void setPaletteTransparency(byte[] alpha) Sets the alpha values associated with each palette entry. Thealpha
parameter should have as many entries as there are RGB triples in the palette.The 'tRNS' chunk will encode this information.
-
getPaletteTransparency
public byte[] getPaletteTransparency()Returns the alpha values associated with each palette entry.If the palette transparency has not previously been set, or has been unset, an
IllegalStateException
will be thrown.- Throws:
IllegalStateException
- if the palette transparency is not set.
-