Class LookAndFeelBean
java.lang.Object
com.atlassian.jira.config.properties.LookAndFeelBean
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 ClassesModifier and TypeClassDescriptionstatic final classThese are the "intended" colours for the Jira Header.static final classThese are the intended colours for the new common Header.static classstatic class -
Method Summary
Modifier and TypeMethodDescriptionReturns the URL for the dark theme logo.getDefaultBackedString(String key, String defaultValue) Performs a lookup on the application properties for the specified key.static LookAndFeelBeanDeprecated.since 7.9.0.static LookAndFeelBeangetInstance(ApplicationProperties ap, LnFDefaultColorProvider lnFDefaultColorProvider) Deprecated.since 7.10.0.static LookAndFeelBeangetInstance(ApplicationProperties ap, LnFDefaultColorProvider lnFDefaultColorProvider, LogoProvider logoProvider) Returns the URL for the light theme logo.Deprecated.since 8.15.Optional<com.atlassian.theme.api.ThemeColorMode> Returns the theme, for which logo is customized, only if logo is configured only for that theme.protected StringgetValue(com.atlassian.jira.config.properties.LookAndFeelBean.LnF config) booleanDeprecated.in Jira 6.0 -- the common header is always enabled.voidsetFaviconHiResUrl(String faviconUrl) voidsetFaviconUrl(String faviconUrl) voidsetGadgetChromeColor(String id, String gadgetChromeColor) voidsetHeroButtonBaseBGColour(String heroButtonBaseBGColour) voidsetHeroButtonTextColour(String heroButtonTextColour) voidsetLogoDarkUrl(String logoUrl) Sets the logo for the dark theme.voidsetLogoHeight(String logoHeight) voidsetLogoUrl(String logoUrl) Sets the logo for the light theme.voidsetLogoWidth(String logoWidth) voidsetMenuBackgroundColour(String menuBackgroundColour) voidsetMenuSeparatorColour(String menuSeparatorColour) voidsetMenuTxtColour(String menuTxtColour) voidsetTextActiveLinkColour(String textActiveLinkColour) voidsetTextHeadingColour(String textHeadingColour) voidsetTextLinkColour(String textLinkColour) voidsetTopBackgroundColour(String topBackgroundColour) voidsetTopHighlightColor(String newValue) voidsetTopSeparatorBackgroundColor(String newValue) voidsetTopTextHighlightColor(String newValue) voidsetTopTxtColour(String topTxtColour) Deprecated.Since v7.0Deprecated.since 8.15.
-
Method Details
-
getInstance
Deprecated. -
getInstance
@Deprecated public static LookAndFeelBean getInstance(ApplicationProperties ap, LnFDefaultColorProvider lnFDefaultColorProvider) Deprecated. -
getInstance
public static LookAndFeelBean getInstance(ApplicationProperties ap, LnFDefaultColorProvider lnFDefaultColorProvider, LogoProvider logoProvider) -
isCommonHeader
Deprecated.in Jira 6.0 -- the common header is always enabled.- Returns:
- true
-
stripHash
Deprecated.Since v7.0- Parameters:
colour-- Returns:
-
updateSettingsHash
Deprecated.since 8.15. UseUiSettingsStateManager.invalidateStateHash(). -
getSettingsHash
Deprecated.since 8.15. UseUiSettingsStateManager.getStateHash(). -
getConfigurationState
-
getLogoUrl
Returns the URL for the light theme logo. If it is default and logo for the dark theme is customized, this returns the dark theme logo.- See Also:
-
getDarkLogoUrl
Returns the URL for the dark theme logo. If it is default and logo for the light theme is customized, this returns the light theme logo.- See Also:
-
getSingleThemeLogo
Returns the theme, for which logo is customized, only if logo is configured only for that theme. If no theme has customized logo, returns empty Optional. If both themes have customized logo, returns empty Optional. -
setLogoUrl
Sets the logo for the light theme.- Parameters:
logoUrl- - path to the logo image resource- See Also:
-
setLogoDarkUrl
Sets the logo for the dark theme.- Parameters:
logoUrl- - path to the logo image resource- See Also:
-
getAbsoluteLogoUrl
-
getLogoWidth
-
setLogoWidth
-
getLogoPixelWidth
-
getLogoHeight
-
setLogoHeight
-
getLogoPixelHeight
-
getFaviconUrl
-
setFaviconUrl
-
getFaviconWidth
-
getFaviconHeight
-
getFaviconHiResUrl
-
setFaviconHiResUrl
-
getFaviconHiResWidth
-
getFaviconHiResHeight
-
getTopBackgroundColour
-
setTopBackgroundColour
-
getTopTxtColour
-
setTopTxtColour
-
getTopHighlightColor
-
setTopHighlightColor
-
getValue
@Nullable protected String getValue(@Nonnull com.atlassian.jira.config.properties.LookAndFeelBean.LnF config) -
getTopTextHighlightColor
-
setTopTextHighlightColor
-
getTopSeparatorBackgroundColor
-
setTopSeparatorBackgroundColor
-
getMenuTxtColour
-
setMenuTxtColour
-
getMenuBackgroundColour
-
setMenuBackgroundColour
-
getMenuSeparatorColour
-
setMenuSeparatorColour
-
getTextHeadingColour
-
setTextHeadingColour
-
getTextLinkColour
-
setTextLinkColour
-
getTextActiveLinkColour
-
setTextActiveLinkColour
-
getHeroButtonTextColour
-
setHeroButtonTextColour
-
getHeroButtonBaseBGColour
-
setHeroButtonBaseBGColour
-
getGadgetChromeColor
-
setGadgetChromeColor
-
getApplicationID
-
getDefaultBackedString
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 updefaultValue- 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
-