API Overview API Index Package Overview Direct link to this page
JDK 1.6
  javax.imageio. ImageWriteParam View Source
Author(s)
Since
Version
0.5
Serial
Hierarchy
 Object
      IIOParam
          ImageWriteParam
Implements
Subclasses
Description
public class ImageWriteParam
  A class describing how a stream is to be encoded.
See also:    ImageReadParam
Constructors
protected ImageWriteParam ()
  Constructs an empty ImageWriteParam.
public ImageWriteParam (Locale locale)
  Constructs an ImageWriteParam set to use a given Locale.
Methods
Hide/Show inherited methods
public boolean activateController () [Inherited From IIOParam]
  Activates the installed IIOParamController for this IIOParam object and returns the resulting value.
public boolean canOffsetTiles ()
  Returns true if the writer can perform tiling with non-zero grid offsets while writing.
public boolean canWriteCompressed ()
  Returns true if this writer supports compression.
public boolean canWriteProgressive ()
  Returns true if the writer can write out images as a series of passes of progressively increasing quality.
public boolean canWriteTiles ()
  Returns true if the writer can perform tiling while writing.
public float getBitRate (float quality)
  Returns a float indicating an estimate of the number of bits of output data for each bit of input image data at the given quality level.
public int getCompressionMode ()
  Returns the current compression mode, if compression is supported.
public float getCompressionQuality ()
  Returns the current compression quality setting.
public String 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 ()
  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 String getCompressionType ()
  Returns the currently set compression type, or null if none has been set.
public String getCompressionTypes ()
  Returns a list of available compression types, as an array or Strings, or null if a compression type may not be chosen using these interfaces.
public IIOParamController getController () [Inherited From IIOParam]
  Returns whatever IIOParamController is currently installed.
public IIOParamController getDefaultController () [Inherited From IIOParam]
  Returns the default IIOParamController, if there is one, regardless of the currently installed controller.
public Point getDestinationOffset () [Inherited From IIOParam]
  Returns the offset in the destination image at which pixels are to be placed.
public ImageTypeSpecifier getDestinationType () [Inherited From IIOParam]
  Returns the type of image to be returned by the read, if one was set by a call to setDestination(ImageTypeSpecifier), as an ImageTypeSpecifier.
public Locale getLocale ()
  Returns the currently set Locale, or null if only a default Locale is supported.
public String getLocalizedCompressionTypeName ()
  Returns a localized version of the name of the current compression type, using the Locale returned by getLocale.
public Dimension getPreferredTileSizes ()
  Returns an array of Dimensions indicating the legal size ranges for tiles as they will be encoded in the output file or stream.
public int getProgressiveMode ()
  Returns the current mode for writing the stream in a progressive manner.
public int getSourceBands () [Inherited From IIOParam]
  Returns the set of of source bands to be used.
public Rectangle getSourceRegion () [Inherited From IIOParam]
  Returns the source region to be used.
public int getSourceXSubsampling () [Inherited From IIOParam]
  Returns the number of source columns to advance for each pixel.
public int getSourceYSubsampling () [Inherited From IIOParam]
  Returns the number of rows to advance for each pixel.
public int getSubsamplingXOffset () [Inherited From IIOParam]
  Returns the horizontal offset of the subsampling grid.
public int getSubsamplingYOffset () [Inherited From IIOParam]
  Returns the vertical offset of the subsampling grid.
public int getTileGridXOffset ()
  Returns the horizontal tile grid offset of an image as it will be written to the output stream.
public int getTileGridYOffset ()
  Returns the vertical tile grid offset of an image as it will be written to the output stream.
public int getTileHeight ()
  Returns the height of each tile in an image as it will be written to the output stream.
public int getTileWidth ()
  Returns the width of each tile in an image as it will be written to the output stream.
public int getTilingMode ()
  Returns the current tiling mode, if tiling is supported.
public boolean hasController () [Inherited From IIOParam]
  Returns true if there is a controller installed for this IIOParam object.
public boolean isCompressionLossless ()
  Returns true if the current compression type provides lossless compression.
public void setCompressionMode (int mode)
  Specifies whether compression is to be performed, and if so how compression parameters are to be determined.
public void setCompressionQuality (float quality)
  Sets the compression quality to a value between 0 and 1.
public void setCompressionType (String compressionType)
  Sets the compression type to one of the values indicated by getCompressionTypes.
public void setController (IIOParamController controller) [Inherited From IIOParam]
  Sets the IIOParamController to be used to provide settings for this IIOParam object when the activateController method is called, overriding any default controller.
public void setDestinationOffset (Point destinationOffset) [Inherited From IIOParam]
  Specifies the offset in the destination image at which future decoded pixels are to be placed, when reading, or where a region will be written, when writing.
public void setDestinationType (ImageTypeSpecifier destinationType) [Inherited From IIOParam]
  Sets the desired image type for the destination image, using an ImageTypeSpecifier.
