ghidra/Ghidra/Framework/Docking/src/main/java/docking/AbstractDockingTool.java

/* ###
 * 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.awt.*;
import java.util.*;
import java.util.List;

import javax.swing.JFrame;

import docking.action.DockingActionIf;
import docking.actions.DockingToolActionManager;
import ghidra.framework.options.ToolOptions;
import ghidra.util.SystemUtilities;

/**
 * A partial implementation of {@link DockingTool} that serves as a place to share common 
 * functionality
 */
public abstract class AbstractDockingTool implements DockingTool {

	protected DockingWindowManager winMgr;
	protected DockingToolActionManager actionMgr;
	protected Map<String, ToolOptions> optionsMap = new HashMap<>();
	protected boolean configChangedFlag;

	@Override
	public boolean isVisible() {
		return winMgr.isVisible();
	}

	@Override
	public void setVisible(boolean visibility) {
		winMgr.setVisible(visibility);
	}

	@Override
	public void toFront() {
		JFrame frame = winMgr.getRootFrame();
		if (frame.getExtendedState() == Frame.ICONIFIED) {
			frame.setExtendedState(Frame.NORMAL);
		}
		frame.toFront();
	}

	@Override
	public void addComponentProvider(ComponentProvider provider, boolean show) {
		Runnable r = () -> winMgr.addComponent(provider, show);
		SystemUtilities.runSwingNow(r);
	}

	@Override
	public void removeComponentProvider(ComponentProvider provider) {
		Runnable r = () -> winMgr.removeComponent(provider);
		SystemUtilities.runSwingNow(r);
	}

	@Override
	public ComponentProvider getComponentProvider(String name) {
		return winMgr.getComponentProvider(name);
	}

	@Override
	public void setStatusInfo(String text) {
		winMgr.setStatusText(text);
	}

	@Override
	public void setStatusInfo(String text, boolean beep) {
		winMgr.setStatusText(text);
		if (beep) {
			Toolkit tk = getToolFrame().getToolkit();
			tk.beep();
		}
	}

	@Override
	public void clearStatusInfo() {
		winMgr.setStatusText("");
	}

	@Override
	public void addAction(DockingActionIf action) {
		actionMgr.addToolAction(action);
	}

	@Override
	public void removeAction(DockingActionIf action) {
		actionMgr.removeToolAction(action);
	}

	@Override
	public void addLocalAction(ComponentProvider provider, DockingActionIf action) {
		actionMgr.addLocalAction(provider, action);
	}

	@Override
	public void removeLocalAction(ComponentProvider provider, DockingActionIf action) {
		actionMgr.removeProviderAction(provider, action);
	}

	@Override
	public List<DockingActionIf> getAllActions() {
		return actionMgr.getAllActions();
	}

	@Override
	public List<DockingActionIf> getDockingActionsByOwnerName(String owner) {
		List<DockingActionIf> actions = actionMgr.getActions(owner);
		return actions;
	}

	@Override
	public List<DockingActionIf> getDockingActionsByFullActionName(String fullActionName) {
		Set<DockingActionIf> set = new HashSet<>();
		set.addAll(actionMgr.getDockingActionsByFullActionName(fullActionName));
		set.addAll(winMgr.getActions(fullActionName));
		return new ArrayList<>(set);
	}

	@Override
	public void showComponentProvider(ComponentProvider provider, boolean visible) {
		Runnable r = () -> winMgr.showComponent(provider, visible);
		SystemUtilities.runSwingNow(r);
	}

	@Override
	public void showDialog(DialogComponentProvider dialogComponent) {
		DockingWindowManager.showDialog(getToolFrame(), dialogComponent);
	}

	public JFrame getToolFrame() {
		return winMgr.getRootFrame();
	}

	@Override
	public Window getProviderWindow(ComponentProvider provider) {
		return winMgr.getProviderWindow(provider);
	}

	@Override
	public void toFront(ComponentProvider provider) {
		Runnable r = () -> winMgr.toFront(provider);
		SystemUtilities.runSwingNow(r);
	}

	@Override
	public boolean isVisible(ComponentProvider provider) {
		return winMgr.isVisible(provider);
	}

	@Override
	public boolean isActive(ComponentProvider provider) {
		return winMgr.isActiveProvider(provider);
	}

	@Override
	public void updateTitle(ComponentProvider provider) {
		winMgr.updateTitle(provider);
	}

	@Override
	public void contextChanged(ComponentProvider provider) {
		winMgr.contextChanged(provider);
	}

	@Override
	public DockingWindowManager getWindowManager() {
		return winMgr;
	}

	@Override
	public void setConfigChanged(boolean changed) {
		configChangedFlag = changed;
	}

	@Override
	public boolean hasConfigChanged() {
		return configChangedFlag;
	}
}