Annotation Interface PluginInfo


@Retention(RUNTIME) @Target(TYPE) public @interface PluginInfo
Class Annotation for informing Plan about a plugin.
See Also:
to determine preferred tab ordering if you use s.
  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Name of the plugin, limited to 50 characters.
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Color preference of the plugin.
    Family of Font Awesome icon.
    Name of Font Awesome icon.
  • Element Details

    • name

      String name
      Name of the plugin, limited to 50 characters.
      Returns:
      String of max 50 characters, remainder will be clipped.
    • iconName

      String iconName
      Name of Font Awesome icon.

      See https://fontawesome.com/icons (select 'free')) for icons and their Family.

      Returns:
      Name of the icon, if name is not valid no icon is shown.
      Default:
      "cube"
    • iconFamily

      Family iconFamily
      Family of Font Awesome icon.

      See https://fontawesome.com/icons (select 'free')) for icons and their Family.

      Returns:
      Family that matches an icon, if there is no icon for this family no icon is shown.
      Default:
      SOLID
    • color

      Color color
      Color preference of the plugin.

      This color will be set as the default color to use for plugin's elements.

      Returns:
      Preferred color. If none are specified defaults are used.
      Default:
      NONE