Summary: Methods | [Expand All]
public interface

LookAndFeelProperties

com.atlassian.jira.lookandfeel.LookAndFeelProperties
Known Indirect Subclasses

Summary

Public Methods
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.
@Deprecated void resetDefaultFaviconUrl()
This method is deprecated. not for external usage, subject to removing
void resetDefaultLogo()
Reset the default logo to the original logo shipped with JIRA.
@Deprecated void resetDefaultLogoUrl()
This method is 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)
@Deprecated void uploadDefaultFavicon(BufferedImage image)
This method is deprecated. use setDefaultFavicon(String, String, String) instead
void uploadDefaultLogo(BufferedImage image)
This method is deprecated. use setDefaultFavicon(String, String, String) instead

Public Methods

public boolean getCustomizeColors ()

public String getDefaultCssLogoUrl ()

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

Returns
  • current default logo URL

public 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

public String getDefaultFaviconUrl ()

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

Returns
  • default favicon URL

public String getDefaultLogoUrl ()

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

Returns
  • default logo URL

public LogoChoice getFaviconChoice ()

public LogoChoice getLogoChoice ()

public int getMaxLogoHeight ()

public 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.

public boolean isBlackArrow ()

public boolean isUsingCustomDefaultFavicon ()

public boolean isUsingCustomDefaultLogo ()

public void reset ()

Reset all L&F properties to defaults.

public void resetDefaultFavicon ()

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

@Deprecated public void resetDefaultFaviconUrl ()

This method is deprecated.
not for external usage, subject to removing

Internal method, don't use

public void resetDefaultLogo ()

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

@Deprecated public void resetDefaultLogoUrl ()

This method is deprecated.
not for external usage, subject to removing

Internal method, don't use

public 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.

public void setBlackArrow (boolean blackArrow)

public void setCustomizeColors (boolean value)

public 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

public 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

public 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

public void setFaviconChoice (LogoChoice choice)

public void setLogoChoice (LogoChoice choice)

@Deprecated public void uploadDefaultFavicon (BufferedImage image)

This method is 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

public void uploadDefaultLogo (BufferedImage image)

This method is 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