java.lang.Object
- docking.action.DockingAction

All Implemented Interfaces:

DockingActionIf, HelpDescriptor

Direct Known Subclasses:

ghidra.app.plugin.core.functioncompare.AbstractApplyFunctionSignatureAction, AbstractSharedKeybindingAction, AddAllFieldAction, AddFieldAction, AddSpacerFieldAction, DisableFieldAction, DomainFileProviderContextAction, DummyKeyBindingsOptionsAction, EnableFieldAction, FSBAction, HelpAction, HorizontalRuleAction, InsertRowAction, KeyBindingAction, ListingContextAction, MultiActionDockingAction, MultiStateDockingAction, NavigatableContextAction, ProgramContextAction, ProgramLocationContextAction, ProgramSymbolContextAction, ProjectDataContextAction, ProjectDataTreeContextAction, RemoveAllFieldsAction, RemoveFieldAction, RemoveRowAction, ResetAllFormatsAction, ResetFormatAction, ResetTranslationAction, SaveImageAction, SetSpacerTextAction, ShowAllComponentsAction, ShowFocusCycleAction, ShowFocusInfoAction, ToggleDockingAction, ZoomInAction, ZoomOutAction, ZoomResetAction
```
public abstract class DockingAction
extends java.lang.Object
implements DockingActionIf
```
DockingAction defines a user action associated with a toolbar icon and/or menu item. All actions must specify an action name which will be used to associate key bindings and will be used as the popup menu item when needed. This name should be unique across the entire application.
DockingActions can be invoked from the global menu, a popup menu, a toolbar, and/or a keybinding, depending on whether or not menuBarData, popupMenuData, toolBarData, and/or keyBindingData have been set.
Implementors of this class should override actionPerformed(ActionContext).
Generally, implementors should also override isEnabledForContext(ActionContext). This method is used to determine if an action if applicable to the current context. Overriding this method allows actions to manage their own enablement. Otherwise, the default behavior for this method is to return the current enabled property of the action. This allows for the possibility for plugins to manage the enablement of its actions.
By default, actions that are not enabledForContext do not appear in the popup menu. To change that behavior, implementors can also override #deleteThisContextMethod(ActionContext). This method is used to determine if the action should appear on the popup menu based on the given context.

Field Summary
- Fields inherited from interface docking.action.DockingActionIf
  DESCRIPTION_PROPERTY, ENABLEMENT_PROPERTY, GLOBALCONTEXT_PROPERTY, KEYBINDING_DATA_PROPERTY, MENUBAR_DATA_PROPERTY, POPUP_MENU_DATA_PROPERTY, TOOLBAR_DATA_PROPERTY

Constructor Summary

