com.atlassian.jira.lookandfeel
Class LookAndFeelPropertiesImpl

java.lang.Object
  extended by com.atlassian.jira.lookandfeel.LookAndFeelPropertiesImpl
All Implemented Interfaces:
LookAndFeelProperties

public class LookAndFeelPropertiesImpl
extends Object
implements LookAndFeelProperties


Constructor Summary
LookAndFeelPropertiesImpl(com.atlassian.sal.api.pluginsettings.PluginSettingsFactory pluginSettingsFactory, ApplicationProperties applicationProperties, UploadService uploadService)
           
 
Method Summary
 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()
          Internal method, don't use
 void resetDefaultLogo()
          Reset the default logo to the original logo shipped with JIRA.
 void resetDefaultLogoUrl()
          Internal method, don't use
 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)
          As of future versions, JIRA will no longer support dynamic adding of default favicons and logos.
 void uploadDefaultLogo(BufferedImage image)
          As of future versions, JIRA will no longer support dynamic adding of default favicons and logos.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LookAndFeelPropertiesImpl

public LookAndFeelPropertiesImpl(com.atlassian.sal.api.pluginsettings.PluginSettingsFactory pluginSettingsFactory,
                                 ApplicationProperties applicationProperties,
                                 UploadService uploadService)
Method Detail

setCustomizeColors

public void setCustomizeColors(boolean value)
Specified by:
setCustomizeColors in interface LookAndFeelProperties

getCustomizeColors

public boolean getCustomizeColors()
Specified by:
getCustomizeColors in interface LookAndFeelProperties

setLogoChoice

public void setLogoChoice(LogoChoice choice)
Specified by:
setLogoChoice in interface LookAndFeelProperties

getLogoChoice

public LogoChoice getLogoChoice()
Specified by:
getLogoChoice in interface LookAndFeelProperties

setFaviconChoice

public void setFaviconChoice(LogoChoice choice)
Specified by:
setFaviconChoice in interface LookAndFeelProperties

getFaviconChoice

public LogoChoice getFaviconChoice()
Specified by:
getFaviconChoice in interface LookAndFeelProperties

reset

public void reset()
Description copied from interface: LookAndFeelProperties
Reset all L&F properties to defaults.

Specified by:
reset in interface LookAndFeelProperties

uploadDefaultLogo

public void uploadDefaultLogo(BufferedImage image)
Description copied from interface: LookAndFeelProperties
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 #LookAndFeelProperties.setDefaultLogo(String, String, String) instead. Note that JIRA already provides ability to upload custom logos and favicons in its Administration section.

Specified by:
uploadDefaultLogo in interface LookAndFeelProperties
Parameters:
image - image to upload

setDefaultLogo

public void setDefaultLogo(String url,
                           String width,
                           String height)
Description copied from interface: LookAndFeelProperties
Set 'custom' default logo for this JIRA instance. It will be used as the 'Default' option for logo in the Look & Feel JIRA settings.

Specified by:
setDefaultLogo in interface LookAndFeelProperties
Parameters:
url - URL of the logo
width - width of the logo
height - height of the logo

resetDefaultLogo

public void resetDefaultLogo()
Description copied from interface: LookAndFeelProperties
Reset the default logo to the original logo shipped with JIRA.

Specified by:
resetDefaultLogo in interface LookAndFeelProperties

uploadDefaultFavicon

public void uploadDefaultFavicon(BufferedImage image)
Description copied from interface: LookAndFeelProperties
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 #LookAndFeelProperties.setDefaultFavicon(String, String, String) instead. Note that JIRA already provides ability to upload custom logos and favicons in its Administration section.

Specified by:
uploadDefaultFavicon in interface LookAndFeelProperties
Parameters:
image - image to upload

setDefaultFavicon

public void setDefaultFavicon(String url,
                              String width,
                              String height)
Description copied from interface: LookAndFeelProperties
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.

Specified by:
setDefaultFavicon in interface LookAndFeelProperties
Parameters:
url - URL of the favicon
width - width of the favicon
height - height of the favicon

setDefaultFavicon

public void setDefaultFavicon(String url,
                              String hiresUrl,
                              String width,
                              String height)
Description copied from interface: LookAndFeelProperties
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.

Specified by:
setDefaultFavicon in interface LookAndFeelProperties
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

public void resetDefaultFavicon()
Description copied from interface: LookAndFeelProperties
Reset the default favicon to the original logo shipped with JIRA.

Specified by:
resetDefaultFavicon in interface LookAndFeelProperties

isUsingCustomDefaultLogo

public boolean isUsingCustomDefaultLogo()
Specified by:
isUsingCustomDefaultLogo in interface LookAndFeelProperties

isUsingCustomDefaultFavicon

public boolean isUsingCustomDefaultFavicon()
Specified by:
isUsingCustomDefaultFavicon in interface LookAndFeelProperties

getDefaultCssLogoUrl

public String getDefaultCssLogoUrl()
Description copied from interface: LookAndFeelProperties
URL to the default logo for display in the L&F configuration section.

Specified by:
getDefaultCssLogoUrl in interface LookAndFeelProperties
Returns:
current default logo URL

getDefaultLogoUrl

public String getDefaultLogoUrl()
Description copied from interface: LookAndFeelProperties
Get the default logo URL of this JIRA instance. This is not necessarily the logo currently served.

Specified by:
getDefaultLogoUrl in interface LookAndFeelProperties
Returns:
default logo URL

getDefaultFaviconUrl

public String getDefaultFaviconUrl()
Description copied from interface: LookAndFeelProperties
Get the default favicon URL of this JIRA instance. This is not necessarily the favicon currently served.

Specified by:
getDefaultFaviconUrl in interface LookAndFeelProperties
Returns:
default favicon URL

getDefaultFaviconHiresUrl

public String getDefaultFaviconHiresUrl()
Description copied from interface: LookAndFeelProperties
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.

Specified by:
getDefaultFaviconHiresUrl in interface LookAndFeelProperties
Returns:
default favicon URL

setBlackArrow

public void setBlackArrow(boolean blackArrow)
Specified by:
setBlackArrow in interface LookAndFeelProperties

isBlackArrow

public boolean isBlackArrow()
Specified by:
isBlackArrow in interface LookAndFeelProperties

resetDefaultFaviconUrl

public void resetDefaultFaviconUrl()
Description copied from interface: LookAndFeelProperties
Internal method, don't use

Specified by:
resetDefaultFaviconUrl in interface LookAndFeelProperties

resetDefaultLogoUrl

public void resetDefaultLogoUrl()
Description copied from interface: LookAndFeelProperties
Internal method, don't use

Specified by:
resetDefaultLogoUrl in interface LookAndFeelProperties

isApplicationTitleShownOnLogo

public boolean isApplicationTitleShownOnLogo()
Description copied from interface: LookAndFeelProperties
Whether the site title should be shown next to the logo.

Specified by:
isApplicationTitleShownOnLogo in interface LookAndFeelProperties
Returns:
true if the site title should be shown next the logo; otherwise, false.

setApplicationTitleShownOnLogoTo

public void setApplicationTitleShownOnLogoTo(boolean shouldShow)
Description copied from interface: LookAndFeelProperties
Configures whether JIRA shows the application title next to the logo.

Specified by:
setApplicationTitleShownOnLogoTo in interface LookAndFeelProperties
Parameters:
shouldShow - true if JIRA should show the application title next to the logo.

getMaxLogoHeight

public int getMaxLogoHeight()
Specified by:
getMaxLogoHeight in interface LookAndFeelProperties


Copyright © 2002-2014 Atlassian. All Rights Reserved.