java.lang.Object
- docking.AbstractDockingTool
- - ghidra.framework.plugintool.PluginTool

All Implemented Interfaces:

DockingTool, DockWinListener, Tool, ToolListener, ServiceProvider

Direct Known Subclasses:

FrontEndTool, GhidraTool, ModalPluginTool, StandAlonePluginTool
```
public abstract class PluginTool
extends AbstractDockingTool
implements Tool, DockWinListener, ServiceProvider
```
Base class that is a container to manage plugins and their actions, and to coordinate the firing of plugin events and tool events. A PluginTool may have visible components supplied by
```
ComponentProviders 
```
. These components may be docked within the tool, or moved out into their own windows.
The PluginTool also manages tasks that run in the background, and options used by the plugins.

Field Summary

Fields
Change	Modifier and Type	Field
NEW	`protected ExtensionTableProvider`	`extensionTableProvider`
NEW	`protected ToolIconURL`	`iconURL`
NEW	`protected boolean`	`isDisposed`
NEW	`protected ManagePluginsDialog`	`manageDialog`
NEW	`protected java.lang.String`	`toolName`

Fields inherited from class docking.AbstractDockingTool
actionMgr, configChangedFlag, optionsMap, winMgr

Fields inherited from interface ghidra.framework.model.Tool
DESCRIPTION_PROPERTY_NAME, ICON_PROPERTY_NAME, PLUGIN_COUNT_PROPERTY_NAME, TOOL_NAME_PROPERTY

Constructor Summary

Constructors
Change	Constructor	Description
`PluginTool(Project project, ProjectManager projectManager, ToolServices toolServices, java.lang.String name, boolean isDockable, boolean hasStatus, boolean isModal)`
`PluginTool(Project project, ToolTemplate template)`	Construct a new PluginTool.
`PluginTool(Project project, java.lang.String name, boolean isDockable, boolean hasStatus, boolean isModal)`	Construct a new PluginTool.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Change	Modifier and Type	Method	Description
	`boolean`	`acceptDomainFiles(DomainFile[] data)`	When the user drags a data file onto a tool, an event will be fired that the tool will respond to by accepting the data.
	`void`	`addAction(DockingActionIf action)`	Adds the action to the tool.
	`void`	`addComponentProvider(ComponentProvider provider, boolean show)`	Adds a visible component to the tool.
	`void`	`addContextListener(DockingContextListener listener)`
NEW	`protected void`	`addExitAction()`
NEW	`protected void`	`addExportToolAction()`
NEW	`protected void`	`addHelpActions()`
	`void`	`addListenerForAllPluginEvents(PluginEventListener listener)`
	`void`	`addLocalAction(ComponentProvider provider, DockingActionIf action)`	Add an action that is associated with the given provider.
NEW	`protected void`	`addOptionsAction()`
	`void`	`addPlugin(Plugin p)`
	`void`	`addPlugin(java.lang.String className)`	Add a plugin to the tool.
	`void`	`addPlugins(java.lang.String[] classNames)`	Add plugins to the tool.
	`void`	`addPopupListener(PopupListener listener)`	Add popup listener that is notified when the popup menu is about to be displayed.
	`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener l)`	Add property change listener.
NEW	`protected void`	`addSaveToolAction()`
	`void`	`addServiceListener(ServiceListener listener)`	Adds a listener that will be called as services are added and removed from this ServiceProvider.
	`void`	`addStatusComponent(javax.swing.JComponent c, boolean addBorder, boolean rightSide)`	Add a status component to the tool.
	`void`	`addToolListener(ToolListener listener)`	Adds a ToolListener to be notified for any of a Tool's ToolEvents.
	`void`	`cancelCurrentTask()`	Cancel the current task in the tool.
	`boolean`	`canClose(boolean isExiting)`	Can this tool be closed? Note: This forces plugins to terminate any tasks they have running and apply any unsaved data to domain objects or files.
	`boolean`	`canCloseDomainFile(DomainFile domainFile)`	Can the domain File be closed? Note: This forces plugins to terminate any tasks they have running for the indicated domain object and apply any unsaved data to the domain object.
	`boolean`	`canCloseDomainObject(DomainObject dObj)`	Can the domain object be closed? Note: This forces plugins to terminate any tasks they have running for the indicated domain object and apply any unsaved data to the domain object.
	`void`	`clearLastEvents()`	Clear the list of events that were last generated.
	`void`	`clearStatusInfo()`	Clear the status information.
	`void`	`close()`	Close this tool: if there are no tasks running.
	`void`	`contextChanged(ComponentProvider provider)`	Signals to the tool that the provider's context has changed.
