ij.gui

Class ImageCanvas

java.lang.Object

java.awt.Component

java.awt.Canvas

ij.gui.ImageCanvas

All Implemented Interfaces:

java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.accessibility.Accessible

Direct Known Subclasses:

PlotCanvas

public class ImageCanvas
extends java.awt.Canvas
implements java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.lang.Cloneable

This is a Canvas used to display images in a Window.

See Also:

Serialized Form

Nested Class Summary

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

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	usePointer

Fields inherited from class java.awt.Component

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
ImageCanvas(ImagePlus imp)

Method Summary

Modifier and Type	Method and Description
boolean	cursorOverImage() Returns 'true' if the cursor is over this image.
void	disablePopupMenu(boolean status) Disable/enable popup menu.
void	fitToWindow()
java.awt.Point	getCursorLoc() Returns the current cursor location in image coordinates.
boolean	getCustomRoi()
java.util.Vector	getDisplayList() Deprecated. replaced by ImagePlus.getOverlay()
static double	getHigherZoomLevel(double currentMag)
ImagePlus	getImage() Returns the ImagePlus object that is associated with this ImageCanvas.
static double	getLowerZoomLevel(double currentMag)
double	getMagnification()
int	getModifiers() Returns the mouse event modifiers.
Overlay	getOverlay() Use ImagePlus.getOverlay().
boolean	getPaintPending()
java.awt.Dimension	getPreferredSize()
boolean	getScaleToFit()
static java.awt.Color	getShowAllColor() Obsolete
Overlay	getShowAllList()
boolean	getShowAllROIs() Obsolete
int	getSliceNumber(java.lang.String label)
java.awt.Rectangle	getSrcRect()
boolean	hideZoomIndicator(boolean hide)
void	mouseClicked(java.awt.event.MouseEvent e)
void	mouseDragged(java.awt.event.MouseEvent e)
void	mouseEntered(java.awt.event.MouseEvent e)
void	mouseExited(java.awt.event.MouseEvent e)
void	mouseMoved(java.awt.event.MouseEvent e)
void	mousePressed(java.awt.event.MouseEvent e)
void	mouseReleased(java.awt.event.MouseEvent e)
int	offScreenX(int sx) Converts a screen x-coordinate to an offscreen x-coordinate.
double	offScreenXD(int sx) Converts a screen x-coordinate to a floating-point offscreen x-coordinate.
int	offScreenY(int sy) Converts a screen y-coordinate to an offscreen y-coordinate.
double	offScreenYD(int sy) Converts a screen y-coordinate to a floating-point offscreen y-coordinate.
void	paint(java.awt.Graphics g)
void	resetDoubleBuffer()
boolean	roiManagerSelect(Roi roi, boolean delete)
int	screenX(int ox) Converts an offscreen x-coordinate to a screen x-coordinate.
int	screenXD(double ox) Converts a floating-point offscreen x-coordinate to a screen x-coordinate.
int	screenY(int oy) Converts an offscreen y-coordinate to a screen y-coordinate.
int	screenYD(double oy) Converts a floating-point offscreen x-coordinate to a screen x-coordinate.
static void	setCursor(java.awt.Cursor cursor, int type) Experimental
void	setCursor(int sx, int sy, int ox, int oy) Sets the cursor based on the current tool and cursor location.
void	setCustomRoi(boolean customRoi) Allows plugins (e.g., Orthogonal_Views) to create a custom ROI using a display list.
void	setDisplayList(Roi roi, java.awt.Color color) Deprecated. replaced by ImagePlus.setOverlay(Roi, Color, int, Color)
void	setDisplayList(java.awt.Shape shape, java.awt.Color color, java.awt.BasicStroke stroke) Deprecated. replaced by ImagePlus.setOverlay(Shape, Color, BasicStroke)
void	setDisplayList(java.util.Vector list) Deprecated. replaced by ImagePlus.setOverlay(ij.gui.Overlay)
void	setDrawingColor(int ox, int oy, boolean setBackground) Sets the foreground drawing color (or background color if 'setBackground' is true) to the color of the pixel at (ox,oy).
void	setDrawingSize(int width, int height) Obsolete; replaced by setSize()
void	setImageUpdated() ImagePlus.updateAndDraw calls this method to force the paint() method to update the image from the ImageProcessor.
void	setMagnification(double magnification)
void	setOverlay(Overlay overlay) Use ImagePlus.setOverlay(ij.gui.Overlay).
void	setPaintPending(boolean state)
void	setScaleToFit(boolean scaleToFit)
static void	setShowAllColor(java.awt.Color c) Obsolete
void	setShowAllList(Overlay showAllList)
void	setShowAllROIs(boolean showAllROIs) Obsolete
void	setShowCursorStatus(boolean status) Called by IJ.showStatus() to prevent status bar text from being overwritten until the cursor moves at least 12 pixels.
void	setSize(int width, int height)
void	setSourceRect(java.awt.Rectangle r) Sets the region of the image (in pixels) to be displayed.
void	unzoom() Implements the Image/Zoom/Original Scale command.
void	update(java.awt.Graphics g)
void	zoom100Percent() Implements the Image/Zoom/View 100% command.
void	zoomIn(int sx, int sy) Zooms in by making the window bigger.
void	zoomOut(int sx, int sy) Zooms out by making the source rectangle (srcRect) larger and centering it on (x,y).