Constructors
Constructor	Description
`DockingAction(java.lang.String name, java.lang.String owner)`
`DockingAction(java.lang.String name, java.lang.String owner, boolean isKeyBindingManaged)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract void`	`actionPerformed(ActionContext context)`	method to actually perform the action logic for this action.
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener listener)`	Adds a listener to be notified if any property changes.
`javax.swing.JButton`	`createButton()`	Returns a JButton that is suitable for this action.
`javax.swing.JMenuItem`	`createMenuItem(boolean isPopup)`	Returns a JMenuItem that is suitable for this action.
`void`	`dispose()`	Cleans up any resources used by the action.
`protected javax.swing.JButton`	`doCreateButton()`
`protected javax.swing.JMenuItem`	`doCreateMenuItem()`
`void`	`firePropertyChanged(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)`
`KeyBindingData`	`getDefaultKeyBindingData()`	Returns the default `KeyBindingData` to be used to assign this action to a key binding.
`java.lang.String`	`getDescription()`	Returns a short description of this action.
`java.lang.String`	`getFullName()`	Returns the full name (the action name combined with the owner name)
`java.lang.String`	`getHelpInfo()`	Returns a descriptive String about the help object that this descriptor represents.
`java.lang.Object`	`getHelpObject()`	Returns the object for which help locations are defined.
`java.lang.String`	`getInceptionInformation()`	Returns a string that includes source file and line number information of where this action was created.
`javax.swing.KeyStroke`	`getKeyBinding()`	Convenience method for getting the keybinding for this action.
`KeyBindingData`	`getKeyBindingData()`	Returns the `KeyBindingData` to be used to assign this action to a key binding.
`MenuData`	`getMenuBarData()`	Returns the `MenuData` to be used to put this action in the menu bar.
`java.lang.String`	`getName()`	Returns the name of the action.
`java.lang.String`	`getOwner()`	Returns the owner of this action.
`MenuData`	`getPopupMenuData()`	Returns the `MenuData` to be used to put this action in a popup menu.
`ToolBarData`	`getToolBarData()`	Returns the `ToolBarData` to be used to put this action in a toolbar.
`boolean`	`isAddToPopup(ActionContext context)`	method is used to determine if this action should be displayed on the current popup.
`boolean`	`isEnabled()`	Returns true if the action is enabled.
`boolean`	`isEnabledForContext(ActionContext context)`	Method used to determine if this action should be enabled for the given context.
`boolean`	`isKeyBindingManaged()`	Returns true if this action can have its keybinding information changed by the user.
`boolean`	`isValidContext(ActionContext context)`	Method that actions implement to indicate if this action is valid (knows how to work with, is appropriate for) for the given context.
`boolean`	`isValidGlobalContext(ActionContext globalContext)`	Method that actions implement to indicate if this action is valid (knows how to work with, is appropriate for) for the given global context.
`void`	`markHelpUnnecessary()`	Signals the the help system that this action does not need a help entry.
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)`	Removes a listener to be notified of property changes.
`void`	`setDescription(java.lang.String newDescription)`	Sets the description to be used in the tooltip.
`boolean`	`setEnabled(boolean newValue)`	Enables or disables the action.
`void`	`setHelpLocation(HelpLocation location)`	Set a specific Help location for this action.
`void`	`setKeyBindingData(KeyBindingData newKeyBindingData)`	Sets the `#KeyBindingData` to be used to assign this action to a keybinding.
`void`	`setMenuBarData(MenuData newMenuData)`	Sets the `#MenuData` to be used to put this action on the tool's menu bar.
`void`	`setPopupMenuData(MenuData newMenuData)`	Sets the `#MenuData` to be used to put this action in the tool's popup menu.
`void`	`setToolBarData(ToolBarData newToolBarData)`	Sets the `#ToolBarData` to be used to put this action on the tool's toolbar.
`void`	`setUnvalidatedKeyBindingData(KeyBindingData newKeyBindingData)`	Users creating actions should not call this method, but should instead call `setKeyBindingData(KeyBindingData)`.
`boolean`	`shouldAddToWindow(boolean isMainWindow, java.util.Set<java.lang.Class<?>> contextTypes)`	Default behavior is to add to main window;
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DockingAction
```
public DockingAction(java.lang.String name,
                     java.lang.String owner)
```
  - DockingAction
```
public DockingAction(java.lang.String name,
                     java.lang.String owner,
                     boolean isKeyBindingManaged)
```
- Method Detail
  - actionPerformed
