Module org.autogui

Package org.autogui.swing

Class GuiSwingViewImagePane.PropertyImagePane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.autogui.swing.GuiSwingViewImagePane.ImagePaneBase

org.autogui.swing.GuiSwingViewImagePane.PropertyImagePane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, GuiMappingContext.SourceUpdateListener, GuiSwingView.SettingsWindowClient, GuiSwingView.ValuePane<Image>

Direct Known Subclasses:

GuiSwingTableColumnImage.ColumnEditImagePane, LambdaProperty.LambdaImagePane

Enclosing class:

GuiSwingViewImagePane

public static class GuiSwingViewImagePane.PropertyImagePane
extends GuiSwingViewImagePane.ImagePaneBase
implements GuiMappingContext.SourceUpdateListener, GuiSwingView.ValuePane<Image>, GuiSwingView.SettingsWindowClient

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 GuiMappingContext	context
protected boolean	currentValueSupported
protected boolean	editable
protected MenuBuilder.MenuLabel	infoLabel
protected GuiSwingViewImagePane.ImagePreviewAction	previewAction	the action for previewing
protected SettingsWindow	settingsWindow	the window for previewing
protected GuiSwingView.SpecifierManager	specifierManager
protected GuiTaskClock	viewClock

Fields inherited from class org.autogui.swing.GuiSwingViewImagePane.ImagePaneBase

autoSwitchByMouseWheel, image, imageScale, imageScaleAutoSwitchByMouseWheel, imageScaleDefault, imageScaleFit, imageScaleMouseWheel, imageSize, menuItems, popup, 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

Constructor	Description
PropertyImagePane(GuiMappingContext context, GuiSwingView.SpecifierManager specifierManager)

Method Summary

Modifier and Type	Method	Description
protected GuiSwingViewImagePane.ImageCopyAction	createCopyAction()
Path	getImagePath(Image image)
RenderedImage	getRenderedImage(Image image)	convert image to a writable RenderedImage
SettingsWindow	getSettingsWindow()
GuiReprValue.ObjectSpecifier	getSpecifier()
List<PopupCategorized.CategorizedMenuItem>	getStaticMenuItems()
PopupExtension.PopupMenuBuilder	getSwingMenuBuilder()	a typical implementation if there are no dynamic items becomes like the following code:
List<PopupCategorized.CategorizedMenuItem>	getSwingStaticMenuItems()	a typical implementation becomes like the following code:
GuiMappingContext	getSwingViewContext()
Image	getSwingViewValue()
void	init()	initializer
void	initContextUpdate()
void	initDragDrop()
void	initEditable()
void	initFocus()	make this view fucusable with a mouse-listener of focusing
void	initName()
void	initPopup()	initialize popup-menu
void	initPreview()
void	initValue()
boolean	isSwingCurrentValueSupported()
boolean	isSwingEditable()
void	prepareForRefresh()	for each component, the method is called before refreshing in order to clear the view-clock.
void	setCurrentValueSupported(boolean currentValueSupported)
void	setEditable(boolean editable)
void	setImage(Image image)	set the image and update rendering
void	setImagePath(Image image, Path path)	an imported image from a file always be called this method with the file.
void	setImageWithoutContextUpdate(Image image)
void	setKeyStrokeString(String keyStrokeString)	set the key-stroke info.
void	setSettingsWindow(SettingsWindow settingsWindow)	at initialization of the root-pane, the method will be called for existing sub-panes.
void	setSwingViewHistoryValue(Object value)	called from a value history menu.
void	setSwingViewValue(Image value)	update GUI display, and it does NOT update the target model value.
void	setSwingViewValue(Image value, GuiTaskClock clock)	update if the clock is newer than the current view-clock of the pane.
void	setSwingViewValueWithUpdate(Image value)	update the GUI display and the model.
void	setSwingViewValueWithUpdate(Image value, GuiTaskClock clock)	update the GUI display and the model if the clock is newer than the current view-clock of the pane.
void	update(GuiMappingContext cause, Object newValue, GuiTaskClock contextClock)
void	updateFromGui(Object v, GuiTaskClock viewClock)

Methods inherited from class org.autogui.swing.GuiSwingViewImagePane.ImagePaneBase

createScaleInfo, createSizeInfo, createStaticMenuItems, dragMove, getDynamicMenuItems, getImage, getImageScale, getImageScaleDefault, getImageScaledSize, getImageScaleFit, getImageScaleMouseWheel, getImageSize, getViewPosition, getViewSize, imageScaleMouseWheelShouldBeActivated, initDragScroll, initScale, isImageScaleAutoSwitchByMouseWheel, isImageScaleChangeByMouseWheel, isParentViewport, paintComponent, setImageScale, setImageScaleAutoSwitchByMouseWheel, setPreferredSizeFromImageSize, subtract, updateScale

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

