Package ghidra.graph.viewer.event.mouse

Interface VisualGraphMousePlugin<V extends VisualVertex,E extends VisualEdge<V>>

Type Parameters:

V - the vertex

E - the edge

All Known Implementing Classes:

VisualGraphAbstractGraphMousePlugin, VisualGraphAnimatedPickingGraphMousePlugin, VisualGraphEdgeSelectionGraphMousePlugin, VisualGraphEventForwardingGraphMousePlugin, VisualGraphHoverMousePlugin, VisualGraphMouseTrackingGraphMousePlugin, VisualGraphPickingGraphMousePlugin, VisualGraphSatelliteAbstractGraphMousePlugin, VisualGraphSatelliteAnimatedPickingGraphMousePlugin, VisualGraphSatelliteEdgeSelectionGraphMousePlugin, VisualGraphSatelliteNavigationGraphMousePlugin, VisualGraphSatelliteScalingGraphMousePlugin, VisualGraphSatelliteTranslatingGraphMousePlugin, VisualGraphScalingGraphMousePlugin, VisualGraphScreenPositioningPlugin, VisualGraphScrollWheelPanningPlugin, VisualGraphTranslatingGraphMousePlugin, VisualGraphZoomingPickingGraphMousePlugin

public interface VisualGraphMousePlugin<V extends VisualVertex,E extends VisualEdge<V>>

An interface to provide a common set of methods for classes that could not otherwise extend an abstract class. This interface signals that the implementer is a VisualGraph mouse plugin.

Note: The implementors of this interface still use the deprecated InputEvent.getModifiers() method, since many of those classes extends from 3rd-party classes that still use them, such as PickingGraphMousePlugin. We will need to update the library (if/when possible), or rewrite our code so that it does not use the old 3rd-party algorithms.

Method Summary

Modifier and Type	Method	Description
default void	dispose()	Signals to perform any cleanup when this plugin is going away
default GraphViewer<V,E>	getGraphViewer(java.awt.event.MouseEvent e)	Returns the primary/master graph viewer.
default SatelliteGraphViewer<V,E>	getSatelliteGraphViewer(java.awt.event.MouseEvent e)	Returns the satellite graph viewer.
default edu.uci.ics.jung.visualization.VisualizationViewer<V,E>	getViewer(java.awt.event.MouseEvent e)
default VisualGraphViewUpdater<V,E>	getViewUpdater(GraphViewer<V,E> viewer)	Returns the updater that is used to modify the primary graph viewer.
default VisualGraphViewUpdater<V,E>	getViewUpdater(java.awt.event.MouseEvent e)	Returns the updater that is used to modify the primary graph viewer.

Method Detail

getViewer

default edu.uci.ics.jung.visualization.VisualizationViewer<V,E> getViewer(java.awt.event.MouseEvent e)

getGraphViewer

default GraphViewer<V,E> getGraphViewer(java.awt.event.MouseEvent e)

Returns the primary/master graph viewer.

Parameters:

e - the mouse event from which to get the viewer

Returns:

the viewer

getSatelliteGraphViewer

default SatelliteGraphViewer<V,E> getSatelliteGraphViewer(java.awt.event.MouseEvent e)

Returns the satellite graph viewer. This assumes that the mouse event originated from the satellite viewer.

Parameters:

e - the mouse event from which to get the viewer

Returns:

the viewer

getViewUpdater

default VisualGraphViewUpdater<V,E> getViewUpdater(java.awt.event.MouseEvent e)

Returns the updater that is used to modify the primary graph viewer.

Parameters:

e - the mouse event from which to get the viewer

Returns:

the updater

getViewUpdater

default VisualGraphViewUpdater<V,E> getViewUpdater(GraphViewer<V,E> viewer)

Returns the updater that is used to modify the primary graph viewer.

Parameters:

viewer - the viewer

Returns:

the updater

dispose

default void dispose()

Signals to perform any cleanup when this plugin is going away