```
public abstract void actionPerformed(ActionContext context)
```
    Description copied from interface: DockingActionIf
    
    method to actually perform the action logic for this action.
    
    Specified by:
    
    actionPerformed in interface DockingActionIf
    
    Parameters:
    
    context - the ActionContext object that provides information about where and how this action was invoked.
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Description copied from interface: DockingActionIf
    
    Adds a listener to be notified if any property changes.
    
    Specified by:
    
    addPropertyChangeListener in interface DockingActionIf
    
    Parameters:
    
    listener - The property change listener that will be notified of property change events.
    
    See Also:
    
    AbstractAction.addPropertyChangeListener(java.beans.PropertyChangeListener)
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
```
    Description copied from interface: DockingActionIf
    
    Removes a listener to be notified of property changes.
    
    Specified by:
    
    removePropertyChangeListener in interface DockingActionIf
    
    Parameters:
    
    listener - The property change listener that will be notified of property change events.
    
    See Also:
    
    DockingActionIf.addPropertyChangeListener(PropertyChangeListener), AbstractAction.addPropertyChangeListener(java.beans.PropertyChangeListener)
  - isKeyBindingManaged
```
public boolean isKeyBindingManaged()
```
    Description copied from interface: DockingActionIf
    
    Returns true if this action can have its keybinding information changed by the user.
    
    Specified by:
    
    isKeyBindingManaged in interface DockingActionIf
    
    Returns:
    
    true if this action can have its keybinding information changed by the user.
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: DockingActionIf
    
    Returns a short description of this action. Generally used for a tooltip.
    
    Specified by:
    
    getDescription in interface DockingActionIf
  - getFullName
```
public java.lang.String getFullName()
```
    Description copied from interface: DockingActionIf
    
    Returns the full name (the action name combined with the owner name)
    
    Specified by:
    
    getFullName in interface DockingActionIf
  - getKeyBindingData
```
public KeyBindingData getKeyBindingData()
```
    Description copied from interface: DockingActionIf
    
    Returns the KeyBindingData to be used to assign this action to a key binding. The KeyBindingData will be null if the action is not set to have a keyBinding.
    
    Specified by:
    
    getKeyBindingData in interface DockingActionIf
    
    Returns:
    
    the KeyBindingData for the action or null if the action does not have a keyBinding.
  - getDefaultKeyBindingData
```
public KeyBindingData getDefaultKeyBindingData()
```
    Description copied from interface: DockingActionIf
    
    Returns the default KeyBindingData to be used to assign this action to a key binding. The KeyBindingData will be null if the action is not set to have a keyBinding.
    
    Specified by:
    
    getDefaultKeyBindingData in interface DockingActionIf
    
    Returns:
    
    the KeyBindingData for the action or null if the action does not have a keyBinding.
  - getKeyBinding
```
public javax.swing.KeyStroke getKeyBinding()
```
    Description copied from interface: DockingActionIf
    
    Convenience method for getting the keybinding for this action.
    
    Specified by:
    
    getKeyBinding in interface DockingActionIf
    
    Returns:
    
    the KeyStroke to be used as a keybinding for this action or null if there is no
  - getMenuBarData
```
public MenuData getMenuBarData()
```
    Description copied from interface: DockingActionIf
    
    Returns the MenuData to be used to put this action in the menu bar. The MenuData will be null if the action in not set to be in the menu bar.
    
    Specified by:
    
    getMenuBarData in interface DockingActionIf
    
    Returns:
    
    the MenuData for the menu bar or null if the action is not in the menu bar.
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: DockingActionIf
    
    Returns the name of the action.
    
    Specified by:
    
    getName in interface DockingActionIf
  - getOwner
```
public java.lang.String getOwner()
```
    Description copied from interface: DockingActionIf
    
    Returns the owner of this action.
    
    Specified by:
    
    getOwner in interface DockingActionIf
  - getPopupMenuData
```
public MenuData getPopupMenuData()
```
    Description copied from interface: DockingActionIf
    
    Returns the MenuData to be used to put this action in a popup menu. The MenuData will be null if the action in not set to be in a popup menu.
    
    Specified by:
    
    getPopupMenuData in interface DockingActionIf
    
    Returns:
    
    the MenuData for a popup menu or null if the action is not to be in a popup menu.
  - getToolBarData
```
public ToolBarData getToolBarData()
```
    Description copied from interface: DockingActionIf
    
    Returns the ToolBarData to be used to put this action in a toolbar. The ToolBarData will be null if the action in not set to be in a tool bar.
    
    Specified by:
    
    getToolBarData in interface DockingActionIf
    
    Returns:
    
    the ToolBarData for the popup menu or null if the action is not in a popup menu.
  - getInceptionInformation
```
public java.lang.String getInceptionInformation()
```
    Description copied from interface: DockingActionIf
    
    Returns a string that includes source file and line number information of where this action was created.
    
    Specified by:
    
    getInceptionInformation in interface DockingActionIf
  - isEnabled
```
public boolean isEnabled()
```
    Description copied from interface: DockingActionIf
    
    Returns true if the action is enabled.
    
    Specified by:
    
    isEnabled in interface DockingActionIf
    
    Returns:
    
    true if the action is enabled, false otherwise
  - isAddToPopup
```
public boolean isAddToPopup(ActionContext context)
```
    Description copied from interface: DockingActionIf
    
    method is used to determine if this action should be displayed on the current popup. This method will only be called if the action has popup PopupMenuData set.
    Generally, actions don't need to override this method as the default implementation will defer to the #isEnabledForContext(), which will have the effect of adding the action to the popup only if it is enabled for a given context. By overriding this method, you can change this behavior so that the action will be added to the popup, even if it is disabled for the context, by having this method return true even if the #isEnabledForContext() method will return false, resulting in the action appearing in the popup menu, but begin disabled.
    
    Specified by:
    
    isAddToPopup in interface DockingActionIf
    
    Parameters:
    
    context - the ActionContext from the active provider.
    
    Returns:
    
    true if this action is appropriate for the given context.
  - isEnabledForContext
```
public boolean isEnabledForContext(ActionContext context)
```
    Description copied from interface: DockingActionIf
    Method used to determine if this action should be enabled for the given context.
    This is the method implementors override to control when the action may be used.
    This method will be called by the DockingWindowManager for actions on the global menuBar and toolBar and for actions that have a keyBinding.
    This method will be called whenever one of the following events occur:
    
    when the user invokes the action via its keyBinding,
    
    the user changes focus from one component provider to another,
    
    the user moves a component to another position in the window or into another window,
    
    a component provider reports a change in it's context,
    
    any plugin or software component reports a general change in context (calls the tool.contextChanged(ComponentProvider) with a null parameter).
    
    The default implementation will simply return this action's enablement state.
    Specified by:
    
    isEnabledForContext in interface DockingActionIf
    
    Parameters:
    
    context - the current ActionContext for the window.
    
    Returns:
    
    true if the action should be enabled for the context or false otherwise.
  - isValidContext
```
public boolean isValidContext(ActionContext context)
```
    Description copied from interface: DockingActionIf
    
    Method that actions implement to indicate if this action is valid (knows how to work with, is appropriate for) for the given context. This method is used to determine if the action should be enabled based on the either the local context or the global context. The action is first asked if it is valid for the local context and if not, then it is asked if it is valid for the global context. If a context is valid, then it will then be asked if it is enabled for that context.
    
    Specified by:
    
    isValidContext in interface DockingActionIf
    
    Parameters:
    
    context - the ActionContext from the active provider.
    
    Returns:
    
    true if this action is appropriate for the given context.
  - isValidGlobalContext
```
public boolean isValidGlobalContext(ActionContext globalContext)
```
    Description copied from interface: DockingActionIf
    
    Method that actions implement to indicate if this action is valid (knows how to work with, is appropriate for) for the given global context. This method is just like the isValidContext and in fact calls that method by default. Many actions will work with either the active provider context or the global (the main listing) context if the local context is not valid. If you want a global action to only work on the global context, then override this method and return false.
    
    Specified by:
    
    isValidGlobalContext in interface DockingActionIf
    
    Returns:
    
    true if this action is appropriate for the given context.
  - shouldAddToWindow
```
public boolean shouldAddToWindow(boolean isMainWindow,
                                 java.util.Set<java.lang.Class<?>> contextTypes)
