Package com.google.gerrit.extensions.webui

Class WebUiPlugin

java.lang.Object
com.google.gerrit.extensions.webui.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:

  • Constructor Details

    • WebUiPlugin

      public WebUiPlugin()

  • Method Details

    • js

      public static final JavaScriptPlugin js(String scriptName)

    • 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.

    • toString

      public String toString()
      Overrides:
      toString in class Object