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;
import java.util.Iterator;
import java.util.Set;
import docking.action.DockingActionIf;
import util.CollectionUtils;
/**
* A class that exists primarily to provide access to action-related package-level methods of the
* {@link DockingWindowManager}. This allows the manager's interface to hide methods that
* don't make sense for public consumption.
*/
public class ActionToGuiHelper {
private DockingWindowManager windowManager;
public ActionToGuiHelper(DockingWindowManager windowManager) {
this.windowManager = windowManager;
}
/**
* Adds an action to the global menu or toolbar which appear in the main frame. If the action
* has a menu path, it will be in the menu. If it has an icon, it will appear in the toolbar.
* @param action the action to be added
*/
public void addToolAction(DockingActionIf action) {
windowManager.addToolAction(action);
}
/**
* Removes the given action from the global menu and toolbar
* @param action the action to be removed
*/
public void removeToolAction(DockingActionIf action) {
windowManager.removeToolAction(action);
}
/**
* Adds an action that will be associated with the given provider. These actions will
* appear in the local header for the component as a toolbar button or a drop-down menu
* item if it has an icon and menu path respectively.
*
* @param provider the provider whose header on which the action is to be placed
* @param action the action to add to the providers header bar
*/
public void addLocalAction(ComponentProvider provider, DockingActionIf action) {
windowManager.addLocalAction(provider, action);
}
/**
* Get an iterator over the actions for the given provider
* @param provider the component provider for which to iterate over all its owned actions
* @return null if the provider does not exist in the window manager
*/
public Iterator<DockingActionIf> getComponentActions(ComponentProvider provider) {
return windowManager.getComponentActions(provider);
}
/**
* Removes the action from the given provider's header bar.
* @param provider the provider whose header bar from which the action should be removed.
* @param action the action to be removed from the provider's header bar.
*/
public void removeProviderAction(ComponentProvider provider, DockingActionIf action) {
windowManager.removeProviderAction(provider, action);
}
/**
* Call this method to signal that key bindings for one or more actions have changed
*/
public void keyBindingsChanged() {
windowManager.scheduleUpdate();
}
public Set<DockingActionIf> getLocalActions(ComponentProvider provider) {
Iterator<DockingActionIf> actionIterator = windowManager.getComponentActions(provider);
return CollectionUtils.asSet(actionIterator);
}
public Set<DockingActionIf> getGlobalActions() {
return windowManager.getGlobalActions();
}
}