Module org.autogui

Package org.autogui.swing

Class GuiSwingActionDefault.ExecutionAction

java.lang.Object

javax.swing.AbstractAction

org.autogui.swing.GuiSwingTaskRunner.ContextAction

org.autogui.swing.GuiSwingActionDefault.ExecutionAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action, GuiSwingKeyBinding.RecommendedKeyStroke, PopupCategorized.CategorizedMenuItem, PopupCategorized.CategorizedMenuItemAction, PopupCategorized.CategorizedMenuItemComponent

Direct Known Subclasses:

GuiSwingTableColumnSetDefault.TableSelectionListAction

Enclosing class:

GuiSwingActionDefault

public static class GuiSwingActionDefault.ExecutionAction
extends GuiSwingTaskRunner.ContextAction
implements PopupCategorized.CategorizedMenuItemAction, GuiSwingKeyBinding.RecommendedKeyStroke

a swing-action executing the action of the context. the icon will be automatically determined by the name of the context via GuiSwingIcons

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	confirmDescription	the message of the confirmation dialog showen when needToConfirm
protected boolean	needToConfirm	if true, the action shows a confirmation dialog before executing
protected Consumer<Object>	resultTarget
protected AtomicBoolean	running
protected GuiSwingView.SpecifierManager	targetSpecifier

Fields inherited from class org.autogui.swing.GuiSwingTaskRunner.ContextAction

taskRunner

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors

Constructor	Description
ExecutionAction(GuiMappingContext context, GuiSwingView.SpecifierManager targetSpecifier)

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent e)
void	actionPerformedWithoutCheckingRunning(ActionEvent e)
Object	executeAction(GuiReprValue.ObjectSpecifier specifier)
Object	executeAction(GuiReprValue.ObjectSpecifier specifier, ActionEvent e)
void	executeWithConfirm(ActionEvent e, Runnable action, Runnable cancelAction)	the void returning version of executeWithConfirmReturn(ActionEvent, Supplier, Supplier)
<RetType> RetType	executeWithConfirmReturn(ActionEvent e, Supplier<RetType> action, Supplier<RetType> cancelAction)	show a confirmation dialog and run the action if the user selects OK of the dialog
Icon	getActionPressedIcon()
Icon	getIcon()
String	getIconName()
GuiSwingKeyBinding.KeyPrecedenceSet	getRecommendedKeyPrecedence()
KeyStroke	getRecommendedKeyStroke()
protected void	initNeedToConfirmDefault()	set needToConfirm and confirmDescription from init-annotation attached to the action method
void	setResultTarget(Consumer<Object> resultTarget)

Methods inherited from class org.autogui.swing.GuiSwingTaskRunner.ContextAction

executeContextTask, executeContextTask, getContext

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.swing.Action

accept, addPropertyChangeListener, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from interface org.autogui.swing.util.PopupCategorized.CategorizedMenuItem

getKeyStroke, getSubCategory

Methods inherited from interface org.autogui.swing.util.PopupCategorized.CategorizedMenuItemAction

getMenuItem, getMenuItemWithAction, remap

Methods inherited from interface org.autogui.swing.util.PopupCategorized.CategorizedMenuItemComponent

getCategory, getName

Field Details

resultTarget

protected Consumer<Object> resultTarget

running

protected AtomicBoolean running

targetSpecifier

protected GuiSwingView.SpecifierManager targetSpecifier

needToConfirm

protected boolean needToConfirm

if true, the action shows a confirmation dialog before executing

Since:

1.8

confirmDescription

protected String confirmDescription

the message of the confirmation dialog showen when needToConfirm

Since:

1.8

Constructor Details

ExecutionAction

public ExecutionAction(GuiMappingContext context,
 GuiSwingView.SpecifierManager targetSpecifier)

Method Details

initNeedToConfirmDefault

protected void initNeedToConfirmDefault()

set needToConfirm and confirmDescription from init-annotation attached to the action method

Since:

1.8

setResultTarget

public void setResultTarget(Consumer<Object> resultTarget)

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

Overrides:

actionPerformed in class GuiSwingTaskRunner.ContextAction

actionPerformedWithoutCheckingRunning

public void actionPerformedWithoutCheckingRunning(ActionEvent e)

getIconName

public String getIconName()

executeWithConfirm

public void executeWithConfirm(ActionEvent e,
 Runnable action,
 Runnable cancelAction)

the void returning version of executeWithConfirmReturn(ActionEvent, Supplier, Supplier)

Parameters:

e - the action-event used for showing the confirmation dialog

action - the action code body; non-null

cancelAction - the action executed when the user selects canceling, or null

Since:

1.8

executeWithConfirmReturn

public <RetType> RetType executeWithConfirmReturn(ActionEvent e,
 Supplier<RetType> action,
 Supplier<RetType> cancelAction)

show a confirmation dialog and run the action if the user selects OK of the dialog

Type Parameters:

RetType - the returned type of the action

Parameters:

e - the action-event used for showing the confirmation dialog; obtaining the root-pane of a source component and used for the dialog parent

action - the action code body; non-null

cancelAction - the action when cancelled ; non-null

Returns:

the returned value of the action (or calcelAction)

Since:

1.8

executeAction

public Object executeAction(GuiReprValue.ObjectSpecifier specifier)

executeAction

public Object executeAction(GuiReprValue.ObjectSpecifier specifier,
 ActionEvent e)

Parameters:

specifier - a specifier for the target object

e - an optional action event

Since:

1.8

getIcon

public Icon getIcon()

Specified by:

getIcon in interface PopupCategorized.CategorizedMenuItem

Specified by:

getIcon in interface PopupCategorized.CategorizedMenuItemComponent

getActionPressedIcon

public Icon getActionPressedIcon()

getRecommendedKeyStroke

public KeyStroke getRecommendedKeyStroke()

Specified by:

getRecommendedKeyStroke in interface GuiSwingKeyBinding.RecommendedKeyStroke

getRecommendedKeyPrecedence

public GuiSwingKeyBinding.KeyPrecedenceSet getRecommendedKeyPrecedence()

Specified by:

getRecommendedKeyPrecedence in interface GuiSwingKeyBinding.RecommendedKeyStroke