Package io.jenkins.plugins.designlibrary

Class Home

java.lang.Object

io.jenkins.plugins.designlibrary.Home

All Implemented Interfaces:

ExtensionPoint, Action, ModelObject, RootAction

@Extension
public class Home
extends Object
implements RootAction

Entry point to all the UI samples.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
Home()

Method Summary

Modifier and Type	Method	Description
String	buildGradientVar()	Generates a dynamic gradient for the Home cards
void	doDynamic(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp)
List<UISample>	getAll()
String	getDisplayName()
UISample	getDynamic(String name)	Dynamically retrieves the appropriate UI sample based on the current URL
static Map<Category,List<UISample>>	getGrouped()
String	getIconFileName()
String	getPluginVersion()	Gets the plugin version number for the plugin for the home page
String	getUrlName()
boolean	isPrimaryAction()

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.Action

getEvent, getGroup, getSemantic, isVisibleInContextMenu

Methods inherited from interface hudson.model.RootAction

getBadge

Constructor Details

Home

public Home()

Method Details

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action

isPrimaryAction

public boolean isPrimaryAction()

Specified by:

isPrimaryAction in interface RootAction

getAll

public List<UISample> getAll()

getGrouped

public static Map<Category,List<UISample>> getGrouped()

getDynamic

public UISample getDynamic(String name)

Dynamically retrieves the appropriate UI sample based on the current URL

doDynamic

public void doDynamic(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
               throws IOException

Throws:

IOException

getPluginVersion

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public String getPluginVersion()

Gets the plugin version number for the plugin for the home page

Returns:

the plugin version

buildGradientVar

public String buildGradientVar()

Generates a dynamic gradient for the Home cards