com.alee.extended.magnifier

Class MagnifierGlass

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.alee.extended.magnifier.MagnifierGlass

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class MagnifierGlass
extends javax.swing.JComponent

Custom component that allows you to display a magnifier within your application window. That magnifier can zoom in any part of the UI displayed within the window.

JComponent is used instead of separate window for three reasons: 1. It is easy to sink events from JComponent to underlying UI elements 2. It is easy to snapshot Swing UI, but magnifying screen parts will not work like that 3. Not all OS support window per-pixel translucency which will limit the usage of this feature

This component might be extended in future to support windowed mode, but for now it is limited to Swing window bounds.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JComponent.AccessibleJComponent

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
protected java.awt.image.BufferedImage	buffer
static javax.swing.ImageIcon	cursorIcon Icons.
protected java.awt.Cursor	defaultCursor
protected boolean	displayDummyCursor Whether or not dummy cursor should be displayed on magnified image.
protected float	dummyCursorOpacity Dummy cursor opacity.
protected long	forceUpdateFrequency Milliseconds to forcefully update magnifier buffer.
protected com.alee.utils.swing.WebTimer	forceUpdater
protected int	lastShadeWidth
protected java.awt.event.AWTEventListener	listener
protected MagnifierPosition	position Magnifier position.
protected boolean	rendered
protected int	round Rectangular magnifier round.
protected javax.swing.Icon	shadeIcon
protected int	shadeWidth Magnifier shade width.
protected java.awt.Dimension	size Zoom area size.
protected MagnifierType	type Zoom area shape type.
protected java.awt.image.BufferedImage	view
protected int	zoomFactor Zoom factor.
protected javax.swing.JComponent	zoomProvider Runtime variables.

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
MagnifierGlass() Constructs magnifier that will work over the specified component.
MagnifierGlass(int zoomFactor) Constructs magnifier that will work over the specified component.

Method Summary

Modifier and Type	Method and Description
void	display(javax.swing.JComponent component) Initializes magnifier on the window where specified component is located.
void	display(java.awt.Window window) Initializes magnifier on the specified window.
protected void	displayOnGlassPane() Display magnifier on the glass pane.
void	displayOrDispose(javax.swing.JComponent component) Initializes or disposes magnifier on the window where specified component is located.
void	displayOrDispose(java.awt.Window window) Initializes or disposes magnifier on the specified window.
void	dispose() Hides magnifier.
protected void	disposeFromGlassPane() Dispose magnifier from the glass pane.
protected java.awt.Dimension	getBufferSize() Returns UI buffer image size.
float	getDummyCursorOpacity() Returns dummy cursor opacity.
long	getForceUpdateFrequency() Returns milliseconds to forcefully update magnifier buffer.
MagnifierPosition	getPosition() Returns magnifier position.
java.awt.Dimension	getPreferredSize()
int	getRound() Returns rectangular magnifier round.
protected javax.swing.Icon	getShadeIcon() Returns custom shade icon.
int	getShadeWidth() Returns magnifier shade width.
MagnifierType	getType() Returns zoom area shape type.
java.awt.Dimension	getZoomAreaSize() Returns zoom area size.
int	getZoomFactor() Returns zoom factor.
protected javax.swing.JComponent	getZoomProvider(java.awt.Window window) Returns zoom provider component for the specified window.
boolean	isDisplayDummyCursor() Returns whether or not dummy cursor should be displayed on magnified image.
boolean	isDisplayed() Returns whether or not this magnifier is currently displayed.
protected void	paintComponent(java.awt.Graphics g)
protected void	restartForceUpdater() Properly restarts
void	setDisplayDummyCursor(boolean display) Sets whether or not dummy cursor should be displayed on magnified image.
void	setDummyCursorOpacity(float opacity) Sets dummy cursor opacity.
void	setForceUpdateFrequency(long forceUpdateFrequency) Sets milliseconds to forcefully update magnifier buffer.
void	setPosition(MagnifierPosition position) Sets magnifier position.
void	setRound(int round) Sets rectangular magnifier round.
void	setShadeWidth(int shadeWidth) Sets magnifier shade width.
void	setType(MagnifierType type) Sets zoom area shape type.
void	setZoomAreaSize(java.awt.Dimension size) Sets zoom area size.
void	setZoomFactor(int zoomFactor) Sets zoom factor.
protected void	updatePreview() Updates magnified UI preview.

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, 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

Field Detail

cursorIcon

public static final javax.swing.ImageIcon cursorIcon

Icons.

size

protected java.awt.Dimension size

Zoom area size.

type

protected MagnifierType type

Zoom area shape type.

position

protected MagnifierPosition position

Magnifier position.

shadeWidth

protected int shadeWidth

Magnifier shade width.

round

protected int round

Rectangular magnifier round.

zoomFactor

protected int zoomFactor

Zoom factor.

displayDummyCursor

protected boolean displayDummyCursor

Whether or not dummy cursor should be displayed on magnified image. Note that displayed cursor will not represent exact system cursor.

dummyCursorOpacity

protected float dummyCursorOpacity

Dummy cursor opacity.

forceUpdateFrequency

protected long forceUpdateFrequency

Milliseconds to forcefully update magnifier buffer. Set to zero to disable forced updates.

zoomProvider

protected javax.swing.JComponent zoomProvider

Runtime variables.

