utils

Class ScreenCapture

java.lang.Object

utils.ScreenCapture

public class ScreenCapture
extends java.lang.Object

A helper class to save the graphical content of any swing or AWT component to individual files.

Author:

Istvan Fehervari

Constructor Summary

Constructors

Constructor and Description
ScreenCapture()

Method Summary

Methods

Modifier and Type	Method and Description
static java.awt.image.BufferedImage	captureImageContent(javax.swing.JComponent component, java.awt.Rectangle region, java.lang.String fileName) Captures the graphical content of the given region of the provided swing JComponent.
static java.awt.image.BufferedImage	captureImageContent(javax.swing.JComponent component, java.lang.String fileName) Captures the graphical content of the provided swing JComponent.
static java.awt.image.BufferedImage	captureScreen(java.awt.Rectangle region, java.lang.String fileName) Creates a BufferedImage from a rectangular region on the screen.
static java.awt.image.BufferedImage	createImage(java.awt.Component component, java.lang.String fileName) Captures the graphical content of the provided AWT Component.
static javax.swing.ImageIcon	resizeImage(java.awt.Image src, int width, int height) Resizes the given Image to the provided dimensions.
static void	writeImage(java.awt.image.BufferedImage image, java.lang.String fileName) Writes a BufferedImage to a File.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScreenCapture

public ScreenCapture()

Method Detail

captureImageContent

public static java.awt.image.BufferedImage captureImageContent(javax.swing.JComponent component,
                                               java.lang.String fileName)
                                                        throws java.io.IOException

Captures the graphical content of the provided swing JComponent. The result will be saved to the given file and returned as a BufferedImage. The entire component will be captured to an image.

Parameters:

component - Swing component to create the image from

fileName - name of file to be created. Passing null skips saving.

Returns:

the image captured

Throws:

java.io.IOException - if an error occurs during writing

captureImageContent

public static java.awt.image.BufferedImage captureImageContent(javax.swing.JComponent component,
                                               java.awt.Rectangle region,
                                               java.lang.String fileName)
                                                        throws java.io.IOException

Captures the graphical content of the given region of the provided swing JComponent. The result will be saved to the given file and returned as a BufferedImage. The entire component will be captured to an image.

Parameters:

component - Swing component to create image from

region - The region of the component to be captured to an image

fileName - name of file to be created. Passing null skips saving.

Returns:

the image captured

Throws:

java.io.IOException - if an error occurs during writing

createImage

public static java.awt.image.BufferedImage createImage(java.awt.Component component,
                                       java.lang.String fileName)
                                                throws java.awt.AWTException,
                                                       java.io.IOException

Captures the graphical content of the provided AWT Component. The result will be saved to the given file and returned as a BufferedImage. The entire component will be captured to an image.

Parameters:

component - AWT component to create the image of

fileName - name of file to be created. Passing null skips saving.

Returns:

the image captured

Throws:

java.awt.AWTException - see Robot.Robot()

java.io.IOException - if an error occurs during writing

captureScreen

public static java.awt.image.BufferedImage captureScreen(java.awt.Rectangle region,
                                         java.lang.String fileName)
                                                  throws java.awt.AWTException,
                                                         java.io.IOException

Creates a BufferedImage from a rectangular region on the screen.

Parameters:

region - region on the screen to create image from

fileName - name of file to be created or null

Returns:

image the image for the given region

Throws:

java.awt.AWTException - see Robot.Robot()

java.io.IOException - if an error occurs during writing

writeImage

public static void writeImage(java.awt.image.BufferedImage image,
              java.lang.String fileName)
                       throws java.io.IOException

Writes a BufferedImage to a File.

Parameters:

image - image to be written

fileName - name of file to be created

Throws:

java.io.IOException - if an error occurs during writing

resizeImage

public static javax.swing.ImageIcon resizeImage(java.awt.Image src,
                                int width,
                                int height)

Resizes the given Image to the provided dimensions.

Parameters:

src - the source image

width - the new width

height - the new height

Returns:

the resized image