Package ghidra.app.context

Class ProgramContextAction

    • Constructor Detail

      • ProgramContextAction

        public ProgramContextAction​(java.lang.String name,
                            java.lang.String owner)

    • Method Detail

      • isEnabledForContext

        public boolean isEnabledForContext​(ActionContext actionContext)
        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:
        actionContext - 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
        Overrides:
        isValidContext in class DockingAction
        Parameters:
        context - the ActionContext from 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: DockingAction
        Default behavior is to add to main window;
        Specified by:
        shouldAddToWindow in interface DockingActionIf
        Overrides:
        shouldAddToWindow in class DockingAction
        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: 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 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 the DockingActionIf.isEnabledForContext(ActionContext) method will return false, resulting in the action appearing in the popup menu, but begin disabled.

        Specified by:
        isAddToPopup in interface DockingActionIf
        Overrides:
        isAddToPopup in class DockingAction
        Parameters:
        context - the ActionContext from the active provider.
        Returns:
        true if this action is appropriate for the given context.

      • actionPerformed

        protected abstract void actionPerformed​(ProgramActionContext programContext)