Package io.jenkins.plugins.designlibrary

Class ToggleSwitch

java.lang.Object

io.jenkins.plugins.designlibrary.UISample

io.jenkins.plugins.designlibrary.ToggleSwitch

All Implemented Interfaces:

ExtensionPoint, Action, Describable<UISample>, ModelObject

@Extension
public class ToggleSwitch
extends UISample

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ToggleSwitch.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
ToggleSwitch()

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Provides a description for the UI sample.
String	getDisplayName()	Gets the default display name for the UI sample.
String	getIconFileName()

Methods inherited from class io.jenkins.plugins.designlibrary.UISample

getAll, getCategory, getDescriptor, getGrouped, getNextPage, getPreviousPage, getPrismConfiguration, getSince, getUrlName

Methods inherited from class java.lang.Object

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

Constructor Details

ToggleSwitch

public ToggleSwitch()

Method Details

getDisplayName

@NonNull
public String getDisplayName()

Description copied from class: UISample

Gets the default display name for the UI sample. This is typically the simple class name of the implementing class.

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

Overrides:

getDisplayName in class UISample

Returns:

the display name.

getIconFileName

public String getIconFileName()

getDescription

public String getDescription()

Description copied from class: UISample

Provides a description for the UI sample. The description is displayed at the top of every UI page for the sample.

Specified by:

getDescription in class UISample

Returns:

the description of the UI sample.