jenkins.plugins.ui_samples
Class UISample

java.lang.Object
  jenkins.plugins.ui_samples.UISample

All Implemented Interfaces:

ExtensionPoint, Action, Describable<UISample>, ModelObject

Direct Known Subclasses:

AutoCompleteTextBox, DropdownList, DynamicComboBox, DynamicDropDownListBox, InpageNavigationWithBreadcrumb, JavaScriptProxy, ModularizeViewScript, NavigationContextMenu, NotificationBar, ProgressBar, SyntaxHighlightedTextArea

public abstract class UISample
extends Object
implements ExtensionPoint, Action, Describable<UISample>

Author:

Kohsuke Kawaguchi

Nested Class Summary

class

UISample.SourceFile

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

UISample()

Method Summary

static ExtensionList<UISample>	all() Returns all the registered UISamples.
void	doSourceFile(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Binds UISample.SourceFiles into URL.
abstract String	getDescription() Returns a paragraph of natural text that describes this sample.
UISampleDescriptor	getDescriptor()
String	getDisplayName() Default display name.
String	getIconFileName()
List<UISample.SourceFile>	getSourceFiles() Source files associated with this sample.
String	getUrlName()

Methods inherited from class java.lang.Object

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

Constructor Detail

UISample

public UISample()

Method Detail

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action

getDisplayName

public String getDisplayName()

Default display name.

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getSourceFiles

public List<UISample.SourceFile> getSourceFiles()

Source files associated with this sample.

doSourceFile

public void doSourceFile(org.kohsuke.stapler.StaplerRequest req,
                         org.kohsuke.stapler.StaplerResponse rsp)
                  throws IOException

Binds UISample.SourceFiles into URL.

Throws:

IOException

getDescription

public abstract String getDescription()

Returns a paragraph of natural text that describes this sample. Interpreted as HTML.

getDescriptor

public UISampleDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<UISample>

all

public static ExtensionList<UISample> all()

Returns all the registered UISamples.