public void setProgressiveMode (int mode)
  Specifies that the writer is to write the image out in a progressive mode such that the stream will contain a series of scans of increasing quality.
public void setSourceBands (int[] sourceBands) [Inherited From IIOParam]
  Sets the indices of the source bands to be used.
public void setSourceRegion (Rectangle sourceRegion) [Inherited From IIOParam]
  Sets the source region of interest.
public void setSourceSubsampling (int sourceXSubsampling, int sourceYSubsampling, int subsamplingXOffset, int subsamplingYOffset) [Inherited From IIOParam]
  Specifies a decimation subsampling to apply on I/O.
public void setTiling (int tileWidth, int tileHeight, int tileGridXOffset, int tileGridYOffset)
  Specifies that the image should be tiled in the output stream.
public void setTilingMode (int mode)
  Determines whether the image will be tiled in the output stream and, if it will, how the tiling parameters will be determined.
public void unsetCompression ()
  Removes any previous compression type and quality settings.
public void unsetTiling ()
  Removes any previous tile grid parameters specified by calls to setTiling.
Fields
Hide/Show inherited fields
protected boolean canOffsetTiles
  A boolean that is true if this ImageWriteParam allows tiling grid offset parameters to be set.
protected boolean canWriteCompressed
  A boolean that is true if this writer can write images using compression.
protected boolean canWriteProgressive
  A boolean that is true if this ImageWriteParam allows images to be written as a progressive sequence of increasing quality passes.
protected boolean canWriteTiles
  A boolean that is true if this ImageWriteParam allows tile width and tile height parameters to be set.
protected int compressionMode
  The mode controlling compression settings, which must be set to one of the four MODE_* values.
protected float compressionQuality
  A float containing the current compression quality setting.
protected String compressionType
  A String containing the name of the current compression type, or null if none is set.
protected String compressionTypes
  An array of Strings containing the names of the available compression types.
protected IIOParamController controller [Inherited From IIOParam]
  The IIOParamController that will be used to provide settings for this IIOParam object when the activateController method is called.
protected IIOParamController defaultController [Inherited From IIOParam]
  The default IIOParamController that will be used to provide settings for this IIOParam object when the activateController method is called.
protected Point destinationOffset [Inherited From IIOParam]
  The offset in the destination where the upper-left decoded pixel should be placed.
protected ImageTypeSpecifier destinationType [Inherited From IIOParam]
  An ImageTypeSpecifier to be used to generate a destination image when reading, or to set the output color type when writing.
protected Locale locale
  A Locale to be used to localize compression type names and quality descriptions, or null to use a default Locale.
publicfinalstatic int MODE_COPY_FROM_METADATA = "3"
  A constant value that may be passed into methods such as setTilingMode, setProgressiveMode, or setCompressionMode to enable that feature for future writes.
publicfinalstatic int MODE_DEFAULT = "1"
  A constant value that may be passed into methods such as setTilingMode, setProgressiveMode, and setCompressionMode to enable that feature for future writes.
publicfinalstatic int MODE_DISABLED = "0"
  A constant value that may be passed into methods such as setTilingMode, setProgressiveMode, and setCompressionMode to disable a feature for future writes.
publicfinalstatic int MODE_EXPLICIT = "2"
  A constant value that may be passed into methods such as setTilingMode or setCompressionMode to enable a feature for future writes.
protected Dimension preferredTileSizes
  An array of 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 sourceBands [Inherited From IIOParam]
  An array of ints indicating which source bands will be used, or null.
protected Rectangle sourceRegion [Inherited From IIOParam]
The source region, on null if none is set.
protected int sourceXSubsampling [Inherited From IIOParam]
  The decimation subsampling to be applied in the horizontal direction.
protected int sourceYSubsampling [Inherited From IIOParam]
  The decimation subsampling to be applied in the vertical direction.
protected int subsamplingXOffset [Inherited From IIOParam]
  A horizontal offset to be applied to the subsampling grid before subsampling.
protected int subsamplingYOffset [Inherited From IIOParam]
  A vertical offset to be applied to the subsampling grid before subsampling.
protected int tileGridXOffset
  The amount by which the tile grid origin should be offset horizontally from the image origin if tiling has been set, or 0 otherwise.
protected int tileGridYOffset
  The amount by which the tile grid origin should be offset vertically from the image origin if tiling has been set, or 0 otherwise.
protected int tileHeight
  The height of each tile if tiling has been set, or 0 otherwise.
protected int tileWidth
  The width of each tile if tiling has been set, or 0 otherwise.
protected int tilingMode
  The mode controlling tiling settings, which Must be set to one of the four MODE_* values.
protected boolean tilingSet
  A boolean that is true if tiling parameters have been specified.
Nested Classes
Generated By: JavaOnTracks Doclet 0.1.4     ©Thibaut Colar