mxPngEncodeParam (mxGraph 2.5.0.3 API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

mxGraph 2.5.0.3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.mxgraph.util.png
Class mxPngEncodeParam

java.lang.Object
  com.mxgraph.util.png.mxPngEncodeParam

Direct Known Subclasses:: mxPngEncodeParam.Gray, mxPngEncodeParam.Palette, mxPngEncodeParam.RGB

public abstract class mxPngEncodeParam
extends Object
extends Object

An instance of ImageEncodeParam for encoding images in the PNG format.

This class is not a committed part of the JAI API. It may be removed or changed in future releases of JAI.

Nested Class Summary
`static class`	`mxPngEncodeParam.Gray`
`static class`	`mxPngEncodeParam.Palette`
`static class`	`mxPngEncodeParam.RGB`

Field Summary
`protected int`	`bitDepth`
`protected boolean`	`bitDepthSet`
`static int`	`INTENT_ABSOLUTE` Constant for use with the sRGB chunk.
`static int`	`INTENT_PERCEPTUAL` Constant for use with the sRGB chunk.
`static int`	`INTENT_RELATIVE` Constant for use with the sRGB chunk.
`static int`	`INTENT_SATURATION` Constant for use with the sRGB chunk.
`static int`	`PNG_FILTER_AVERAGE` Constant for use in filtering.
`static int`	`PNG_FILTER_NONE` Constant for use in filtering.
`static int`	`PNG_FILTER_PAETH` Constant for use in filtering.
`static int`	`PNG_FILTER_SUB` Constant for use in filtering.
`static int`	`PNG_FILTER_UP` Constant for use in filtering.

Constructor Summary
`mxPngEncodeParam()`

Method Summary
`void`	`addPrivateChunk(String type, byte[] data)` Adds a private chunk, in binary form, to the list of chunks to be stored with this image.
`int`	`filterRow(byte[] currRow, byte[] prevRow, byte[][] scratchRows, int bytesPerRow, int bytesPerPixel)` Performs filtering on a row of an image.
`int`	`getBitDepth()` Returns the desired bit depth for a grayscale image.
`float[]`	`getChromaticity()` Returns the white point and primary chromaticities in CIE (x, y) space.
`String[]`	`getCompressedText()` Returns the text strings to be stored in compressed form with this image as an array of `String`s.
`static mxPngEncodeParam`	`getDefaultEncodeParam(RenderedImage im)` Returns an instance of `PNGEncodeParam.Palette`, `PNGEncodeParam.Gray`, or `PNGEncodeParam.RGB` appropriate for encoding the given image.
`float`	`getGamma()` Returns the file gamma value for the image.
`byte[]`	`getICCProfileData()` Returns the ICC profile data to be stored with this image.
`boolean`	`getInterlacing()` Returns `true` if Adam7 interlacing will be used.
`Date`	`getModificationTime()` Returns the modification time to be stored with this image.
`int`	`getNumPrivateChunks()` Returns the number of private chunks to be written to the output file.
`int[]`	`getPaletteHistogram()` Returns the palette histogram to be stored with this image.
`int[]`	`getPhysicalDimension()` Returns the physical dimension information to be stored with this image.
`byte[]`	`getPrivateChunkData(int index)` Returns the data associated of the private chunk at a given index, as an array of `byte`s.
`String`	`getPrivateChunkType(int index)` Returns the type of the private chunk at a given index, as a 4-character `String`.
`int[]`	`getSignificantBits()` Returns the number of significant bits for each band of the image.
`int`	`getSRGBIntent()` Returns the sRGB rendering intent to be stored with this image.
`String[]`	`getText()` Returns the text strings to be stored in uncompressed form with this image as an array of `String`s.
`boolean`	`isBackgroundSet()` Returns true if a 'bKGD' chunk will be output.
`boolean`	`isChromaticitySet()` Returns true if a 'cHRM' chunk will be output.
`boolean`	`isCompressedTextSet()` Returns true if a 'zTXT' chunk will be output.
`boolean`	`isGammaSet()` Returns true if a 'gAMA' chunk will be output.
`boolean`	`isICCProfileDataSet()` Returns true if a 'iCCP' chunk will be output.
`boolean`	`isModificationTimeSet()` Returns true if a 'tIME' chunk will be output.
`boolean`	`isPaletteHistogramSet()` Returns true if a 'hIST' chunk will be output.
`boolean`	`isPhysicalDimensionSet()` Returns true if a 'pHYS' chunk will be output.
`boolean`	`isSignificantBitsSet()` Returns true if an 'sBIT' chunk will be output.
`boolean`	`isSRGBIntentSet()` Returns true if an 'sRGB' chunk will be output.
`boolean`	`isSuggestedPaletteSet()` Returns true if a 'sPLT' chunk will be output.
`boolean`	`isTextSet()` Returns true if a 'tEXt' chunk will be output.
`boolean`	`isTransparencySet()` Returns true if a 'tRNS' chunk will be output.
`static int`	`paethPredictor(int a, int b, int c)` The Paeth predictor routine used in PNG encoding.
`void`	`removeAllPrivateChunks()` Remove all private chunks associated with this parameter instance.
`void`	`removeUnsafeToCopyPrivateChunks()` Remove all private chunks associated with this parameter instance whose 'safe-to-copy' bit is not set.
`abstract void`	`setBitDepth(int bitDepth)` Sets the desired bit depth of an image.
`void`	`setChromaticity(float[] chromaticity)` Sets the white point and primary chromaticities in CIE (x, y) space.
`void`	`setChromaticity(float whitePointX, float whitePointY, float redX, float redY, float greenX, float greenY, float blueX, float blueY)` A convenience method that calls the array version.
`void`	`setCompressedText(String[] text)` Sets the text strings to be stored in compressed form with this image.
`void`	`setGamma(float gamma)` Sets the file gamma value for the image.
`void`	`setICCProfileData(byte[] ICCProfileData)` Sets the ICC profile data to be stored with this image.
`void`	`setInterlacing(boolean useInterlacing)` Turns Adam7 interlacing on or off.
`void`	`setModificationTime(Date modificationTime)` Sets the modification time, as a `Date`, to be stored with this image.
`void`	`setPaletteHistogram(int[] paletteHistogram)` Sets the palette histogram to be stored with this image.
`void`	`setPhysicalDimension(int[] physicalDimension)` Sets the physical dimension information to be stored with this image.
`void`	`setPhysicalDimension(int xPixelsPerUnit, int yPixelsPerUnit, int unitSpecifier)` A convenience method that calls the array version.
`void`	`setSignificantBits(int[] significantBits)` Sets the number of significant bits for each band of the image.
`void`	`setSRGBIntent(int SRGBIntent)` Sets the sRGB rendering intent to be stored with this image.
`void`	`setSuggestedPalette(mxPngSuggestedPaletteEntry[] palette)` Sets the suggested palette information to be stored with this image.
`void`	`setText(String[] text)` Sets the textual data to be stored in uncompressed form with this image.
`void`	`unsetBackground()` Suppresses the 'bKGD' chunk from being output.
`void`	`unsetBitDepth()` Suppresses the setting of the bit depth of a grayscale image.
`void`	`unsetChromaticity()` Suppresses the 'cHRM' chunk from being output.
`void`	`unsetCompressedText()` Suppresses the 'zTXt' chunk from being output.
`void`	`unsetGamma()` Suppresses the 'gAMA' chunk from being output.
`void`	`unsetICCProfileData()` Suppresses the 'iCCP' chunk from being output.
`void`	`unsetModificationTime()` Suppresses the 'tIME' chunk from being output.
`void`	`unsetPaletteHistogram()` Suppresses the 'hIST' chunk from being output.
`void`	`unsetPhysicalDimension()` Suppresses the 'pHYS' chunk from being output.
`void`	`unsetSignificantBits()` Suppresses the 'sBIT' chunk from being output.
`void`	`unsetSRGBIntent()` Suppresses the 'sRGB' chunk from being output.
`void`	`unsetSuggestedPalette()` Suppresses the 'sPLT' chunk from being output.
`void`	`unsetText()` Suppresses the 'tEXt' chunk from being output.
`void`	`unsetTransparency()` Suppresses the 'tRNS' chunk from being output.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

INTENT_PERCEPTUAL

public static final int INTENT_PERCEPTUAL

Constant for use with the sRGB chunk.

See Also:: Constant Field Values

INTENT_RELATIVE

public static final int INTENT_RELATIVE

Constant for use with the sRGB chunk.

See Also:: Constant Field Values

INTENT_SATURATION

public static final int INTENT_SATURATION

Constant for use with the sRGB chunk.

See Also:: Constant Field Values

INTENT_ABSOLUTE

public static final int INTENT_ABSOLUTE

Constant for use with the sRGB chunk.

See Also:: Constant Field Values