org.openimaj.image

Class DisplayUtilities.ImageComponent

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.openimaj.image.DisplayUtilities.ImageComponent

All Implemented Interfaces:

MouseListener, MouseMotionListener, ImageObserver, MenuContainer, Serializable, EventListener

Direct Known Subclasses:

DisplayUtilities.ScalingImageComponent

Enclosing class:

DisplayUtilities

public static class DisplayUtilities.ImageComponent
extends JComponent
implements MouseListener, MouseMotionListener

An image viewer that displays and image and allows zooming and panning of images.

When allowZooming is TRUE, clicking in the image will zoom in. CTRL-click in the image to zoom out.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk), David Dupplaw (dpd@ecs.soton.ac.uk)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DisplayUtilities.ImageComponent.ImageComponentListener Listener for zoom and pan events

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

JComponent.AccessibleJComponent

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 BufferedImage	image The image being displayed
protected Image<?,?>	originalImage The original image being displayed.

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
ImageComponent() Default constructor
ImageComponent(boolean autoResize) Default constructor.
ImageComponent(boolean autoResize, boolean autoPack) Default constructor.
ImageComponent(BufferedImage image) Construct with given image
ImageComponent(float initialScale, boolean autoResize, boolean autoPack) Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addImageComponentListener(DisplayUtilities.ImageComponent.ImageComponentListener l) Add the given listener to this image component.
int	getCurrentDisplayedPixelColour() Returns the current displayed pixel colour (as an RGB encoded int) from the currently displayed image.
Point2d	getCurrentMouseImagePosition() Returns the current mouse position in the coordinates of the image and is determined by the scaling factors and the position of the image within the viewport.
Point2d	getCurrentMousePosition() Returns the current mouse position in pixels within the viewport.
Float[]	getCurrentPixelColour() Returns the current pixel colour at the point of the mouse.
BufferedImage	getDisplayedImage() Returns the currently displaying image.
void	mouseClicked(MouseEvent e)
void	mouseDragged(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mouseMoved(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
void	moveTo(double x, double y) Move the image to the given position (image coordinates)
void	paint(Graphics gfx)
void	removeImageComponentListener(DisplayUtilities.ImageComponent.ImageComponentListener l) Remove the given listener from this image component.
void	setAllowPanning(boolean allowPan) Set whether to allow panning.
void	setAllowZoom(boolean allowZoom) Set whether to allow zooming.
void	setAutoFit(boolean tf) Sets whether to automatically size the image to fit within the bounds of the image component which is being sized externally.
void	setAutoPack(boolean tf) Sets whether the component is to attempt to pack a frame into which it is added.
void	setAutoResize(boolean tf) Sets whether to automatically resize the component to fit image (at it's given scale factor) within it.
void	setImage(BufferedImage image) Set the image to draw
void	setKeepAspect(boolean tf) Sets whether to keep the aspect ratio of the image constant when the image is being autoFit into the component.
void	setOriginalImage(Image<?,?> image) If you want to be able to inspect the original image's pixel values (rather than the generated BufferedImage) set the original image here.
void	setScaleFactor(double sfx, double sfy) Set the scale factor to draw the image.
void	setScaleFactorX(double sf) Set the scale factor to draw the image in the x-direction.
void	setScaleFactorY(double sf) Set the scale factor to draw the image in the y-direction.
void	setShowPixelColours(boolean showPixelColours) Set whether to show pixel colours or not.
void	setShowXYPosition(boolean showXYPosition) Set whether to show the XY position of the mouse curson or not
void	setTransparencyGrid(boolean drawGrid) Set whether to allow drawing of the transparency grid.
protected void	updatePixelColours() Update the display of pixel colours
void	zoom(double sf) Set the scale factor to zoom to

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

image

protected BufferedImage image

The image being displayed

originalImage

protected Image<?,?> originalImage

The original image being displayed. Used for pixel interrogation

Constructor Detail

ImageComponent

public ImageComponent()

Default constructor

ImageComponent

public ImageComponent(boolean autoResize)

Default constructor. Allows setting of the autoResize parameter which if true changes the size of the component to fit the contents.

Parameters:

autoResize - automatically resize the component to the content size

ImageComponent

public ImageComponent(BufferedImage image)

Construct with given image

Parameters:

image - the image

ImageComponent

public ImageComponent(boolean autoResize,
                      boolean autoPack)

Default constructor. Allows setting of the autoResize parameter which if true changes the size of the component to fit the contents, and the autoPack parameter which automatically packs the containers root (if its a JFrame) whenever it is resized.

Parameters:

autoResize - automatically resize the component to the content size

autoPack - automatically pack the root component on resize

ImageComponent

public ImageComponent(float initialScale,
                      boolean autoResize,
                      boolean autoPack)

Default constructor. Allows setting of the autoResize parameter which if true changes the size of the component to fit the contents, and the autoPack parameter which automatically packs the containers root (if its a JFrame) whenever it is resized.

Parameters:

initialScale - initial scale of the image

autoResize - automatically resize the component to the content size

autoPack - automatically pack the root component on resize

Method Detail

addImageComponentListener

public void addImageComponentListener(DisplayUtilities.ImageComponent.ImageComponentListener l)

Add the given listener to this image component.

Parameters:

l - The listener to add

removeImageComponentListener

public void removeImageComponentListener(DisplayUtilities.ImageComponent.ImageComponentListener l)

Remove the given listener from this image component.

Parameters:

l - The listener to remove.

setAllowZoom

public void setAllowZoom(boolean allowZoom)

Set whether to allow zooming.

Parameters:

allowZoom - TRUE to allow zooming

setAllowPanning

public void setAllowPanning(boolean allowPan)

Set whether to allow panning.

Parameters:

allowPan - TRUE to allow panning

setTransparencyGrid

public void setTransparencyGrid(boolean drawGrid)

Set whether to allow drawing of the transparency grid.

Parameters:

drawGrid - TRUE draws the grid

setShowPixelColours

public void setShowPixelColours(boolean showPixelColours)

Set whether to show pixel colours or not.

Parameters:

showPixelColours - TRUE to show pixel colours

setShowXYPosition

public void setShowXYPosition(boolean showXYPosition)

Set whether to show the XY position of the mouse curson or not

Parameters:

showXYPosition - TRUE to show XY position

setImage

public void setImage(BufferedImage image)

Set the image to draw

Parameters:

image - the image

moveTo

public void moveTo(double x,
                   double y)

Move the image to the given position (image coordinates)

Parameters:

x - The x image coordinate

y - The y image coordinate

zoom

public void zoom(double sf)

Set the scale factor to zoom to

Parameters:

sf - The scale factor

setScaleFactorX

public void setScaleFactorX(double sf)

Set the scale factor to draw the image in the x-direction. Allows the image to be stretched or shrunk horizontally.

Parameters:

sf - The new scale factor

setScaleFactorY

public void setScaleFactorY(double sf)

Set the scale factor to draw the image in the y-direction. Allows the image to be stretched or shrunk vertically.

Parameters:

sf - The new scale factor

setScaleFactor

public void setScaleFactor(double sfx,
                           double sfy)

Set the scale factor to draw the image. Allows the image to be stretched or shrunk both horizontall or vertically.

Parameters:

sfx - The new x scale factor

sfy - The new y scale factor

setOriginalImage

public void setOriginalImage(Image<?,?> image)

If you want to be able to inspect the original image's pixel values (rather than the generated BufferedImage) set the original image here. Use null to enforce showing the BufferedImage pixel values. This does not set the BufferedImage that is being used for the display.

Parameters:

image - The original image.

paint

public void paint(Graphics gfx)

Overrides:

paint in class JComponent

See Also:

JComponent.paint(java.awt.Graphics)

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

See Also:

MouseListener.mouseClicked(java.awt.event.MouseEvent)

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

mouseDragged

public void mouseDragged(MouseEvent e)

Specified by:

mouseDragged in interface MouseMotionListener

mouseMoved

public void mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

updatePixelColours

protected void updatePixelColours()

Update the display of pixel colours

setAutoFit

public void setAutoFit(boolean tf)

Sets whether to automatically size the image to fit within the bounds of the image component which is being sized externally. This shouldn't be used in combination with autoResize. When this method is called with TRUE, zooming and dragging are disabled.

Parameters:

tf - TRUE to auto fit the image.

setKeepAspect

public void setKeepAspect(boolean tf)

Sets whether to keep the aspect ratio of the image constant when the image is being autoFit into the component.

Parameters:

tf - TRUE to keep the aspect ratio constant

setAutoResize

public void setAutoResize(boolean tf)

Sets whether to automatically resize the component to fit image (at it's given scale factor) within it. Note that in certain circumstances, where the image component is being sized by external forces (such as a layout manager), setting this to true can cause weird results where the image is pulled out and in constantly. This shouldn't be used in combination with autoFit.

Parameters:

tf - TRUE to resize the component.

setAutoPack

public void setAutoPack(boolean tf)

Sets whether the component is to attempt to pack a frame into which it is added. If it is not in a frame this will have no effect. This allows the frame to resize with the component.

Parameters:

tf - TRUE to auto pack the parent frame.

getCurrentMousePosition

public Point2d getCurrentMousePosition()

Returns the current mouse position in pixels within the viewport. Will return the last known position if the mouse is no longer within the viewport.

Returns:

The position in pixels

getCurrentMouseImagePosition

public Point2d getCurrentMouseImagePosition()

Returns the current mouse position in the coordinates of the image and is determined by the scaling factors and the position of the image within the viewport. If the mouse is no longer in the viewport, the last known mouse position will be returned.

Returns:

The position in image coordinates.

getCurrentPixelColour

public Float[] getCurrentPixelColour()

Returns the current pixel colour at the point of the mouse. The number of elements in the array will equal be 3, if no original has been supplied to the image component. The values will be between 0 and 255 and ordered red, green and blue. If the original has been supplied, then the number of elements will be equal to the number of bands in the original image and the values will be the original pixel values in the original image.

Returns:

The current pixel colour.

getCurrentDisplayedPixelColour

public int getCurrentDisplayedPixelColour()

Returns the current displayed pixel colour (as an RGB encoded int) from the currently displayed image.

Returns:

The current displayed pixel colour.

getDisplayedImage

public BufferedImage getDisplayedImage()

Returns the currently displaying image.

Returns:

The displayed image.