Methods inherited from class java.awt.Canvas

addNotify, createBufferStrategy, createBufferStrategy, getAccessibleContext, getBufferStrategy

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, dispatchEvent, doLayout, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocusInWindow, reshape, resize, resize, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, validate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

usePointer

public static boolean usePointer

Constructor Detail

ImageCanvas

public ImageCanvas(ImagePlus imp)

Method Detail

setSourceRect

public void setSourceRect(java.awt.Rectangle r)

Sets the region of the image (in pixels) to be displayed.

getSrcRect

public java.awt.Rectangle getSrcRect()

setDrawingSize

public void setDrawingSize(int width,
                           int height)

Obsolete; replaced by setSize()

setSize

public void setSize(int width,
                    int height)

Overrides:

setSize in class java.awt.Component

setImageUpdated

public void setImageUpdated()

ImagePlus.updateAndDraw calls this method to force the paint() method to update the image from the ImageProcessor.

setPaintPending

public void setPaintPending(boolean state)

getPaintPending

public boolean getPaintPending()

update

public void update(java.awt.Graphics g)

Overrides:

update in class java.awt.Canvas

paint

public void paint(java.awt.Graphics g)

Overrides:

paint in class java.awt.Canvas

getSliceNumber

public int getSliceNumber(java.lang.String label)

resetDoubleBuffer

public void resetDoubleBuffer()

getPreferredSize

public java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class java.awt.Component

getCursorLoc

public java.awt.Point getCursorLoc()

Returns the current cursor location in image coordinates.

cursorOverImage

public boolean cursorOverImage()

Returns 'true' if the cursor is over this image.

getModifiers

public int getModifiers()

Returns the mouse event modifiers.

getImage

public ImagePlus getImage()

Returns the ImagePlus object that is associated with this ImageCanvas.

setCursor

public void setCursor(int sx,
                      int sy,
                      int ox,
                      int oy)

Sets the cursor based on the current tool and cursor location.

offScreenX

public int offScreenX(int sx)

Converts a screen x-coordinate to an offscreen x-coordinate.

offScreenY

public int offScreenY(int sy)

Converts a screen y-coordinate to an offscreen y-coordinate.

offScreenXD

public double offScreenXD(int sx)

Converts a screen x-coordinate to a floating-point offscreen x-coordinate.

offScreenYD

public double offScreenYD(int sy)

Converts a screen y-coordinate to a floating-point offscreen y-coordinate.

screenX

public int screenX(int ox)

Converts an offscreen x-coordinate to a screen x-coordinate.

screenY

public int screenY(int oy)

Converts an offscreen y-coordinate to a screen y-coordinate.

screenXD

public int screenXD(double ox)

Converts a floating-point offscreen x-coordinate to a screen x-coordinate.

screenYD

