Public Member Functions | Package Functions

BinNavi.API.plugins.IGraphMenuPlugin Interface Reference

Used to extend the main menu of graph windows. More...

Inheritance diagram for BinNavi.API.plugins.IGraphMenuPlugin:
BinNavi.API.plugins.IPlugin

List of all members.

Public Member Functions

List< JComponent > extendPluginMenu (GraphFrame graphFrame)
 Extends the graph window plugin menu.
long getGuid ()
 The GUID of the plugin.
String getName ()
 The name of the plugin.
void init (PluginInterface pluginInterface)
 Initializes the plugin.
void unload ()
 Unloads the plugin.

Package Functions

void closed (GraphFrame graphFrame)
 Invoked after a graph closed.
String getDescription ()
 The description of the plugin.

Detailed Description

This interface can be implemented by all plugins that want to extend the main menu of graph windows.


Member Function Documentation

void BinNavi.API.plugins.IGraphMenuPlugin.closed ( GraphFrame  graphFrame  )  [package]

Invoked after a graph frame was closed. This gives the plugin the opportunity to free allocated resources.

Parameters:
graphFrame Frame that was closed.
List<JComponent> BinNavi.API.plugins.IGraphMenuPlugin.extendPluginMenu ( GraphFrame  graphFrame  ) 

Returns the components that should be added to the main menu of the graph window.

Parameters:
graphFrame Frame where the view is shown.
Returns:
A list of components that are added to the plugin menu.
String BinNavi.API.plugins.IPlugin.getDescription (  )  [package, inherited]

Returns a description of the plugin. This description is used in the plugin configuration dialog to let the user know what the plugin does.

Returns:
The description of the plugin.
long BinNavi.API.plugins.IPlugin.getGuid (  )  [inherited]

Returns a unique GUID that identifies the plugin. Plugins with duplicate GUIDs will not be loaded.

Returns:
The GUID that identifies the plugin.
String BinNavi.API.plugins.IPlugin.getName (  )  [inherited]

Returns the name of the plugin. This name is used in the plugin configuration dialog to let the user select what plugin to configure.

Note that plugins that return null from this function will not be loaded.

Returns:
The name of the plugin.
void BinNavi.API.plugins.IPlugin.init ( PluginInterface  pluginInterface  )  [inherited]

The plugin manager calls this function for each plugin right after loading a plugin for the first time.

Note that this function should be used to initialize the plugin. Do not use the constructor of the plugin to initialize plugin.

Further note that all plugins must have a standard constructor that does not take any arguments. Only this constructor is used to load a plugin.

Parameters:
pluginInterface The plugin interface that gives a plugin access to BinNavi.
void BinNavi.API.plugins.IPlugin.unload (  )  [inherited]

This function is called when the plugin is unloaded. Plugins that actively changed the appearance of BinNavi (for example by adding menus or showing dialogs) must remove all changes in this function.