Module org.autogui

Package org.autogui.swing

Class GuiSwingViewPropertyPane.NamedPropertyPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.autogui.swing.util.NamedPane

org.autogui.swing.GuiSwingViewPropertyPane.NamedPropertyPane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, GuiSwingView.ValuePane<Object>, GuiSwingViewWrapper.ValuePaneWrapper<Object>

Direct Known Subclasses:

GuiSwingViewPropertyPane.PropertyPane

Enclosing class:

GuiSwingViewPropertyPane

public static class GuiSwingViewPropertyPane.NamedPropertyPane
extends NamedPane
implements GuiSwingViewWrapper.ValuePaneWrapper<Object>

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 PopupExtension	popup
protected GuiTaskClock	viewClock

Fields inherited from class org.autogui.swing.util.NamedPane

contentPane, displayName, label

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
NamedPropertyPane()
NamedPropertyPane(String displayName, String name)
NamedPropertyPane(String displayName, String name, JComponent contentPane)
NamedPropertyPane(String displayName, String name, JComponent contentPane, PopupExtension.PopupMenuBuilder menuBuilder)

Method Summary

Modifier and Type	Method	Description
void	addSwingEditFinishHandler(Runnable eventHandler)	the method is used for table cell-editors, in order to observe the completion of editing.
GuiSwingView.ValuePane<Object>	getContentPaneAsValuePane()
GuiReprValue.ObjectSpecifier	getSpecifier()
KeyStroke	getSwingFocusKeyStroke()
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()
Object	getSwingViewValue()
GuiSwingView.ValuePane<Object>	getSwingViewWrappedPane()
boolean	hasContentValuePane()
void	init()
boolean	isProperty()
void	prepareForRefresh()	for each component, the method is called before refreshing in order to clear the view-clock.
void	setSwingViewValue(Object value)	update GUI display, and it does NOT update the target model value.
void	setSwingViewValue(Object value, GuiTaskClock clock)	update if the clock is newer than the current view-clock of the pane.
void	setSwingViewValueWithUpdate(Object value)	update the GUI display and the model.
void	setSwingViewValueWithUpdate(Object value, GuiTaskClock clock)	update the GUI display and the model if the clock is newer than the current view-clock of the pane.

Methods inherited from class org.autogui.swing.util.NamedPane

getContentPane, getDisplayName, getLabel, initNameLabel, setContentPane, setDisplayName

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

asSwingViewComponent, executeContextTask, getChildByName, getDescendantActionByContext, getDescendantByContext, getDescendantByValue, getDescendantByValueIf, getPrefsJsonSupported, isSwingCurrentValueSupported, isSwingEditable, loadSwingPreferences, refreshByContext, requestSwingViewFocus, setKeyStrokeString, setPrefsJsonSupported, setSwingViewHistoryValue, setSwingViewValueForTable, shutdownSwingView, updateSwingViewSource, updateSwingViewSourceFromRoot, wrapSwingNamed, wrapSwingPane, wrapSwingProperty, wrapSwingScrollPane

Methods inherited from interface org.autogui.swing.GuiSwingViewWrapper.ValuePaneWrapper

getActionByContext, getActionByName, getSwingViewWrappedPaneAsTypeOrNull, isSwingViewWrappedPaneSameContext, loadSwingPreferences, saveSwingPreferences

Field Details

popup

protected PopupExtension popup

viewClock

protected GuiTaskClock viewClock

Constructor Details

NamedPropertyPane

public NamedPropertyPane()

NamedPropertyPane

public NamedPropertyPane(String displayName,
 String name)

NamedPropertyPane

public NamedPropertyPane(String displayName,
 String name,
 JComponent contentPane)

NamedPropertyPane

public NamedPropertyPane(String displayName,
 String name,
 JComponent contentPane,
 PopupExtension.PopupMenuBuilder menuBuilder)

Method Details

init

public void init()

Overrides:

init in class NamedPane

hasContentValuePane

public boolean hasContentValuePane()

getContentPaneAsValuePane

public GuiSwingView.ValuePane<Object> getContentPaneAsValuePane()

getSwingViewValue

public Object getSwingViewValue()

Specified by:

getSwingViewValue in interface GuiSwingView.ValuePane<Object>

Returns:

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

setSwingViewValue

public void setSwingViewValue(Object 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<Object>

Parameters:

value - the new value

setSwingViewValueWithUpdate

public void setSwingViewValueWithUpdate(Object 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<Object>

Parameters:

value - the new value

setSwingViewValue

public void setSwingViewValue(Object 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<Object>

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(Object 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<Object>

Parameters:

value - the new value

clock - the clock of the value

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

Returns:

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

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

Returns:

a menu builder

addSwingEditFinishHandler

public void addSwingEditFinishHandler(Runnable eventHandler)

Description copied from interface: GuiSwingView.ValuePane

the method is used for table cell-editors, in order to observe the completion of editing. the default impl. is empty.

Specified by:

addSwingEditFinishHandler in interface GuiSwingView.ValuePane<Object>

Parameters:

eventHandler - the handler called when the editing is finished

isProperty

public boolean isProperty()

getSwingViewContext

public GuiMappingContext getSwingViewContext()

Specified by:

getSwingViewContext in interface GuiSwingView.ValuePane<Object>

getSwingFocusKeyStroke

public KeyStroke getSwingFocusKeyStroke()

Specified by:

getSwingFocusKeyStroke in interface GuiSwingView.ValuePane<Object>

Specified by:

getSwingFocusKeyStroke in interface GuiSwingViewWrapper.ValuePaneWrapper<Object>

Returns:

null meaning the named pane will never become key-binding target

getSwingViewWrappedPane

public GuiSwingView.ValuePane<Object> getSwingViewWrappedPane()

Specified by:

getSwingViewWrappedPane in interface GuiSwingViewWrapper.ValuePaneWrapper<Object>

Returns:

a wrapped child pane or null. the returned pane might have the same context of this, or different one like "property(value)"

getSpecifier

public GuiReprValue.ObjectSpecifier getSpecifier()

Specified by:

getSpecifier in interface GuiSwingView.ValuePane<Object>

Returns:

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

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