Package ghidra.app.events

Class ProgramLocationPluginEvent

java.lang.Object

ghidra.framework.plugintool.PluginEvent

ghidra.app.events.ProgramLocationPluginEvent

public final class ProgramLocationPluginEvent
extends PluginEvent

This plugin event class provides program location information. The event is fired when a plugin's program location has changed. Typically, a plugin does not actually generate the event unless it is processing some user action, e.g., the user mouse clicks somewhere on a plugin component to cause the program location to change.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	The name of this plugin event.

Fields inherited from class ghidra.framework.plugintool.PluginEvent

EXTERNAL_SOURCE_NAME

Constructor Summary

Constructors

Constructor	Description
ProgramLocationPluginEvent(String src, ProgramLocation loc, Program program)	Construct a new ProgramLocationEvent.

Method Summary

Modifier and Type	Method	Description
protected String	getDetails()
ProgramLocation	getLocation()	Returns the ProgramLocation stored in this event.
Program	getProgram()	Returns the Program object that the location refers to.

Methods inherited from class ghidra.framework.plugintool.PluginEvent

getEventName, getSourceName, getToolEventName, getTriggerEvent, isToolEvent, lookupToolEventName, setSourceName, setTriggerEvent, toString

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

The name of this plugin event.

See Also:

• Constant Field Values

Constructor Details

ProgramLocationPluginEvent

public ProgramLocationPluginEvent(String src,
 ProgramLocation loc,
 Program program)

Construct a new ProgramLocationEvent.

Parameters:

src - the name of the plugin that generated this event.

loc - the ProgramLocation object that contains the new location.

program - the Program for which the loc object refers.

Method Details

getLocation

public ProgramLocation getLocation()

Returns the ProgramLocation stored in this event.

getProgram

public Program getProgram()

Returns the Program object that the location refers to.

getDetails

protected String getDetails()

Overrides:

getDetails in class PluginEvent