org.safs.image

Class ImageManager

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

org.safs.image.ImageManager

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.KeyListener, java.awt.event.WindowFocusListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class ImageManager
extends javax.swing.JFrame
implements java.awt.event.ActionListener, java.awt.event.KeyListener, java.awt.event.WindowFocusListener

ImageManager is a small utility that allows us to easily capture arbitrary areas of the screen and save them them as BMP or JPG files.

ImageManager allows us to set a default Project Root. The Project Root is the root or parent directory into which all images can be stored. Images can be saved anywhere, but the File dialogs will use the Project Root as your current directory when prompting you for a image name and save location. You would typically save images to this root directory or one of its subdirectories.

With ImageManager running, you can start the image capture process in two ways.

• CTRL mode

  The Image Manager window is expected to remain the Active window.
  This mode can be used to capture arbitrary onscreen images when the item or Window containing the item does not need to become the active window.

  1. Press the CTRL GO button to enter CTRL mode.

  2. Move the mouse cursor to the area to capture.

  3. Press and hold the CTRL key while moving the mouse to define the area to capture.
     Note: you do not Click any of the buttons on the mouse.
     If you do, this will deactivate the CTRL mode.
     

  4. You will notice that Image Manager is tracking the rectangle size.

  5. Release the CTRL key when you are done defining the area.

  6. You will be prompted to save or discard the image you have captured.

• FOCUS mode

  The item or Window containing the item must become the Active window.
  Image Manager must track the mouse when it is NOT the active window.

  1. Press the FOCUS GO button to enter FOCUS mode.

  2. Move the mouse cursor to the screen point to start the capture.

  3. Click on the point to start the capture or cycle through ALT+TAB to switch to the application giving it focus. Either way, when Image Manager is no longer the active window it is monitoring the rectangle to capture.

  4. You will notice that Image Manager is tracking the rectangle size.

  5. Move the cursor to the screen point that completes the rectangle you wish to capture. Hold the cursor there during the next step.

  6. Press or cycle through ALT+TAB to make Image Manager the active Window.

  7. You will be prompted to save or discard the image you have captured.

ImageManager can accept one argument in its constructor or from the Java command-line:

prjroot -- A valid directory to use as the Project Root.

From inside a Java application:

import org.safs.image.ImageManager;
...
ImageManager im = new ImageManager("C:\SAFSProject\images");

From the Java command-line:

java org.safs.image.ImageManager "C:\SAFSProject\images"

ImageManager requires Java 1.5 or higher.

Author:

Carl Nagle

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ImageManager.MyCanvas Class used internally to present the screen captured image in the Save As dialog.
class	ImageManager.MyThread

Nested classes/interfaces inherited from class javax.swing.JFrame

javax.swing.JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class java.awt.Frame

java.awt.Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
(package private) javax.swing.JButton	_altstart
(package private) javax.swing.JTextField	_focus
(package private) java.lang.String	_focus_capture
(package private) java.lang.String	_focus_release
(package private) java.lang.String	_focus_swapoff
(package private) java.lang.String	_focus_swapon
(package private) java.lang.String	_focus_unknown
(package private) javax.swing.JLabel	_info
(package private) javax.swing.JButton	_start
(package private) javax.swing.JButton	_stop
(package private) ImageManager.MyThread	altrect
(package private) boolean	ctrl_mode
(package private) java.awt.Point	end_rect
(package private) java.awt.image.BufferedImage	image
(package private) java.lang.String	info_unknown
(package private) javax.swing.JTextField	path
(package private) javax.swing.JButton	project_browse
(package private) javax.swing.JLabel	project_label
(package private) java.awt.Rectangle	rect
(package private) boolean	rect_started
(package private) java.awt.Robot	robot
(package private) boolean	running
(package private) java.awt.Point	start_rect

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Modifier	Constructor and Description
	ImageManager() Default constructor trying to set C:\SAFS\Project as the initial Project Root.
protected	ImageManager(java.awt.GraphicsConfiguration arg0)
	ImageManager(java.lang.String prjroot) Constructor trying to set an alternate Project Root at startup.
