OME
Interface OMEPlugin


public interface OMEPlugin

This interface describes the methods that need to be implemented by any Plugin in OME. A Plugin in OME is a collection of routines (specifically PluginMethods) that get hooked up to the view's GUI. Plugins are the intended place to add framework specific functionality to the tool. Plugins are described in considerable detail in the OME3 PowerUser Manual.

Plugins must also provide the following method:

public static boolean isCompatibleWith(OMEModel model)

This method is called prior to construction of the plugin to determine if it should be used for a particular model. It is not included in the interface proper because Java does not allow for static methods to be placed in interfaces.


Method Summary
 java.util.Collection getMenubarMethods(View v)
          Returns a collection of our PluginMethods that are to be placed on the OME menubar.
 java.util.Collection getPopupMethods(View v)
          Returns a collection of our PluginMethods that are to be placed in the OME popup-menu (when the user clicks the right mouse button).
 java.util.Collection getToolbarMethods(View v)
          Returns a collection of our PluginMethods that are to be placed on the OME toolbar.
 

Method Detail

getToolbarMethods

public java.util.Collection getToolbarMethods(View v)
Returns a collection of our PluginMethods that are to be placed on the OME toolbar.
Parameters:
v - the view been provided

getMenubarMethods

public java.util.Collection getMenubarMethods(View v)
Returns a collection of our PluginMethods that are to be placed on the OME menubar. Presumably these are all menus that will be populated through the getSubmenu() method.
Parameters:
v - the view been provided

getPopupMethods

public java.util.Collection getPopupMethods(View v)
Returns a collection of our PluginMethods that are to be placed in the OME popup-menu (when the user clicks the right mouse button). These methods (and their subMenus) are the only ones that will have their setClicked method called, and this will happen once--prior to the first call to nextParamter().
Parameters:
v - the view been provided