com.atlassian.jira.config.properties

Class LookAndFeelBean

java.lang.Object

com.atlassian.jira.config.properties.LookAndFeelBean

public class LookAndFeelBean
extends Object

Bean mainly used to maintain a version number for all the menu colours. This allows us to cache this information until it is updated (i.e.:version number is incremented).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LookAndFeelBean.DefaultColours These are the "intended" colours for the JIRA Header.
static class	LookAndFeelBean.DefaultCommonColours These are the intended colours for the new common Header.
static class	LookAndFeelBean.DefaultFaviconDimensions
static class	LookAndFeelBean.LookAndFeelChangedEvent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LookAndFeelBean(ApplicationProperties applicationProperties)

Method Summary

Modifier and Type	Method and Description
String	getAbsoluteLogoUrl()
String	getApplicationID()
String	getDefaultBackedString(String key)
String	getDefaultBackedString(String key, String defaultValue) Performs a lookup on the application properties for the specified key.
String	getFaviconHeight()
String	getFaviconHiResHeight()
String	getFaviconHiResUrl()
String	getFaviconHiResWidth()
String	getFaviconUrl()
String	getFaviconWidth()
String	getGadgetChromeColor(String id)
String	getHeroButtonBaseBGColour()
String	getHeroButtonTextColour()
static LookAndFeelBean	getInstance(ApplicationProperties ap)
String	getLogoHeight()
String	getLogoPixelHeight()
String	getLogoPixelWidth()
String	getLogoUrl()
String	getLogoWidth()
String	getMenuBackgroundColour()
String	getMenuSeparatorColour()
String	getMenuTxtColour()
String	getSettingsHash()
String	getTextActiveLinkColour()
String	getTextHeadingColour()
String	getTextLinkColour()
String	getTopBackgroundColour()
String	getTopHighlightColor()
String	getTopSeparatorBackgroundColor()
String	getTopTextHighlightColor()
String	getTopTxtColour()
protected String	getValue(com.atlassian.jira.config.properties.LookAndFeelBean.LnF config)
long	getVersion() Deprecated. Since 7.0.0. Use getSettingsHash() to get the state of Look and feel.
boolean	isCommonHeader() Deprecated. in JIRA 6.0 -- the common header is always enabled.
void	setFaviconHiResUrl(String faviconUrl)
void	setFaviconUrl(String faviconUrl)
void	setGadgetChromeColor(String id, String gadgetChromeColor)
void	setHeroButtonBaseBGColour(String heroButtonBaseBGColour)
void	setHeroButtonTextColour(String heroButtonTextColour)
void	setLogoHeight(String logoHeight)
void	setLogoUrl(String logoUrl)
void	setLogoWidth(String logoWidth)
void	setMenuBackgroundColour(String menuBackgroundColour)
void	setMenuSeparatorColour(String menuSeparatorColour)
void	setMenuTxtColour(String menuTxtColour)
void	setTextActiveLinkColour(String textActiveLinkColour)
void	setTextHeadingColour(String textHeadingColour)
void	setTextLinkColour(String textLinkColour)
void	setTopBackgroundColour(String topBackgroundColour)
void	setTopHighlightColor(String newValue)
void	setTopSeparatorBackgroundColor(String newValue)
void	setTopTextHighlightColor(String newValue)
void	setTopTxtColour(String topTxtColour)
String	stripHash(String colour) Deprecated. Since v7.0
String	updateSettingsHash()
void	updateVersion(long oldVersion) Deprecated. Since 7.0.0. Use updateSettingsHash().

Methods inherited from class java.lang.Object

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

Constructor Detail

LookAndFeelBean

protected LookAndFeelBean(ApplicationProperties applicationProperties)

Method Detail

getInstance

public static LookAndFeelBean getInstance(ApplicationProperties ap)

isCommonHeader

@Deprecated
public boolean isCommonHeader()

Deprecated. in JIRA 6.0 -- the common header is always enabled.

Returns:

true

stripHash

@Deprecated
public String stripHash(String colour)

Deprecated. Since v7.0

Parameters:

colour -

Returns:

updateVersion

@Deprecated
public void updateVersion(long oldVersion)

Deprecated. Since 7.0.0. Use updateSettingsHash().

Convenience method used by data import (see JRA-11680) to update version number to the greater version number after the import (to make sure LF values wont be cached).

