net.shredzone.jshred.swing

Class JImageViewer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

net.shredzone.jshred.swing.JImageViewer

All Implemented Interfaces:

ImageObserver, MenuContainer, Printable, Serializable

Direct Known Subclasses:

JScrollableImageViewer

public class JImageViewer
extends JComponent
implements Printable

An JImageViewer renders an image in the centre of the component. This image can be scaled, and a transparency checkboard can also be drawn behind it.

As an extra feature, the image can be dragged with the mouse if the viewer is in a JScrollPane.

This class also implements the Printable interface since R13.

Since:

R9

Author:

Richard "Shred" Körber

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JImageViewer.Autoscale
static class	JImageViewer.Quality

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 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.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
JImageViewer() Creates an empty JImageViewer.
JImageViewer(Image image) Creates a JImageViewer showing the given Image.
JImageViewer(ImageIcon icon) Creates a JImageViewer showing the given ImageIcon.
JImageViewer(InputStream is) Creates a JImageViewer showing an image that is read from the given InputStream.
JImageViewer(URL url) Creates a JImageViewer showing an image that is read from the given URL.

Method Summary

Modifier and Type	Method and Description
JImageViewer.Autoscale	getAutoscale() Gets the current autoscale mode.
Color	getCheckboardColor() Gets the transparency checkboard color.
Image	getImage() Gets the Image that is currently set.
Dimension	getMinimumSize()
Dimension	getPreferredSize()
JImageViewer.Quality	getQuality() Gets the current scaling quality.
protected Dimension	getScaledDimension() Gets the final Dimension of the image after proper scaling was applied.
float	getZoomFactor() Gets the current zoom factor.
boolean	isCheckboard() Checks if the transparency checkboard is to be drawn.
protected void	paintComponent(Graphics g)
int	print(Graphics graphics, PageFormat pageFormat, int pageIndex)
void	setAutoscale(JImageViewer.Autoscale autoscale) Sets the autoscale mode.
void	setCheckboard(boolean checkboard) Draws the transparency checkboard.
void	setCheckboardColor(Color color) Sets the transparency checkboard color.
void	setImage(Image img) Sets a new Image to be shown.
void	setImage(ImageIcon icon) Sets a new ImageIcon to be shown.
void	setImage(InputStream in) Sets a new image that is to be read from the InputStream.
void	setImage(URL url) Sets a new image that is to be read from the URL.
protected void	setQuality(Graphics2D g2d, JImageViewer.Quality quality) Sets the rendering hints according to the quality.
void	setQuality(JImageViewer.Quality quality) Sets the scaling quality.
void	setZoomFactor(float zoom) Sets the zoom factor for the shown image.

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, getNextFocusableComponent, getPopupLocation, 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, paint, paintBorder, paintChildren, 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

Constructor Detail

JImageViewer

public JImageViewer()

Creates an empty JImageViewer.

JImageViewer

public JImageViewer(Image image)

Creates a JImageViewer showing the given Image.

Parameters:

image - Image to be shown.

JImageViewer

public JImageViewer(ImageIcon icon)

Creates a JImageViewer showing the given ImageIcon.

Parameters:

icon - ImageIcon to be shown.

JImageViewer

public JImageViewer(InputStream is)
             throws IOException

Creates a JImageViewer showing an image that is read from the given InputStream.

Parameters:

is - InputStream to read the image data from.

Throws:

IOException - if the stream could not be read.

JImageViewer

public JImageViewer(URL url)

Creates a JImageViewer showing an image that is read from the given URL.

Parameters:

url - URL to read the image data from.

Method Detail

setImage

public void setImage(Image img)

Sets a new Image to be shown.

Parameters:

img - New Image to be shown.

setImage

public void setImage(ImageIcon icon)

Sets a new ImageIcon to be shown. This is a convenience method that will just invoke ImageIcon.getImage().

Parameters:

icon - New ImageIcon to be shown.

setImage

public void setImage(InputStream in)
              throws IOException

Sets a new image that is to be read from the InputStream. No fancy image formats are supported, just the one that are supported by ImageIO.

Parameters:

in - InputStream providing the image data.

Throws:

IOException - if the image could not be read.

setImage

public void setImage(URL url)

Sets a new image that is to be read from the URL. No fancy image formats are supported, just the one that are supported by ImageIO.

Parameters:

url - URL to read the image from.

getImage

public Image getImage()

Gets the Image that is currently set.

Returns:

Current Image, or null if none was set.

setCheckboard

public void setCheckboard(boolean checkboard)

Draws the transparency checkboard. The checkboard is drawn behind the image and can be seen through the transparent parts of it.

By default, no transparency checkboard is shown since it slows down the performance and might confuse the user.

Parameters:

checkboard - true: show transparency checkboard.

isCheckboard

public boolean isCheckboard()

Checks if the transparency checkboard is to be drawn.

Returns:

true: show transparency checkboard.

setCheckboardColor

public void setCheckboardColor(Color color)

Sets the transparency checkboard color. By default (or if null is passed in here), the background color's Color.brighter() is used for the bright fields. For the dark fields, Component.getBackground() is always used if this component is opaque.

Parameters:

color - Checkboard Color, null means default color.

getCheckboardColor

public Color getCheckboardColor()

Gets the transparency checkboard color.

Returns:

Checkboard Color, or null if the default color is used.

setAutoscale

public void setAutoscale(JImageViewer.Autoscale autoscale)

Sets the autoscale mode. The default is JImageViewer.Autoscale.OFF, so you can embed a JImageViewer into a JScrollPane.

Parameters:

autoscale - The new JImageViewer.Autoscale mode.

getAutoscale

public JImageViewer.Autoscale getAutoscale()

Gets the current autoscale mode.

Returns:

Current autoscale mode.

setZoomFactor

public void setZoomFactor(float zoom)

Sets the zoom factor for the shown image. A factor of 1.0f means that the image is shown in the original size. A factor <1.0f will reduce the image, while a factor >1.0f will magnify it.

NOTE that JImageViewer.Autoscale.OFF must be set in order to use zooming. This might change in future releases though.

Parameters:

zoom - Zoom factor. Default is 1.0f.

getZoomFactor

public float getZoomFactor()

Gets the current zoom factor.

Returns:

Current zoom factor.

setQuality

public void setQuality(JImageViewer.Quality quality)

Sets the scaling quality.

Parameters:

quality - New scaling quality.

getQuality

public JImageViewer.Quality getQuality()

Gets the current scaling quality.

Returns:

Current scaling quality.

getScaledDimension

protected Dimension getScaledDimension()

Gets the final Dimension of the image after proper scaling was applied.

Returns:

Dimension of the image to be drawn. The returned Dimension object is a copy that can be manipulated by the caller.

getMinimumSize

public Dimension getMinimumSize()

Overrides:

getMinimumSize in class JComponent

getPreferredSize

public Dimension getPreferredSize()

Overrides:

getPreferredSize in class JComponent

paintComponent

protected void paintComponent(Graphics g)

Overrides:

paintComponent in class JComponent

print

public int print(Graphics graphics,
                 PageFormat pageFormat,
                 int pageIndex)

Specified by:

print in interface Printable

setQuality

protected void setQuality(Graphics2D g2d,
                          JImageViewer.Quality quality)

Sets the rendering hints according to the quality.

Parameters:

g2d - Graphics2D to set the rendering hints.

quality - JImageViewer.Quality desired.

Since:

R13