NEW	`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.
NEW	`protected void`	`dispose()`
NEW	`protected boolean`	`doSaveTool()`	Called when it is time to save the tool.
	`boolean`	`execute(Command command, DomainObject obj)`	Call the applyTo() method on the given command to make some change to the domain object; the command is done in the AWT thread, therefore, the command that is to be executed should be a relatively quick operation so that the event queue does not appear to "hang." For lengthy operations, the command should be done in a background task.
	`void`	`execute(Task task)`	Launch the task in a new thread.
	`void`	`execute(Task task, int delay)`	Launch the task in a new thread.
	`void`	`executeBackgroundCommand(BackgroundCommand cmd, UndoableDomainObject obj)`	Start a new thread that will call the given command's applyTo() method to make some change in the domain object.
	`void`	`exit()`	Tells the tool to stop functioning and release its resources.
	`void`	`firePluginEvent(PluginEvent event)`	Fire the plugin event by notifying the event manager which calls the listeners.
	`ComponentProvider`	`getActiveComponentProvider()`
	`java.awt.Window`	`getActiveWindow()`
	`java.util.List<DockingActionIf>`	`getAllActions()`	Return a list of all actions in the tool.
	`ComponentProvider`	`getComponentProvider(java.lang.String name)`	Returns the ComponentProvider with the given name.
	`java.lang.String[]`	`getConsumedToolEventNames()`	Returns a list of eventNames that this Tool is interested in.
	`java.util.List<DockingActionIf>`	`getDockingActionsByFullActionName(java.lang.String fullActionName)`	Return an list of actions with the given full name
	`java.util.List<DockingActionIf>`	`getDockingActionsByOwnerName(java.lang.String owner)`	Returns all actions for the given owner
	`DomainFile[]`	`getDomainFiles()`	Get the domain files that this tool currently has open.
	`javax.swing.ImageIcon`	`getIcon()`	Get the icon that the tool is using.
	`ToolIconURL`	`getIconURL()`	Get the url for the icon that this tool is using.
	`java.lang.String`	`getInstanceName()`	Returns the tool's unique name.
	`java.awt.Point`	`getLocation()`	Return the location of this tool's frame on the screen.
	`java.util.List<Plugin>`	`getManagedPlugins()`	Return a list of plugins in the tool
	`ManagePluginsDialog`	`getManagePluginsDialog()`	Returns the manage plugins dialog that is currently being used.
	`java.lang.String`	`getName()`	Returns a combination of the tool name and the instance name of the form tool name(instance name), e.g., SomeTool(2)
	`ToolOptions[]`	`getOptions()`	Get all options.
	`ToolOptions`	`getOptions(java.lang.String categoryName)`	Get the options for the given category name; if no options exist with the given name, then one is created.
	`abstract PluginClassManager`	`getPluginClassManager()`
	`java.util.List<DockingActionIf>`	`getPopupActions(ActionContext context)`	Provides notification when a popup menu is about to be displayed and permits a list of temporary actions to be returned.
	`Project`	`getProject()`	Get the project associated with this tool.
	`ProjectManager`	`getProjectManager()`	Returns the project manager associated with this tool.
	`java.awt.Window`	`getProviderWindow(ComponentProvider componentProvider)`	Returns the parent window for the given provider
	`<T> T`	`getService(java.lang.Class<T> c)`	Returns the Service object that implements the given service interface.
	`<T> T[]`	`getServices(java.lang.Class<T> c)`	Get the objects that implement the given service.
	`java.awt.Dimension`	`getSize()`	Return the dimension of this tool's frame.
	`java.lang.Class<?>[]`	`getSupportedDataTypes()`	Get the classes of the data types that this tool supports, i.e., what data types can be dropped onto this tool.
	`java.lang.String[]`	`getToolEventNames()`	Returns the names of all the possible ToolEvents that this tool might generate.
	`javax.swing.JFrame`	`getToolFrame()`	Returns the tool's frame
	`java.lang.String`	`getToolName()`	Returns the name associated with the tool
	`ToolServices`	`getToolServices()`	Returns an object that provides fundamental services that plugins can use.
	`ToolTemplate`	`getToolTemplate(boolean includeConfigState)`	Returns a ToolTemplate for this Tool that describes the state of the tool.
	`TransientToolState`	`getTransientState()`
	`UndoRedoToolState`	`getUndoRedoToolState(DomainObject domainObject)`
	`DockingWindowManager`	`getWindowManager()`	Returns the DockingWindowManger for this tool.
	`boolean`	`hasOptions(java.lang.String category)`	Return true if there is an options category with the given name
	`boolean`	`hasToolListeners()`	Returns true if there is at least one tool listening to this tool's plugin events.
	`boolean`	`hasUnsavedData()`
NEW	`protected void`	`initActions()`	Placeholder for subclasses to get a chance to install actions before plugins.
NEW	`protected void`	`installHomeButton()`
	`boolean`	`isActive(ComponentProvider provider)`	Returns true if the ComponentProvider is the currently active provider.
	`boolean`	`isConfigurable()`
	`boolean`	`isExecutingCommand()`	Return whether there is a command being executed.
	`boolean`	`isService(java.lang.Class<?> serviceInterface)`	Returns true if the specified `serviceInterface` is a valid service that exists in this tool.
	`boolean`	`isVisible()`	Returns true if tool is visible.
	`boolean`	`isVisible(ComponentProvider provider)`	Returns true if the given ComponentProvider is currently visible.
	`boolean`	`isWindowsOnTop()`	Return the value of the Tool option (GhidraOptions.OPTION_DOCKING_WINDOWS_ON_TOP) for whether docked windows will always be shown on top of their parent windows.
NEW	`protected void`	`optionsChanged(Options options, java.lang.String name, java.lang.Object oldValue, java.lang.Object newValue)`
	`void`	`prepareToSave(DomainObject dobj)`	Called when the domain object is about to be saved; this allows any plugin that has a cache to flush out to the domain object.
	`void`	`processToolEvent(PluginEvent toolEvent)`	This method is invoked when the registered ToolEvent event occurs.
	`void`	`putInstanceName(java.lang.String newInstanceName)`	Associates a unique(within the active project) name to a tool instance.
	`void`	`refreshKeybindings()`
	`void`	`registerOptionsNameChange(java.lang.String oldName, java.lang.String newName)`	Updates saved options from an old name to a new name.
	`void`	`removeAction(DockingActionIf action)`	Removes the given action from the tool
	`void`	`removeComponentProvider(ComponentProvider provider)`	Removes the given ComponentProvider from the tool.
	`void`	`removeContextListener(DockingContextListener listener)`
	`void`	`removeListenerForAllPluginEvents(PluginEventListener listener)`
	`void`	`removeLocalAction(ComponentProvider provider, DockingActionIf action)`	Removes the action from the provider
	`void`	`removePlugins(Plugin[] plugins)`	Remove the array of plugins from the tool.
	`void`	`removePopupListener(PopupListener listener)`	Remove popup listener
	`void`	`removePreferenceState(java.lang.String name)`
	`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener l)`	Remove property change listener.
	`void`	`removeServiceListener(ServiceListener listener)`	Removes the given listener from this ServiceProvider.
	`void`	`removeStatusComponent(javax.swing.JComponent c)`	Remove the status component.
	`void`	`removeToolListener(ToolListener listener)`	Removes a ToolListener from receiving any event generated by this Tool.
	`void`	`restoreDataStateFromXml(org.jdom.Element root)`	Tells tool to read its data state from the given input stream.
NEW	`protected boolean`	`restoreFromXml(org.jdom.Element root)`
NEW	`protected void`	`restoreOptionsFromXml(org.jdom.Element root)`
NEW	`protected void`	`restorePluginsFromXml(org.jdom.Element elem)`
	`void`	`restoreWindowingDataFromXml(org.jdom.Element windowData)`	Restores the tool's Docking Window layout and positioning information from an XML element.
	`org.jdom.Element`	`saveDataStateToXml(boolean savingProject)`	Tells tool to write its data state from the given output stream.
	`void`	`saveTool()`	Save this tool's configuration.
	`boolean`	`saveToolAs()`	Triggers a 'Save As' dialog that allows the user to save off the tool under a different name.
	`ToolTemplate`	`saveToolToToolTemplate()`	Save the tool and return its state as a ToolTemplate.
	`org.jdom.Element`	`saveToXml(boolean includeConfigState)`
	`org.jdom.Element`	`saveWindowingDataToXml()`	Saves the tool's Docking Window layout and positioning information to an XML element.
	`void`	`scheduleFollowOnCommand(BackgroundCommand cmd, UndoableDomainObject obj)`	Add the given background command to a queue that is processed after the main background command completes.
	`void`	`setConfigChanged(boolean changed)`	Toggles the "change" state of the tool...
	`void`	`setDefaultComponent(ComponentProvider provider)`	Sets the provider that should get the default focus when no component has focus.
	`void`	`setIconURL(ToolIconURL newIconURL)`	Set the icon for this tool.
	`void`	`setLocation(int x, int y)`	Set the location of this tool's frame on the screen.
	`void`	`setMenuGroup(java.lang.String[] menuPath, java.lang.String group)`	Set the menu group associated with a cascaded submenu.
	`void`	`setMenuGroup(java.lang.String[] menuPath, java.lang.String group, java.lang.String menuSubGroup)`	Set the menu group associated with a cascaded submenu.
NEW	`protected void`	`setProject(Project project)`
	`void`	`setSize(int width, int height)`	Sets the size of the tool's main window
	`void`	`setStatusInfo(java.lang.String text)`	Set the status information
	`void`	`setStatusInfo(java.lang.String text, boolean beep)`	Set the status information.
	`void`	`setSubTitle(java.lang.String subTitle)`	Sets the subtitle on the tool; the subtitle is extra text in the title.
	`void`	`setToolName(java.lang.String name)`	Sets the type name of the tool.
	`void`	`setUnconfigurable()`
	`void`	`setVisible(boolean visibility)`	Sets the tool visible or invisible.
	`void`	`setWindowsOnTop(boolean b)`	Set the Tool option (GhidraOptions.OPTION_DOCKING_WINDOWS_ON_TOP) for whether a docked window will always be shown on top of its parent window.
	`boolean`	`shouldSave()`	Returns true if this tool should save its data, based upon its changed state and the state of Ghidra's saving method.
	`void`	`showComponentHeader(ComponentProvider provider, boolean b)`	Set whether a component's header should be shown; the header is the component that is dragged in order to move the component within the tool, or out of the tool into a separate window
	`void`	`showComponentProvider(ComponentProvider provider, boolean visibleState)`	Hides or shows the component associated with the given provider.
	`void`	`showConfig(boolean addSaveActions, boolean isNewTool)`	Displays the manage plugins dialog.
	`void`	`showDialog(DialogComponentProvider dialogComponent)`	Shows the dialog using the active top-level window (often the tool's root frame) as a parent.
	`void`	`showDialog(DialogComponentProvider dialogComponent, ComponentProvider centeredOnProvider)`	Shows the dialog using the window containing the given componentProvider as its parent window.
	`void`	`showDialog(DialogComponentProvider dialogComponent, java.awt.Component centeredOnComponent)`	Shows the dialog using the tool's parent frame, but centers the dialog on the given component
	`void`	`showDialogOnActiveWindow(DialogComponentProvider dialogComponent)`	Shows the dialog using the tool's currently active window as a parent.
	`void`	`showEditWindow(java.lang.String defaultText, java.awt.Component comp, java.awt.Rectangle rect, EditListener listener)`	Display an text edit box on top of the specified component.
	`void`	`showExtensions()`	Displays the extensions installation dialog.
	`void`	`terminateBackgroundCommands(boolean wait)`	Cancel any running command and clear the command queue.
	`boolean`	`threadIsBackgroundTaskThread()`
	`void`	`toFront()`	Brings this tool to the front.
	`void`	`toFront(ComponentProvider provider)`	Makes the given ComponentProvider move to the front if it is tabbed with other components.
	`void`	`updateTitle(ComponentProvider provider)`	Indicates to the tool that the given componentProvider's title has changed.

Methods inherited from class docking.AbstractDockingTool
hasConfigChanged

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface docking.DockingTool
hasConfigChanged

Field Detail

toolName NEW
```
protected java.lang.String toolName
```

manageDialog NEW

protected ManagePluginsDialog manageDialog

extensionTableProvider NEW

protected ExtensionTableProvider extensionTableProvider

iconURL NEW
```
protected ToolIconURL iconURL
```

isDisposed NEW
```
protected boolean isDisposed
```

Constructor Detail

PluginTool
```
public PluginTool(Project project,
                  ToolTemplate template)