```
    Default behavior is to add to main window;
    
    Specified by:
    
    shouldAddToWindow in interface DockingActionIf
    
    Parameters:
    
    isMainWindow - true if the window in question is the main window. Otherwise, the window is a secondary window.
    
    contextTypes - a list of contextTypes (Classes) based on the providers that are currently in the window.
    
    Returns:
    
    true if this action should be added to the window, false otherwise.
  - setHelpLocation
```
public void setHelpLocation(HelpLocation location)
```
    Set a specific Help location for this action. This will replace the default help location
    
    Parameters:
    
    location - the help location for the action.
  - markHelpUnnecessary
```
public void markHelpUnnecessary()
```
    Signals the the help system that this action does not need a help entry. Some actions are so obvious that they do not require help, such as an action that renames a file.
    The method should be sparsely used, as most actions should provide help.
  - setEnabled
```
public boolean setEnabled(boolean newValue)
```
    Description copied from interface: DockingActionIf
    
    Enables or disables the action.
    
    Specified by:
    
    setEnabled in interface DockingActionIf
    
    Parameters:
    
    newValue - true to enable the action, false to disable it
  - createButton
```
public final javax.swing.JButton createButton()
```
    Description copied from interface: DockingActionIf
    
    Returns a JButton that is suitable for this action. For example, It creates a ToggleButton if the action is a ToggleDockingActionIf.
    
    Specified by:
    
    createButton in interface DockingActionIf
    
    Returns:
    
    a JButton to be used in a toolbar or null if the action does not have ToolBarData set.
  - createMenuItem
```
public javax.swing.JMenuItem createMenuItem(boolean isPopup)
```
    Description copied from interface: DockingActionIf
    
    Returns a JMenuItem that is suitable for this action. For example, if the action is a ToggleDockingActionIf, then a JCheckBoxMenuItem will be created.
    
    Specified by:
    
    createMenuItem in interface DockingActionIf
    
    Parameters:
    
    isPopup - true if the action should use its Popup MenuData, else it uses the MenuBar MenuData.
    
    Returns:
    
    a JMenuItem for placement in either the menu bar or a popup menu.
  - setMenuBarData
```
public void setMenuBarData(MenuData newMenuData)
```
    Sets the #MenuData to be used to put this action on the tool's menu bar.
    
    Parameters:
    
    newMenuData - the MenuData to be used to put this action on the tool's menu bar.
  - setPopupMenuData
```
public void setPopupMenuData(MenuData newMenuData)
```
    Sets the #MenuData to be used to put this action in the tool's popup menu.
    
    Parameters:
    
    newMenuData - the MenuData to be used to put this action on the tool's popup menu.
  - setToolBarData
```
public void setToolBarData(ToolBarData newToolBarData)
```
    Sets the #ToolBarData to be used to put this action on the tool's toolbar.
    
    Parameters:
    
    newToolBarData - the ToolBarData to be used to put this action on the tool's toolbar.
  - setKeyBindingData
```
public void setKeyBindingData(KeyBindingData newKeyBindingData)
```
    Sets the #KeyBindingData to be used to assign this action to a keybinding.
    
    Specified by:
    
    setKeyBindingData in interface DockingActionIf
    
    Parameters:
    
    newKeyBindingData - the KeyBindingData to be used to assign this action to a keybinding.
  - setUnvalidatedKeyBindingData
```
public void setUnvalidatedKeyBindingData(KeyBindingData newKeyBindingData)
```
    Users creating actions should not call this method, but should instead call setKeyBindingData(KeyBindingData).
    
    Specified by:
    
    setUnvalidatedKeyBindingData in interface DockingActionIf
    
    Parameters:
    
    newKeyBindingData - the KeyBindingData to be used to assign this action to a keybinding.
    
    validate - true signals that this method should convert keybindings to their OS-dependent form (for example, on Mac a Ctrl key is changed to the Command key).
  - setDescription
```
public void setDescription(java.lang.String newDescription)
```
    Sets the description to be used in the tooltip.
    
    Parameters:
    
    description - the description to be set.
  - dispose
```
public void dispose()
```
    Cleans up any resources used by the action.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getHelpInfo
```
public java.lang.String getHelpInfo()
```
    Description copied from interface: HelpDescriptor
    
    Returns a descriptive String about the help object that this descriptor represents.
    
    Specified by:
    
    getHelpInfo in interface HelpDescriptor
  - firePropertyChanged
```
public void firePropertyChanged(java.lang.String propertyName,
                                java.lang.Object oldValue,
                                java.lang.Object newValue)
