xal.tools.apputils

Class ImageCaptureManager

java.lang.Object

xal.tools.apputils.ImageCaptureManager

public class ImageCaptureManager
extends java.lang.Object

ImageCaptureManager manages the file chooser used to save image captures of the main window. All applications share the same default folder where the images are saved. This default folder is the last folder where a user saved an image.

Field Summary

Fields

Modifier and Type	Field and Description
protected DefaultFolderAccessory	_defaultFolderAccessory accessory for managing the default snapshot folder
protected javax.swing.JFileChooser	_fileChooser chooser for saving images
protected static int	NO_OPTION
protected static int	YES_OPTION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ImageCaptureManager() Creates a new instance of ImageCaptureManager

Method Summary

Modifier and Type	Method and Description
static ImageCaptureManager	defaultManager() Get the default ImageCaptureManager instance.
static int	displayConfirmDialog(java.awt.Component owner, java.lang.String title, java.lang.String message) Display a confirmation dialog with a title and message
javax.swing.JFileChooser	getFileChooser() Get the file chooser which determines where snapshots are saved.
void	saveSnapshot(java.awt.Component component) Save a snapshot of the component as a PNG image.
void	saveSnapshot(java.awt.Component component, java.lang.String name) Save a snapshot of the component as a PNG image.

Methods inherited from class java.lang.Object

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

Field Detail

YES_OPTION

protected static final int YES_OPTION

See Also:

Constant Field Values

NO_OPTION

protected static final int NO_OPTION

See Also:

Constant Field Values

_fileChooser

protected final javax.swing.JFileChooser _fileChooser

chooser for saving images

_defaultFolderAccessory

protected final DefaultFolderAccessory _defaultFolderAccessory

accessory for managing the default snapshot folder

Constructor Detail

ImageCaptureManager

protected ImageCaptureManager()

Creates a new instance of ImageCaptureManager

Method Detail

defaultManager

public static ImageCaptureManager defaultManager()

Get the default ImageCaptureManager instance.

Returns:

The default ImageCaptureManager instance.

getFileChooser

public javax.swing.JFileChooser getFileChooser()

Get the file chooser which determines where snapshots are saved.

Returns:

the image capture file chooser

saveSnapshot

public void saveSnapshot(java.awt.Component component)
                  throws java.awt.AWTException,
                         java.io.IOException

Save a snapshot of the component as a PNG image.

Parameters:

component - The component to capture.

Throws:

java.awt.AWTException - If there is an AWT exception.

java.io.IOException - If there is a file exception.

saveSnapshot

public void saveSnapshot(java.awt.Component component,
                         java.lang.String name)
                  throws java.awt.AWTException,
                         java.io.IOException

Save a snapshot of the component as a PNG image.

Parameters:

component - The component to capture.

name - The snapshot name

Throws:

java.awt.AWTException - If there is an AWT exception.

java.io.IOException - If there is a file exception.

displayConfirmDialog

public static int displayConfirmDialog(java.awt.Component owner,
                                       java.lang.String title,
                                       java.lang.String message)

Display a confirmation dialog with a title and message

Parameters:

owner - The component in front of which to show the dialog

title - The title of the dialog

message - The message to display

Returns:

YES_OPTION or NO_OPTION