Module org.autogui

Package org.autogui.swing

Class GuiSwingViewPropertyPane.PropertyPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.autogui.swing.util.NamedPane

org.autogui.swing.GuiSwingViewPropertyPane.NamedPropertyPane

org.autogui.swing.GuiSwingViewPropertyPane.PropertyPane

All Implemented Interfaces:

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

Direct Known Subclasses:

GuiSwingViewPropertyPane.PropertyWrapperPane

Enclosing class:

GuiSwingViewPropertyPane

public static class GuiSwingViewPropertyPane.PropertyPane
extends GuiSwingViewPropertyPane.NamedPropertyPane

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 MenuBuilder.MenuLabel	infoLabel
protected List<PopupCategorized.CategorizedMenuItem>	menuItems
protected PopupExtension	popup
protected boolean	showName
protected GuiSwingView.SpecifierManager	specifierManager

Fields inherited from class org.autogui.swing.GuiSwingViewPropertyPane.NamedPropertyPane

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
PropertyPane(GuiMappingContext context, boolean showName, GuiSwingView.SpecifierManager specifierManager)
PropertyPane(GuiMappingContext context, boolean showName, GuiSwingView.SpecifierManager specifierManager, JComponent content)

Method Summary

Modifier and Type	Method	Description
PopupExtension	getPopup()
GuiReprValue.ObjectSpecifier	getSpecifier()
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()
void	init()
void	initLazy()
void	initName()
void	initNameLabel()
void	initPopup()
void	setContentPane(JComponent content)
void	setKeyStrokeString(String keyStrokeString)	set the key-stroke info.
void	setPopupBuilder()

Methods inherited from class org.autogui.swing.GuiSwingViewPropertyPane.NamedPropertyPane

addSwingEditFinishHandler, getContentPaneAsValuePane, getSwingFocusKeyStroke, getSwingViewValue, getSwingViewWrappedPane, hasContentValuePane, isProperty, prepareForRefresh, setSwingViewValue, setSwingViewValue, setSwingViewValueWithUpdate, setSwingViewValueWithUpdate

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

getContentPane, getDisplayName, getLabel, 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, 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

context

protected GuiMappingContext context

specifierManager

protected GuiSwingView.SpecifierManager specifierManager

popup

protected PopupExtension popup

showName

protected boolean showName

menuItems

protected List<PopupCategorized.CategorizedMenuItem> menuItems

infoLabel

protected MenuBuilder.MenuLabel infoLabel

Constructor Details

PropertyPane

public PropertyPane(GuiMappingContext context,
 boolean showName,
 GuiSwingView.SpecifierManager specifierManager)

PropertyPane

public PropertyPane(GuiMappingContext context,
 boolean showName,
 GuiSwingView.SpecifierManager specifierManager,
 JComponent content)

Method Details

init

public void init()

Overrides:

init in class GuiSwingViewPropertyPane.NamedPropertyPane

initLazy

public void initLazy()

initName

public void initName()

initNameLabel

public void initNameLabel()

Overrides:

initNameLabel in class NamedPane

initPopup

public void initPopup()

setPopupBuilder

public void setPopupBuilder()

setContentPane

public void setContentPane(JComponent content)

Overrides:

setContentPane in class NamedPane

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>

Overrides:

getSwingStaticMenuItems in class GuiSwingViewPropertyPane.NamedPropertyPane

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>

Overrides:

getSwingMenuBuilder in class GuiSwingViewPropertyPane.NamedPropertyPane

Returns:

a menu builder

getSwingViewContext

public GuiMappingContext getSwingViewContext()

Specified by:

getSwingViewContext in interface GuiSwingView.ValuePane<Object>

Overrides:

getSwingViewContext in class GuiSwingViewPropertyPane.NamedPropertyPane

getSpecifier

public GuiReprValue.ObjectSpecifier getSpecifier()

Specified by:

getSpecifier in interface GuiSwingView.ValuePane<Object>

Overrides:

getSpecifier in class GuiSwingViewPropertyPane.NamedPropertyPane

Returns:

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

getPopup

public PopupExtension getPopup()

setKeyStrokeString

public void setKeyStrokeString(String keyStrokeString)

Description copied from interface: GuiSwingView.ValuePane

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

Parameters:

keyStrokeString - the key stroke info to be set.