defaultCursor

protected java.awt.Cursor defaultCursor

buffer

protected java.awt.image.BufferedImage buffer

view

protected java.awt.image.BufferedImage view

listener

protected java.awt.event.AWTEventListener listener

forceUpdater

protected com.alee.utils.swing.WebTimer forceUpdater

shadeIcon

protected javax.swing.Icon shadeIcon

lastShadeWidth

protected int lastShadeWidth

rendered

protected boolean rendered

Constructor Detail

MagnifierGlass

public MagnifierGlass()

Constructs magnifier that will work over the specified component. Note that zoom will only display elements which are contained inside of the specified component.

MagnifierGlass

public MagnifierGlass(int zoomFactor)

Constructs magnifier that will work over the specified component. Note that zoom will only display elements which are contained inside of the specified component.

Method Detail

getZoomAreaSize

public java.awt.Dimension getZoomAreaSize()

Returns zoom area size.

Returns:

zoom area size

setZoomAreaSize

public void setZoomAreaSize(java.awt.Dimension size)

Sets zoom area size.

Parameters:

size - zoom area size

getType

public MagnifierType getType()

Returns zoom area shape type.

Returns:

zoom area shape type

setType

public void setType(MagnifierType type)

Sets zoom area shape type.

Parameters:

type - zoom area shape type

getPosition

public MagnifierPosition getPosition()

Returns magnifier position.

Returns:

magnifier position

setPosition

public void setPosition(MagnifierPosition position)

Sets magnifier position.

Parameters:

position - magnifier position

getShadeWidth

public int getShadeWidth()

Returns magnifier shade width.

Returns:

magnifier shade width

setShadeWidth

public void setShadeWidth(int shadeWidth)

Sets magnifier shade width.

Parameters:

shadeWidth - magnifier shade width

getRound

public int getRound()

Returns rectangular magnifier round.

Returns:

rectangular magnifier round

setRound

public void setRound(int round)

Sets rectangular magnifier round.

Parameters:

round - rectangular magnifier round

getZoomFactor

public int getZoomFactor()

Returns zoom factor.

Returns:

zoom factor

setZoomFactor

public void setZoomFactor(int zoomFactor)

Sets zoom factor.

Parameters:

zoomFactor - zoom factor

isDisplayDummyCursor

public boolean isDisplayDummyCursor()

Returns whether or not dummy cursor should be displayed on magnified image.

Returns:

true if dummy cursor should be displayed on magnified image, false otherwise

setDisplayDummyCursor

public void setDisplayDummyCursor(boolean display)

Sets whether or not dummy cursor should be displayed on magnified image.

Parameters:

display - whether or not dummy cursor should be displayed on magnified image

getDummyCursorOpacity

public float getDummyCursorOpacity()

Returns dummy cursor opacity.

Returns:

dummy cursor opacity

setDummyCursorOpacity

public void setDummyCursorOpacity(float opacity)

Sets dummy cursor opacity.

Parameters:

opacity - dummy cursor opacity

getForceUpdateFrequency

public long getForceUpdateFrequency()

Returns milliseconds to forcefully update magnifier buffer.

Returns:

milliseconds to forcefully update magnifier buffer

setForceUpdateFrequency

public void setForceUpdateFrequency(long forceUpdateFrequency)

Sets milliseconds to forcefully update magnifier buffer.

Parameters:

forceUpdateFrequency - milliseconds to forcefully update magnifier buffer

restartForceUpdater

protected void restartForceUpdater()

Properly restarts

getBufferSize

protected java.awt.Dimension getBufferSize()

Returns UI buffer image size.

Returns:

UI buffer image size

updatePreview

protected void updatePreview()

Updates magnified UI preview.

paintComponent

protected void paintComponent(java.awt.Graphics g)

Overrides:

paintComponent in class javax.swing.JComponent

getShadeIcon

protected javax.swing.Icon getShadeIcon()

Returns custom shade icon.

Returns:

custom shade icon

displayOrDispose

public void displayOrDispose(java.awt.Window window)

Initializes or disposes magnifier on the specified window.

Parameters:

window - magnifier window

displayOrDispose

public void displayOrDispose(javax.swing.JComponent component)

Initializes or disposes magnifier on the window where specified component is located.

Parameters:

component - magnifier provider

display

public void display(java.awt.Window window)

Initializes magnifier on the specified window.

Parameters:

window - magnifier window

display

public void display(javax.swing.JComponent component)

Initializes magnifier on the window where specified component is located.

Parameters:

component - magnifier provider

dispose

public void dispose()

Hides magnifier.

isDisplayed

public boolean isDisplayed()

Returns whether or not this magnifier is currently displayed. Be aware that this method only says whether or not this magnifier is active. Actual visibility state can be retrieved through Component.isShowing() method like in any other Swing component.

Returns:

true if this magnifier is currently displayed, false otherwise

getZoomProvider

protected javax.swing.JComponent getZoomProvider(java.awt.Window window)

Returns zoom provider component for the specified window.

Parameters:

window - window to retrieve zoom provider for

Returns:

zoom provider component for the specified window

displayOnGlassPane

protected void displayOnGlassPane()

Display magnifier on the glass pane.

disposeFromGlassPane

protected void disposeFromGlassPane()

Dispose magnifier from the glass pane.

getPreferredSize

public java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class javax.swing.JComponent