loci.formats.gui

Class ImageViewer

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

loci.formats.gui.ImageViewer

All Implemented Interfaces:

ActionListener, KeyListener, MouseMotionListener, WindowListener, ImageObserver, MenuContainer, Serializable, Runnable, EventListener, Accessible, ChangeListener, RootPaneContainer, WindowConstants

public class ImageViewer
extends JFrame
implements ActionListener, ChangeListener, KeyListener, MouseMotionListener, Runnable, WindowListener

ImageViewer is a simple viewer/converter for the Bio-Formats image formats.

Author:

Curtis Rueden ctrueden at wisc.edu

See Also:

Serialized Form

Nested Class Summary

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

JFrame.AccessibleJFrame

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

Frame.AccessibleAWTFrame

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

Window.AccessibleAWTWindow, Window.Type

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	anim
protected static char	ANIMATION_KEY
protected boolean	canCloseReader
protected JSlider	cSlider
protected String	filename
protected IFormatReader	fileReader Reader for files on disk.
protected JMenuItem	fileSave
protected JMenuItem	fileView
protected IFormatWriter	fileWriter Writer for files on disk.
protected int	fps
protected ImageIcon	icon
protected JLabel	iconLabel
protected BufferedImage[]	images
protected IFormatReader	in
private static org.slf4j.Logger	LOGGER
protected BufferedImageReader	myReader Current format reader.
protected BufferedImageWriter	myWriter Current format writer.
protected JSlider	nSlider
protected MetadataStore	omeMeta Attached OME metadata store, if available.
protected OMEXMLService	omexmlService Service for working with OME-XML metadata.
protected JPanel	pane
protected JLabel	probeLabel
protected StringBuilder	sb
protected int	sizeC
protected int	sizeT
protected int	sizeZ
protected JPanel	sliderPanel
protected static String	TITLE
protected JSlider	tSlider
protected JSlider	zSlider

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