protected	ImageManager(java.lang.String arg0, java.awt.GraphicsConfiguration arg1)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent event)
void	keyPressed(java.awt.event.KeyEvent e)
void	keyReleased(java.awt.event.KeyEvent e)
void	keyTyped(java.awt.event.KeyEvent e)
static void	main(java.lang.String[] args) Accepts one optional argument -- the path to a valid Project Root directory.
protected void	promptSaveSnapshot()
protected void	startAltCaptureEvents()
protected void	startCaptureEvents()
protected void	startCaptureRect()
protected void	stopCaptureEvents()
protected void	stopCaptureRect()
void	windowGainedFocus(java.awt.event.WindowEvent e)
void	windowLostFocus(java.awt.event.WindowEvent e)

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

info_unknown

java.lang.String info_unknown

_focus_unknown

java.lang.String _focus_unknown

_focus_capture

java.lang.String _focus_capture

_focus_release

java.lang.String _focus_release

_focus_swapon

java.lang.String _focus_swapon

_focus_swapoff

java.lang.String _focus_swapoff

project_label

javax.swing.JLabel project_label

project_browse

javax.swing.JButton project_browse

path

javax.swing.JTextField path

_info

javax.swing.JLabel _info

_start

javax.swing.JButton _start

_altstart

javax.swing.JButton _altstart

_stop

javax.swing.JButton _stop

_focus

javax.swing.JTextField _focus

robot

java.awt.Robot robot

image

java.awt.image.BufferedImage image

ctrl_mode

boolean ctrl_mode

running

boolean running

rect_started

boolean rect_started

start_rect

java.awt.Point start_rect

end_rect

java.awt.Point end_rect

rect

java.awt.Rectangle rect

altrect

ImageManager.MyThread altrect

Constructor Detail

ImageManager

public ImageManager()
             throws java.awt.HeadlessException

Default constructor trying to set C:\SAFS\Project as the initial Project Root.

Throws:

java.awt.HeadlessException

ImageManager

protected ImageManager(java.awt.GraphicsConfiguration arg0)

ImageManager

public ImageManager(java.lang.String prjroot)
             throws java.awt.HeadlessException

Constructor trying to set an alternate Project Root at startup. If the directory is determined to be invalid or does not have write permissions then the User's Current Working Directory is used as the Project Root.

Parameters:

prjroot - -- full path to a valid directory to serve as the Project Root.

Throws:

java.awt.HeadlessException

ImageManager

protected ImageManager(java.lang.String arg0,
                       java.awt.GraphicsConfiguration arg1)

Method Detail

startCaptureRect

protected void startCaptureRect()

stopCaptureRect

protected void stopCaptureRect()

promptSaveSnapshot

protected void promptSaveSnapshot()

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)

Specified by:

keyPressed in interface java.awt.event.KeyListener

keyReleased

public void keyReleased(java.awt.event.KeyEvent e)

Specified by:

keyReleased in interface java.awt.event.KeyListener

keyTyped

public void keyTyped(java.awt.event.KeyEvent e)

Specified by:

keyTyped in interface java.awt.event.KeyListener

windowGainedFocus

public void windowGainedFocus(java.awt.event.WindowEvent e)

Specified by:

windowGainedFocus in interface java.awt.event.WindowFocusListener

windowLostFocus

public void windowLostFocus(java.awt.event.WindowEvent e)

Specified by:

windowLostFocus in interface java.awt.event.WindowFocusListener

startAltCaptureEvents

protected void startAltCaptureEvents()

startCaptureEvents

protected void startCaptureEvents()

stopCaptureEvents

protected void stopCaptureEvents()

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

main

public static void main(java.lang.String[] args)

Accepts one optional argument -- the path to a valid Project Root directory. If the path contains spaces then it should be enclosed in double-quotes.

From the Java command-line:

java org.safs.image.ImageManager "C:\SAFSProject\images"

Parameters:

args - String[] of which only arg[0] will be used.