```
Construct a new PluginTool.

Parameters:

project - project that contains this tool

template - the template from which to load this tool

PluginTool
```
public PluginTool(Project project,
                  java.lang.String name,
                  boolean isDockable,
                  boolean hasStatus,
                  boolean isModal)
```
Construct a new PluginTool.

Parameters:

project - project that contains the tool

name - the name of the tool

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

PluginTool

public PluginTool(Project project,
                  ProjectManager projectManager,
                  ToolServices toolServices,
                  java.lang.String name,
                  boolean isDockable,
                  boolean hasStatus,
                  boolean isModal)

Method Detail
- getPluginClassManager
```
public abstract PluginClassManager getPluginClassManager()
```
- createDockingWindowManager NEW
```
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.
  
  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
- installHomeButton NEW
```
protected void installHomeButton()
```
- initActions NEW
```
protected void initActions()
```
  Placeholder for subclasses to get a chance to install actions before plugins.
- getWindowManager
```
public DockingWindowManager getWindowManager()
```
  Description copied from interface: DockingTool
  
  Returns the DockingWindowManger for this tool.
  
  Specified by:
  
  getWindowManager in interface DockingTool
  
  Overrides:
  
  getWindowManager in class AbstractDockingTool
  
  Returns:
  
  the DockingWindowManger for this tool.
- optionsChanged NEW
```
protected void optionsChanged(Options options,
                              java.lang.String name,
                              java.lang.Object oldValue,
                              java.lang.Object newValue)
```
- setWindowsOnTop
```
public void setWindowsOnTop(boolean b)
```
  Set the Tool option (GhidraOptions.OPTION_DOCKING_WINDOWS_ON_TOP) for whether a docked window will always be shown on top of its parent window.
  
  Parameters:
  
  b - true means that the docked window will always appear on top of its parent window; false means to allow the docked window to be "hidden" under its parent dialog
- isWindowsOnTop
```
public boolean isWindowsOnTop()
```
  Return the value of the Tool option (GhidraOptions.OPTION_DOCKING_WINDOWS_ON_TOP) for whether docked windows will always be shown on top of their parent windows.
  
  Returns:
  
  value of the Tool option, GhidraOptions.OPTION_DOCKING_WINDOWS_ON_TOP
- addPopupListener
```
public void addPopupListener(PopupListener listener)
```
  Add popup listener that is notified when the popup menu is about to be displayed.
  
  Parameters:
  
  listener - listener that is notified when the popup menu is to be displayed
- getManagePluginsDialog
```
public ManagePluginsDialog getManagePluginsDialog()
```
  Returns the manage plugins dialog that is currently being used.
  
  Returns:
  
  the current manage plugins dialog
- showConfig
```
public void showConfig(boolean addSaveActions,
                       boolean isNewTool)
```
  Displays the manage plugins dialog.
  
  Parameters:
  
  addSaveActions - if true show save actions
  
  isNewTool - true if creating a new tool
- showExtensions
```
public void showExtensions()
```
  Displays the extensions installation dialog.
- removePopupListener
```
public void removePopupListener(PopupListener listener)
```
  Remove popup listener
  
  Parameters:
  
  listener - listener that is notified when the popup menu is to be displayed
- addAction
```
public void addAction(DockingActionIf action)
```
  Adds the action to the tool.
  
  Specified by:
  
  addAction in interface DockingTool
  
  Overrides:
  
  addAction in class AbstractDockingTool
  
  Parameters:
  
  action - the action to be added.
