Ghidra is a software reverse engineering (SRE) framework
/* ###
* IP: GHIDRA
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package docking.menu;
import java.util.Collections;
import java.util.List;
import javax.swing.JButton;
import docking.ActionContext;
import docking.action.*;
import ghidra.util.Swing;
/**
* A class that supports multiple sub-actions, as well as a primary action. This is useful for
* actions that perform navigation operations.
* <p>
* Clients may add actions to this class with the intention that they will be accessible to the
* user via a GUI; for example, from a popup menu.
* <p>
* Actions added must have menu bar data set.
*
* <p>This action has a drop-down button that shows a popup menu of all available actions for
* the user to execute.
*
* <p>
* If the user executes this action directly (by clicking the non-popup section of the button),
* then {@link #actionPerformed(ActionContext)} will be called. By default, when the button is
* clicked, the popup menu is shown. To change this behavior, override
* {@link #actionPerformed(ActionContext)}. If an item of the popup menu is clicked, then the
* {@link DockingAction#actionPerformed(ActionContext)} method of the sub-action that was executed
* will be called.
*
* @see MultiStateDockingAction
*/
public class MultiActionDockingAction extends DockingAction
implements MultiActionDockingActionIf {
private List<DockingActionIf> actionList = Collections.emptyList();
private MultipleActionDockingToolbarButton multipleButton;
public MultiActionDockingAction(String name, String owner) {
super(name, owner);
}
public void setActions(List<DockingActionIf> actionList) {
if (actionList == null) {
this.actionList = Collections.emptyList();
}
else {
this.actionList = actionList;
}
}
@Override
public List<DockingActionIf> getActionList(ActionContext context) {
return actionList;
}
/**
* This method is called when the user clicks the button <B>when this action is used as part of
* the default {@link DockingAction} framework.</B>
*
* This is the callback to be overridden when the child wishes to respond to user button
* presses that are on the button and not the drop-down. The default behavior is to show the
* popup menu when the button is clicked.
*/
@Override
public void actionPerformed(ActionContext context) {
Swing.runLater(() -> multipleButton.showPopup());
}
@Override
public JButton doCreateButton() {
multipleButton = new MultipleActionDockingToolbarButton(this);
return multipleButton;
}
public static DockingActionIf createSeparator() {
DockingAction separatorAction = new DockingAction("", "") {
@Override
public void actionPerformed(ActionContext context) {
// dummy action
}
};
separatorAction.setMenuBarData(new MenuData(new String[] { "" }));
separatorAction.setEnabled(false);
return separatorAction;
}
//==================================================================================================
// DockableAction methods
//==================================================================================================
@Override
public boolean isEnabledForContext(ActionContext context) {
return isEnabled();
}
}