Package jenkins.widgets

Interface HasWidgets

All Known Implementing Classes:
AbstractCloudComputer, AbstractProject, AllView, Computer, ComputerSet, FreeStyleProject, Hudson.MasterComputer, Jenkins.MasterComputer, Job, ListView, MyView, Project, ProxyView, SlaveComputer, View, ViewJob
@StaplerAccessibleType public interface HasWidgets
Classes implementing this interface can have widgets, and they can be accessed using relative urls "widget/widgetName"
Since:
2.410

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Logger
    LOGGER
     

  • Method Summary

    Modifier and Type
    Method
    Description
    default Widget
    getWidget(String name)
    Returns the named widget, or null if it does not exist.
    default List<Widget>
    getWidgets()
     

  • Field Details

    • LOGGER

      static final Logger LOGGER

  • Method Details

    • getWidgets

      default List<Widget> getWidgets()
      Returns:
      the list of widgets attached to the object.

    • getWidget

      @CheckForNull @StaplerDispatchable default Widget getWidget(String name)
      Returns the named widget, or null if it does not exist. Defaults to iterating on widgets and filtering based on the defined urlName.
      Parameters:
      name - the name of the widget within the current context.
      Returns:
      the named widget, or null if it does not exist.