Package io.jenkins.plugins.customizable_header

Class CustomHeaderConfiguration

java.lang.Object

hudson.model.Descriptor<GlobalConfiguration>

jenkins.model.GlobalConfiguration

io.jenkins.plugins.customizable_header.CustomHeaderConfiguration

All Implemented Interfaces:

ExtensionPoint, Describable<GlobalConfiguration>, Saveable, Loadable, OnMaster

@Extension
@Symbol("customHeader")
public class CustomHeaderConfiguration
extends GlobalConfiguration

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
CustomHeaderConfiguration()

Method Summary

Modifier and Type	Method	Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)
Logo	defaultLogo()
static CustomHeaderConfiguration	get()
HeaderSelector	getActiveHeader()
HeaderColor	getActiveHeaderColor()	The active header color.
GlobalConfigurationCategory	getCategory()
String	getCssResource()
String	getCssResourceUrl()
List<AppNavLink>	getFavorites()
HeaderSelector	getHeader()
HeaderColor	getHeaderColor()	The globally configured Headercolor.
List<AppNavLink>	getLinks()
Logo	getLogo()
List<Descriptor<Logo>>	getLogoDescriptors()
String	getLogoText()
SystemMessage	getSystemMessage()
String	getTitle()
List<AppNavLink>	getUserLinks()
boolean	hasLinks()
boolean	isEnabled()
boolean	isThinHeader()
Object	readResolve()
void	setCssResource(String cssResource)
void	setEnabled(boolean enabled)
void	setHeader(HeaderSelector header)
void	setHeaderColor(HeaderColor headerColor)
void	setLinks(List<AppNavLink> links)
void	setLogo(Logo logo)
void	setLogoText(String logoText)
void	setSystemMessage(SystemMessage systemMessage)
void	setThinHeader(boolean thinHeader)
void	setTitle(String title)

Methods inherited from class jenkins.model.GlobalConfiguration

all, getDescriptor, getGlobalConfigPage

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, 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

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomHeaderConfiguration

@DataBoundConstructor
public CustomHeaderConfiguration()

Method Detail

getCategory

@NonNull
public GlobalConfigurationCategory getCategory()

Overrides:

getCategory in class Descriptor<GlobalConfiguration>

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                         net.sf.json.JSONObject json)
                  throws Descriptor.FormException

Overrides:

configure in class GlobalConfiguration

Throws:

Descriptor.FormException

readResolve

public Object readResolve()

getFavorites

public List<AppNavLink> getFavorites()

getSystemMessage

public SystemMessage getSystemMessage()

setSystemMessage

@DataBoundSetter
public void setSystemMessage(SystemMessage systemMessage)

getLinks

public List<AppNavLink> getLinks()

setLinks

@DataBoundSetter
public void setLinks(List<AppNavLink> links)

hasLinks

public boolean hasLinks()

getUserLinks

public List<AppNavLink> getUserLinks()

isThinHeader

public boolean isThinHeader()

setThinHeader

@DataBoundSetter
public void setThinHeader(boolean thinHeader)

setHeader

@DataBoundSetter
public void setHeader(HeaderSelector header)

getHeader

public HeaderSelector getHeader()

setEnabled

@DataBoundSetter
public void setEnabled(boolean enabled)

isEnabled

public boolean isEnabled()

setLogo

@DataBoundSetter
public void setLogo(Logo logo)

getLogo

public Logo getLogo()

setHeaderColor

@DataBoundSetter
public void setHeaderColor(HeaderColor headerColor)

getHeaderColor

public HeaderColor getHeaderColor()

The globally configured Headercolor.

Returns:

global headercolor.

getActiveHeaderColor

public HeaderColor getActiveHeaderColor()

The active header color. If the user has overwritten the colors those colors are used.

Returns:

getActiveHeader

public HeaderSelector getActiveHeader()

setLogoText

@DataBoundSetter
public void setLogoText(String logoText)

getLogoText

public String getLogoText()

get

public static CustomHeaderConfiguration get()

getTitle

public String getTitle()

setTitle

@DataBoundSetter
public void setTitle(String title)

getCssResource

public String getCssResource()

setCssResource

@DataBoundSetter
public void setCssResource(String cssResource)

getCssResourceUrl

public String getCssResourceUrl()

defaultLogo

public Logo defaultLogo()

getLogoDescriptors

public List<Descriptor<Logo>> getLogoDescriptors()