- addLocalAction
```
public void addLocalAction(ComponentProvider provider,
                           DockingActionIf action)
```
  Add an action that is associated with the given provider. The action works only in the context of the provider, and not across the tool as for a "global" action.
  
  Specified by:
  
  addLocalAction in interface DockingTool
  
  Overrides:
  
  addLocalAction in class AbstractDockingTool
  
  Parameters:
  
  provider - provider that has a visible component in the tool
  
  action - local action to associate with the provider
- removeAction
```
public void removeAction(DockingActionIf action)
```
  Removes the given action from the tool
  
  Specified by:
  
  removeAction in interface DockingTool
  
  Overrides:
  
  removeAction in class AbstractDockingTool
  
  Parameters:
  
  action - the action to be removed.
- addComponentProvider
```
public void addComponentProvider(ComponentProvider provider,
                                 boolean show)
```
  Adds a visible component to the tool.
  
  Specified by:
  
  addComponentProvider in interface DockingTool
  
  Overrides:
  
  addComponentProvider in class AbstractDockingTool
  
  Parameters:
  
  provider - The component provider that provides the component to be added.
  
  show - flag to initially show the component.
- showComponentHeader
```
public void showComponentHeader(ComponentProvider provider,
                                boolean b)
```
  Set whether a component's header should be shown; the header is the component that is dragged in order to move the component within the tool, or out of the tool into a separate window
  
  Parameters:
  
  provider - provider of the visible component in the tool
  
  b - true means to show the header
- isActive
```
public boolean isActive(ComponentProvider provider)
```
  Description copied from interface: DockingTool
  
  Returns true if the ComponentProvider is the currently active provider. The active provider is the provider that has keyboard focus and provides the current action context.
  
  Specified by:
  
  isActive in interface DockingTool
  
  Overrides:
  
  isActive in class AbstractDockingTool
  
  Parameters:
  
  provider - the provider to check for active.
  
  Returns:
  
  true if the ComponentProvider is the currently active provider.
- showComponentProvider
```
public void showComponentProvider(ComponentProvider provider,
                                  boolean visibleState)
```
  Hides or shows the component associated with the given provider.
  
  Specified by:
  
  showComponentProvider in interface DockingTool
  
  Overrides:
  
  showComponentProvider in class AbstractDockingTool
  
  Parameters:
  
  provider - the provider of the component to be hidden or shown.
  
  visibleState - true to show the component, false to hide it.
- toFront
```
public void toFront(ComponentProvider provider)
```
  Description copied from interface: DockingTool
  
  Makes the given ComponentProvider move to the front if it is tabbed with other components.
  
  Specified by:
  
  toFront in interface DockingTool
  
  Overrides:
  
  toFront in class AbstractDockingTool
  
  Parameters:
  
  provider - the provider to move to the top of its stacking order.
- removeComponentProvider
```
public void removeComponentProvider(ComponentProvider provider)
```
  Description copied from interface: DockingTool
  
  Removes the given ComponentProvider from the tool.
  
  Specified by:
  
  removeComponentProvider in interface DockingTool
  
  Overrides:
  
  removeComponentProvider in class AbstractDockingTool
- updateTitle
```
public void updateTitle(ComponentProvider provider)
```
  Description copied from interface: DockingTool
  
  Indicates to the tool that the given componentProvider's title has changed.
  
  Specified by:
  
  updateTitle in interface DockingTool
  
  Overrides:
  
  updateTitle in class AbstractDockingTool
  
  Parameters:
  
  provider - the componentProvider whose title has changed.
- isVisible
```
public boolean isVisible(ComponentProvider provider)
```
  Description copied from interface: DockingTool
  
  Returns true if the given ComponentProvider is currently visible.
  
  Specified by:
  
  isVisible in interface DockingTool
  
  Overrides:
  
  isVisible in class AbstractDockingTool
  
  Parameters:
  
  provider - the provider to check for visibility.
  
  Returns:
  
  true if the given ComponentProvider is currently visible.
- isVisible
```
public boolean isVisible()
```
  Description copied from interface: DockingTool
  
  Returns true if tool is visible.
  
  Specified by:
  
  isVisible in interface DockingTool
  
  Overrides:
  
  isVisible in class AbstractDockingTool
- setVisible
```
public void setVisible(boolean visibility)
```
  Description copied from interface: DockingTool
  
  Sets the tool visible or invisible. This method is used by the Project to make it's tools visible or invisible depending on whether this tool is in is the active workspace.
  
  Specified by:
  
  setVisible in interface DockingTool
  
  Overrides:
  
  setVisible in class AbstractDockingTool
  
  Parameters:
  
  visibility - true specifies that the tool should be visible
  
  See Also:
  
  DockingTool.setVisible(boolean)
- toFront
```
public void toFront()
```
  Description copied from interface: DockingTool
  
  Brings this tool to the front. Places this tool at the top of the stacking order and shows it in front of any other tools.
  
  Specified by:
  
  toFront in interface DockingTool
  
  Overrides:
  
  toFront in class AbstractDockingTool
- getToolFrame
```
public javax.swing.JFrame getToolFrame()
```
  Returns the tool's frame
  
  Overrides:
  
  getToolFrame in class AbstractDockingTool
  
  Returns:
  
  the tool's frame
- isService
```
public boolean isService(java.lang.Class<?> serviceInterface)
```
  Returns true if the specified serviceInterface is a valid service that exists in this tool.
  
  Parameters:
  
  serviceInterface - the service interface
  
  Returns:
  
  true if the specified serviceInterface
- getService
```
public <T> T getService(java.lang.Class<T> c)
```
  Description copied from interface: ServiceProvider
  
  Returns the Service object that implements the given service interface.
  
  Specified by:
  
  getService in interface ServiceProvider
  
  Parameters:
  
  c - the interface class.
- getServices
```
public <T> T[] getServices(java.lang.Class<T> c)
```
  Get the objects that implement the given service.
  
  Parameters:
  
  c - service class
  
  Returns:
  
  array of Objects that implement the service, c.
- addServiceListener
```
public void addServiceListener(ServiceListener listener)
```
  Description copied from interface: ServiceProvider
  
  Adds a listener that will be called as services are added and removed from this ServiceProvider.
  
  Specified by:
  
  addServiceListener in interface ServiceProvider
  
  Parameters:
  
  listener - The listener to add.
- removeServiceListener
```
public void removeServiceListener(ServiceListener listener)
```
  Description copied from interface: ServiceProvider
  
  Removes the given listener from this ServiceProvider. This method does nothing if the given listener is not contained by this ServiceProvider.
  
  Specified by:
  
  removeServiceListener in interface ServiceProvider
- setStatusInfo
```
public void setStatusInfo(java.lang.String text,
                          boolean beep)
```
  Set the status information.
  
  Parameters:
  
  text - string to be displayed in the Status display area
  
  beep - whether to be or not
- setStatusInfo
```
public void setStatusInfo(java.lang.String text)
```
  Description copied from interface: DockingTool
  
  Set the status information
  
  Specified by:
  
  setStatusInfo in interface DockingTool
  
  Overrides:
  
  setStatusInfo in class AbstractDockingTool
  
  Parameters:
  
  text - string to be displayed in the Status display area
