All Superinterfaces:

Action, ActionListener, CleanUpHandler, EventListener

All Known Subinterfaces:

BaseActionWithGroup, FlowEditorAction, PropertiesAction<T>, SpreadSheetViewerAction, TreePopupAction, TreeQuickAction

All Known Implementing Classes:

AbstractActionWithDialog, AbstractAddBreakpointAction, AbstractAddMostCommonActorAction, AbstractBaseAction, AbstractBaseActionWithGroup, AbstractCompareActors, AbstractEditableDataTableAction, AbstractEncloseActor, AbstractFileCommanderAction, AbstractFindInFilesAction, AbstractFlowEditorCheckBoxMenuItemAction, AbstractFlowEditorMenuItemAction, AbstractFlowEditorSubMenuAction, AbstractFromTemplateAction, AbstractGOEQuickAction, AbstractLocalFilesAction, AbstractNotificationAreaAction, AbstractPDFViewerAction, AbstractPixelSelectorAction, AbstractPropertiesAction, AbstractPropertiesCheckBoxMenuItemAction, AbstractPropertiesMenuItemAction, AbstractPropertiesSubMenuAction, AbstractSelectedAttributesAction, AbstractSource, AbstractSpreadSheetViewerCheckBoxMenuItemAction, AbstractSpreadSheetViewerMenuItemAction, AbstractSpreadSheetViewerSubMenuAction, AbstractTableAction, AbstractTableActionWithDatabaseAccess, AbstractTableActionWithDataContainerPanel, AbstractTreePopupMenuItemAction, AbstractTreePopupSubMenuAction, AbstractTreeQuickMenuItemAction, Actions, ActiveClearGraphicalOutput, ActiveDebug, ActiveDisplayErrors, ActiveGC, ActiveHeadless, ActiveKill, ActivePauseResume, ActiveRun, ActiveStop, ActiveStorage, ActiveValidateSetup, ActiveVariables, AddActor, AddActorAfter, AddActorBeneath, AddActorHere, AddBookmark, AddBreakpoint, AddBreakpointAfter, AddBreakpointBeneath, AddBreakpointHere, AddClassification, AddField, AddFromTemplate, AddFromTemplateAfter, AddFromTemplateBeneath, AddFromTemplateHere, AddMostCommonActor, AddMostCommonActorAfter, AddMostCommonActorBeneath, AddMostCommonActorHere, AnnotateActor, Append, AttachBreakpointHere, AttachListener, Bookmark, BottomRightCorner, Bzip2, ChangeCallableActor, ChangeExternalActorFile, ChangeStorageName, ChangeVariableName, ChangeVariableValue, CleanUpActorName, Clipboard, CloseAndCleanUp, CollapseAll, CompareActors, CompareJustActors, CompareSubFlows, Compatibility, ConvertToDate, ConvertToNominal, ConvertToString, Copy, Copy, CopyActor, CopyActorCommandline, CopyActorMore, CopyActorName, CopyActorPath, CopyActorPlainText, CopyDir, CopyFieldName, CopyFieldValue, CopyFileTo, CopyFullPath, CopyName, CopyTo, CreateCallableActor, CutActor, Database, DatabaseAddField, DatabaseModifyValue, DatabaseRemoveField, DataChart, DataComputeDifference, DataConvert, DataFilterColumns, DataFilterRows, DataGenerator, DataSort, DataTransform, DeleteFiles, DeleteStar, EditActor, EditBooleanCondition, EditBooleanExpressionText, EditCheckVariables, EditCleanUpFlow, EditClearClipboard, EditClearClipboard, EditCombineXExpression, EditConversion, EditDiff, EditEnableUndo, EditExternalFlow, EditFind, EditIgnoreNameChanges, EditInteractiveActors, EditListeners, EditListTODOs, EditLocateActor, EditLocateStorageName, EditLocateVariable, EditMathematicalExpressionText, EditPasteAsNew, EditProcessActors, EditRedo, EditStorageValuesArrayNames, EditStringConstantsStrings, EditTimedActors, EditUndo, EditVariablesArrayVariables, EditWekaASEvaluator, EditWekaASSearch, EditWekaClassifier, EditWekaClusterer, EditWekaDataGenerator, EditWekaFilter, EditWekaStreamableFilter, EncloseActor, EncloseActorAll, EncloseActorCommon, EncloseActorCompact, EncloseActorSpecial, ExcludedFlag, ExpandAll, ExpandCollapseExternalFlow, ExportActor, ExternalFlow, ExternalizeActor, FileCheckOnSave, FileClose, FileClosePage, FileClosePage, FileExit, FileExport, FileGarbageCollectionOnClose, FileImport, FileNewFlow, FileNewFromClipboard, FileOpen, FileOpen, FileProperties, FileRevert, FileSave, FileSave, FileSaveAs, FileSaveAs, FindUsages, GoTo, Gzip, Help, HelpActors, HelpBooleanExpression, HelpClasses, HelpFormulas, HelpMathematicalExpression, HelpQuery, HelpStringExpression, HelpVariables, InspectMemory, InspectMemoryDetails, InspectMemorySize, LastTemplate, Listeners, Lzf, Lzma, MakeConditional, MakeInteractive, MakeTimed, MaterializeExternalActor, MenuHeader, Merge, ModifyValue, MoveTo, OpenFile, PasteActor, PasteActorAfter, PasteActorBeneath, PasteActorHere, Print, PrintFile, PrintReport, PullUpActor, Randomize, RandomSubset, Remove, RemoveActor, RemoveBookmark, RemoveBreakpoints, RemoveField, RemoveListeners, RemoveTestSet, Rename, Rename, RenameActor, RenameActor, ReorderAttributes, Revert, RunClearGraphicalOutput, RunDebug, RunDisableAllBreakpoints, RunDisplayErrors, RunEnableAllBreakpoints, RunGC, RunHeadless, RunKill, RunParseError, RunPauseResume, RunRemoveAllBreakpoints, RunRun, RunRunAll, RunStop, RunStopAll, RunStorage, RunToHere, RunValidateSetup, RunVariables, Save, Save, SaveIndexedSplitsRuns, SaveReport, SendErrorReport, Separator, Separator, SimpleSelect, Split, SpreadSheet, SwapActor, Tar, TextDirectory, ToggleAction, ToggleState, ToolExtractImages, ToolExtractPages, ToolExtractText, TopLeftCorner, UseAsClass, View, ViewApplyToAll, ViewCellRenderingCustomizer, ViewDecimals, ViewFullExpansion, ViewOptimalColumnWidth, ViewRedraw, ViewSetColumnWidth, ViewShowAnnotations, ViewShowCellTypes, ViewShowFormulas, ViewShowInputOutput, ViewShowQuickInfo, ViewShowSource, ViewShowToolbar, ViewStatistics, ViewValue, ViewZoom, WindowDuplicateInTab, WindowDuplicateInWindow, WindowHalfHeight, WindowHalfWidth, WindowMoveToNewWindow, WindowNew, Xz, Zip, Zstd
```
public interface BaseAction
extends Action, CleanUpHandler
```
Extended interface for actions.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Field Summary
- 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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`cleanUp()`	Cleans up data structures, frees up memory.
`KeyStroke`	`getAccelerator()`	Returns the accelerator (KeyStroke) in use for the action.
`Icon`	`getIcon()`	Returns the icon the action (stored under SMALL_ICON).
`Integer`	`getMnemonic()`	Returns the mnemonic in use for the action.
`String`	`getName()`	Returns the name of the action, i.e., the menuitem/button caption.
`String`	`getToolTipText()`	Returns the TipText in use for the action.
`boolean`	`hasAccelerator()`	Checks whether a keystroke is available for this action.
`boolean`	`hasMnemonic()`	Checks whether a mnemonic is available for this action.
`boolean`	`hasToolTipText()`	Checks whether a tip text is available for this action.
`boolean`	`isAsynchronous()`	Returns whether to launch the menu item asynchronously using a swingworker.
`boolean`	`isSelected()`	Returns the name of the action, i.e., the menuitem/button caption.
`void`	`setAccelerator(String value)`	Sets the accelerator (KeyStroke) to use for the action.
`void`	`setAsynchronous(boolean value)`	Sets whether to launch the menu item asynchronously using a swingworker.
`void`	`setIcon(String name)`	Sets the icon of the action, i.e., the menuitem/button icon.
`void`	`setIcon(Icon value)`	Sets the icon of the action, i.e., the menuitem/button icon.
`void`	`setMnemonic(int value)`	Sets the mnemonic to use for the action.
`void`	`setName(String value)`	Sets the name of the action, i.e., the menuitem/button caption.
`void`	`setSelected(boolean value)`	Sets the name of the action, i.e., the menuitem/button caption.
`void`	`setToolTipText(String value)`	Sets the TipText to use for the action, i.e., button.