Constructor and Description
ImageViewer() Constructs an image viewer.
ImageViewer(boolean canCloseReader) Constructs an image viewer.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e) Handles menu commands.
int	getC() Gets the C value of the currently displayed image.
BufferedImage	getImage() Gets the currently displayed image.
int	getImageIndex() Gets the index of the currently displayed image.
int	getT() Gets the T value of the currently displayed image.
int	getZ() Gets the Z value of the currently displayed image.
void	keyPressed(KeyEvent e) Handles key presses.
void	keyReleased(KeyEvent e)
void	keyTyped(KeyEvent e)
static void	main(String[] args)
void	mouseDragged(MouseEvent e) Handles cursor probes.
void	mouseMoved(MouseEvent e) Handles cursor probes.
void	open(String id) Opens the given data source using the current format reader.
protected void	open(String id, IFormatReader r) Opens from the given data source using the specified reader in a separate thread.
void	run() Handles animation.
void	save(String id) Saves the current images to the given destination using the current format writer.
protected void	save(String id, IFormatWriter w) Saves to the given data destination using the specified writer in a separate thread.
void	setImages(BufferedImage[] img) Sets the viewer to display the given images.
void	setImages(IFormatReader reader, BufferedImage[] img) Sets the viewer to display the given images, obtaining corresponding core metadata from the specified format reader.
void	setVisible(boolean visible)
void	stateChanged(ChangeEvent e) Handles slider events.
protected void	updateLabel(int x, int y) Updates cursor probe label.
protected void	wait(boolean wait) Toggles wait cursor.
void	windowActivated(WindowEvent e)
void	windowClosed(WindowEvent e)
void	windowClosing(WindowEvent e)
void	windowDeactivated(WindowEvent e)
void	windowDeiconified(WindowEvent e)
void	windowIconified(WindowEvent e)
void	windowOpened(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, 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

LOGGER

private static final org.slf4j.Logger LOGGER

TITLE

protected static final String TITLE

See Also:

Constant Field Values

ANIMATION_KEY

protected static final char ANIMATION_KEY

See Also:

Constant Field Values

pane

protected JPanel pane

icon

protected ImageIcon icon

iconLabel

protected JLabel iconLabel

sliderPanel

protected JPanel sliderPanel

nSlider

protected JSlider nSlider

zSlider

protected JSlider zSlider

tSlider

protected JSlider tSlider

cSlider

protected JSlider cSlider

probeLabel

protected JLabel probeLabel

fileView

protected JMenuItem fileView

fileSave

protected JMenuItem fileSave

omeMeta

protected MetadataStore omeMeta

Attached OME metadata store, if available.

myReader

protected BufferedImageReader myReader

Current format reader.

myWriter

protected BufferedImageWriter myWriter

Current format writer.

fileReader

protected IFormatReader fileReader

Reader for files on disk.

fileWriter

protected IFormatWriter fileWriter

Writer for files on disk.

filename

protected String filename

in

protected IFormatReader in

images

protected BufferedImage[] images

sizeZ

protected int sizeZ

sizeT

protected int sizeT

sizeC

protected int sizeC

anim

protected boolean anim

fps

protected int fps

canCloseReader

protected boolean canCloseReader

omexmlService

protected OMEXMLService omexmlService

Service for working with OME-XML metadata.

sb

protected final StringBuilder sb

Constructor Detail

ImageViewer

public ImageViewer()

Constructs an image viewer.

ImageViewer

public ImageViewer(boolean canCloseReader)

Constructs an image viewer.

Parameters:

canCloseReader - whether or not the underlying reader can be closed

Method Detail

open

public void open(String id)

Opens the given data source using the current format reader.

save

public void save(String id)

Saves the current images to the given destination using the current format writer.

setImages

public void setImages(BufferedImage[] img)

Sets the viewer to display the given images.

setImages

public void setImages(IFormatReader reader,
                      BufferedImage[] img)

Sets the viewer to display the given images, obtaining corresponding core metadata from the specified format reader.

getImage

public BufferedImage getImage()

Gets the currently displayed image.

getImageIndex

public int getImageIndex()

Gets the index of the currently displayed image.

getZ

public int getZ()

Gets the Z value of the currently displayed image.

getT

public int getT()

Gets the T value of the currently displayed image.

getC

public int getC()

Gets the C value of the currently displayed image.

setVisible

public void setVisible(boolean visible)

Overrides:

setVisible in class Window

actionPerformed

public void actionPerformed(ActionEvent e)

Handles menu commands.

Specified by:

actionPerformed in interface ActionListener

stateChanged

public void stateChanged(ChangeEvent e)

Handles slider events.

Specified by:

stateChanged in interface ChangeListener

keyPressed

public void keyPressed(KeyEvent e)

Handles key presses.

Specified by:

keyPressed in interface KeyListener

keyReleased

public void keyReleased(KeyEvent e)

Specified by:

keyReleased in interface KeyListener

keyTyped

public void keyTyped(KeyEvent e)

Specified by:

keyTyped in interface KeyListener

mouseDragged

public void mouseDragged(MouseEvent e)

Handles cursor probes.

Specified by:

mouseDragged in interface MouseMotionListener

mouseMoved

public void mouseMoved(MouseEvent e)

Handles cursor probes.

Specified by:

mouseMoved in interface MouseMotionListener

run

public void run()

Handles animation.

Specified by:

run in interface Runnable

windowClosing

public void windowClosing(WindowEvent e)

Specified by:

windowClosing in interface WindowListener

windowActivated

public void windowActivated(WindowEvent e)

Specified by:

windowActivated in interface WindowListener

windowDeactivated

public void windowDeactivated(WindowEvent e)

Specified by:

windowDeactivated in interface WindowListener

windowOpened

public void windowOpened(WindowEvent e)

Specified by:

windowOpened in interface WindowListener

windowIconified

public void windowIconified(WindowEvent e)

Specified by:

windowIconified in interface WindowListener

windowDeiconified

public void windowDeiconified(WindowEvent e)

Specified by:

windowDeiconified in interface WindowListener

windowClosed

public void windowClosed(WindowEvent e)

Specified by:

windowClosed in interface WindowListener

updateLabel

protected void updateLabel(int x,
                           int y)

Updates cursor probe label.

wait

protected void wait(boolean wait)

Toggles wait cursor.

open

protected void open(String id,
                    IFormatReader r)

Opens from the given data source using the specified reader in a separate thread.

save

protected void save(String id,
                    IFormatWriter w)

Saves to the given data destination using the specified writer in a separate thread.

main

public static void main(String[] args)