- clearStatusInfo
```
public void clearStatusInfo()
```
  Clear the status information.
- setDefaultComponent
```
public void setDefaultComponent(ComponentProvider provider)
```
  Sets the provider that should get the default focus when no component has focus.
  
  Parameters:
  
  provider - the provider that should get the default focus when no component has focus.
- getToolTemplate
```
public ToolTemplate getToolTemplate(boolean includeConfigState)
```
  Description copied from interface: Tool
  
  Returns a ToolTemplate for this Tool that describes the state of the tool.
  
  Specified by:
  
  getToolTemplate in interface Tool
  
  Returns:
  
  a ToolTemplate for this Tool that describes the state of the tool.
- saveToolToToolTemplate
```
public ToolTemplate saveToolToToolTemplate()
```
  Description copied from interface: Tool
  
  Save the tool and return its state as a ToolTemplate. Forces a complete regeneration of the tool template.
  
  Specified by:
  
  saveToolToToolTemplate in interface Tool
  
  Returns:
  
  a toolTemplate for this tool.
- saveWindowingDataToXml
```
public org.jdom.Element saveWindowingDataToXml()
```
  Description copied from interface: Tool
  
  Saves the tool's Docking Window layout and positioning information to an XML element.
  
  Specified by:
  
  saveWindowingDataToXml in interface Tool
  
  Returns:
  
  the element containing the DockingWindow's layout information.
- restoreWindowingDataFromXml
```
public void restoreWindowingDataFromXml(org.jdom.Element windowData)
```
  Description copied from interface: Tool
  
  Restores the tool's Docking Window layout and positioning information from an XML element.
  
  Specified by:
  
  restoreWindowingDataFromXml in interface Tool
  
  Parameters:
  
  windowData - the element containing the information.
- acceptDomainFiles
```
public boolean acceptDomainFiles(DomainFile[] data)
```
  Description copied from interface: Tool
  
  When the user drags a data file onto a tool, an event will be fired that the tool will respond to by accepting the data.
  
  Specified by:
  
  acceptDomainFiles in interface Tool
  
  Parameters:
  
  data - the data to be used by the running tool
- addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener l)
```
  Description copied from interface: Tool
  
  Add property change listener.
  
  Specified by:
  
  addPropertyChangeListener in interface Tool
- addToolListener
```
public void addToolListener(ToolListener listener)
```
  Description copied from interface: Tool
  
  Adds a ToolListener to be notified for any of a Tool's ToolEvents. The listener will be notified of any events that this tool generates.
  
  Specified by:
  
  addToolListener in interface Tool
  
  Parameters:
  
  listener - ToolListener to be added to receive all events
- hasToolListeners
```
public boolean hasToolListeners()
```
  Returns true if there is at least one tool listening to this tool's plugin events.
- exit
```
public void exit()
```
  Description copied from interface: Tool
  
  Tells the tool to stop functioning and release its resources. The tool should dispose of all its windows and other resources.
  
  Specified by:
  
  exit in interface Tool
- dispose NEW
```
protected void dispose()
```
- firePluginEvent
```
public void firePluginEvent(PluginEvent event)
```
  Description copied from interface: Tool
  
  Fire the plugin event by notifying the event manager which calls the listeners.
  
  Specified by:
  
  firePluginEvent in interface Tool
  
  Parameters:
  
  event - plugin event
- getConsumedToolEventNames
```
public java.lang.String[] getConsumedToolEventNames()
```
  Description copied from interface: Tool
  
  Returns a list of eventNames that this Tool is interested in.
  
  Specified by:
  
  getConsumedToolEventNames in interface Tool
- getDomainFiles
```
public DomainFile[] getDomainFiles()
```
  Description copied from interface: Tool
  
  Get the domain files that this tool currently has open.
  
  Specified by:
  
  getDomainFiles in interface Tool
- getIcon
```
public javax.swing.ImageIcon getIcon()
```
  Description copied from interface: DockingTool
  
  Get the icon that the tool is using.
  
  Specified by:
  
  getIcon in interface DockingTool
- getIconURL
```
public ToolIconURL getIconURL()
```
  Description copied from interface: Tool
  
  Get the url for the icon that this tool is using.
  
  Specified by:
  
  getIconURL in interface Tool
- getInstanceName
```
public java.lang.String getInstanceName()
```
  Description copied from interface: Tool
  
  Returns the tool's unique name.
  
  Specified by:
  
  getInstanceName in interface Tool
- getName
```
public java.lang.String getName()
```
  Description copied from interface: DockingTool
  
  Returns a combination of the tool name and the instance name of the form tool name(instance name), e.g., SomeTool(2)
  
  Specified by:
  
  getName in interface DockingTool
- getSupportedDataTypes
```
public java.lang.Class<?>[] getSupportedDataTypes()
```
  Description copied from interface: Tool
  
  Get the classes of the data types that this tool supports, i.e., what data types can be dropped onto this tool.
  
  Specified by:
  
  getSupportedDataTypes in interface Tool
- getToolEventNames
```
public java.lang.String[] getToolEventNames()
```
  Description copied from interface: Tool
  
  Returns the names of all the possible ToolEvents that this tool might generate. Used by the ConnectionManager to connect tools together.
  
  Specified by:
  
  getToolEventNames in interface Tool
- getToolName
```
public java.lang.String getToolName()
```
  Description copied from interface: Tool
  
  Returns the name associated with the tool
  
  Specified by:
  
  getToolName in interface Tool
- putInstanceName
```
public void putInstanceName(java.lang.String newInstanceName)
```
  Description copied from interface: Tool
  
  Associates a unique(within the active project) name to a tool instance.
  
  Specified by:
  
  putInstanceName in interface Tool
  
  Parameters:
  
  newInstanceName - unique tool instance name
- removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener l)
```
  Description copied from interface: Tool
  
  Remove property change listener.
  
  Specified by:
  
  removePropertyChangeListener in interface Tool
- removeToolListener
```
public void removeToolListener(ToolListener listener)
```
  Description copied from interface: Tool
  
  Removes a ToolListener from receiving any event generated by this Tool. The tool will still recieve specific events that it has registered for.
  
  Specified by:
  
  removeToolListener in interface Tool
  
  Parameters:
  
  listener - The ToolListener to be removed from receiving all events.
- restoreDataStateFromXml
```
public void restoreDataStateFromXml(org.jdom.Element root)
```
  Description copied from interface: Tool
  
  Tells tool to read its data state from the given input stream.
  
  Specified by:
  
  restoreDataStateFromXml in interface Tool
  
  Parameters:
  
  root - XML data state
- saveDataStateToXml
```
public org.jdom.Element saveDataStateToXml(boolean savingProject)
```
  Description copied from interface: Tool
  
  Tells tool to write its data state from the given output stream.
  
  Specified by:
  
  saveDataStateToXml in interface Tool
  
  Parameters:
  
  savingProject - true if saving the toolstate is for a potential undo/redo (database transaction)
