Module org.autogui

Package org.autogui.swing

Class GuiSwingViewImagePane.ImagePaneBase

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.autogui.swing.GuiSwingViewImagePane.ImagePaneBase

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:

GuiSwingViewImagePane.PropertyImagePane

Enclosing class:

GuiSwingViewImagePane

public static class GuiSwingViewImagePane.ImagePaneBase
extends JComponent

a base image-pane for rendering an image object

Since:

1.7

See Also:

• Serialized Form

Nested Class Summary

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	Description
protected GuiSwingViewImagePane.ImageScaleAutoSwitchByMouseWheel	autoSwitchByMouseWheel
protected Image	image
protected GuiSwingViewImagePane.ImageScale	imageScale
protected boolean	imageScaleAutoSwitchByMouseWheel
protected GuiSwingViewImagePane.ImageScaleFit	imageScaleDefault
protected GuiSwingViewImagePane.ImageScaleFit	imageScaleFit
protected GuiSwingViewImagePane.ImageScaleMouseWheel	imageScaleMouseWheel
protected Dimension	imageSize
protected List<PopupCategorized.CategorizedMenuItem>	menuItems
protected PopupExtension	popup
protected GuiSwingViewImagePane.ImageScaleSwitchFitAction	switchFitAction

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

Modifier	Constructor	Description
	ImagePaneBase()	the constructor calling init()
protected	ImagePaneBase(boolean init)

Method Summary

Modifier and Type	Method	Description
protected GuiSwingViewImagePane.ImageCopyAction	createCopyAction()
JComponent	createScaleInfo(Dimension size)
JComponent	createSizeInfo(Dimension size)
protected List<PopupCategorized.CategorizedMenuItem>	createStaticMenuItems()
static void	dragMove(Point dragStart, Point current, JViewport viewport)	set viewPosition of viewport
List<PopupCategorized.CategorizedMenuItem>	getDynamicMenuItems()
Image	getImage()
GuiSwingViewImagePane.ImageScale	getImageScale()
GuiSwingViewImagePane.ImageScaleFit	getImageScaleDefault()
Dimension	getImageScaledSize()
GuiSwingViewImagePane.ImageScaleFit	getImageScaleFit()
GuiSwingViewImagePane.ImageScaleMouseWheel	getImageScaleMouseWheel()
Dimension	getImageSize()
RenderedImage	getRenderedImage(Image image)	convert image to a writable RenderedImage
List<PopupCategorized.CategorizedMenuItem>	getStaticMenuItems()
Point	getViewPosition()
Dimension	getViewSize()
protected boolean	imageScaleMouseWheelShouldBeActivated(MouseWheelEvent e)
void	init()	initializer
void	initDragScroll()	adding listeners for supporting drag scrolling
void	initFocus()	make this view fucusable with a mouse-listener of focusing
void	initPopup()	initialize popup-menu
void	initScale()	initializer for image-scaling
boolean	isImageScaleAutoSwitchByMouseWheel()
boolean	isImageScaleChangeByMouseWheel(MouseWheelEvent event)	checking for the ALT-down mask; Note: macOS trackpad-scrolling will set a Shift-down mask for some gestures that occurs in normal use.
protected boolean	isParentViewport()
protected void	paintComponent(Graphics g)
void	setImage(Image image)	set the image and update rendering
void	setImageScale(GuiSwingViewImagePane.ImageScale imageScale)	update the imageScale value and relating listeners.
void	setImageScaleAutoSwitchByMouseWheel(boolean imageScaleAutoSwitchByMouseWheel)	set the property and add/remove the imageScale if it is a MouseWheelListener
void	setPreferredSizeFromImageSize()	call JComponent.setPreferredSize(Dimension) with imageSize
protected Dimension	subtract(Dimension dim, Insets insets)
void	updateScale()	reflects image-scale settings

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, getUI, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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 Details

image

protected Image image

imageSize

protected Dimension imageSize

imageScale

protected GuiSwingViewImagePane.ImageScale imageScale

imageScaleDefault

protected GuiSwingViewImagePane.ImageScaleFit imageScaleDefault

imageScaleFit

protected GuiSwingViewImagePane.ImageScaleFit imageScaleFit

imageScaleMouseWheel

protected GuiSwingViewImagePane.ImageScaleMouseWheel imageScaleMouseWheel

imageScaleAutoSwitchByMouseWheel

protected boolean imageScaleAutoSwitchByMouseWheel

autoSwitchByMouseWheel

protected GuiSwingViewImagePane.ImageScaleAutoSwitchByMouseWheel autoSwitchByMouseWheel

switchFitAction

protected GuiSwingViewImagePane.ImageScaleSwitchFitAction switchFitAction

popup

protected PopupExtension popup

menuItems

protected List<PopupCategorized.CategorizedMenuItem> menuItems

Constructor Details

ImagePaneBase

public ImagePaneBase()

the constructor calling init()

ImagePaneBase

