com.cloudbees.plugins.registration

Class DataPoint

java.lang.Object

com.cloudbees.plugins.registration.DataPoint

Direct Known Subclasses:

CloudBeesWidget.StatusLine

public abstract class DataPoint
extends Object

Corresponds to a single line in the "cloudbees" status widget.

Author:

Kohsuke Kawaguchi

See Also:

DataPointContributor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataPoint(String iconFileName)

Method Summary

Methods

Modifier and Type	Method and Description
abstract String	getFormattedValue() The value of the data point in a few words.
String	getIconFileName() Icon name like "foo.png".
String	getIconUrl(org.kohsuke.stapler.StaplerRequest req)
abstract String	getMessage() Title of the data point in a few words.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataPoint

protected DataPoint(String iconFileName)

Method Detail

getIconFileName

public String getIconFileName()

Icon name like "foo.png". Must be 16x16. If the value contains no path portion, it points to the icon inside the cloudbees-registration plugin. If the value starts from '/', it is interpreted as relative to the context path where Jenkins is deployed. If you point to an icon file inside your plugin, don't forget to prepend it with Jenkins.RESOURCE_PATH to benefit from caching. Otherwise the value is interpreted as an absolute URL.

getIconUrl

public String getIconUrl(org.kohsuke.stapler.StaplerRequest req)

getMessage

public abstract String getMessage()

Title of the data point in a few words. The casing should be "Something Like This". This value is shown to the left column.

getFormattedValue

public abstract String getFormattedValue()

The value of the data point in a few words. This casing should be "something like this". This value is shown to the right column. To further control the rendering of this in HTML, override data.jelly