pt.lsts.neptus.plugins

Class PluginMenuUtils

java.lang.Object

pt.lsts.neptus.plugins.PluginMenuUtils

public class PluginMenuUtils
extends java.lang.Object

This class provides utilitary methods to automatically add menus to a console. Any method in the plugin class annotated with NeptusMenuItem is invoked when the menu is activated by the user.

Author:

zp

Constructor Summary

Constructors

Constructor and Description
PluginMenuUtils()

Method Summary

Modifier and Type	Method and Description
static java.util.List<javax.swing.JMenuItem>	addPluginMenus(ConsoleLayout console, java.lang.Object plugin) This method will look for NeptusMenuItem annotatated methods and add them as menus to the console
static void	removePluginMenus(ConsoleLayout console, java.lang.Object plugin) This method will remove the automatically added menus from given plugin
static java.lang.String	translatePath(java.lang.String path)

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginMenuUtils

public PluginMenuUtils()

Method Detail

translatePath

public static java.lang.String translatePath(java.lang.String path)

addPluginMenus

public static java.util.List<javax.swing.JMenuItem> addPluginMenus(ConsoleLayout console,
                                                                   java.lang.Object plugin)

This method will look for NeptusMenuItem annotatated methods and add them as menus to the console

Parameters:

console - The console where to add the menus

plugin - A class with zero or more NeptusMenuItem annotated methods.

Returns:

The menus that were added to the console

removePluginMenus

public static void removePluginMenus(ConsoleLayout console,
                                     java.lang.Object plugin)

This method will remove the automatically added menus from given plugin

Parameters:

console - The console from which to remove the menus

plugin - The plugin from where the menus were added

See Also:

addPluginMenus(ConsoleLayout, Object)