Class WebUiPlugin

  • Direct Known Subclasses:
    JavaScriptPlugin

    public abstract class WebUiPlugin
    extends Object
    Specifies JavaScript to dynamically load into the web UI.

    To automatically register (instead of writing a Guice module), declare the intention with @Listen, extend the correct class and define a constructor to configure the correct resource:

     @Listen
     class MyJs extends JavaScriptPlugin {
       MyJs() {
         super("hello.js");
       }
     }
     
    See Also:
    JavaScriptPlugin
    • Constructor Detail

      • WebUiPlugin

        public WebUiPlugin()
    • Method Detail

      • getPluginName

        public final String getPluginName()
        Returns:
        installed name of the plugin that provides this UI feature.
      • getJavaScriptResourcePath

        public abstract String getJavaScriptResourcePath()
        Returns:
        path to initialization script within the plugin's JAR.