API Overview API Index Package Overview Direct link to this page
JDK 1.6
  javax.imageio. ImageReadParam View Source
Author(s)
Since
Version
0.5
Serial
Hierarchy
 Object
      IIOParam
          ImageReadParam
Implements
Subclasses
Description
public class ImageReadParam
  A class describing how a stream is to be decoded.
Constructors
public ImageReadParam ()
Constructs an ImageReadParam.
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 canSetSourceRenderSize ()
  Returns true if this reader allows the source image to be rendered at an arbitrary size as part of the decoding process, by means of the setSourceRenderSize method.
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 BufferedImage getDestination ()
  Returns the BufferedImage currently set by the setDestination method, or null if none is set.
public int getDestinationBands ()
  Returns the set of band indices where data will be placed.
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 int getSourceBands () [Inherited From IIOParam]
  Returns the set of of source bands to be used.
public int getSourceMaxProgressivePass ()
  If getSourceNumProgressivePasses is equal to Integer.MAX_VALUE, returns Integer.MAX_VALUE.
public int getSourceMinProgressivePass ()
  Returns the index of the first progressive pass that will be decoded.
public int getSourceNumProgressivePasses ()
  Returns the number of the progressive passes that will be decoded.
public Rectangle getSourceRegion () [Inherited From IIOParam]
  Returns the source region to be used.
public Dimension getSourceRenderSize ()
  Returns the width and height of the source image as it will be rendered during decoding, if they have been set via the setSourceRenderSize method.
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 boolean hasController () [Inherited From IIOParam]
  Returns true if there is a controller installed for this IIOParam object.
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 setDestination (BufferedImage destination)
  Supplies a BufferedImage to be used as the destination for decoded pixel data.
public void setDestinationBands (int[] destinationBands)
  Sets the indices of the destination bands where data will be placed.
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) [Overrides IIOParam]
public void setSourceBands (int[] sourceBands) [Inherited From IIOParam]
  Sets the indices of the source bands to be used.
public void setSourceProgressivePasses (int minPass, int numPasses)
  Sets the range of progressive passes that will be decoded.
public void setSourceRegion (Rectangle sourceRegion) [Inherited From IIOParam]
  Sets the source region of interest.
public void setSourceRenderSize (Dimension size) throws UnsupportedOperationException
  If the image is able to be rendered at an arbitrary size, sets the source width and height to the supplied values.
public void setSourceSubsampling (int sourceXSubsampling, int sourceYSubsampling, int subsamplingXOffset, int subsamplingYOffset) [Inherited From IIOParam]
  Specifies a decimation subsampling to apply on I/O.
Fields
Hide/Show inherited fields
protected boolean canSetSourceRenderSize
  true if this ImageReadParam allows the source rendering dimensions to be set.
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 BufferedImage destination
  The current destination BufferedImage, or null if none has been set.
protected int destinationBands
  The set of destination bands to be used, as an array of ints.
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 int minProgressivePass
  The minimum index of a progressive pass to read from the source.
protected int numProgressivePasses
  The maximum number of progressive passes to read from the source.
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 Dimension sourceRenderSize
  The desired rendering width and height of the source, if canSetSourceRenderSize is true, or null.
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.
Nested Classes
Generated By: JavaOnTracks Doclet 0.1.4     ©Thibaut Colar