Package ghidra.app.actions

Class AbstractFindReferencesDataTypeAction

java.lang.Object

docking.action.DockingAction

ghidra.app.actions.AbstractFindReferencesDataTypeAction

All Implemented Interfaces:

DockingActionIf, HelpDescriptor

public abstract class AbstractFindReferencesDataTypeAction
extends DockingAction

Field Summary

Fields

Modifier and Type	Field	Description
static javax.swing.KeyStroke	DEFAULT_KEY_STROKE
static java.lang.String	NAME

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

Modifier	Constructor	Description
protected	AbstractFindReferencesDataTypeAction(PluginTool tool, java.lang.String name, java.lang.String owner)
protected	AbstractFindReferencesDataTypeAction(PluginTool tool, java.lang.String name, java.lang.String owner, javax.swing.KeyStroke defaultKeyStroke)

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionContext context)	method to actually perform the action logic for this action.
protected abstract DataType	getDataType(ActionContext context)
protected java.lang.String	getDataTypeField()
boolean	isEnabledForContext(ActionContext context)	Method used to determine if this action should be enabled for the given context.

Methods inherited from class docking.action.DockingAction

addPropertyChangeListener, createButton, createMenuItem, dispose, doCreateButton, doCreateMenuItem, firePropertyChanged, getDefaultKeyBindingData, getDescription, getFullName, getHelpInfo, getHelpObject, getInceptionFromTheFirstClassThatIsNotUs, getInceptionInformation, getKeyBinding, getKeyBindingData, getKeyBindingType, getMenuBarData, getName, getOwner, getPopupMenuData, getPreferredKeyBindingType, getToolBarData, isAddToPopup, isEnabled, isValidContext, isValidGlobalContext, markHelpUnnecessary, removePropertyChangeListener, setDescription, setEnabled, setHelpLocation, setKeyBindingData, setMenuBarData, setPopupMenuData, setToolBarData, setUnvalidatedKeyBindingData, shouldAddToWindow, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface docking.action.DockingActionIf

getOwnerDescription

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

DEFAULT_KEY_STROKE

public static final javax.swing.KeyStroke DEFAULT_KEY_STROKE

Constructor Detail

AbstractFindReferencesDataTypeAction

protected AbstractFindReferencesDataTypeAction(PluginTool tool,
                                               java.lang.String name,
                                               java.lang.String owner)

AbstractFindReferencesDataTypeAction

protected AbstractFindReferencesDataTypeAction(PluginTool tool,
                                               java.lang.String name,
                                               java.lang.String owner,
                                               javax.swing.KeyStroke defaultKeyStroke)

Method Detail

getDataType

protected abstract DataType getDataType(ActionContext context)

getDataTypeField

protected java.lang.String getDataTypeField()

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:

1. when the user invokes the action via its keyBinding,
2. the user changes focus from one component provider to another,
3. the user moves a component to another position in the window or into another window,
4. a component provider reports a change in it's context,
5. 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

Overrides:

isEnabledForContext in class DockingAction

Parameters:

context - the current ActionContext for the window.

Returns:

true if the action should be enabled for the context or false otherwise.

actionPerformed

public 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

Specified by:

actionPerformed in class DockingAction

Parameters:

context - the ActionContext object that provides information about where and how this action was invoked.