com.atlassian.jira.lookandfeel

Interface LookAndFeelProperties

All Known Implementing Classes:

LookAndFeelPropertiesImpl

public interface LookAndFeelProperties

Since:

v4.4

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getCustomizeColors()
String	getDefaultCssLogoUrl() URL to the default logo for display in the L&F configuration section.
String	getDefaultFaviconHiresUrl() Get the default favicon URL of this JIRA instance.
String	getDefaultFaviconUrl() Get the default favicon URL of this JIRA instance.
String	getDefaultLogoUrl() Get the default logo URL of this JIRA instance.
LogoChoice	getFaviconChoice()
LogoChoice	getLogoChoice()
int	getMaxLogoHeight()
boolean	isApplicationTitleShownOnLogo() Whether the site title should be shown next to the logo.
boolean	isBlackArrow()
boolean	isUsingCustomDefaultFavicon()
boolean	isUsingCustomDefaultLogo()
void	reset() Reset all L&F properties to defaults.
void	resetDefaultFavicon() Reset the default favicon to the original logo shipped with JIRA.
void	resetDefaultFaviconUrl() Deprecated. not for external usage, subject to removing
void	resetDefaultLogo() Reset the default logo to the original logo shipped with JIRA.
void	resetDefaultLogoUrl() Deprecated. not for external usage, subject to removing
void	setApplicationTitleShownOnLogoTo(boolean shouldShow) Configures whether JIRA shows the application title next to the logo.
void	setBlackArrow(boolean blackArrow)
void	setCustomizeColors(boolean value)
void	setDefaultFavicon(String url, String width, String height) Set 'custom' default favicon for this JIRA instance.
void	setDefaultFavicon(String url, String hiresUrl, String width, String height) Set 'custom' default favicon for this JIRA instance.
void	setDefaultLogo(String url, String width, String height) Set 'custom' default logo for this JIRA instance.
void	setFaviconChoice(LogoChoice choice)
void	setLogoChoice(LogoChoice choice)
void	uploadDefaultFavicon(BufferedImage image) Deprecated. use setDefaultFavicon(String, String, String) instead
void	uploadDefaultLogo(BufferedImage image) Deprecated. use setDefaultFavicon(String, String, String) instead

Method Detail

setCustomizeColors

void setCustomizeColors(boolean value)

getCustomizeColors

boolean getCustomizeColors()

setLogoChoice

void setLogoChoice(LogoChoice choice)

getLogoChoice

LogoChoice getLogoChoice()

setFaviconChoice

void setFaviconChoice(LogoChoice choice)

getFaviconChoice

LogoChoice getFaviconChoice()

uploadDefaultLogo

void uploadDefaultLogo(BufferedImage image)

Deprecated. use setDefaultFavicon(String, String, String) instead

As of future versions, JIRA will no longer support dynamic adding of default favicons and logos. Plugins that wish to modify default logo should add the logo as a web resource and use #setDefaultLogo(String, String, String) instead. Note that JIRA already provides ability to upload custom logos and favicons in its Administration section.

Parameters:

image - image to upload

setDefaultLogo

void setDefaultLogo(String url,
                  String width,
                  String height)

Set 'custom' default logo for this JIRA instance. It will be used as the 'Default' option for logo in the Look & Feel JIRA settings.

Parameters:

url - URL of the logo

width - width of the logo

height - height of the logo

resetDefaultLogo

void resetDefaultLogo()

Reset the default logo to the original logo shipped with JIRA.

uploadDefaultFavicon

@Deprecated
void uploadDefaultFavicon(BufferedImage image)

Deprecated. use setDefaultFavicon(String, String, String) instead

As of future versions, JIRA will no longer support dynamic adding of default favicons and logos. Plugins that wish to modify default favicon should add the favicon as a web resource and use #setDefaultFavicon(String, String, String) instead. Note that JIRA already provides ability to upload custom logos and favicons in its Administration section.

Parameters:

image - image to upload

setDefaultFavicon

void setDefaultFavicon(String url,
                     String width,
                     String height)

Set 'custom' default favicon for this JIRA instance. It will be used as the 'Default' option for the favicon in the Look & Feel JIRA settings.

Parameters:

url - URL of the favicon

width - width of the favicon

height - height of the favicon

setDefaultFavicon

void setDefaultFavicon(String url,
                     String hiresUrl,
                     String width,
                     String height)

Set 'custom' default favicon for this JIRA instance. It will be used as the 'Default' option for the favicon in the Look & Feel JIRA settings.

Parameters:

url - URL of the favicon

hiresUrl - URL of the favicon in high resolution for display in L&F admin

width - width of the favicon

height - height of the favicon

resetDefaultFavicon

void resetDefaultFavicon()

Reset the default favicon to the original logo shipped with JIRA.

reset

void reset()

Reset all L&F properties to defaults.

isBlackArrow

boolean isBlackArrow()

setBlackArrow

void setBlackArrow(boolean blackArrow)

isUsingCustomDefaultLogo

boolean isUsingCustomDefaultLogo()

isUsingCustomDefaultFavicon

boolean isUsingCustomDefaultFavicon()

getDefaultCssLogoUrl

String getDefaultCssLogoUrl()

URL to the default logo for display in the L&F configuration section.

Returns:

current default logo URL

getDefaultLogoUrl

String getDefaultLogoUrl()

Get the default logo URL of this JIRA instance. This is not necessarily the logo currently served.

Returns:

default logo URL

getDefaultFaviconUrl

String getDefaultFaviconUrl()

Get the default favicon URL of this JIRA instance. This is not necessarily the favicon currently served.

Returns:

default favicon URL

getDefaultFaviconHiresUrl

String getDefaultFaviconHiresUrl()

Get the default favicon URL of this JIRA instance. This is not necessarily the favicon currently served. This is URL to the favicon in high resolution, for display in L&F administration.

Returns:

default favicon URL

resetDefaultFaviconUrl

@Deprecated
void resetDefaultFaviconUrl()

Deprecated. not for external usage, subject to removing

Internal method, don't use

resetDefaultLogoUrl

@Deprecated
void resetDefaultLogoUrl()

Deprecated. not for external usage, subject to removing

Internal method, don't use

isApplicationTitleShownOnLogo

boolean isApplicationTitleShownOnLogo()

Whether the site title should be shown next to the logo.

Returns:

true if the site title should be shown next the logo; otherwise, false.

setApplicationTitleShownOnLogoTo

void setApplicationTitleShownOnLogoTo(boolean shouldShow)

Configures whether JIRA shows the application title next to the logo.

Parameters:

shouldShow - true if JIRA should show the application title next to the logo.

getMaxLogoHeight

int getMaxLogoHeight()