- restoreFromXml NEW
```
protected boolean restoreFromXml(org.jdom.Element root)
```
- saveToXml
```
public org.jdom.Element saveToXml(boolean includeConfigState)
```
  Specified by:
  
  saveToXml in interface Tool
- setConfigChanged
```
public void setConfigChanged(boolean changed)
```
  Description copied from interface: DockingTool
  
  Toggles the "change" state of the tool...
  
  Specified by:
  
  setConfigChanged in interface DockingTool
  
  Overrides:
  
  setConfigChanged in class AbstractDockingTool
  
  Parameters:
  
  changed - true indicates that the tool config has changed.
- setIconURL
```
public void setIconURL(ToolIconURL newIconURL)
```
  Description copied from interface: Tool
  
  Set the icon for this tool.
  
  Specified by:
  
  setIconURL in interface Tool
  
  Parameters:
  
  newIconURL - icon location
- setToolName
```
public void setToolName(java.lang.String name)
```
  Description copied from interface: Tool
  
  Sets the type name of the tool.
  
  Specified by:
  
  setToolName in interface Tool
  
  Parameters:
  
  name - the basename to use when setting the tool's name
- processToolEvent
```
public void processToolEvent(PluginEvent toolEvent)
```
  Description copied from interface: ToolListener
  
  This method is invoked when the registered ToolEvent event occurs.
  
  Specified by:
  
  processToolEvent in interface ToolListener
  
  Parameters:
  
  toolEvent - The cross-tool PluginEvent.
- execute
```
public boolean execute(Command command,
                       DomainObject obj)
```
  Call the applyTo() method on the given command to make some change to the domain object; the command is done in the AWT thread, therefore, the command that is to be executed should be a relatively quick operation so that the event queue does not appear to "hang." For lengthy operations, the command should be done in a background task.
  
  Parameters:
  
  command - command to apply
  
  obj - domain object that the command will be applied to
  
  Returns:
  
  status of the command's applyTo() method
  
  See Also:
  
  executeBackgroundCommand(BackgroundCommand, UndoableDomainObject)
- isExecutingCommand
```
public boolean isExecutingCommand()
```
  Return whether there is a command being executed.
- threadIsBackgroundTaskThread
```
public boolean threadIsBackgroundTaskThread()
```
  Returns:
  
  true if the current thread group or its ancestors is a member of this tools background task thread group, else false
- executeBackgroundCommand
```
public void executeBackgroundCommand(BackgroundCommand cmd,
                                     UndoableDomainObject obj)
```
  Start a new thread that will call the given command's applyTo() method to make some change in the domain object. This method should be called for an operation that could potentially take a long time to complete.
  
  Parameters:
  
  cmd - command that will be executed in another thread (not the AWT Thread)
  
  obj - domain object that the command will be applied to
- terminateBackgroundCommands
```
public void terminateBackgroundCommands(boolean wait)
```
  Cancel any running command and clear the command queue.
  
  Parameters:
  
  wait - if true wait for current task to cancel cleanly
- scheduleFollowOnCommand
```
public void scheduleFollowOnCommand(BackgroundCommand cmd,
                                    UndoableDomainObject obj)
```
  Add the given background command to a queue that is processed after the main background command completes.
  
  Parameters:
  
  cmd - background command to submit
  
  obj - the domain object to be modified by the command.
- getOptions
```
public ToolOptions getOptions(java.lang.String categoryName)
```
  Get the options for the given category name; if no options exist with the given name, then one is created.
  
  Specified by:
  
  getOptions in interface DockingTool
- registerOptionsNameChange
```
public void registerOptionsNameChange(java.lang.String oldName,
                                      java.lang.String newName)
```
  Updates saved options from an old name to a new name. NOTE: this must be called before any calls to register or get options.
  
  Parameters:
  
  oldName - the old name of the options.
  
  newName - the new name of the options.
- hasOptions
```
public boolean hasOptions(java.lang.String category)
```
  Return true if there is an options category with the given name
  
  Parameters:
  
  category - name of the options set
  
  Returns:
  
  true if there is an options category with the given name
- getOptions
```
public ToolOptions[] getOptions()
```
  Get all options.
  
  Returns:
  
  zero-length array if no options exist.
- execute
```
public void execute(Task task,
                    int delay)
```
  Launch the task in a new thread.
  
  Parameters:
  
  task - task to run in a new thread
  
  delay - number of milliseconds to delay the display of task monitor dialog
- execute
```
public void execute(Task task)
```
  Launch the task in a new thread.
  
  Parameters:
  
  task - task to run in a new thread
- getProject
```
public Project getProject()
```
  Get the project associated with this tool. Null will be returned if there is no project open or if this tool does not use projects.
  
  Returns:
  
  null if there is no open project
- getProjectManager
```
public ProjectManager getProjectManager()
```
  Returns the project manager associated with this tool.
  Null will be returned if this tool does not use projects.
  
  Returns:
  
  the project manager associated with this tool
- getToolServices
```
public ToolServices getToolServices()
```
  Returns an object that provides fundamental services that plugins can use.
- setSubTitle
```
public void setSubTitle(java.lang.String subTitle)
```
  Sets the subtitle on the tool; the subtitle is extra text in the title.
  
  Parameters:
  
  subTitle - the subtitle to display on the tool
- addPlugin
```
public void addPlugin(java.lang.String className)
               throws PluginException
```
  Add a plugin to the tool.
  
  Parameters:
  
  className - name of the plugin class, e.g., "MyPlugin.class.getName()"
  
  Throws:
  
  PluginException - if the plugin could not be constructed, or there was problem executing its init() method, or if a plugin of this class already exists in the tool
- addPlugins
```
public void addPlugins(java.lang.String[] classNames)
                throws PluginException
```
  Add plugins to the tool.
  
  Parameters:
  
  classNames - array of plugin class names
  
  Throws:
  
  PluginException - if a plugin could not be constructed, or there was problem executing its init() method, or if a plugin of this class already exists in the tool
- addPlugin
```
public void addPlugin(Plugin p)
               throws PluginException
```
  Throws:
  
  PluginException
- hasUnsavedData
```
public boolean hasUnsavedData()
```
- removePlugins
```
public void removePlugins(Plugin[] plugins)
```
  Remove the array of plugins from the tool.
  
  Parameters:
  
  plugins - array of plugins to remove
- getManagedPlugins
```
public java.util.List<Plugin> getManagedPlugins()
```
  Return a list of plugins in the tool
  
  Returns:
  
  list of plugins in the tool
- saveTool
```
public void saveTool()
```
  Save this tool's configuration.
- saveToolAs
```
public boolean saveToolAs()
```
  Triggers a 'Save As' dialog that allows the user to save off the tool under a different name. This returns true if the user performed a save.
