Module org.autogui

Package org.autogui.swing

Class GuiSwingViewStringField.PropertyStringPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.autogui.swing.util.SearchTextField

org.autogui.swing.GuiSwingViewStringField.PropertyStringPane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, GuiMappingContext.SourceUpdateListener, GuiSwingView.ValuePane<String>

Direct Known Subclasses:

GuiSwingTableColumnString.ColumnEditTextPane, LambdaProperty.LambdaStringPane

Enclosing class:

GuiSwingViewStringField

public static class GuiSwingViewStringField.PropertyStringPane
extends SearchTextField
implements GuiMappingContext.SourceUpdateListener, GuiSwingView.ValuePane<String>

See Also:

• Serialized Form

Nested Class Summary

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

SearchTextField.DynamicItemAction, SearchTextField.SearchBackgroundPainter, SearchTextField.SearchBackgroundPainterBordered, SearchTextField.SearchedItemsListener, SearchTextField.SearchTask, SearchTextField.SearchTextFieldModel, SearchTextField.SearchTextFieldModelEmpty, SearchTextField.SearchTextFieldPublisher, SearchTextField.SearchTextFieldPublisherEmpty

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 List<Runnable>	editFinishHandlers
protected MenuBuilder.MenuLabel	infoLabel
protected List<PopupCategorized.CategorizedMenuItem>	menuItems
protected GuiSwingView.SpecifierManager	specifierManager
protected GuiTaskClock	viewClock

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

backgroundPainter, buttonsPane, currentSearchedItems, currentTask, editingRunner, emptyIcon, field, icon, menuItemsSource, model, popup, popupButton, searchedItemsListeners, undoManager

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

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.
Supplier<List<PopupCategorized.CategorizedMenuItem>>	getMenuItems()
List<Object>	getMenuItemsSource()
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()
String	getSwingViewValue()
void	init()
void	initContextUpdate()
void	initDragDrop()
void	initEditable()
void	initLazy()
void	initName()
void	initPopup()
void	initValue()
boolean	isSwingCurrentValueSupported()
void	prepareForRefresh()	for each component, the method is called before refreshing in order to clear the view-clock.
void	requestSwingViewFocus()
void	setCurrentValueSupported(boolean currentValueSupported)
void	setKeyStrokeString(String keyStrokeString)	set the key-stroke info.
void	setSwingViewValue(String value)	update GUI display, and it does NOT update the target model value.
void	setSwingViewValue(String value, GuiTaskClock contextClock)	update if the clock is newer than the current view-clock of the pane.
void	setSwingViewValueWithUpdate(String value)	update the GUI display and the model.
void	setSwingViewValueWithUpdate(String value, GuiTaskClock contextClock)	update the GUI display and the model if the clock is newer than the current view-clock of the pane.
void	shutdownSwingView()	for each component, at the end of the process, this method will be called
void	update(GuiMappingContext cause, Object newValue, GuiTaskClock contextClock)
void	updateField(List<Object> events)	After editing text or action performed, this method will be executed under the scheduler thread
void	updateFieldInEvent(boolean modified, boolean immediate)	executed under event thread: start a new search task in background
void	updateFieldInEventWithoutEditFinish()
void	updateFromGui(Object v, GuiTaskClock viewClock)

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

add, addSearchItemsListener, convertIcon, createSearchTask, doActionButtons, getButtonsPane, getCurrentTask, getDynamicItemAction, getEditingRunner, getEditingRunnerDelay, getEmptyIcon, getField, getFocusColor, getIcon, getModel, getPopup, getPopupButton, getPopupUpdateListener, getSearchedItems, getSearchedItemsListeners, initAfter, initBackgroundPainter, initField, initIcon, initLayout, initLayoutButtons, initLayoutButtonsPane, initPopupCategorized, isSwingEditable, isUpdateFieldImmediateEvent, isUpdateFieldImmediateEvent, isUpdateFieldModifiedEvent, isUpdateFieldModifiedEvents, paintComponent, removeSearchItemsListener, selectSearchedItemFromGui, selectSearchedItemFromModel, setBackground, setBackgroundWithoutInit, setCurrentSearchedItems, setCurrentSearchedItems, setIconFromSearchedItem, setTextFromSearchedItem, setTextWithoutUpdateField, setToolTipText, setTransferHandlerWithSettingExportingDragSource, setupCopyAndPaste, shutdown

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, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

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, getActionByContext, getActionByName, getChildByName, getDescendantActionByContext, getDescendantByContext, getDescendantByValue, getDescendantByValueIf, getPrefsJsonSupported, getSwingFocusKeyStroke, isSwingEditable, loadSwingPreferences, loadSwingPreferences, refreshByContext, saveSwingPreferences, setPrefsJsonSupported, setSwingViewHistoryValue, setSwingViewValueForTable, updateSwingViewSource, updateSwingViewSourceFromRoot, wrapSwingNamed, wrapSwingPane, wrapSwingProperty, wrapSwingScrollPane

