Plugin properties

The Plugin.getProperty(Object) is called by the PluginsManager to retrieve the plugin characteristics. The minimum elements to return are:

• PluginElementTypes.PROPERTY_DESC for the description of the Plugin which will be presented in the About menu
• PluginElementTypes.PROPERTY_DATE for the date of the Plugin build
• PluginElementTypes.PROPERTY_VERSION for the version of the Plugin build

Note that if you get the Application description from the configuration

Plugin dependencies

Additionally, the PluginElementTypes.PROPERTY_DEPEND property allow to specify other plugins (by their name) on which the Plugin depend on. It can contain a single String or a List of Strings. If one of the Plugins on which a Plugins depends on is not present or is disabled, the dependent Plugin will be disabled.

Examples

Simple Plugin properties

  public Object getPluginProperty(String prop) {
    if (prop.equals(PluginElementTypes.PROPERTY_DATE)) {
      return "26/07/2016";
    } else if (prop.equals(PluginElementTypes.PROPERTY_DESC)) {
      return "My Plugin description";
    } else if (prop.equals(PluginElementTypes.PROPERTY_VERSION)) {
      return "1.0";
    } else {
      return null;
    }
  }

Example with one dependency

In the following example, the Plugin depend on the "masterPlugin" Plugin:

   public Object getPluginProperty(String prop) {
     if (prop.equals(PluginElementTypes.PROPERTY_DATE)) {
       return "26/07/2016";
     } else if (prop.equals(PluginElementTypes.PROPERTY_DESC)) {
       return "My Plugin description";
     } else if (prop.equals(PluginElementTypes.PROPERTY_VERSION)) {
       return "1.0";
     } else if (prop.equals(PluginElementTypes.PROPERTY_DEPEND)) {
       return "masterPlugin";
     }
   }