hudson.widgets.Widget Maven / Gradle / Ivy

Go to download
package hudson.widgets;

import hudson.ExtensionPoint;
import hudson.model.Hudson;

/**
 * Box to be rendered in the side panel.
 *
 * Views
 * 
 * index.jelly should display the widget. It should have:
 *   <l:pane width="2" title="..."> ...body... </l:pane> structure.
 *
 * @author Kohsuke Kawaguchi
 * @since 1.146
 * @see Hudson#getWidgets() 
 */
public abstract class Widget implements ExtensionPoint {
    /**
     * Gets the URL path name.
     *
     * 
     * For example, if this method returns "xyz", and if the parent object
     * (that this widget is associated with) is bound to /foo/bar/zot,
     * then this widget object will be exposed to /foo/bar/zot/xyz.
     *
     * 

     * This method is useful when the widget needs to expose additional URLs,
     * for example for serving AJAX requests.
     *
     * 
     * This method should return a string that's unique among other {@link Widget}s.
     * The default implementation returns the unqualified class name.
     */
    public String getUrlName() {
        return getClass().getSimpleName();
    }
}