net.sf.jcgm.imageio.plugins.cgm
Class CGMImageReadParam

java.lang.Object
  javax.imageio.IIOParam
      javax.imageio.ImageReadParam
          net.sf.jcgm.imageio.plugins.cgm.CGMImageReadParam

public class CGMImageReadParam
extends javax.imageio.ImageReadParam

CGM specific image read parameters. Adds the ability to define the resolution to use for the CGM image, in DPI (dots per inch).

Version:

$Id: CGMImageReadParam.java 39 2011-04-20 08:44:38Z phica $

Author:

xphc (Philippe Cadé)

Field Summary

Fields inherited from class javax.imageio.ImageReadParam

canSetSourceRenderSize, destination, destinationBands, minProgressivePass, numProgressivePasses, sourceRenderSize

Fields inherited from class javax.imageio.IIOParam

controller, defaultController, destinationOffset, destinationType, sourceBands, sourceRegion, sourceXSubsampling, sourceYSubsampling, subsamplingXOffset, subsamplingYOffset

Constructor Summary

CGMImageReadParam()
Builds image read parameters for a CGM file, using the default DPI settings

CGMImageReadParam(double dpi)
Builds image read parameters for a CGM file

Method Summary

boolean	canSetSourceRenderSize()
double	getDPI() Returns the dots per inch setting defined when reading the CGM file
java.util.List<Message>	getMessages() Returns the error messages that were encountered while reading the CGM files
void	setDPI(double dpi) Defines the dot per inch setting to use when reading the CGM file
void	setMessages(java.util.List<Message> messages) Sets the error messages that were encountered during the reading of the CGM file.

Methods inherited from class javax.imageio.ImageReadParam

getDestination, getDestinationBands, getSourceMaxProgressivePass, getSourceMinProgressivePass, getSourceNumProgressivePasses, getSourceRenderSize, setDestination, setDestinationBands, setDestinationType, setSourceProgressivePasses, setSourceRenderSize

Methods inherited from class javax.imageio.IIOParam

activateController, getController, getDefaultController, getDestinationOffset, getDestinationType, getSourceBands, getSourceRegion, getSourceXSubsampling, getSourceYSubsampling, getSubsamplingXOffset, getSubsamplingYOffset, hasController, setController, setDestinationOffset, setSourceBands, setSourceRegion, setSourceSubsampling

Methods inherited from class java.lang.Object

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

Constructor Detail

CGMImageReadParam

public CGMImageReadParam()

Builds image read parameters for a CGM file, using the default DPI settings

CGMImageReadParam

public CGMImageReadParam(double dpi)

Builds image read parameters for a CGM file

Parameters:

dpi - The DPI setting to use

Method Detail

canSetSourceRenderSize

public boolean canSetSourceRenderSize()

Overrides:

canSetSourceRenderSize in class javax.imageio.ImageReadParam

setDPI

public void setDPI(double dpi)

Defines the dot per inch setting to use when reading the CGM file

Parameters:

dpi - the DPI to set

getDPI

public double getDPI()

Returns the dots per inch setting defined when reading the CGM file

Returns:

the current DPI setting

getMessages

public java.util.List<Message> getMessages()

Returns the error messages that were encountered while reading the CGM files

Returns:

A list of messages

setMessages

public void setMessages(java.util.List<Message> messages)

Sets the error messages that were encountered during the reading of the CGM file. This method is called by the CGMImageReader class.

Parameters:

messages - The error messages to set