Module org.autogui

Package org.autogui.swing.prefs

Class GuiSwingPrefsEditor.ValueListMapPane<Key,Value>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.autogui.swing.util.ValueListPane<Map.Entry<Key,Value>,GuiSwingPrefsEditor.ValueListMapItemPane<Key,Value>>

org.autogui.swing.prefs.GuiSwingPrefsEditor.ValueListMapPane<Key,Value>

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:

GuiSwingPrefsEditor.ValueListMapPaneForTableColumnOrder, GuiSwingPrefsEditor.ValueListMapPaneForTableColumnWidthStatic

Enclosing class:

GuiSwingPrefsEditor

public abstract static class GuiSwingPrefsEditor.ValueListMapPane<Key,Value>
extends ValueListPane<Map.Entry<Key,Value>,GuiSwingPrefsEditor.ValueListMapItemPane<Key,Value>>

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.autogui.swing.util.ValueListPane

ValueListPane.ValueListAddAction, ValueListPane.ValueListContentPane<ValueType,PaneType extends JComponent>, ValueListPane.ValueListDownAction, ValueListPane.ValueListElementPane<ValueType,PaneType extends JComponent>, ValueListPane.ValueListElementTransferable, ValueListPane.ValueListElementTransferHandler, ValueListPane.ValueListModel<ValueType,PaneType extends JComponent>, ValueListPane.ValueListModelAdapter, ValueListPane.ValueListModelUpdater, ValueListPane.ValueListRemoveAction, ValueListPane.ValueListUpAction

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 Runnable	saveRunner
protected Supplier<Map<Key,Value>>	source
protected GuiSwingPrefsEditor.MapList<Key,Value>	sourceWrapper

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

addAction, downAction, globalFocusChangeListener, list, listWrapper, model, removeAction, upAction

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
ValueListMapPane(Supplier<Map<Key,Value>> source, Runnable saveRunner)

Method Summary

Modifier and Type	Method	Description
void	sourceAdded(int newIndex, Map.Entry<Key,Value> v)	called after the source-element is added: the default-impl is nothing
void	sourceRemoved(int[] removedIndices, List<Map.Entry<Key,Value>> removed)	called after removing elements from the source: the default-impl is nothing
void	sourceUpdated(int index, Map.Entry<Key,Value> v)
List<Map.Entry<Key,Value>>	takeSource()	Note: the default constructors does not call the method at initialization.
Map<Key,Value>	takeSourceMap()
void	updateSource()
boolean	updateSourceValueToElementPane(int i, Map.Entry<Key,Value> value, ValueListPane.ValueListElementPane<Map.Entry<Key,Value>,GuiSwingPrefsEditor.ValueListMapItemPane<Key,Value>> pane)	re-assign the i-th element-value to the target pane; the method is always called even if the i is not changed.

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

addNewElement, afterUpdateElements, close, editSource, focusCchange, getList, getModel, getValueListElementFlavor, init, initFocusRepainter, initLayout, initList, initTool, initToolActions, isParent, matchOrParent, moveDownSelectedElements, moveElements, moveSelectedElements, moveSourceValues, moveUpSelectedElements, newElementPane, newSourceValue, removeAll, removeElements, removeSelectedElements, removeSourceValue, scrollWrapper, selectionFlip, selectionRangeTo, selectionSet, sourceMoved, syncElements, updateSelectedElements, upperElement

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

Field Details

source

protected Supplier<Map<Key,Value>> source

sourceWrapper

protected GuiSwingPrefsEditor.MapList<Key,Value> sourceWrapper

saveRunner

protected Runnable saveRunner

Constructor Details

ValueListMapPane

public ValueListMapPane(Supplier<Map<Key,Value>> source,
 Runnable saveRunner)

Method Details

takeSource

public List<Map.Entry<Key,Value>> takeSource()

Description copied from class: ValueListPane

Note: the default constructors does not call the method at initialization. the constructors of sub-classes need to ValueListPane.syncElements() for initializing elements

Specified by:

takeSource in class ValueListPane<Map.Entry<Key,Value>,GuiSwingPrefsEditor.ValueListMapItemPane<Key,Value>>

Returns:

the direct reference to the source-list. it needs to be stable and modifiable

updateSource

public void updateSource()

takeSourceMap

public Map<Key,Value> takeSourceMap()

updateSourceValueToElementPane

public boolean updateSourceValueToElementPane(int i,
 Map.Entry<Key,Value> value,
 ValueListPane.ValueListElementPane<Map.Entry<Key,Value>,GuiSwingPrefsEditor.ValueListMapItemPane<Key,Value>> pane)

Description copied from class: ValueListPane

re-assign the i-th element-value to the target pane; the method is always called even if the i is not changed.

Specified by:

updateSourceValueToElementPane in class ValueListPane<Map.Entry<Key,Value>,GuiSwingPrefsEditor.ValueListMapItemPane<Key,Value>>

Parameters:

i - the index of the element

value - the value of the element

pane - the i-th element-pane

Returns:

true if the value of the pane is updated by the given (i,value).

sourceAdded

public void sourceAdded(int newIndex,
 Map.Entry<Key,Value> v)

Description copied from class: ValueListPane

called after the source-element is added: the default-impl is nothing

Overrides:

sourceAdded in class ValueListPane<Map.Entry<Key,Value>,GuiSwingPrefsEditor.ValueListMapItemPane<Key,Value>>

Parameters:

newIndex - the new-element index

v - the added value

sourceRemoved

public void sourceRemoved(int[] removedIndices,
 List<Map.Entry<Key,Value>> removed)

Description copied from class: ValueListPane

called after removing elements from the source: the default-impl is nothing

Overrides:

sourceRemoved in class ValueListPane<Map.Entry<Key,Value>,GuiSwingPrefsEditor.ValueListMapItemPane<Key,Value>>

Parameters:

removedIndices - removed indices

removed - removed values

sourceUpdated

public void sourceUpdated(int index,
 Map.Entry<Key,Value> v)