Package io.jenkins.plugins.thememanager
Class ThemeManagerFactoryDescriptor
- java.lang.Object
-
- hudson.model.Descriptor<ThemeManagerFactory>
-
- io.jenkins.plugins.thememanager.ThemeManagerFactoryDescriptor
-
- Direct Known Subclasses:
NoOpThemeManagerFactory.NoOpThemeManagerFactoryDescriptor
public abstract class ThemeManagerFactoryDescriptor extends Descriptor<ThemeManagerFactory>
Definition of a Theme Manager- See Also:
ThemeManagerFactory
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class hudson.model.Descriptor
Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self
-
-
Field Summary
-
Fields inherited from class hudson.model.Descriptor
clazz
-
-
Constructor Summary
Constructors Constructor Description ThemeManagerFactoryDescriptor()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static DescriptorExtensionList<ThemeManagerFactory,ThemeManagerFactoryDescriptor>
all()
All implementations ofThemeManagerFactory
andThemeManagerFactoryDescriptor
.ThemeManagerFactory
getInstance()
String
getThemeCssSuffix()
Name of the theme resource file.abstract String
getThemeId()
A name for a theme pluginString
getThemeJsSuffix()
Name of the theme resource file.String
getThemeKey()
A unique key for a theme pluginboolean
isNamespaced()
If the theme's CSS will only be selected under the '[data-theme=theme-key]' selector-
Methods inherited from class hudson.model.Descriptor
addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap
-
-
-
-
Method Detail
-
getInstance
public ThemeManagerFactory getInstance()
-
getThemeId
public abstract String getThemeId()
A name for a theme pluginThis should be all lower case and URL safe, i.e. 'dark', 'neo2'
The ID can be re-used inside of your plugin if you are serving multiple variations of the theme, i.e. 'Dark', 'Dark (System)' could both be 'dark'.
Used in generating URLs for Jenkins to find your theme files.
- Returns:
- the theme ID.
-
getThemeKey
public String getThemeKey()
A unique key for a theme pluginThis should be all lower case and URL safe, i.e. 'dark-system', 'neo2'
Used in the html dataset namespace for the theme.
- Returns:
- the theme key
-
isNamespaced
public boolean isNamespaced()
If the theme's CSS will only be selected under the '[data-theme=theme-key]' selectorIt will be served on all pages even if not activated, ensure all selectors are behind the dataset selector.
All new themes should be namespaced
- Returns:
- if it's namespaced.
-
getThemeCssSuffix
public String getThemeCssSuffix()
Name of the theme resource file.Used in generating URLs for Jenkins to find your theme files.
- Returns:
- name of the theme resource file.
-
getThemeJsSuffix
public String getThemeJsSuffix()
Name of the theme resource file.Used in generating URLs for Jenkins to find your theme files.
- Returns:
- name of the theme resource file.
-
all
public static DescriptorExtensionList<ThemeManagerFactory,ThemeManagerFactoryDescriptor> all()
All implementations ofThemeManagerFactory
andThemeManagerFactoryDescriptor
.- Returns:
- descriptor extension list containing all themes.
-
-