Methods inherited from interface javax.swing.Action
accept, addPropertyChangeListener, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from interface java.awt.event.ActionListener
actionPerformed

- Method Detail
  - setName
```
void setName(String value)
```
    Sets the name of the action, i.e., the menuitem/button caption.
    
    Parameters:
    
    value - the name
  - getName
```
String getName()
```
    Returns the name of the action, i.e., the menuitem/button caption.
    
    Returns:
    
    the name
  - setIcon
```
void setIcon(String name)
```
    Sets the icon of the action, i.e., the menuitem/button icon.
    
    Parameters:
    
    name - the icon
    
    See Also:
    
    setIcon(Icon), ImageManager.getIcon(String)
  - setIcon
```
void setIcon(Icon value)
```
    Sets the icon of the action, i.e., the menuitem/button icon. Sets SMALL_ICON and LARGE_ICON_KEY at the same time.
    
    Parameters:
    
    value - the icon
  - getIcon
```
Icon getIcon()
```
    Returns the icon the action (stored under SMALL_ICON).
    
    Returns:
    
    the icon
  - setSelected
```
void setSelected(boolean value)
```
    Sets the name of the action, i.e., the menuitem/button caption.
    
    Parameters:
    
    value - the name
  - isSelected
```
boolean isSelected()
```
    Returns the name of the action, i.e., the menuitem/button caption.
    
    Returns:
    
    the name
  - setMnemonic