```
  - getHelpObject
```
public java.lang.Object getHelpObject()
```
    Description copied from interface: HelpDescriptor
    
    Returns the object for which help locations are defined. This may be the implementor of this interface or some other delegate object.
    
    Specified by:
    
    getHelpObject in interface HelpDescriptor
  - doCreateButton
```
protected javax.swing.JButton doCreateButton()
```
  - doCreateMenuItem
```
protected javax.swing.JMenuItem doCreateMenuItem()
```

Class DockingAction

Field Summary

Fields inherited from interface docking.action.DockingActionIf

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DockingAction

DockingAction

Method Detail

actionPerformed

addPropertyChangeListener

removePropertyChangeListener

isKeyBindingManaged

getDescription

getFullName

getKeyBindingData

getDefaultKeyBindingData

getKeyBinding

getMenuBarData

getName

getOwner

getPopupMenuData

getToolBarData

getInceptionInformation

isEnabled

isAddToPopup

isEnabledForContext

isValidContext

isValidGlobalContext

shouldAddToWindow

setHelpLocation

markHelpUnnecessary

setEnabled

createButton

createMenuItem

setMenuBarData

setPopupMenuData

setToolBarData

setKeyBindingData

setUnvalidatedKeyBindingData

setDescription

dispose

toString

getHelpInfo

firePropertyChanged

getHelpObject

doCreateButton

doCreateMenuItem