- addStatusComponent
```
public void addStatusComponent(javax.swing.JComponent c,
                               boolean addBorder,
                               boolean rightSide)
```
  Add a status component to the tool.
  
  Parameters:
  
  c - component to add
  
  addBorder - true if a border should be added to the component
  
  rightSide - true if the component should be placed in the right side of the tool
- removeStatusComponent
```
public void removeStatusComponent(javax.swing.JComponent c)
```
  Remove the status component.
  
  Parameters:
  
  c - status component to remove
- getDockingActionsByFullActionName
```
public java.util.List<DockingActionIf> getDockingActionsByFullActionName(java.lang.String fullActionName)
```
  Description copied from interface: DockingTool
  
  Return an list of actions with the given full name
  
  Specified by:
  
  getDockingActionsByFullActionName in interface DockingTool
  
  Overrides:
  
  getDockingActionsByFullActionName in class AbstractDockingTool
  
  Parameters:
  
  fullActionName - action name that includes the owner's name in parentheses, e.g. "MyAction (MyPlugin)"
  
  Returns:
  
  the actions
- getDockingActionsByOwnerName
```
public java.util.List<DockingActionIf> getDockingActionsByOwnerName(java.lang.String owner)
```
  Description copied from interface: DockingTool
  
  Returns all actions for the given owner
  
  Specified by:
  
  getDockingActionsByOwnerName in interface DockingTool
  
  Overrides:
  
  getDockingActionsByOwnerName in class AbstractDockingTool
  
  Parameters:
  
  owner - the action owner's name
  
  Returns:
  
  the actions
- getAllActions
```
public java.util.List<DockingActionIf> getAllActions()
```
  Description copied from interface: DockingTool
  
  Return a list of all actions in the tool.
  
  Specified by:
  
  getAllActions in interface DockingTool
  
  Overrides:
  
  getAllActions in class AbstractDockingTool
  
  Returns:
  
  list of all actions
- removeLocalAction
```
public void removeLocalAction(ComponentProvider provider,
                              DockingActionIf action)
```
  Description copied from interface: DockingTool
  
  Removes the action from the provider
  
  Specified by:
  
  removeLocalAction in interface DockingTool
  
  Overrides:
  
  removeLocalAction in class AbstractDockingTool
  
  Parameters:
  
  provider - the component provider from which to remove the action.
  
  action - the action to remove.
- addExitAction NEW
```
protected void addExitAction()
```
- addOptionsAction NEW
```
protected void addOptionsAction()
```
- addSaveToolAction NEW
```
protected void addSaveToolAction()
```
- addExportToolAction NEW
```
protected void addExportToolAction()
```
- addHelpActions NEW
```
protected void addHelpActions()
```
- clearLastEvents
```
public void clearLastEvents()
```
  Clear the list of events that were last generated.
- getPopupActions
```
public java.util.List<DockingActionIf> getPopupActions(ActionContext context)
```
  Description copied from interface: DockWinListener
  
  Provides notification when a popup menu is about to be displayed and permits a list of temporary actions to be returned. Only those actions which have a suitable popup menu path will be considered.
  
  Specified by:
  
  getPopupActions in interface DockWinListener
  
  Parameters:
  
  context - the ActionContext
  
  Returns:
  
  list of temporary actions.
- close
```
public void close()
```
  Close this tool:
  1. if there are no tasks running.
  2. resolve the state of any plugins so they can be closed.
  3. Prompt the user to save any changes.
  4. close all associated plugins (this closes the domain object if one is open).
  5. pop up dialog to save the configuration if it has changed.
  6. notify the project tool services that this tool is going away.
  Specified by:
  
  close in interface DockWinListener
  
  Specified by:
  
  close in interface Tool
- shouldSave
```
public boolean shouldSave()
```
  Description copied from interface: Tool
  
  Returns true if this tool should save its data, based upon its changed state and the state of Ghidra's saving method.
  
  Specified by:
  
  shouldSave in interface Tool
  
  Returns:
  
  true if this tool should save its data
- doSaveTool NEW
```
protected boolean doSaveTool()
```
  Called when it is time to save the tool. Handles auto-saving logic.
- canClose
```
public boolean canClose(boolean isExiting)
```
  Can this tool be closed?
  Note: This forces plugins to terminate any tasks they have running and apply any unsaved data to domain objects or files. If they can't do this or the user cancels then this returns false.
  
  Specified by:
  
  canClose in interface Tool
  
  Parameters:
  
  isExiting - true if all of Ghidra is closing, false if just this tool is closing.
  
  Returns:
  
  false if this tool has tasks in progress or can't be closed since the user has unfinished/unsaved changes.
- canCloseDomainObject
```
public boolean canCloseDomainObject(DomainObject dObj)
```
  Can the domain object be closed?
  Note: This forces plugins to terminate any tasks they have running for the indicated domain object and apply any unsaved data to the domain object. If they can't do this or the user cancels then this returns false.
  
  Returns:
  
  false any of the plugins reports that the domain object should not be closed
- canCloseDomainFile
```
public boolean canCloseDomainFile(DomainFile domainFile)
```
  Description copied from interface: Tool
  
  Can the domain File be closed?
  Note: This forces plugins to terminate any tasks they have running for the indicated domain object and apply any unsaved data to the domain object. If they can't do this or the user cancels then this returns false.
  
  Specified by:
  
  canCloseDomainFile in interface Tool
  
  Returns:
  
  false any of the plugins reports that the domain object should not be closed
- prepareToSave
```
public void prepareToSave(DomainObject dobj)
```
  Called when the domain object is about to be saved; this allows any plugin that has a cache to flush out to the domain object.
  
  Parameters:
  
  dobj - domain object that is about to be saved
- setSize
```
public void setSize(int width,
                    int height)
```
  Sets the size of the tool's main window
  
  Parameters:
  
  width - width in pixels
  
  height - height in pixels
- getSize
```
public java.awt.Dimension getSize()
```
  Return the dimension of this tool's frame.
  
  Returns:
  
  dimension of this tool's frame
- setLocation
```
public void setLocation(int x,
                        int y)
```
  Set the location of this tool's frame on the screen.
  
  Parameters:
  
  x - screen x coordinate
  
  y - screen y coordinate
- getLocation
```
public java.awt.Point getLocation()
```
  Return the location of this tool's frame on the screen.
  
  Returns:
  
  location of this tool's frame
- restoreOptionsFromXml NEW
```
protected void restoreOptionsFromXml(org.jdom.Element root)
```
- setProject NEW
```
protected void setProject(Project project)
```
- restorePluginsFromXml NEW
```
protected void restorePluginsFromXml(org.jdom.Element elem)
                              throws PluginException
```
  Throws:
  
  PluginException
