Module org.autogui

Package org.autogui.swing

Class GuiSwingViewObjectPane.ObjectPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.autogui.swing.GuiSwingViewObjectPane.ObjectPane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, GuiMappingContext.SourceUpdateListener, GuiSwingView.ValuePane<Object>, GuiSwingPrefsSupports.PreferencesUpdateSupport

Direct Known Subclasses:

GuiSwingViewTabbedPane.ObjectTabbedPane

Enclosing class:

GuiSwingViewObjectPane

public static class GuiSwingViewObjectPane.ObjectPane
extends JPanel
implements GuiMappingContext.SourceUpdateListener, GuiSwingView.ValuePane<Object>, GuiSwingPrefsSupports.PreferencesUpdateSupport

 actionToolBar: [JToolBar: actionButtons...],
 contentPane: [
   fixedSizeComponent1,
   ...
   resizableSubComponents [
       [splitPane: resizableComponent1 |
         [splitPane: resizableComponent2 | ... ]
       ]
   ],
   fixedSizeComponent2,
   fixedSizeComponent3,
   ... ]
  

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

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 List<Action>	actions
protected JToolBar	actionToolBar
protected Map<String,JComponent>	childContextToComponents	recording mapping between prop (context) name to subcomponent
protected JComponent	contentPane
protected GuiMappingContext	context
protected boolean	defaultSplitOrientationHorizontal	the default setting for the orientation of split-panes
protected MenuBuilder.MenuLabel	infoLabel
protected SettingsWindow.LabelGroup	labelGroup
protected List<PopupCategorized.CategorizedMenuItem>	menuItems
protected PopupExtension	popup
protected GuiSwingViewObjectPane.SplitPreferencesUpdater	preferencesUpdater
protected JComponent	resizableSubComponents
protected GuiSwingView.SpecifierManager	specifierManager
protected List<JSplitPane>	splitPanes
protected GuiTaskClock	viewClock

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
ObjectPane(GuiMappingContext context, GuiSwingView.SpecifierManager specifierManager)

Method Summary

Modifier and Type	Method	Description
void	addAction(Action action)
void	addAction(Action action, GuiMappingContext subContext)	adding the action created from subContext
void	addSubComponent(JComponent component, boolean resizable)
void	addSubComponent(JComponent component, boolean resizable, GuiMappingContext subContext)	adding a child component
void	addSubComponentResizable(JComponent component)
void	afterActionsAdded()
JComponent	createResizableSplit(boolean horizontal, Component left, Component right)
JComponent	createResizableSubComponents()
void	fit()
List<Action>	getActions()
JToolBar	getActionToolBar()
JComponent	getContentPane()
PopupExtension	getPopup()
JComponent	getResizableSubComponents()
GuiReprValue.ObjectSpecifier	getSpecifier()
List<JSplitPane>	getSplitPanes()
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()
protected SearchTextField	getTargetForTextAction(GuiMappingContext subContext)	obtains action target for a sub-context.
void	init()
void	initActionToolBar()
void	initBorder()
void	initContentPane()
void	initContextUpdate()
void	initDragDrop()
void	initFocus()
void	initLabelGroup()
void	initLayout()
void	initName()
void	initPopup()
void	initPreferencesUpdater()
void	initSplitDefaultOrientation()	called from init(); set defaultSplitOrientationHorizontal from the context type
boolean	isDefaultSplitOrientationHorizontal()
void	loadSwingPreferences(GuiPreferences prefs, GuiSwingPrefsApplyOptions options)	a sub-class which wraps another value-pane should overrides the method in order to omit needless value setting.
void	prepareForRefresh()	for each component, the method is called before refreshing in order to clear the view-clock.
void	saveSwingPreferences(GuiPreferences prefs)	only save the component itself, not including children.
void	setDefaultSplitOrientationHorizontal(boolean defaultSplitOrientationHorizontal)
void	setKeyStrokeString(String keyStrokeString)	set the key-stroke info.
void	setPreferencesUpdater(Consumer<GuiSwingPrefsSupports.PreferencesUpdateEvent> updater)
void	setSwingViewValue(Object value)	special case: update the source
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.
void	update(GuiMappingContext cause, Object newValue, GuiTaskClock clock)
void	updateFromGui(Object v, GuiTaskClock viewClock)

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, 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

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, 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, isSwingCurrentValueSupported, isSwingEditable, loadSwingPreferences, refreshByContext, requestSwingViewFocus, setPrefsJsonSupported, setSwingViewHistoryValue, setSwingViewValueForTable, shutdownSwingView, updateSwingViewSource, updateSwingViewSourceFromRoot, wrapSwingNamed, wrapSwingPane, wrapSwingProperty, wrapSwingScrollPane

Field Details

context

protected GuiMappingContext context

specifierManager

protected GuiSwingView.SpecifierManager specifierManager

actionToolBar

protected JToolBar actionToolBar

contentPane

protected JComponent contentPane

resizableSubComponents

protected JComponent resizableSubComponents

popup

protected PopupExtension popup

actions

protected List<Action> actions

menuItems

protected List<PopupCategorized.CategorizedMenuItem> menuItems

infoLabel

protected MenuBuilder.MenuLabel infoLabel

