Package ghidra.graph.featurette

Class VgSatelliteFeaturette<V extends VisualVertex,E extends VisualEdge<V>,G extends VisualGraph<V,E>>

java.lang.Object

ghidra.graph.featurette.VgSatelliteFeaturette<V,E,G>

Type Parameters:

V - the vertex type

E - the edge type

G - the graph type

All Implemented Interfaces:

VisualGraphFeaturette<V,E,G>

public class VgSatelliteFeaturette<V extends VisualVertex,E extends VisualEdge<V>,G extends VisualGraph<V,E>>
extends Object
implements VisualGraphFeaturette<V,E,G>

A sub-feature that provides a satellite viewer to VisualGraphComponentProviders

Note: this class installs actions to manipulate the satellite view. For these to be correctly enabled, you must produce VgActionContext objects in your VisualGraphComponentProvider.getActionContext(MouseEvent) method. Specifically, the context returned must be a type of VgActionContext, with the VgActionContext.shouldShowSatelliteActions() returning true.

Constructor Summary

Constructors

Constructor	Description
VgSatelliteFeaturette()

Method Summary

Modifier and Type	Method	Description
ComponentProvider	getSatelliteProvider()
void	init(VisualGraphComponentProvider<V,E,G> provider)	Called to initialize this feature when the provider and view are ready
void	providerClosed(VisualGraphComponentProvider<V,E,G> provider)	Called when the client provider is closed
void	providerOpened(VisualGraphComponentProvider<V,E,G> provider)	Called when the client provider is opened
void	readConfigState(SaveState saveState)	Called when the client wishes to restore configuration state.
void	remove()	Called when the provider is being disposed
void	writeConfigState(SaveState saveState)	Called when the client wishes to save configuration state.

Methods inherited from class java.lang.Object

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

Constructor Details

VgSatelliteFeaturette

public VgSatelliteFeaturette()

Method Details

writeConfigState

public void writeConfigState(SaveState saveState)

Description copied from interface: VisualGraphFeaturette

Called when the client wishes to save configuration state. Features can add any state they wish to be persisted over tool launches.

Specified by:

writeConfigState in interface VisualGraphFeaturette<V extends VisualVertex,E extends VisualEdge<V>,G extends VisualGraph<V,E>>

Parameters:

saveState - the container for state information

readConfigState

public void readConfigState(SaveState saveState)

Description copied from interface: VisualGraphFeaturette

Called when the client wishes to restore configuration state. Features can read state previously saved from a call to VisualGraphFeaturette.writeConfigState(SaveState).

Specified by:

readConfigState in interface VisualGraphFeaturette<V extends VisualVertex,E extends VisualEdge<V>,G extends VisualGraph<V,E>>

Parameters:

saveState - the container for state information

init

public void init(VisualGraphComponentProvider<V,E,G> provider)

Description copied from interface: VisualGraphFeaturette

Called to initialize this feature when the provider and view are ready

Specified by:

init in interface VisualGraphFeaturette<V extends VisualVertex,E extends VisualEdge<V>,G extends VisualGraph<V,E>>

Parameters:

provider - the provider associated with this feature

providerOpened

public void providerOpened(VisualGraphComponentProvider<V,E,G> provider)

Description copied from interface: VisualGraphFeaturette

Called when the client provider is opened

Specified by:

providerOpened in interface VisualGraphFeaturette<V extends VisualVertex,E extends VisualEdge<V>,G extends VisualGraph<V,E>>

Parameters:

provider - the provider

providerClosed

public void providerClosed(VisualGraphComponentProvider<V,E,G> provider)

Description copied from interface: VisualGraphFeaturette

Called when the client provider is closed

Specified by:

providerClosed in interface VisualGraphFeaturette<V extends VisualVertex,E extends VisualEdge<V>,G extends VisualGraph<V,E>>

Parameters:

provider - the provider

getSatelliteProvider

public ComponentProvider getSatelliteProvider()

remove

public void remove()

Description copied from interface: VisualGraphFeaturette

Called when the provider is being disposed

Specified by:

remove in interface VisualGraphFeaturette<V extends VisualVertex,E extends VisualEdge<V>,G extends VisualGraph<V,E>>