- addListenerForAllPluginEvents
```
public void addListenerForAllPluginEvents(PluginEventListener listener)
```
- removeListenerForAllPluginEvents
```
public void removeListenerForAllPluginEvents(PluginEventListener listener)
```
- showEditWindow
```
public void showEditWindow(java.lang.String defaultText,
                           java.awt.Component comp,
                           java.awt.Rectangle rect,
                           EditListener listener)
```
  Display an text edit box on top of the specified component.
  
  Parameters:
  
  defaultText - initial text to be displayed in edit box
  
  comp - component over which the edit box will be placed
  
  rect - specifies the bounds of the edit box relative to the component. The height is ignored. The default text field height is used as the preferred height.
  
  listener - when the edit is complete, this listener is notified with the new text. The edit box is dismissed prior to notifying the listener.
- setMenuGroup
```
public void setMenuGroup(java.lang.String[] menuPath,
                         java.lang.String group)
```
  Set the menu group associated with a cascaded submenu. This allows a cascading menu item to be grouped with a specific set of actions. The default group for a cascaded submenu is the name of the submenu.
  
  Parameters:
  
  menuPath - menu name path where the last element corresponds to the specified group name.
  
  group - group name
  
  See Also:
  
  setMenuGroup(String[], String, String)
- setMenuGroup
```
public void setMenuGroup(java.lang.String[] menuPath,
                         java.lang.String group,
                         java.lang.String menuSubGroup)
```
  Set the menu group associated with a cascaded submenu. This allows a cascading menu item to be grouped with a specific set of actions.
  The default group for a cascaded submenu is the name of the submenu.
  
  Parameters:
  
  menuPath - menu name path where the last element corresponds to the specified group name.
  
  group - group name
  
  menuSubGroup - the name used to sort the cascaded menu within other menu items at its level
- cancelCurrentTask
```
public void cancelCurrentTask()
```
  Cancel the current task in the tool.
- getTransientState
```
public TransientToolState getTransientState()
```
- getUndoRedoToolState
```
public UndoRedoToolState getUndoRedoToolState(DomainObject domainObject)
```
- showDialog
```
public void showDialog(DialogComponentProvider dialogComponent)
```
  Shows the dialog using the active top-level window (often the tool's root frame) as a parent. Also, remembers any size and location adjustments made by the user for the next time the dialog is shown.
  
  Specified by:
  
  showDialog in interface DockingTool
  
  Overrides:
  
  showDialog in class AbstractDockingTool
  
  Parameters:
  
  dialogComponent - the DialogComponentProvider object to be shown in a dialog.
- showDialogOnActiveWindow
```
public void showDialogOnActiveWindow(DialogComponentProvider dialogComponent)
```
  Shows the dialog using the tool's currently active window as a parent. Also, remembers any size and location adjustments made by the user for the next time the dialog is shown.
  
  Parameters:
  
  dialogComponent - the DialogComponentProvider object to be shown in a dialog.
- showDialog
```
public void showDialog(DialogComponentProvider dialogComponent,
                       ComponentProvider centeredOnProvider)
```
  Shows the dialog using the window containing the given componentProvider as its parent window. Remembers the last location and size of this dialog for the next time it is shown.
  
  Parameters:
  
  dialogComponent - the DialogComponentProvider object to be shown in a dialog.
  
  centeredOnProvider - the component provider that is used to find a parent window for this dialog. The dialog is centered on this component provider's component.
- showDialog
```
public void showDialog(DialogComponentProvider dialogComponent,
                       java.awt.Component centeredOnComponent)
```
  Shows the dialog using the tool's parent frame, but centers the dialog on the given component
  
  Parameters:
  
  dialogComponent - the DialogComponentProvider object to be shown in a dialog.
  
  centeredOnComponent - the component on which to center the dialog.
- getComponentProvider
```
public ComponentProvider getComponentProvider(java.lang.String name)
```
  Returns the ComponentProvider with the given name. If more than one provider exists with the name, one will be returned, but it could be any one of them.
  
  Specified by:
  
  getComponentProvider in interface DockingTool
  
  Overrides:
  
  getComponentProvider in class AbstractDockingTool
  
  Parameters:
  
  name - the name of the provider to return.
  
  Returns:
  
  a provider with the given name, or null if no providers with that name exist.
- getActiveWindow
```
public java.awt.Window getActiveWindow()
```
- getActiveComponentProvider
```
public ComponentProvider getActiveComponentProvider()
```
- contextChanged
```
public void contextChanged(ComponentProvider provider)
```
  Description copied from interface: DockingTool
  
  Signals to the tool that the provider's context has changed. This lets toolbar actions update enablement based on current context.
  
  Specified by:
  
  contextChanged in interface DockingTool
  
  Overrides:
  
  contextChanged in class AbstractDockingTool
  
  Parameters:
  
  provider - the provider whose context changed.
- addContextListener
```
public void addContextListener(DockingContextListener listener)
```
- removeContextListener
```
public void removeContextListener(DockingContextListener listener)
```
- refreshKeybindings
```
public void refreshKeybindings()
```
- setUnconfigurable
```
public void setUnconfigurable()
```
- isConfigurable
```
public boolean isConfigurable()
```
- removePreferenceState
```
public void removePreferenceState(java.lang.String name)
```
- getProviderWindow
```
public java.awt.Window getProviderWindow(ComponentProvider componentProvider)
```
  Description copied from interface: DockingTool
  
  Returns the parent window for the given provider
  
  Specified by:
  
  getProviderWindow in interface DockingTool
  
  Overrides:
  
  getProviderWindow in class AbstractDockingTool
  
  Parameters:
  
  componentProvider - the provider
  
  Returns:
  
  the window

Class PluginTool

Field Summary

Fields inherited from class docking.AbstractDockingTool

Fields inherited from interface ghidra.framework.model.Tool

Constructor Summary

Method Summary

Methods inherited from class docking.AbstractDockingTool

Methods inherited from class java.lang.Object

Methods inherited from interface docking.DockingTool

Field Detail

toolName NEW

manageDialog NEW

extensionTableProvider NEW

iconURL NEW

isDisposed NEW

Constructor Detail

PluginTool

PluginTool

PluginTool

Method Detail

getPluginClassManager

createDockingWindowManager NEW

installHomeButton NEW

initActions NEW

getWindowManager

optionsChanged NEW

setWindowsOnTop

isWindowsOnTop

addPopupListener

getManagePluginsDialog

showConfig

showExtensions

removePopupListener

addAction

addLocalAction

removeAction

addComponentProvider

showComponentHeader

isActive

showComponentProvider

toFront

removeComponentProvider

updateTitle

isVisible

isVisible

setVisible

toFront

getToolFrame

isService

getService

getServices

addServiceListener

removeServiceListener

setStatusInfo

setStatusInfo

clearStatusInfo

setDefaultComponent

getToolTemplate

saveToolToToolTemplate

saveWindowingDataToXml

restoreWindowingDataFromXml

acceptDomainFiles

addPropertyChangeListener

addToolListener

hasToolListeners

exit

dispose NEW

firePluginEvent

getConsumedToolEventNames

getDomainFiles

getIcon

getIconURL

getInstanceName

getName

getSupportedDataTypes

getToolEventNames

getToolName

putInstanceName

removePropertyChangeListener

removeToolListener