Field Details

context

protected GuiMappingContext context

specifierManager

protected GuiSwingView.SpecifierManager specifierManager

menuItems

protected List<PopupCategorized.CategorizedMenuItem> menuItems

infoLabel

protected MenuBuilder.MenuLabel infoLabel

viewClock

protected GuiTaskClock viewClock

currentValueSupported

protected boolean currentValueSupported

editFinishHandlers

protected List<Runnable> editFinishHandlers

Constructor Details

PropertyStringPane

public PropertyStringPane(GuiMappingContext context,
 GuiSwingView.SpecifierManager specifierManager)

Method Details

init

public void init()

Overrides:

init in class SearchTextField

initLazy

public void initLazy()

initPopup

public void initPopup()

Overrides:

initPopup in class SearchTextField

initName

public void initName()

initEditable

public void initEditable()

initContextUpdate

public void initContextUpdate()

initValue

public void initValue()

initDragDrop

public void initDragDrop()

updateField

public void updateField(List<Object> events)

Description copied from class: SearchTextField

After editing text or action performed, this method will be executed under the scheduler thread

Overrides:

updateField in class SearchTextField

Parameters:

events - the accumulated events

isSwingCurrentValueSupported

public boolean isSwingCurrentValueSupported()

Specified by:

isSwingCurrentValueSupported in interface GuiSwingView.ValuePane<String>

setCurrentValueSupported

public void setCurrentValueSupported(boolean currentValueSupported)

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

Returns:

a menu builder

getMenuItems

public Supplier<List<PopupCategorized.CategorizedMenuItem>> getMenuItems()

Overrides:

getMenuItems in class SearchTextField

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

Returns:

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

getMenuItemsSource

public List<Object> getMenuItemsSource()

Overrides:

getMenuItemsSource in class SearchTextField

Returns:

list of menu items including Action or JComponent

updateFieldInEvent

public void updateFieldInEvent(boolean modified,
 boolean immediate)

Description copied from class: SearchTextField

executed under event thread: start a new search task in background

Overrides:

updateFieldInEvent in class SearchTextField

Parameters:

modified - true if the field is actually edited

immediate - if true, a background task will not be created even if the model supports it

updateFieldInEventWithoutEditFinish

public void updateFieldInEventWithoutEditFinish()

updateFromGui

public void updateFromGui(Object v,
 GuiTaskClock viewClock)

update

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

Specified by:

update in interface GuiMappingContext.SourceUpdateListener

getSwingViewValue

public String getSwingViewValue()

Specified by:

getSwingViewValue in interface GuiSwingView.ValuePane<String>

Returns:

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

setSwingViewValue

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

Parameters:

value - the new value

setSwingViewValueWithUpdate

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

Parameters:

value - the new value

setSwingViewValue

public void setSwingViewValue(String value,
 GuiTaskClock contextClock)

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

Parameters:

value - the new value

contextClock - 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(String value,
 GuiTaskClock contextClock)

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

Parameters:

value - the new value

contextClock - the clock of the value

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

Parameters:

eventHandler - the handler called when the editing is finished

getSwingViewContext

public GuiMappingContext getSwingViewContext()

Specified by:

getSwingViewContext in interface GuiSwingView.ValuePane<String>

shutdownSwingView

public void shutdownSwingView()

Description copied from interface: GuiSwingView.ValuePane

for each component, at the end of the process, this method will be called

Specified by:

shutdownSwingView in interface GuiSwingView.ValuePane<String>

getSpecifier

public GuiReprValue.ObjectSpecifier getSpecifier()

Specified by:

getSpecifier in interface GuiSwingView.ValuePane<String>

Returns:

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

requestSwingViewFocus

public void requestSwingViewFocus()

Specified by:

requestSwingViewFocus in interface GuiSwingView.ValuePane<String>

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

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