com.ajtjp.jImageReader.reader

Class PCXReader

java.lang.Object

javax.imageio.ImageReader

com.ajtjp.jImageReader.reader.PCXReader

All Implemented Interfaces:

JImageReader

public class PCXReader
extends ImageReader
implements JImageReader

Reader for 8-bit and 24-bit PCX files.

This class does not support EGA (16 color) or CGA .PCX files.

Originally created on April 15, 2010. 24-bit PCX support added March 28, 2011.

Author:

Andrew Jones

Field Summary

Fields inherited from class javax.imageio.ImageReader

availableLocales, ignoreMetadata, input, locale, minIndex, originatingProvider, progressListeners, seekForwardOnly, updateListeners, warningListeners, warningLocales

Constructor Summary

Constructors

Constructor and Description
PCXReader(ImageReaderSpi originatingProvider)
PCXReader(String string) Constructor takes a String representation of the PCX file location.

Method Summary

Modifier and Type	Method and Description
static boolean	canReadImage(ImageInputStream iis)
void	createBufferedImage() Creates a BufferedImage from the PCX image.
int	getHeight() Returns the image's height.
int	getHeight(int imageIndex)
BufferedImage	getImage() Returns the PCX image as a BufferedImage.
IIOMetadata	getImageMetadata(int imageIndex)
Iterator<ImageTypeSpecifier>	getImageTypes(int image)
String	getMetadataSummary() Returns a summary of the image's metadata.
int	getNumImages(boolean whatever)
IIOMetadata	getStreamMetadata()
BufferedImage	getSubimage(int xStart, int yStart, int width, int height) Returns the subimage of this PCX image.
int	getWidth() Returns the image's width.
int	getWidth(int imageIndex)
void	parse() Parses the PCX that has been read into the buffer.
void	processFile() Processes the file supplied at initialization, and stores the image in the reader.
BufferedImage	read(int imageIndex, ImageReadParam ignored)
void	readFile() Reads the PCX file into the buffer.
void	readFile(ImageInputStream iis) Reads the PCX file into the buffer.
void	saveExistingPCX(String filename) Saves a PCX, assuming that we already have a PCX.
void	setColor(int index, Color color) Changes the color that was at position index in the palette to a new color, color.
String	toString()

Methods inherited from class javax.imageio.ImageReader

abort, abortRequested, addIIOReadProgressListener, addIIOReadUpdateListener, addIIOReadWarningListener, canReadRaster, checkReadParamBandSettings, clearAbortRequest, computeRegions, dispose, getAspectRatio, getAvailableLocales, getDefaultReadParam, getDestination, getFormatName, getImageMetadata, getInput, getLocale, getMinIndex, getNumThumbnails, getOriginatingProvider, getRawImageType, getSourceRegion, getStreamMetadata, getThumbnailHeight, getThumbnailWidth, getTileGridXOffset, getTileGridYOffset, getTileHeight, getTileWidth, hasThumbnails, isIgnoringMetadata, isImageTiled, isRandomAccessEasy, isSeekForwardOnly, processImageComplete, processImageProgress, processImageStarted, processImageUpdate, processPassComplete, processPassStarted, processReadAborted, processSequenceComplete, processSequenceStarted, processThumbnailComplete, processThumbnailPassComplete, processThumbnailPassStarted, processThumbnailProgress, processThumbnailStarted, processThumbnailUpdate, processWarningOccurred, processWarningOccurred, read, readAll, readAll, readAsRenderedImage, readerSupportsThumbnails, readRaster, readThumbnail, readTile, readTileRaster, removeAllIIOReadProgressListeners, removeAllIIOReadUpdateListeners, removeAllIIOReadWarningListeners, removeIIOReadProgressListener, removeIIOReadUpdateListener, removeIIOReadWarningListener, reset, setInput, setInput, setInput, setLocale

Methods inherited from class java.lang.Object

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

Constructor Detail

PCXReader

public PCXReader(String string)

Constructor takes a String representation of the PCX file location.

Parameters:

string - - A String representing the PCX file location.

PCXReader

public PCXReader(ImageReaderSpi originatingProvider)

Method Detail

processFile

public void processFile()

Description copied from interface: JImageReader

Processes the file supplied at initialization, and stores the image in the reader.

Specified by:

processFile in interface JImageReader

readFile

public void readFile()

Reads the PCX file into the buffer. Does not actually do any processing.

readFile

public void readFile(ImageInputStream iis)

Reads the PCX file into the buffer. Does not actually do any processing.

Parameters:

iis - The ImageInputStream that is being read.

parse

public void parse()

Parses the PCX that has been read into the buffer.

createBufferedImage

public void createBufferedImage()

Creates a BufferedImage from the PCX image.

getSubimage

public BufferedImage getSubimage(int xStart,
                                 int yStart,
                                 int width,
                                 int height)

Returns the subimage of this PCX image. This method does not do bounds-checking to make sure the subimage does not go off the edge of this image.

Parameters:

xStart - - The x coordinate (in this image) of the leftmost part of the subimage.

yStart - - The y coordinate (in this image) of the uppermost part of the subimage.

width - - The width of the subimage.

height - - The height of the subimage.

Returns:

- The subimage, as a BufferedImage.

getImage

public BufferedImage getImage()

Returns the PCX image as a BufferedImage. Note that the BufferedImage must already have been created.

Specified by:

getImage in interface JImageReader

Returns:

The PCX image as a BufferedImage

getWidth

public int getWidth()

Description copied from interface: JImageReader

Returns the image's width.

Specified by:

getWidth in interface JImageReader

Returns:

The image's width.

getHeight

public int getHeight()

Description copied from interface: JImageReader

Returns the image's height.

Specified by:

getHeight in interface JImageReader

Returns:

The image's height.

toString

public String toString()

Overrides:

toString in class Object

Returns:

- A string representation of the PCX file, including metadata.

saveExistingPCX

public void saveExistingPCX(String filename)

Saves a PCX, assuming that we already have a PCX.

Parameters:

filename - The name of the file, as it should be saved on disk.

setColor

public void setColor(int index,
                     Color color)

Changes the color that was at position index in the palette to a new color, color.

Parameters:

index - - The index in the palette of the color to be replaced.

color - - The new color.

getMetadataSummary

public String getMetadataSummary()

Description copied from interface: JImageReader

Returns a summary of the image's metadata. This will likely not be a String in future releases.

Specified by:

getMetadataSummary in interface JImageReader

Returns:

A summary fo the image's metadata.

read

public BufferedImage read(int imageIndex,
                          ImageReadParam ignored)

Specified by:

read in class ImageReader

getImageMetadata

public IIOMetadata getImageMetadata(int imageIndex)

Specified by:

getImageMetadata in class ImageReader

getStreamMetadata

public IIOMetadata getStreamMetadata()

Specified by:

getStreamMetadata in class ImageReader

getImageTypes

public Iterator<ImageTypeSpecifier> getImageTypes(int image)

Specified by:

getImageTypes in class ImageReader

getHeight

public int getHeight(int imageIndex)

Specified by:

getHeight in class ImageReader

getWidth

public int getWidth(int imageIndex)

Specified by:

getWidth in class ImageReader

getNumImages

public int getNumImages(boolean whatever)

Specified by:

getNumImages in class ImageReader

canReadImage

public static boolean canReadImage(ImageInputStream iis)