Class TestTool

java.lang.Object

docking.AbstractDockingTool

ghidra.framework.plugintool.PluginTool

ghidra.framework.project.tool.GhidraTool

ghidra.test.TestTool

All Implemented Interfaces:

Tool, ServiceProvider

public class TestTool
extends GhidraTool

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from class GhidraTool

autoSave

Fields inherited from class PluginTool

DESCRIPTION_PROPERTY_NAME, ICON_PROPERTY_NAME, iconURL, isDisposed, manageDialog, PLUGIN_COUNT_PROPERTY_NAME, TOOL_NAME_PROPERTY, toolName

Fields inherited from class AbstractDockingTool

optionsMap, toolActions, winMgr

Constructor Summary

Constructors

Constructor	Description
TestTool(Project project)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this tool, possibly with input from the user.
protected DockingWindowManager	createDockingWindowManager(boolean isDockable, boolean hasStatus, boolean isModal)	This method exists here, as opposed to inline in the constructor, so that subclasses can alter the behavior of the DockingWindowManager construction.

Methods inherited from class GhidraTool

addManagePluginsAction, createPluginsConfigurations, dispose, doSaveTool, getToolTemplate, initActions, restoreFromXml, restoreWindowingDataFromXml, saveToXml, saveWindowingDataToXml, setToolName, setVisible, shouldSave, showConfig

Methods inherited from class PluginTool

accept, acceptDomainFiles, addEventListener, addExitAction, addExportToolAction, addHelpActions, addListenerForAllPluginEvents, addNextPreviousProviderActions, addOptionsAction, addPlugin, addPlugin, addPlugins, addPlugins, addPropertyChangeListener, addSaveToolAction, addServiceListener, addStatusComponent, addToolListener, allowTerminatingTasksWhenClosing, beep, cancelCurrentTask, canClose, canCloseDomainFile, canCloseDomainObject, canClosePlugins, canStopTasks, clearLastEvents, contextChanged, execute, execute, execute, execute, execute, executeBackgroundCommand, firePluginEvent, getActiveComponentProvider, getActiveWindow, getConsumedToolEventNames, getDomainFiles, getIcon, getIconURL, getInstanceName, getLocation, getManagedPlugins, getManagePluginsDialog, getName, getOptions, getOptions, getPluginsConfiguration, getProject, getProjectManager, getService, getServices, getSize, getSupportedDataTypes, getToolEventNames, getToolName, getToolServices, getTransientState, getUndoRedoToolState, hasOptions, hasToolListeners, hasUnsavedData, installHomeButton, installUtilityPlugins, isConfigurable, isExecutingCommand, isRestoringDataState, isService, isWindowsOnTop, optionsChanged, prepareToSave, processToolEvent, putInstanceName, registerDefaultContextProvider, registerOptionsNameChange, removeEventListener, removeListenerForAllPluginEvents, removePlugins, removePlugins, removePreferenceState, removePropertyChangeListener, removeServiceListener, removeStatusComponent, removeToolListener, restoreDataStateFromXml, restoreOptionsFromXml, restorePluginsFromXml, saveDataStateToXml, saveTool, saveToolAs, saveToolToToolTemplate, scheduleFollowOnCommand, setConfigChanged, setDefaultComponent, setIconURL, setLocation, setProject, setSize, setSubTitle, setUnconfigurable, setWindowsOnTop, showComponentHeader, showConfig, showDialog, showDialog, showDialogOnActiveWindow, showExtensions, threadIsBackgroundTaskThread, unregisterDefaultContextProvider

Methods inherited from class AbstractDockingTool

addAction, addComponentProvider, addContextListener, addLocalAction, addPopupActionProvider, clearStatusInfo, getAllActions, getComponentProvider, getDockingActionsByOwnerName, getGlobalActions, getLocalActions, getProviderWindow, getStatusInfo, getToolActions, getToolFrame, getWindowManager, hasConfigChanged, isActive, isVisible, isVisible, removeAction, removeComponentProvider, removeContextListener, removeLocalAction, removePopupActionProvider, setMenuGroup, setMenuGroup, setStatusInfo, setStatusInfo, showComponentProvider, showDialog, toFront, toFront, updateTitle

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

TestTool

public TestTool(Project project)

Method Details

createDockingWindowManager

protected DockingWindowManager createDockingWindowManager(boolean isDockable,
 boolean hasStatus,
 boolean isModal)

Description copied from class: PluginTool

This method exists here, as opposed to inline in the constructor, so that subclasses can alter the behavior of the DockingWindowManager construction.

Overrides:

createDockingWindowManager in class GhidraTool

Parameters:

isDockable - true if the tool contains components that can be docked

hasStatus - true if the tool should display a status component

isModal - true if the tool is modal, meaning that while this tool is visible, no other tool or dialog in Ghidra can have focus

Returns:

a new DockingWindowManager

close

public void close()

Description copied from class: PluginTool

Closes this tool, possibly with input from the user. The following conditions are checked and can prompt the user for more info and allow them to cancel the close.

1. Running tasks. Closing with running tasks could lead to data loss.
2. Plugins get asked if they can be closed. They may prompt the user to resolve some plugin specific state.
3. The user is prompted to save any data changes.
4. Tools are saved, possibly asking the user to resolve any conflicts caused by changing multiple instances of the same tool in different ways.
5. If all the above conditions passed, the tool is closed and disposed.

Specified by:

close in interface Tool

Overrides:

close in class PluginTool