org.jemmy.image

Class PNGEncoder

java.lang.Object

org.jemmy.image.PNGEncoder

public class PNGEncoder
extends Object

This class allows to encode BufferedImage into B/W, greyscale or true color PNG image format with maximum compression.
It also provides complete functionality for capturing full screen, part of screen or single component, encoding and saving captured image info PNG file.

Version:

1.0

Author:

Adam Sotona

Field Summary

Fields

Modifier and Type	Field and Description
static byte	BW_MODE black and white image mode.
static byte	COLOR_MODE full color image mode.
static byte	GREYSCALE_MODE grey scale image mode.

Constructor Summary

Constructors

Constructor and Description
PNGEncoder(File file)
PNGEncoder(OutputStream out) public constructor of PNGEncoder class with greyscale mode by default.
PNGEncoder(OutputStream out, byte mode) public constructor of PNGEncoder class.

Method Summary

Modifier and Type	Method and Description
static void	captureScreen(Rectangle rect, String fileName) Static method performing screen capture into PNG image format file with given fileName.
static void	captureScreen(Rectangle rect, String fileName, byte mode) Static method performing screen capture into PNG image format file with given fileName.
static void	captureScreen(ScreenArea comp, String fileName) Static method performing one component screen capture into PNG image format file with given fileName.
static void	captureScreen(ScreenArea comp, String fileName, byte mode) Static method performing one component screen capture into PNG image format file with given fileName.
static void	captureScreen(String fileName) Static method performing whole screen capture into PNG image format file with given fileName.
static void	captureScreen(String fileName, byte mode) Static method performing whole screen capture into PNG image format file with given fileName.
void	encode(BufferedImage image) main encoding method (stays blocked till encoding is finished).
void	encode(BufferedImage image, boolean closeStream) main encoding method (stays blocked till encoding is finished).

Methods inherited from class java.lang.Object

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

Field Detail

BW_MODE

public static final byte BW_MODE

black and white image mode.

See Also:

Constant Field Values

GREYSCALE_MODE

public static final byte GREYSCALE_MODE

grey scale image mode.

See Also:

Constant Field Values

COLOR_MODE

public static final byte COLOR_MODE

full color image mode.

See Also:

Constant Field Values

Constructor Detail

PNGEncoder

public PNGEncoder(File file)
           throws FileNotFoundException

Throws:

FileNotFoundException

PNGEncoder

public PNGEncoder(OutputStream out)

public constructor of PNGEncoder class with greyscale mode by default.

Parameters:

out - output stream for PNG image format to write into

PNGEncoder

public PNGEncoder(OutputStream out,
                  byte mode)

public constructor of PNGEncoder class.

Parameters:

out - output stream for PNG image format to write into

mode - BW_MODE, GREYSCALE_MODE or COLOR_MODE

Method Detail

encode

public void encode(BufferedImage image)
            throws IOException

main encoding method (stays blocked till encoding is finished).

Parameters:

image - BufferedImage to encode

Throws:

IOException - IOException

encode

public void encode(BufferedImage image,
                   boolean closeStream)
            throws IOException

main encoding method (stays blocked till encoding is finished).

Parameters:

image - BufferedImage to encode

closeStream - requests method to close the stream after the image is written

Throws:

IOException - IOException

captureScreen

public static void captureScreen(Rectangle rect,
                                 String fileName)

Static method performing screen capture into PNG image format file with given fileName.

Parameters:

rect - Rectangle of screen to be captured

fileName - file name for screen capture PNG image file

captureScreen

public static void captureScreen(Rectangle rect,
                                 String fileName,
                                 byte mode)

Static method performing screen capture into PNG image format file with given fileName.

Parameters:

rect - Rectangle of screen to be captured

mode - image color mode

fileName - file name for screen capture PNG image file

captureScreen

public static void captureScreen(ScreenArea comp,
                                 String fileName)

Static method performing one component screen capture into PNG image format file with given fileName.

Parameters:

comp - Component to be captured

fileName - String image target filename

captureScreen

public static void captureScreen(ScreenArea comp,
                                 String fileName,
                                 byte mode)

Static method performing one component screen capture into PNG image format file with given fileName.

Parameters:

comp - Component to be captured

fileName - String image target filename

mode - image color mode

captureScreen

public static void captureScreen(String fileName)

Static method performing whole screen capture into PNG image format file with given fileName.

Parameters:

fileName - String image target filename

captureScreen

public static void captureScreen(String fileName,
                                 byte mode)

Static method performing whole screen capture into PNG image format file with given fileName.

Parameters:

fileName - String image target filename

mode - image color mode