protected ImagePaneBase(boolean init)

Parameters:

init - if true, call init()

Method Details

init

public void init()

initializer

initScale

public void initScale()

initializer for image-scaling

initPopup

public void initPopup()

initialize popup-menu

initDragScroll

public void initDragScroll()

adding listeners for supporting drag scrolling

Since:

1.5

dragMove

public static void dragMove(Point dragStart,
 Point current,
 JViewport viewport)

set viewPosition of viewport

Parameters:

dragStart - the previous drag-position (the previous value of "current")

current - the next drag-position (can be obtained by MouseEvent.getLocationOnScreen())

viewport - the target view-port (the parent of the target-pane)

initFocus

public void initFocus()

make this view fucusable with a mouse-listener of focusing

isImageScaleChangeByMouseWheel

public boolean isImageScaleChangeByMouseWheel(MouseWheelEvent event)

checking for the ALT-down mask; Note: macOS trackpad-scrolling will set a Shift-down mask for some gestures that occurs in normal use.

Parameters:

event - an event

Returns:

the event is satisfied the condition for updating scale setting; checking ALT down.

Since:

1.7

imageScaleMouseWheelShouldBeActivated

protected boolean imageScaleMouseWheelShouldBeActivated(MouseWheelEvent e)

Parameters:

e - the tested event

Returns:

returns the autho-switch property value

setImageScaleAutoSwitchByMouseWheel

public void setImageScaleAutoSwitchByMouseWheel(boolean imageScaleAutoSwitchByMouseWheel)

set the property and add/remove the imageScale if it is a MouseWheelListener

Parameters:

imageScaleAutoSwitchByMouseWheel - the new flag

isImageScaleAutoSwitchByMouseWheel

public boolean isImageScaleAutoSwitchByMouseWheel()

Returns:

the auto-switch property value

getImage

public Image getImage()

Returns:

the current-image object

setImageScale

public void setImageScale(GuiSwingViewImagePane.ImageScale imageScale)

update the imageScale value and relating listeners.

1. update MouseWheelListener if the imageScale has the interface
2. if the imageScale is a GuiSwingViewImagePane.ImageScaleFit, inherits the current scale
3. call updateScale()

Parameters:

imageScale - the new instance

setImage

public void setImage(Image image)

set the image and update rendering

Parameters:

image - the new image

setPreferredSizeFromImageSize

public void setPreferredSizeFromImageSize()

call JComponent.setPreferredSize(Dimension) with imageSize

getImageScale

public GuiSwingViewImagePane.ImageScale getImageScale()

Returns:

the image-scale object

getImageScaleDefault

public GuiSwingViewImagePane.ImageScaleFit getImageScaleDefault()

Returns:

the image-scale-default object

getImageScaleMouseWheel

public GuiSwingViewImagePane.ImageScaleMouseWheel getImageScaleMouseWheel()

Returns:

the image-scale-wheel object

getImageScaleFit

public GuiSwingViewImagePane.ImageScaleFit getImageScaleFit()

Returns:

the image-scale-fit object

paintComponent

protected void paintComponent(Graphics g)

Overrides:

paintComponent in class JComponent

getViewSize

public Dimension getViewSize()

Returns:

size - insets , or if the parent is a viewport, the parent-size - insets

subtract

protected Dimension subtract(Dimension dim,
 Insets insets)

Parameters:

dim - a dimension

insets - a insets or null

Returns:

subtract insets from dim

isParentViewport

protected boolean isParentViewport()

Returns:

Component.getParent()

getImageScaledSize

public Dimension getImageScaledSize()

Returns:

the fit

getImageSize

public Dimension getImageSize()

Returns:

the imageSize object

updateScale

public void updateScale()

reflects image-scale settings

getViewPosition

public Point getViewPosition()

Returns:

the parent viewport's viewPosition or (0,0)

Since:

1.5

getRenderedImage

public RenderedImage getRenderedImage(Image image)

convert image to a writable RenderedImage

Parameters:

image - the source image

Returns:

call GuiReprValueImagePane.getRenderedImageWithSupport(GuiReprValueImagePane.RenderedImageGetterSupport, Object)

getStaticMenuItems

public List<PopupCategorized.CategorizedMenuItem> getStaticMenuItems()

Returns:

default list of menu-items; creates the list if not yet

createStaticMenuItems

protected List<PopupCategorized.CategorizedMenuItem> createStaticMenuItems()

Returns:

creating a list of menu-item

createCopyAction

protected GuiSwingViewImagePane.ImageCopyAction createCopyAction()

getDynamicMenuItems

public List<PopupCategorized.CategorizedMenuItem> getDynamicMenuItems()

Returns:

size-info and scale-info

createSizeInfo

public JComponent createSizeInfo(Dimension size)

Parameters:

size - the given image-size

Returns:

the label of current size-info

createScaleInfo

public JComponent createScaleInfo(Dimension size)

Parameters:

size - the given image-size

Returns:

the label of current scale-info