splitPanes

protected List<JSplitPane> splitPanes

preferencesUpdater

protected GuiSwingViewObjectPane.SplitPreferencesUpdater preferencesUpdater

labelGroup

protected SettingsWindow.LabelGroup labelGroup

defaultSplitOrientationHorizontal

protected boolean defaultSplitOrientationHorizontal

the default setting for the orientation of split-panes

Since:

1.5

childContextToComponents

protected Map<String,JComponent> childContextToComponents

recording mapping between prop (context) name to subcomponent

Since:

1.5

viewClock

protected GuiTaskClock viewClock

Constructor Details

ObjectPane

public ObjectPane(GuiMappingContext context,
 GuiSwingView.SpecifierManager specifierManager)

Method Details

init

public void init()

initName

public void initName()

initLayout

public void initLayout()

initBorder

public void initBorder()

initContentPane

public void initContentPane()

initLabelGroup

public void initLabelGroup()

initPreferencesUpdater

public void initPreferencesUpdater()

initContextUpdate

public void initContextUpdate()

initPopup

public void initPopup()

initFocus

public void initFocus()

initDragDrop

public void initDragDrop()

initSplitDefaultOrientation

public void initSplitDefaultOrientation()

called from init(); set defaultSplitOrientationHorizontal from the context type

Since:

1.8

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

getActions

public List<Action> getActions()

getContentPane

public JComponent getContentPane()

getActionToolBar

public JToolBar getActionToolBar()

getResizableSubComponents

public JComponent getResizableSubComponents()

isDefaultSplitOrientationHorizontal

public boolean isDefaultSplitOrientationHorizontal()

Returns:

the default value is true

Since:

1.8

setDefaultSplitOrientationHorizontal

public void setDefaultSplitOrientationHorizontal(boolean defaultSplitOrientationHorizontal)

Parameters:

defaultSplitOrientationHorizontal - the flag

Since:

1.8

update

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

Specified by:

update in interface GuiMappingContext.SourceUpdateListener

addSubComponent

public void addSubComponent(JComponent component,
 boolean resizable,
 GuiMappingContext subContext)

adding a child component

Parameters:

component - the component for the subContext

resizable - true if the component is resizable

subContext - a target child of the context of the pane

Since:

1.5

addSubComponent

public void addSubComponent(JComponent component,
 boolean resizable)

addSubComponentResizable

public void addSubComponentResizable(JComponent component)

createResizableSubComponents

public JComponent createResizableSubComponents()

createResizableSplit

public JComponent createResizableSplit(boolean horizontal,
 Component left,
 Component right)

afterActionsAdded

public void afterActionsAdded()

fit

public void fit()

getSplitPanes

public List<JSplitPane> getSplitPanes()

addAction

public void addAction(Action action,
 GuiMappingContext subContext)

adding the action created from subContext

Parameters:

action - the action for subContext

subContext - a child context of the context of the pane

Since:

1.5

getTargetForTextAction

protected SearchTextField getTargetForTextAction(GuiMappingContext subContext)

obtains action target for a sub-context. if the action is "xyzAction" then, searches the "xyz" property, and it is a SearchTextField, then it can combine the action and the field as like [ field [action] ]

Parameters:

subContext - the context of the action

Returns:

non-null target-field if exists, or null

addAction

public void addAction(Action action)

initActionToolBar

public void initActionToolBar()

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)

special case: update the source

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

updateFromGui

public void updateFromGui(Object v,
 GuiTaskClock viewClock)

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

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

getSwingViewContext

public GuiMappingContext getSwingViewContext()

Specified by:

getSwingViewContext in interface GuiSwingView.ValuePane<Object>

loadSwingPreferences

public void loadSwingPreferences(GuiPreferences prefs,
 GuiSwingPrefsApplyOptions options)

Description copied from interface: GuiSwingView.ValuePane

a sub-class which wraps another value-pane should overrides the method in order to omit needless value setting. it can use GuiSwingView.loadPreferencesDefault(JComponent, GuiPreferences)

Specified by:

loadSwingPreferences in interface GuiSwingView.ValuePane<Object>

Parameters:

prefs - target prefs or ancestor of the target; actual target can be obtained by GuiPreferences.getDescendant(GuiMappingContext)

options - options for applying

saveSwingPreferences

public void saveSwingPreferences(GuiPreferences prefs)

Description copied from interface: GuiSwingView.ValuePane

only save the component itself, not including children. it can use GuiSwingView.savePreferencesDefault(JComponent, GuiPreferences)

Specified by:

saveSwingPreferences in interface GuiSwingView.ValuePane<Object>

Parameters:

prefs - target prefs or ancestor of the target; actual target can be obtained by GuiPreferences.getDescendant(GuiMappingContext)

setPreferencesUpdater

public void setPreferencesUpdater(Consumer<GuiSwingPrefsSupports.PreferencesUpdateEvent> updater)

Specified by:

setPreferencesUpdater in interface GuiSwingPrefsSupports.PreferencesUpdateSupport

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

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

Specified by:

setKeyStrokeString in interface GuiSwingView.ValuePane<Object>

Parameters:

keyStrokeString - the key stroke info to be set.

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>