Methods inherited from interface org.autogui.swing.GuiSwingView.ValuePane

addSwingEditFinishHandler, asSwingViewComponent, executeContextTask, getActionByContext, getActionByName, getChildByName, getDescendantActionByContext, getDescendantByContext, getDescendantByValue, getDescendantByValueIf, getPrefsJsonSupported, getSwingFocusKeyStroke, loadSwingPreferences, loadSwingPreferences, refreshByContext, requestSwingViewFocus, saveSwingPreferences, setPrefsJsonSupported, setSwingViewValueForTable, shutdownSwingView, updateSwingViewSource, updateSwingViewSourceFromRoot, wrapSwingNamed, wrapSwingPane, wrapSwingProperty, wrapSwingScrollPane

Field Details

context

protected GuiMappingContext context

specifierManager

protected GuiSwingView.SpecifierManager specifierManager

editable

protected boolean editable

infoLabel

protected MenuBuilder.MenuLabel infoLabel

viewClock

protected GuiTaskClock viewClock

currentValueSupported

protected boolean currentValueSupported

settingsWindow

protected SettingsWindow settingsWindow

the window for previewing

previewAction

protected GuiSwingViewImagePane.ImagePreviewAction previewAction

the action for previewing

Constructor Details

PropertyImagePane

public PropertyImagePane(GuiMappingContext context,
 GuiSwingView.SpecifierManager specifierManager)

Method Details

init

public void init()

Description copied from class: GuiSwingViewImagePane.ImagePaneBase

initializer

Overrides:

init in class GuiSwingViewImagePane.ImagePaneBase

initName

public void initName()

initEditable

public void initEditable()

initContextUpdate

public void initContextUpdate()

initValue

public void initValue()

initPreview

public void initPreview()

initPopup

public void initPopup()

Description copied from class: GuiSwingViewImagePane.ImagePaneBase

initialize popup-menu

Overrides:

initPopup in class GuiSwingViewImagePane.ImagePaneBase

initDragDrop

public void initDragDrop()

initFocus

public void initFocus()

Description copied from class: GuiSwingViewImagePane.ImagePaneBase

make this view fucusable with a mouse-listener of focusing

Overrides:

initFocus in class GuiSwingViewImagePane.ImagePaneBase

isSwingCurrentValueSupported

public boolean isSwingCurrentValueSupported()

Specified by:

isSwingCurrentValueSupported in interface GuiSwingView.ValuePane<Image>

setCurrentValueSupported

public void setCurrentValueSupported(boolean currentValueSupported)

setSettingsWindow

public void setSettingsWindow(SettingsWindow settingsWindow)

Description copied from interface: GuiSwingView.SettingsWindowClient

at initialization of the root-pane, the method will be called for existing sub-panes. a dynamically created view needs to be manually set by those panes.

Specified by:

setSettingsWindow in interface GuiSwingView.SettingsWindowClient

Parameters:

settingsWindow - a settings-window from the root-pane, which will be disposed at closing of the main window

getSettingsWindow

public SettingsWindow getSettingsWindow()

Specified by:

getSettingsWindow in interface GuiSwingView.SettingsWindowClient

getSwingViewContext

public GuiMappingContext getSwingViewContext()

Specified by:

getSwingViewContext in interface GuiSwingView.ValuePane<Image>

getSwingStaticMenuItems

public List<PopupCategorized.CategorizedMenuItem> getSwingStaticMenuItems()

Description copied from interface: GuiSwingView.ValuePane

a typical implementation becomes like the following code:

      if (menuItems == null) { menuItems = PopupCategorized.getMenuItems(actions, menus); }
      return menuItems;
  

the method returns original menu items for the pane. so, if a wrapper pane has a wrapped sub-pane added as a child component, it should not include items of the wrapped sub-pane.

Specified by:

getSwingStaticMenuItems in interface GuiSwingView.ValuePane<Image>

Returns:

a list of actions (or menu-components) statically determined, that should be always same instances

getStaticMenuItems

public List<PopupCategorized.CategorizedMenuItem> getStaticMenuItems()

Overrides:

getStaticMenuItems in class GuiSwingViewImagePane.ImagePaneBase

Returns:

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

createCopyAction

protected GuiSwingViewImagePane.ImageCopyAction createCopyAction()

Overrides:

createCopyAction in class GuiSwingViewImagePane.ImagePaneBase

getSwingMenuBuilder

public PopupExtension.PopupMenuBuilder getSwingMenuBuilder()

Description copied from interface: GuiSwingView.ValuePane

a typical implementation if there are no dynamic items becomes like the following code:

     if (popup == null) { popup = new PopupExtension(this,
                                    new PopupCategorized(this::getSwingStaticMenuItems)); }
     return popup.getMenuBuilder();
 

Specified by:

