Package ghidra.framework.plugintool

Class NavigatableComponentProviderAdapter

java.lang.Object

docking.ComponentProvider

ghidra.framework.plugintool.ComponentProviderAdapter

ghidra.framework.plugintool.NavigatableComponentProviderAdapter

All Implemented Interfaces:

ActionContextProvider, HelpDescriptor, Navigatable

public abstract class NavigatableComponentProviderAdapter
extends ComponentProviderAdapter
implements Navigatable

Field Summary

Fields inherited from class ghidra.framework.plugintool.ComponentProviderAdapter

tool

Fields inherited from class docking.ComponentProvider

DEFAULT_WINDOW_GROUP, dockingTool

Fields inherited from interface ghidra.app.nav.Navigatable

DEFAULT_NAVIGATABLE_ID

Constructor Summary

Constructors

Constructor	Description
NavigatableComponentProviderAdapter(PluginTool tool, java.lang.String name, java.lang.String owner, java.lang.Class<?> contextType)

Method Summary

Modifier and Type	Method	Description
void	addNavigatableListener(NavigatableRemovalListener listener)	Adds a listener to be notified if this Navigatable is terminated
void	dispose()
javax.swing.Icon	getIcon()	Returns the Icon associated with the component view
javax.swing.Icon	getNavigatableIcon()	Returns an icon that represents this Navigatable
boolean	isConnected()	Returns true if this Navigatable is "connected".
boolean	isDisposed()	Returns true if this navigatable is no longer valid, false if it is still good
void	readDataState(SaveState saveState)
void	removeNavigatableListener(NavigatableRemovalListener listener)	Removes a listener to be notified if this Navigatable is terminated.
protected void	setConnected(boolean newValue)
boolean	supportsMarkers()	Currently only the 'connected' windows support markers
void	writeDataState(SaveState saveState)

Methods inherited from class ghidra.framework.plugintool.ComponentProviderAdapter

getTool

Methods inherited from class docking.ComponentProvider

addLocalAction, addToTool, addToToolbar, closeComponent, componentActivated, componentDeactived, componentHidden, componentShown, contextChanged, createContext, createContext, createContext, getActionContext, getComponent, getContextType, getDefaultWindowPosition, getHelpInfo, getHelpLocation, getHelpObject, getInstanceID, getIntraGroupPosition, getMappedName, getMappedOwner, getName, getOwner, getSubTitle, getTabText, getTitle, getWindowGroup, getWindowSubMenuName, initializeInstanceID, isActive, isFocusedProvider, isInTool, isSnapshot, isTransient, isVisible, registerProviderNameOwnerChange, removeAllLocalActions, removeFromTool, removeLocalAction, requestFocus, setDefaultWindowPosition, setHelpLocation, setIcon, setIntraGroupPosition, setKeyBinding, 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

Methods inherited from interface ghidra.app.nav.Navigatable

getHighlight, getInstanceID, getLocation, getMemento, getProgram, getSelection, getTextSelection, goTo, isVisible, removeHighlightProvider, requestFocus, setHighlight, setHighlightProvider, setMemento, setSelection, supportsHighlight

Constructor Detail

NavigatableComponentProviderAdapter

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

Method Detail

getIcon

public javax.swing.Icon getIcon()

Description copied from class: ComponentProvider

Returns the Icon associated with the component view

Overrides:

getIcon in class ComponentProvider

Returns:

the Icon associated with the component view

getNavigatableIcon

public javax.swing.Icon getNavigatableIcon()

Description copied from interface: Navigatable

Returns an icon that represents this Navigatable

Specified by:

getNavigatableIcon in interface Navigatable

Returns:

the icon

isConnected

public boolean isConnected()

Description copied from interface: Navigatable

Returns true if this Navigatable is "connected". Navigatables are connected if they produce and consume location and selection events.

Specified by:

isConnected in interface Navigatable

Returns:

true if this Navigatable is "connected"

supportsMarkers

public boolean supportsMarkers()

Description copied from interface: Navigatable

Currently only the 'connected' windows support markers

Specified by:

supportsMarkers in interface Navigatable

Returns:

true if this navigatable supports markers

setConnected

protected void setConnected(boolean newValue)

isDisposed

public boolean isDisposed()

Description copied from interface: Navigatable

Returns true if this navigatable is no longer valid, false if it is still good

Specified by:

isDisposed in interface Navigatable

Returns:

true if this navigatable is no longer valid, false if it is still good

dispose

public void dispose()

addNavigatableListener

public void addNavigatableListener(NavigatableRemovalListener listener)

Description copied from interface: Navigatable

Adds a listener to be notified if this Navigatable is terminated

Specified by:

addNavigatableListener in interface Navigatable

Parameters:

listener - the listener to be notified when this Navigatable is closed

removeNavigatableListener

public void removeNavigatableListener(NavigatableRemovalListener listener)

Description copied from interface: Navigatable

Removes a listener to be notified if this Navigatable is terminated.

Specified by:

removeNavigatableListener in interface Navigatable

Parameters:

listener - the listener that no longer should be notified when this Navigatable is closed.

readDataState

public void readDataState(SaveState saveState)

writeDataState

public void writeDataState(SaveState saveState)