Parameters:

oldVersion - the previous version

getVersion

@Deprecated
public long getVersion()

Deprecated. Since 7.0.0. Use getSettingsHash() to get the state of Look and feel.

Returns:

1 as we don't track version any more.

updateSettingsHash

@Nonnull
public String updateSettingsHash()

getSettingsHash

@Nonnull
public String getSettingsHash()

getLogoUrl

public String getLogoUrl()

setLogoUrl

public void setLogoUrl(String logoUrl)

getAbsoluteLogoUrl

public String getAbsoluteLogoUrl()

getLogoWidth

public String getLogoWidth()

setLogoWidth

public void setLogoWidth(String logoWidth)

getLogoPixelWidth

public String getLogoPixelWidth()

getLogoHeight

public String getLogoHeight()

setLogoHeight

public void setLogoHeight(String logoHeight)

getLogoPixelHeight

public String getLogoPixelHeight()

getFaviconUrl

public String getFaviconUrl()

setFaviconUrl

public void setFaviconUrl(String faviconUrl)

getFaviconWidth

public String getFaviconWidth()

getFaviconHeight

public String getFaviconHeight()

getFaviconHiResUrl

public String getFaviconHiResUrl()

setFaviconHiResUrl

public void setFaviconHiResUrl(String faviconUrl)

getFaviconHiResWidth

public String getFaviconHiResWidth()

getFaviconHiResHeight

public String getFaviconHiResHeight()

getTopBackgroundColour

public String getTopBackgroundColour()

setTopBackgroundColour

public void setTopBackgroundColour(String topBackgroundColour)

getTopTxtColour

public String getTopTxtColour()

setTopTxtColour

public void setTopTxtColour(String topTxtColour)

getTopHighlightColor

public String getTopHighlightColor()

setTopHighlightColor

public void setTopHighlightColor(String newValue)

getValue

@Nullable
protected String getValue(@Nonnull
                                    com.atlassian.jira.config.properties.LookAndFeelBean.LnF config)

getTopTextHighlightColor

public String getTopTextHighlightColor()

setTopTextHighlightColor

public void setTopTextHighlightColor(String newValue)

getTopSeparatorBackgroundColor

public String getTopSeparatorBackgroundColor()

setTopSeparatorBackgroundColor

public void setTopSeparatorBackgroundColor(String newValue)

getMenuTxtColour

public String getMenuTxtColour()

setMenuTxtColour

public void setMenuTxtColour(String menuTxtColour)

getMenuBackgroundColour

public String getMenuBackgroundColour()

setMenuBackgroundColour

public void setMenuBackgroundColour(String menuBackgroundColour)

getMenuSeparatorColour

public String getMenuSeparatorColour()

setMenuSeparatorColour

public void setMenuSeparatorColour(String menuSeparatorColour)

getTextHeadingColour

public String getTextHeadingColour()

setTextHeadingColour

public void setTextHeadingColour(String textHeadingColour)

getTextLinkColour

public String getTextLinkColour()

setTextLinkColour

public void setTextLinkColour(String textLinkColour)

getTextActiveLinkColour

public String getTextActiveLinkColour()

setTextActiveLinkColour

public void setTextActiveLinkColour(String textActiveLinkColour)

getHeroButtonTextColour

public String getHeroButtonTextColour()

setHeroButtonTextColour

public void setHeroButtonTextColour(String heroButtonTextColour)

getHeroButtonBaseBGColour

public String getHeroButtonBaseBGColour()

setHeroButtonBaseBGColour

public void setHeroButtonBaseBGColour(String heroButtonBaseBGColour)

getGadgetChromeColor

public String getGadgetChromeColor(String id)

setGadgetChromeColor

public void setGadgetChromeColor(String id,
                                 String gadgetChromeColor)

getApplicationID

public String getApplicationID()

getDefaultBackedString

public String getDefaultBackedString(@Nonnull
                                     String key,
                                     @Nullable
                                     String defaultValue)

Performs a lookup on the application properties for the specified key. If the key returns a null value, returns the default value specified. This would happen if no value exists in the database AND no value exists in the jira-application.properties file.

Parameters:

key - the Application Properties key to look up

defaultValue - the value to return if the key yields null

Returns:

the value of the key in the Application Properties, or the default value specified

getDefaultBackedString

public String getDefaultBackedString(@Nonnull
                                     String key)