getSwingMenuBuilder in interface GuiSwingView.ValuePane<Image>

Returns:

a menu builder

isSwingEditable

public boolean isSwingEditable()

Specified by:

isSwingEditable in interface GuiSwingView.ValuePane<Image>

setEditable

public void setEditable(boolean editable)

update

public void update(GuiMappingContext cause,
 Object newValue,
 GuiTaskClock contextClock)

Specified by:

update in interface GuiMappingContext.SourceUpdateListener

setImageWithoutContextUpdate

public void setImageWithoutContextUpdate(Image image)

setImage

public void setImage(Image image)

Description copied from class: GuiSwingViewImagePane.ImagePaneBase

set the image and update rendering

Overrides:

setImage in class GuiSwingViewImagePane.ImagePaneBase

Parameters:

image - the new image

updateFromGui

public void updateFromGui(Object v,
 GuiTaskClock viewClock)

getSwingViewValue

public Image getSwingViewValue()

Specified by:

getSwingViewValue in interface GuiSwingView.ValuePane<Image>

Returns:

basically, the source value of the context, held by the component without touching the context.

setSwingViewValue

public void setSwingViewValue(Image value)

Description copied from interface: GuiSwingView.ValuePane

update GUI display, and it does NOT update the target model value. processed under the event thread. also increment the view-clock.

Specified by:

setSwingViewValue in interface GuiSwingView.ValuePane<Image>

Parameters:

value - the new value

setSwingViewValueWithUpdate

public void setSwingViewValueWithUpdate(Image value)

Description copied from interface: GuiSwingView.ValuePane

update the GUI display and the model. processed under the event thread. also increment the view-clock

Specified by:

setSwingViewValueWithUpdate in interface GuiSwingView.ValuePane<Image>

Parameters:

value - the new value

setSwingViewValue

public void setSwingViewValue(Image value,
 GuiTaskClock clock)

Description copied from interface: GuiSwingView.ValuePane

update if the clock is newer than the current view-clock of the pane. the view-clock becomes the given clock. Note: instead, GuiSwingView.ValuePane.setSwingViewValue(Object) increments the current clock

Specified by:

setSwingViewValue in interface GuiSwingView.ValuePane<Image>

Parameters:

value - the new value

clock - the clock of the value: if the clock is newer than the current view-clock of the pane, it can update

setSwingViewValueWithUpdate

public void setSwingViewValueWithUpdate(Image value,
 GuiTaskClock clock)

Description copied from interface: GuiSwingView.ValuePane

update the GUI display and the model if the clock is newer than the current view-clock of the pane. the view-clock becomes the given clock.

Specified by:

setSwingViewValueWithUpdate in interface GuiSwingView.ValuePane<Image>

Parameters:

value - the new value

clock - the clock of the value

getSpecifier

public GuiReprValue.ObjectSpecifier getSpecifier()

Specified by:

getSpecifier in interface GuiSwingView.ValuePane<Image>

Returns:

the specifier for the context value, typically obtained from GuiSwingView.SpecifierManager

setKeyStrokeString

public void setKeyStrokeString(String keyStrokeString)

Description copied from interface: GuiSwingView.ValuePane

set the key-stroke info. to the pane as a guide

Specified by:

setKeyStrokeString in interface GuiSwingView.ValuePane<Image>

Parameters:

keyStrokeString - the key stroke info to be set.

setImagePath

public void setImagePath(Image image,
 Path path)

an imported image from a file always be called this method with the file. then the value of GuiPreferences.HistoryValueEntry becomes GuiReprValueImagePane.ImageHistoryEntry.

Parameters:

image - a loaded image. if null, ignored

path - source path of the image

getImagePath

public Path getImagePath(Image image)

setSwingViewHistoryValue

public void setSwingViewHistoryValue(Object value)

Description copied from interface: GuiSwingView.ValuePane

called from a value history menu. the default impl. just calls GuiSwingView.ValuePane.setSwingViewValueWithUpdate(Object).

Specified by:

setSwingViewHistoryValue in interface GuiSwingView.ValuePane<Image>

Parameters:

value - the new value. usually a ValueType.

prepareForRefresh

public void prepareForRefresh()

Description copied from interface: GuiSwingView.ValuePane

for each component, the method is called before refreshing in order to clear the view-clock.

Specified by:

prepareForRefresh in interface GuiSwingView.ValuePane<Image>

getRenderedImage

public RenderedImage getRenderedImage(Image image)

Description copied from class: GuiSwingViewImagePane.ImagePaneBase

convert image to a writable RenderedImage

Overrides:

getRenderedImage in class GuiSwingViewImagePane.ImagePaneBase

Parameters:

image - the source image

Returns:

call GuiReprValueImagePane.getRenderedImageWithSupport(GuiReprValueImagePane.RenderedImageGetterSupport, Object)