Package ghidra.framework.plugintool

Class ComponentProviderAdapter

java.lang.Object

docking.ComponentProvider

ghidra.framework.plugintool.ComponentProviderAdapter

All Implemented Interfaces:

ActionContextProvider, HelpDescriptor

Direct Known Subclasses:

ListingComparisonProvider, ListingMergePanelProvider, NavigatableComponentProviderAdapter

public abstract class ComponentProviderAdapter
extends ComponentProvider

Extends the ComponentProvider to fit into the Plugin architecture by taking in a PluginTool which extends DockingTool. Most implementers will want to extend this class instead of the ComponentProvider class because they will want to access the extra methods provided by PluginTool over DockingTool without having to cast the dockingTool variable.

Field Summary

Fields

Change	Modifier and Type	Field	Description
NEW	protected PluginTool	tool

Fields inherited from class docking.ComponentProvider

DEFAULT_WINDOW_GROUP, dockingTool

Constructor Summary

Constructors

Change	Constructor	Description
ComponentProviderAdapter(PluginTool tool, java.lang.String name, java.lang.String owner)	Creates a new component provider with a default location of PluginTool#WINDOW.
ComponentProviderAdapter(PluginTool tool, java.lang.String name, java.lang.String owner, java.lang.Class<?> contextType)	Creates a new component provider with a default location of PluginTool#WINDOW.

Method Summary

Change	Modifier and Type	Method	Description
	PluginTool	getTool()

Methods inherited from class docking.ComponentProvider

addLocalAction, addToTool, closeComponent, componentActivated, componentDeactived, componentHidden, componentShown, contextChanged, getActionContext, getComponent, getContextType, getDefaultWindowPosition, getHelpInfo, getHelpLocation, getHelpObject, getIcon, getInstanceID, getIntraGroupPosition, getMappedName, getMappedOwner, getName, getOwner, getSubTitle, getTabText, getTitle, getWindowGroup, getWindowSubMenuName, initializeInstanceID, isActive, isFocusedProvider, isInTool, isTransient, isVisible, registerProviderNameOwnerChange, removeFromTool, removeLocalAction, requestFocus, setDefaultWindowPosition, setHelpLocation, setIcon, setIntraGroupPosition, setSubTitle, setTabText, setTitle, setTransient, setVisible, setWindowGroup, setWindowMenuGroup, toFront, toString

Methods inherited from class java.lang.Object

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

Field Detail

tool NEW

protected PluginTool tool

Constructor Detail

ComponentProviderAdapter

public ComponentProviderAdapter(PluginTool tool,
                                java.lang.String name,
                                java.lang.String owner)

Creates a new component provider with a default location of PluginTool#WINDOW.

Parameters:

windowMgr - The window manager that will manage and show this provider.

name - The providers name. This is used to group similar providers into a tab within the same window.

owner - The owner of this provider, usually a plugin name.

ComponentProviderAdapter

public ComponentProviderAdapter(PluginTool tool,
                                java.lang.String name,
                                java.lang.String owner,
                                java.lang.Class<?> contextType)

Creates a new component provider with a default location of PluginTool#WINDOW.

Parameters:

windowMgr - The window manager that will manage and show this provider.

name - The providers name. This is used to group similar providers into a tab within the same window.

owner - The owner of this provider, usually a plugin name.

Method Detail

getTool

public PluginTool getTool()

Overrides:

getTool in class ComponentProvider