Widget (Jenkins core 2.357 API)

java.lang.Object
- hudson.widgets.Widget

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

BuildQueueWidget, ExecutorsWidget, HistoryWidget
```
public abstract class Widget
extends Object
implements ExtensionPoint
```
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. In this view, "it" points to the Widget and "view" points to View that's rendering the widget.
TODO: - make Widget describable and provide the UI to let admin configure widgets? - backward compatibility implications?
Since:

1.146

Author:

Kohsuke Kawaguchi

See Also:

Jenkins.getWidgets()

- Nested Class Summary
  - Nested classes/interfaces inherited from interface hudson.ExtensionPoint
    ExtensionPoint.LegacyInstancesAreScopedToHudson
- Constructor Summary
  
  Constructors
  Constructor Description
  
  Widget()
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  String getUrlName()
  Gets the URL path name.
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Widget
```
public Widget()
```
- Method Detail
  - getUrlName
```
public String getUrlName()
```
    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 Widgets. The default implementation returns the unqualified class name.