Class ProgramContextAction
- java.lang.Object
-
- docking.action.DockingAction
-
- ghidra.app.context.ProgramContextAction
-
- All Implemented Interfaces:
DockingActionIf,HelpDescriptor
public abstract class ProgramContextAction extends DockingAction
-
-
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 ProgramContextAction(java.lang.String name, java.lang.String owner)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description voidactionPerformed(ActionContext context)method to actually perform the action logic for this action.protected abstract voidactionPerformed(ProgramActionContext programContext)protected voidactionPerformed(ProgramActionContext programContext, ActionContext actionContext)booleanisAddToPopup(ActionContext context)method is used to determine if this action should be displayed on the current popup.protected booleanisAddToPopup(ProgramActionContext context)booleanisEnabledForContext(ActionContext actionContext)Method used to determine if this action should be enabled for the given context.protected booleanisEnabledForContext(ProgramActionContext context)booleanisValidContext(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.protected booleanisValidContext(ProgramActionContext context)booleanshouldAddToWindow(boolean isMainWindow, java.util.Set<java.lang.Class<?>> contextTypes)Default behavior is to add to main window;-
Methods inherited from class docking.action.DockingAction
addPropertyChangeListener, createButton, createMenuItem, dispose, doCreateButton, doCreateMenuItem, firePropertyChanged, getDefaultKeyBindingData, getDescription, getFullName, getHelpInfo, getHelpObject, getInceptionInformation, getKeyBinding, getKeyBindingData, getMenuBarData, getName, getOwner, getPopupMenuData, getToolBarData, isEnabled, isKeyBindingManaged, isValidGlobalContext, markHelpUnnecessary, removePropertyChangeListener, setDescription, setEnabled, setHelpLocation, setKeyBindingData, setMenuBarData, setPopupMenuData, setToolBarData, setUnvalidatedKeyBindingData, toString
-
-
-
-
Method Detail
-
isEnabledForContext
public boolean isEnabledForContext(ActionContext actionContext)
Description copied from interface:DockingActionIfMethod 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).
- Specified by:
isEnabledForContextin interfaceDockingActionIf- Overrides:
isEnabledForContextin classDockingAction- Parameters:
actionContext- the currentActionContextfor the window.- Returns:
- true if the action should be enabled for the context or false otherwise.
-
actionPerformed
public final void actionPerformed(ActionContext context)
Description copied from interface:DockingActionIfmethod to actually perform the action logic for this action.- Specified by:
actionPerformedin interfaceDockingActionIf- Specified by:
actionPerformedin classDockingAction- Parameters:
context- theActionContextobject that provides information about where and how this action was invoked.
-
isValidContext
public boolean isValidContext(ActionContext context)
Description copied from interface:DockingActionIfMethod 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:
isValidContextin interfaceDockingActionIf- Overrides:
isValidContextin classDockingAction- Parameters:
context- theActionContextfrom the active provider.- Returns:
- true if this action is appropriate for the given context.
-
shouldAddToWindow
public boolean shouldAddToWindow(boolean isMainWindow, java.util.Set<java.lang.Class<?>> contextTypes)Description copied from class:DockingActionDefault behavior is to add to main window;- Specified by:
shouldAddToWindowin interfaceDockingActionIf- Overrides:
shouldAddToWindowin classDockingAction- 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.
-
isAddToPopup
public boolean isAddToPopup(ActionContext context)
Description copied from interface:DockingActionIfmethod is used to determine if this action should be displayed on the current popup. This method will only be called if the action has popupPopupMenuDataset.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:
isAddToPopupin interfaceDockingActionIf- Overrides:
isAddToPopupin classDockingAction- Parameters:
context- theActionContextfrom the active provider.- Returns:
- true if this action is appropriate for the given context.
-
isAddToPopup
protected boolean isAddToPopup(ProgramActionContext context)
-
isValidContext
protected boolean isValidContext(ProgramActionContext context)
-
isEnabledForContext
protected boolean isEnabledForContext(ProgramActionContext context)
-
actionPerformed
protected abstract void actionPerformed(ProgramActionContext programContext)
-
actionPerformed
protected final void actionPerformed(ProgramActionContext programContext, ActionContext actionContext)
-
-