DashboardPortlet (Dashboard View 2.508.va_74654f026d1 API)

java.lang.Object
- hudson.plugins.view.dashboard.DashboardPortlet

All Implemented Interfaces:

ExtensionPoint, Describable<DashboardPortlet>, ModelObject

Direct Known Subclasses:

HudsonStdJobsPortlet, IframePortlet, ImagePortlet, JobsPortlet, LatestBuilds, StatBuilds, StatJobs, StatSlaves, TestStatisticsChart, TestStatisticsPortlet, TestTrendChart, UnstableJobsPortlet
```
public abstract class DashboardPortlet
extends Object
implements ModelObject, Describable<DashboardPortlet>, ExtensionPoint
```
Report that can summarize project data across multiple projects and display the resulting data.

Author:

Peter Hayes

Nested Class Summary
- Nested classes/interfaces inherited from interface hudson.ExtensionPoint
  ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors
Constructor Description

DashboardPortlet(String name)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DescriptorExtensionList<DashboardPortlet,Descriptor<DashboardPortlet>>`	`all()`	Returns all the registered `DashboardPortlet` descriptors.
`static Comparator`	`getComparator()`
`Dashboard`	`getDashboard()`
`Descriptor<DashboardPortlet>`	`getDescriptor()`
`String`	`getDisplayName()`
`String`	`getId()`
`TopLevelItem`	`getJob(String name)`	Support accessing jobs available via view through portlets
`String`	`getName()`
`String`	`getUrl()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DashboardPortlet

public DashboardPortlet(String name)

Method Detail

getId
```
public String getId()
```

getName
```
public String getName()
```

getDashboard
```
public Dashboard getDashboard()
```

getDisplayName
```
public String getDisplayName()
```
Specified by:

getDisplayName in interface ModelObject

getUrl
```
public String getUrl()
```

getJob
```
public TopLevelItem getJob(String name)
```
Support accessing jobs available via view through portlets

getDescriptor
```
public Descriptor<DashboardPortlet> getDescriptor()
```
Specified by:

getDescriptor in interface Describable<DashboardPortlet>

all

public static DescriptorExtensionList<DashboardPortlet,Descriptor<DashboardPortlet>> all()

Returns all the registered DashboardPortlet descriptors.

getComparator

public static Comparator getComparator()