com.atlassian.confluence.plugin.webresource
Class DefaultConfluenceWebResourceManager

java.lang.Object
  extended by com.atlassian.plugin.webresource.WebResourceManagerImpl
      extended by com.atlassian.confluence.plugin.webresource.DefaultConfluenceWebResourceManager
All Implemented Interfaces:
ConfluenceWebResourceManager, com.atlassian.plugin.webresource.WebResourceManager

public class DefaultConfluenceWebResourceManager
extends com.atlassian.plugin.webresource.WebResourceManagerImpl
implements ConfluenceWebResourceManager


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.atlassian.plugin.webresource.WebResourceManager
com.atlassian.plugin.webresource.WebResourceManager.IncludeMode
 
Field Summary
 
Fields inherited from class com.atlassian.plugin.webresource.WebResourceManagerImpl
batchingConfiguration, dependencyResolver, pluginResourceLocator, webResourceFormatters, webResourceIntegration
 
Fields inherited from interface com.atlassian.plugin.webresource.WebResourceManager
DELAYED_INCLUDE_MODE, INLINE_INCLUDE_MODE
 
Constructor Summary
DefaultConfluenceWebResourceManager(com.atlassian.plugin.webresource.PluginResourceLocator pluginResourceLocator, com.atlassian.plugin.webresource.WebResourceIntegration webResourceIntegration, com.atlassian.plugin.webresource.ResourceBatchingConfiguration batchingConfiguration, ThemeManager themeManager)
           
 
Method Summary
 java.lang.String getCssResources()
          Returns the HTML output of WebResourceManager.includeResources(Writer, UrlMode, WebResourceFilter), which includes references to all the delayed CSS resources requested by WebResourceManager.requireResource(String).
 java.lang.String getGlobalCssResourcePrefix()
          Get the resource prefix for the global CSS file.
 java.lang.String getJsResources()
          Returns the HTML output of WebResourceManager.includeResources(Writer, UrlMode, WebResourceFilter), which includes references to all the delayed Javascript resources requested by WebResourceManager.requireResource(String).
 java.lang.String getResourceContent(java.lang.String resourceName)
          Gets the content of a resource specified.
 java.lang.String getResources()
          Returns the HTML output of WebResourceManager.includeResources(java.io.Writer), which includes references to all the delayed Javascript and CSS resources requested by WebResourceManager.requireResource(String).
 java.lang.String getResourceTags(java.lang.String resourceName)
           
 java.lang.String getSpaceCssPrefix(java.lang.String spaceKey)
          Get the resource prefix for a particular space's CSS file.
 java.lang.String getThemeJsResources(java.lang.String spaceKey)
          Returns the script tags for the theme specific javascript resources.
 void requireResource(java.lang.String resourceName)
          Wraps the parent method to provide logging.
 void requireResourcesForContext(java.lang.String context)
          Requires all resources which have the given context specified in their descriptor
 void setCssResourceCounterManager(CssResourceCounterManager cssResourceCounterManager)
           
 void setPluginAccessor(com.atlassian.plugin.PluginAccessor pluginAccessor)
           
 void setResourceAccessor(ResourceAccessor resourceAccessor)
           
 void setSettingsManager(SettingsManager settingsManager)
           
 
Methods inherited from class com.atlassian.plugin.webresource.WebResourceManagerImpl
getRequiredResources, getRequiredResources, getRequiredResources, getResourceTags, getStaticPluginResource, getStaticPluginResource, getStaticPluginResource, getStaticPluginResource, getStaticPluginResourcePrefix, getStaticResourcePrefix, getStaticResourcePrefix, getStaticResourcePrefix, getStaticResourcePrefix, includeResources, includeResources, includeResources, includeResources, requireResource, requireResource, setIncludeMode
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.atlassian.plugin.webresource.WebResourceManager
getRequiredResources, getRequiredResources, getRequiredResources, getResourceTags, getStaticPluginResource, getStaticPluginResource, getStaticPluginResource, getStaticPluginResource, getStaticPluginResourcePrefix, getStaticResourcePrefix, getStaticResourcePrefix, getStaticResourcePrefix, getStaticResourcePrefix, includeResources, includeResources, includeResources, includeResources, requireResource, requireResource, setIncludeMode
 

Constructor Detail

DefaultConfluenceWebResourceManager

public DefaultConfluenceWebResourceManager(com.atlassian.plugin.webresource.PluginResourceLocator pluginResourceLocator,
                                           com.atlassian.plugin.webresource.WebResourceIntegration webResourceIntegration,
                                           com.atlassian.plugin.webresource.ResourceBatchingConfiguration batchingConfiguration,
                                           ThemeManager themeManager)
Method Detail

getResources

