Class DockingAction
- java.lang.Object
-
- docking.action.DockingAction
-
- All Implemented Interfaces:
DockingActionIf,HelpDescriptor
- Direct Known Subclasses:
ghidra.app.plugin.core.functioncompare.AbstractApplyFunctionSignatureAction,AbstractFindReferencesDataTypeAction,AddAllFieldAction,AddFieldAction,AddSpacerFieldAction,DeleteTableRowAction,DisableFieldAction,DomainFileProviderContextAction,EnableFieldAction,FSBAction,HelpAction,HorizontalRuleAction,InsertRowAction,KeyBindingAction,ListingContextAction,MakeProgramSelectionAction,MultiActionDockingAction,MultiStateDockingAction,NavigatableContextAction,ProgramContextAction,ProgramLocationContextAction,ProgramSymbolContextAction,ProjectDataContextAction,ProjectDataTreeContextAction,RemoveAllFieldsAction,RemoveFieldAction,RemoveRowAction,ResetAllFormatsAction,ResetFormatAction,ResetTranslationAction,SaveImageAction,SetSpacerTextAction,SharedStubKeyBindingAction,ShowAllComponentsAction,ShowFocusCycleAction,ShowFocusInfoAction,ToggleDockingAction,ZoomInAction,ZoomOutAction,ZoomResetAction
public abstract class DockingAction extends java.lang.Object implements DockingActionIf
DockingActiondefines 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.
-
-
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 supportsKeyBindings)DockingAction(java.lang.String name, java.lang.String owner, KeyBindingType kbType)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract voidactionPerformed(ActionContext context)method to actually perform the action logic for this action.voidaddPropertyChangeListener(java.beans.PropertyChangeListener listener)Adds a listener to be notified if any property changesjavax.swing.JButtoncreateButton()Returns a JButton that is suitable for this action.javax.swing.JMenuItemcreateMenuItem(boolean isPopup)Returns a JMenuItem that is suitable for this action.voiddispose()Cleans up any resources used by the action.protected javax.swing.JButtondoCreateButton()protected javax.swing.JMenuItemdoCreateMenuItem()voidfirePropertyChanged(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)KeyBindingDatagetDefaultKeyBindingData()Returns the defaultKeyBindingDatato be used to assign this action to a key binding.java.lang.StringgetDescription()Returns a short description of this action.java.lang.StringgetFullName()Returns the full name (the action name combined with the owner name)java.lang.StringgetHelpInfo()Returns a descriptive String about the help object that this descriptor represents.java.lang.ObjectgetHelpObject()Returns the object for which help locations are defined.protected java.lang.StringgetInceptionFromTheFirstClassThatIsNotUs()java.lang.StringgetInceptionInformation()Returns a string that includes source file and line number information of where this action was createdjavax.swing.KeyStrokegetKeyBinding()Convenience method for getting the keybinding for this action.KeyBindingDatagetKeyBindingData()Returns theKeyBindingDatato be used to assign this action to a key binding.KeyBindingTypegetKeyBindingType()Returns this actions level of support for key binding accelerator keysMenuDatagetMenuBarData()Returns theMenuDatato be used to put this action in the menu bar.java.lang.StringgetName()Returns the name of the actionjava.lang.StringgetOwner()Returns the owner of this actionMenuDatagetPopupMenuData()Returns theMenuDatato be used to put this action in a popup menu.protected KeyBindingTypegetPreferredKeyBindingType()ToolBarDatagetToolBarData()Returns theToolBarDatato be used to put this action in a toolbar.booleanisAddToPopup(ActionContext context)method is used to determine if this action should be displayed on the current popup.booleanisEnabled()Returns true if the action is enabled.booleanisEnabledForContext(ActionContext context)Method used to determine if this action should be enabled for the given 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.booleanisValidGlobalContext(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.voidmarkHelpUnnecessary()Signals the the help system that this action does not need a help entry.voidremovePropertyChangeListener(java.beans.PropertyChangeListener listener)Removes a listener to be notified of property changes.voidsetDescription(java.lang.String newDescription)Sets the description to be used in the tooltip.booleansetEnabled(boolean newValue)Enables or disables the actionvoidsetHelpLocation(HelpLocation location)Set a specific Help location for this action.voidsetKeyBindingData(KeyBindingData newKeyBindingData)Sets theKeyBindingDataon an action to either assign a keybinding or remove it (keyBindingData = null).voidsetMenuBarData(MenuData newMenuData)Sets theMenuDatato be used to put this action on the tool's menu barvoidsetPopupMenuData(MenuData newMenuData)Sets theMenuDatato be used to put this action in the tool's popup menuvoidsetToolBarData(ToolBarData newToolBarData)Sets theToolBarDatato be used to put this action on the tool's toolbarvoidsetUnvalidatedKeyBindingData(KeyBindingData newKeyBindingData)Users creating actions should not call this method, but should instead callDockingActionIf.setKeyBindingData(KeyBindingData).booleanshouldAddToWindow(boolean isMainWindow, java.util.Set<java.lang.Class<?>> contextTypes)Default behavior is to add to main window;java.lang.StringtoString()-
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
-
-
-
-
Constructor Detail
-
DockingAction
public DockingAction(java.lang.String name, java.lang.String owner)
-
DockingAction
public DockingAction(java.lang.String name, java.lang.String owner, KeyBindingType kbType)
-
DockingAction
public DockingAction(java.lang.String name, java.lang.String owner, boolean supportsKeyBindings)
-
-
Method Detail
-
getPreferredKeyBindingType
protected KeyBindingType getPreferredKeyBindingType()
-
actionPerformed
public abstract void actionPerformed(ActionContext context)
Description copied from interface:DockingActionIfmethod to actually perform the action logic for this action.- Specified by:
actionPerformedin interfaceDockingActionIf- Parameters:
context- theActionContextobject that provides information about where and how this action was invoked.
-
addPropertyChangeListener
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Description copied from interface:DockingActionIfAdds a listener to be notified if any property changes- Specified by:
addPropertyChangeListenerin interfaceDockingActionIf- Parameters:
listener- The property change listener that will be notified of property change events.- See Also:
Action.addPropertyChangeListener(java.beans.PropertyChangeListener)
-
removePropertyChangeListener
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Description copied from interface:DockingActionIfRemoves a listener to be notified of property changes.- Specified by:
removePropertyChangeListenerin interfaceDockingActionIf- Parameters:
listener- The property change listener that will be notified of property change events.- See Also:
DockingActionIf.addPropertyChangeListener(PropertyChangeListener),Action.addPropertyChangeListener(java.beans.PropertyChangeListener)
-
getDescription
public java.lang.String getDescription()
Description copied from interface:DockingActionIfReturns a short description of this action. Generally used for a tooltip- Specified by:
getDescriptionin interfaceDockingActionIf- Returns:
- the description
-
getFullName
public java.lang.String getFullName()
Description copied from interface:DockingActionIfReturns the full name (the action name combined with the owner name)- Specified by:
getFullNamein interfaceDockingActionIf- Returns:
- the full name
-
getMenuBarData
public MenuData getMenuBarData()
Description copied from interface:DockingActionIfReturns theMenuDatato 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:
getMenuBarDatain interfaceDockingActionIf- Returns:
- the
MenuDatafor the menu bar or null if the action is not in the menu bar.
-
getName
public java.lang.String getName()
Description copied from interface:DockingActionIfReturns the name of the action- Specified by:
getNamein interfaceDockingActionIf- Returns:
- the name
-
getOwner
public java.lang.String getOwner()
Description copied from interface:DockingActionIfReturns the owner of this action- Specified by:
getOwnerin interfaceDockingActionIf- Returns:
- the owner
-
getPopupMenuData
public MenuData getPopupMenuData()
Description copied from interface:DockingActionIfReturns theMenuDatato 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:
getPopupMenuDatain interfaceDockingActionIf- Returns:
- the
MenuDatafor a popup menu or null if the action is not to be in a popup menu.
-
getToolBarData
public ToolBarData getToolBarData()
Description copied from interface:DockingActionIfReturns theToolBarDatato 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:
getToolBarDatain interfaceDockingActionIf- Returns:
- the
ToolBarDatafor the popup menu or null if the action is not in a popup menu.
-
getInceptionInformation
public java.lang.String getInceptionInformation()
Description copied from interface:DockingActionIfReturns a string that includes source file and line number information of where this action was created- Specified by:
getInceptionInformationin interfaceDockingActionIf- Returns:
- the inception information
-
isEnabled
public boolean isEnabled()
Description copied from interface:DockingActionIfReturns true if the action is enabled.- Specified by:
isEnabledin interfaceDockingActionIf- Returns:
- true if the action is enabled, 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
DockingActionIf.isEnabledForContext(ActionContext), 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 theDockingActionIf.isEnabledForContext(ActionContext)method will return false, resulting in the action appearing in the popup menu, but begin disabled.- Specified by:
isAddToPopupin interfaceDockingActionIf- Parameters:
context- theActionContextfrom the active provider.- Returns:
- true if this action is appropriate for the given context.
-
isEnabledForContext
public boolean isEnabledForContext(ActionContext context)
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- Parameters:
context- the currentActionContextfor 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: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- Parameters:
context- theActionContextfrom the active provider.- Returns:
- true if this action is appropriate for the given context.
-
isValidGlobalContext
public boolean isValidGlobalContext(ActionContext globalContext)
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 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:
isValidGlobalContextin interfaceDockingActionIf- Parameters:
globalContext- the globalActionContextfrom 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)Default behavior is to add to main window;- Specified by:
shouldAddToWindowin interfaceDockingActionIf- 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:DockingActionIfEnables or disables the action- Specified by:
setEnabledin interfaceDockingActionIf- Parameters:
newValue- true to enable the action, false to disable it- Returns:
- the enabled value of the action after this call
-
createButton
public final javax.swing.JButton createButton()
Description copied from interface:DockingActionIfReturns a JButton that is suitable for this action. For example, It creates a ToggleButton if the action is aToggleDockingActionIf.- Specified by:
createButtonin interfaceDockingActionIf- 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:DockingActionIfReturns a JMenuItem that is suitable for this action. For example, if the action is aToggleDockingActionIf, then a JCheckBoxMenuItem will be created.- Specified by:
createMenuItemin interfaceDockingActionIf- 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.
-
getKeyBindingType
public KeyBindingType getKeyBindingType()
Description copied from interface:DockingActionIfReturns this actions level of support for key binding accelerator keysActions support key bindings by default. Some reserved actions do not support key bindings, while others wish to share the same key bindings with multiple, equivalent actions (this allows the user to set one binding that works in many different contexts).
- Specified by:
getKeyBindingTypein interfaceDockingActionIf- Returns:
- the key binding support
-
getKeyBinding
public javax.swing.KeyStroke getKeyBinding()
Description copied from interface:DockingActionIfConvenience method for getting the keybinding for this action.- Specified by:
getKeyBindingin interfaceDockingActionIf- Returns:
- the
KeyStroketo be used as a keybinding for this action or null if there is no
-
getKeyBindingData
public KeyBindingData getKeyBindingData()
Description copied from interface:DockingActionIfReturns theKeyBindingDatato 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:
getKeyBindingDatain interfaceDockingActionIf- Returns:
- the
KeyBindingDatafor the action or null if the action does not have a keyBinding.
-
getDefaultKeyBindingData
public KeyBindingData getDefaultKeyBindingData()
Description copied from interface:DockingActionIfReturns the defaultKeyBindingDatato 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. The value of this method is that which is set from a call toDockingActionIf.setKeyBindingData(KeyBindingData).- Specified by:
getDefaultKeyBindingDatain interfaceDockingActionIf- Returns:
- the
KeyBindingDatafor the action or null if the action does not have a keyBinding.
-
setKeyBindingData
public void setKeyBindingData(KeyBindingData newKeyBindingData)
Description copied from interface:DockingActionIfSets theKeyBindingDataon an action to either assign a keybinding or remove it (keyBindingData = null).- Specified by:
setKeyBindingDatain interfaceDockingActionIf- Parameters:
newKeyBindingData- if non-null, assigns a keybinding to the action. Otherwise, removes any keybinding from the action.
-
setUnvalidatedKeyBindingData
public void setUnvalidatedKeyBindingData(KeyBindingData newKeyBindingData)
Description copied from interface:DockingActionIfUsers creating actions should not call this method, but should instead callDockingActionIf.setKeyBindingData(KeyBindingData).Call this method when you wish to bypass the validation of
DockingActionIf.setKeyBindingData(KeyBindingData)so that keybindings are set exactly as they are given (such as when set by the user and not by the programmer).- Specified by:
setUnvalidatedKeyBindingDatain interfaceDockingActionIf- Parameters:
newKeyBindingData- the KeyBindingData to be used to assign this action to a keybinding
-
setMenuBarData
public void setMenuBarData(MenuData newMenuData)
Sets theMenuDatato 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 theMenuDatato 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 theToolBarDatato 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
-
setDescription
public void setDescription(java.lang.String newDescription)
Sets the description to be used in the tooltip.- Parameters:
newDescription- the description to be set.
-
dispose
public void dispose()
Cleans up any resources used by the action.- Specified by:
disposein interfaceDockingActionIf
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
getHelpInfo
public java.lang.String getHelpInfo()
Description copied from interface:HelpDescriptorReturns a descriptive String about the help object that this descriptor represents.- Specified by:
getHelpInfoin interfaceHelpDescriptor
-
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:HelpDescriptorReturns the object for which help locations are defined. This may be the implementor of this interface or some other delegate object.- Specified by:
getHelpObjectin interfaceHelpDescriptor
-
doCreateButton
protected javax.swing.JButton doCreateButton()
-
doCreateMenuItem
protected javax.swing.JMenuItem doCreateMenuItem()
-
getInceptionFromTheFirstClassThatIsNotUs
protected java.lang.String getInceptionFromTheFirstClassThatIsNotUs()
-
-