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 typeE
- the edge typeG
- 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 java.lang.Object implements VisualGraphFeaturette<V,E,G>
A sub-feature that provides a satellite viewer toVisualGraphComponentProvider
sNote: this class installs actions to manipulate the satellite view. For these to be correctly enabled, you must produce
VgActionContext
objects in yourVisualGraphComponentProvider.getActionContext(MouseEvent)
method. Specifically, the context returned must be a type ofVgActionContext
, with theVgActionContext.shouldShowSatelliteActions()
returning true.
-
-
Constructor Summary
Constructors Constructor Description VgSatelliteFeaturette()
-
Method Summary
All Methods Instance Methods Concrete Methods 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 readyvoid
providerClosed(VisualGraphComponentProvider<V,E,G> provider)
Called when the client provider is closedvoid
providerOpened(VisualGraphComponentProvider<V,E,G> provider)
Called when the client provider is openedvoid
readConfigState(SaveState saveState)
Called when the client wishes to restore configuration state.void
remove()
Called when the provider is being disposedvoid
writeConfigState(SaveState saveState)
Called when the client wishes to save configuration state.
-
-
-
Method Detail
-
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 interfaceVisualGraphFeaturette<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 toVisualGraphFeaturette.writeConfigState(SaveState)
.- Specified by:
readConfigState
in interfaceVisualGraphFeaturette<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 interfaceVisualGraphFeaturette<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 interfaceVisualGraphFeaturette<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 interfaceVisualGraphFeaturette<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 interfaceVisualGraphFeaturette<V extends VisualVertex,E extends VisualEdge<V>,G extends VisualGraph<V,E>>
-
-