public int screenYD(double oy)

Converts a floating-point offscreen x-coordinate to a screen x-coordinate.

getMagnification

public double getMagnification()

setMagnification

public void setMagnification(double magnification)

fitToWindow

public void fitToWindow()

getLowerZoomLevel

public static double getLowerZoomLevel(double currentMag)

getHigherZoomLevel

public static double getHigherZoomLevel(double currentMag)

zoomIn

public void zoomIn(int sx,
                   int sy)

Zooms in by making the window bigger. If it can't be made bigger, then makes the source rectangle (srcRect) smaller and centers it on the position in the image where the cursor was when zooming has started. Note that sx and sy are screen coordinates.

zoomOut

public void zoomOut(int sx,
                    int sy)

Zooms out by making the source rectangle (srcRect) larger and centering it on (x,y). If we can't make it larger, then make the window smaller. Note that sx and sy are screen coordinates.

unzoom

public void unzoom()

Implements the Image/Zoom/Original Scale command.

zoom100Percent

public void zoom100Percent()

Implements the Image/Zoom/View 100% command.

setDrawingColor

public void setDrawingColor(int ox,
                            int oy,
                            boolean setBackground)

Sets the foreground drawing color (or background color if 'setBackground' is true) to the color of the pixel at (ox,oy).

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)

Specified by:

mousePressed in interface java.awt.event.MouseListener

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)

Specified by:

mouseExited in interface java.awt.event.MouseListener

mouseDragged

public void mouseDragged(java.awt.event.MouseEvent e)

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener

disablePopupMenu

public void disablePopupMenu(boolean status)

Disable/enable popup menu.

setShowAllList

public void setShowAllList(Overlay showAllList)

getShowAllList

public Overlay getShowAllList()

setShowAllROIs

public void setShowAllROIs(boolean showAllROIs)

Obsolete

getShowAllROIs

public boolean getShowAllROIs()

Obsolete

getShowAllColor

public static java.awt.Color getShowAllColor()

Obsolete

setShowAllColor

public static void setShowAllColor(java.awt.Color c)

Obsolete

setCursor

public static void setCursor(java.awt.Cursor cursor,
                             int type)

Experimental

setOverlay

public void setOverlay(Overlay overlay)

Use ImagePlus.setOverlay(ij.gui.Overlay).

getOverlay

public Overlay getOverlay()

Use ImagePlus.getOverlay().

setDisplayList

public void setDisplayList(java.util.Vector list)

Deprecated. replaced by ImagePlus.setOverlay(ij.gui.Overlay)

setDisplayList

public void setDisplayList(java.awt.Shape shape,
                           java.awt.Color color,
                           java.awt.BasicStroke stroke)

Deprecated. replaced by ImagePlus.setOverlay(Shape, Color, BasicStroke)

setDisplayList

public void setDisplayList(Roi roi,
                           java.awt.Color color)

Deprecated. replaced by ImagePlus.setOverlay(Roi, Color, int, Color)

getDisplayList

public java.util.Vector getDisplayList()

Deprecated. replaced by ImagePlus.getOverlay()

setCustomRoi

public void setCustomRoi(boolean customRoi)

Allows plugins (e.g., Orthogonal_Views) to create a custom ROI using a display list.

getCustomRoi

public boolean getCustomRoi()

setShowCursorStatus

public void setShowCursorStatus(boolean status)

Called by IJ.showStatus() to prevent status bar text from being overwritten until the cursor moves at least 12 pixels.

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)

Specified by:

mouseReleased in interface java.awt.event.MouseListener

roiManagerSelect

public boolean roiManagerSelect(Roi roi,
                                boolean delete)

mouseMoved

public void mouseMoved(java.awt.event.MouseEvent e)

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)

Specified by:

mouseEntered in interface java.awt.event.MouseListener

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)

Specified by:

mouseClicked in interface java.awt.event.MouseListener

setScaleToFit

public void setScaleToFit(boolean scaleToFit)

getScaleToFit

public boolean getScaleToFit()

hideZoomIndicator

public boolean hideZoomIndicator(boolean hide)