public java.lang.String getResources()
Description copied from interface: ConfluenceWebResourceManager
Returns the HTML output of WebResourceManager.includeResources(java.io.Writer), which includes references to all the delayed Javascript and CSS resources requested by WebResourceManager.requireResource(String). This is a convenience method for velocity templates and is equivalent to calling includeResources with UrlMode.AUTO and DefaultWebResourceFilter.

Specified by:
getResources in interface ConfluenceWebResourceManager

getCssResources

public java.lang.String getCssResources()
Description copied from interface: ConfluenceWebResourceManager
Returns the HTML output of WebResourceManager.includeResources(Writer, UrlMode, WebResourceFilter), which includes references to all the delayed CSS resources requested by WebResourceManager.requireResource(String). This method should only be called once for each request. Multiple calls to this method will result with null being returned. This is a convenience method for velocity templates and is equivalent to calling includeResources with UrlMode.AUTO and CssWebResource.

Specified by:
getCssResources in interface ConfluenceWebResourceManager

getJsResources

public java.lang.String getJsResources()
Description copied from interface: ConfluenceWebResourceManager
Returns the HTML output of WebResourceManager.includeResources(Writer, UrlMode, WebResourceFilter), which includes references to all the delayed Javascript resources requested by WebResourceManager.requireResource(String). This method should only be called once for each request. Multiple calls to this method will result with null being returned. This is a convenience method for velocity templates and is equivalent to calling includeResources with UrlMode.AUTO and JavascriptWebResource.

Specified by:
getJsResources in interface ConfluenceWebResourceManager

getThemeJsResources

public java.lang.String getThemeJsResources(java.lang.String spaceKey)
Description copied from interface: ConfluenceWebResourceManager
Returns the script tags for the theme specific javascript resources. If spaceKey is null or invalid, the globally configured theme resources are returned.

Specified by:
getThemeJsResources in interface ConfluenceWebResourceManager

getResourceTags

public java.lang.String getResourceTags(java.lang.String resourceName)
Specified by:
getResourceTags in interface com.atlassian.plugin.webresource.WebResourceManager
Overrides:
getResourceTags in class com.atlassian.plugin.webresource.WebResourceManagerImpl

requireResource

public void requireResource(java.lang.String resourceName)
Wraps the parent method to provide logging.

Specified by:
requireResource in interface com.atlassian.plugin.webresource.WebResourceManager
Overrides:
requireResource in class com.atlassian.plugin.webresource.WebResourceManagerImpl

requireResourcesForContext

public void requireResourcesForContext(java.lang.String context)
Description copied from interface: ConfluenceWebResourceManager
Requires all resources which have the given context specified in their descriptor

Specified by:
requireResourcesForContext in interface ConfluenceWebResourceManager
Specified by:
requireResourcesForContext in interface com.atlassian.plugin.webresource.WebResourceManager
Overrides:
requireResourcesForContext in class com.atlassian.plugin.webresource.WebResourceManagerImpl
Parameters:
context - The name of the context for which you want to require resources (eg "confluence.main")

getGlobalCssResourcePrefix

public java.lang.String getGlobalCssResourcePrefix()
Description copied from interface: ConfluenceWebResourceManager
Get the resource prefix for the global CSS file. This prefix should be updated every time there is a change to the global theme or colour scheme.

Specified by:
getGlobalCssResourcePrefix in interface ConfluenceWebResourceManager

getSpaceCssPrefix

public java.lang.String getSpaceCssPrefix(java.lang.String spaceKey)
Description copied from interface: ConfluenceWebResourceManager
Get the resource prefix for a particular space's CSS file. This prefix should be updated every time there is a change to the space's theme or colour scheme.

Specified by:
getSpaceCssPrefix in interface ConfluenceWebResourceManager
Parameters:
spaceKey - the key of the space we're viewing the CSS for, or null for the global CSS.

getResourceContent

public java.lang.String getResourceContent(java.lang.String resourceName)
Description copied from interface: ConfluenceWebResourceManager
Gets the content of a resource specified.

Specified by:
getResourceContent in interface ConfluenceWebResourceManager
Parameters:
resourceName - The fully qualified plugin name and resource to include (eg confluence.web.resources:legacy-styles)
Returns:
the content of the resource

setCssResourceCounterManager

public void setCssResourceCounterManager(CssResourceCounterManager cssResourceCounterManager)

setResourceAccessor

public void setResourceAccessor(ResourceAccessor resourceAccessor)

setSettingsManager

public void setSettingsManager(SettingsManager settingsManager)

setPluginAccessor

public void setPluginAccessor(com.atlassian.plugin.PluginAccessor pluginAccessor)


Copyright © 2003-2010 Atlassian. All Rights Reserved.