```
void setMnemonic(int value)
```
    Sets the mnemonic to use for the action.
    
    Parameters:
    
    value - the mnemonic, e.g., KeyEvent.VK_O
    
    See Also:
    
    KeyEvent
  - hasMnemonic
```
boolean hasMnemonic()
```
    Checks whether a mnemonic is available for this action.
    
    Returns:
    
    true if a mnemonic is available
  - getMnemonic
```
Integer getMnemonic()
```
    Returns the mnemonic in use for the action.
    
    Returns:
    
    the mnemonic if available (e.g., KeyEvent.VK_O), otherwise null
    
    See Also:
    
    hasMnemonic()
  - setAccelerator
```
void setAccelerator(String value)
```
    Sets the accelerator (KeyStroke) to use for the action.
    
    Parameters:
    
    value - the keystroke, e.g., "ctrl pressed O"
    
    See Also:
    
    KeyStroke.getKeyStroke(String)
  - hasAccelerator
```
boolean hasAccelerator()
```
    Checks whether a keystroke is available for this action.
    
    Returns:
    
    true if a keystroke is available
  - getAccelerator
```
KeyStroke getAccelerator()
```
    Returns the accelerator (KeyStroke) in use for the action.
    
    Returns:
    
    the keystroke if available, otherwise null
    
    See Also:
    
    hasAccelerator()
  - setToolTipText
```
void setToolTipText(String value)
```
    Sets the TipText to use for the action, i.e., button.
    
    Parameters:
    
    value - the tip text
  - hasToolTipText
```
boolean hasToolTipText()
```
    Checks whether a tip text is available for this action.
    
    Returns:
    
    true if a tip text is available
  - getToolTipText
```
String getToolTipText()
```
    Returns the TipText in use for the action.
    
    Returns:
    
    the tip text if available, otherwise null
    
    See Also:
    
    hasToolTipText()
  - setAsynchronous
```
void setAsynchronous(boolean value)
```
    Sets whether to launch the menu item asynchronously using a swingworker.
    
    Parameters:
    
    value - true if asynchronous
  - isAsynchronous
```
boolean isAsynchronous()
```
    Returns whether to launch the menu item asynchronously using a swingworker.
    
    Returns:
    
    true if asynchronous
  - cleanUp
```
void cleanUp()
```
    Cleans up data structures, frees up memory.
    
    Specified by:
    
    cleanUp in interface CleanUpHandler

Interface BaseAction

Field Summary

Fields inherited from interface javax.swing.Action

Method Summary

Methods inherited from interface javax.swing.Action

Methods inherited from interface java.awt.event.ActionListener

Method Detail

setName

getName

setIcon

setIcon

getIcon

setSelected

isSelected

setMnemonic

hasMnemonic

getMnemonic

setAccelerator

hasAccelerator

getAccelerator

setToolTipText

hasToolTipText

getToolTipText

setAsynchronous

isAsynchronous

cleanUp