com.atlassian.confluence.themes

Class PluginThemeResource

java.lang.Object

com.atlassian.confluence.themes.PluginThemeResource

All Implemented Interfaces:

ThemeResource, ThemeStylesheet

public class PluginThemeResource
extends java.lang.Object
implements ThemeResource, ThemeStylesheet

A theme stylesheet which is a resource in a plugin.

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.confluence.themes.ThemeResource

ThemeResource.Type

Method Summary

Methods

Modifier and Type	Method and Description
static PluginThemeResource	css(java.lang.String completeModuleKey, com.atlassian.plugin.elements.ResourceDescriptor resourceDescriptor) Creates a theme resource for a stylesheet in a dynamic plugin.
java.lang.String	getCompleteModuleKey() Returns the plugin module key which this stylesheet belongs to, or the plugin key if the resource is specified at the plugin level.
java.lang.String	getLocation() Returns the location of this resource as defined in the plugin xml.
java.lang.String	getName() Returns the name of the stylesheet resource.
ThemeResource.Type	getType()
boolean	isIeOnly() Returns true iff the ieonly param is set to true in the plugin, false otherwise.
static PluginThemeResource	javascript(java.lang.String completeModuleKey, com.atlassian.plugin.elements.ResourceDescriptor resourceDescriptor) Creates a theme resource for a JavaScript file in a dynamic plugin.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

css

public static PluginThemeResource css(java.lang.String completeModuleKey,
                      com.atlassian.plugin.elements.ResourceDescriptor resourceDescriptor)

Creates a theme resource for a stylesheet in a dynamic plugin.

Parameters:

completeModuleKey - the key of the module or plugin which the stylesheet resource is in

resourceDescriptor - the resource descriptor for the stylesheet resource

javascript

public static PluginThemeResource javascript(java.lang.String completeModuleKey,
                             com.atlassian.plugin.elements.ResourceDescriptor resourceDescriptor)

Creates a theme resource for a JavaScript file in a dynamic plugin.

Parameters:

completeModuleKey - the key of the module or plugin which the stylesheet resource is in

resourceDescriptor - the resource descriptor for the stylesheet resource

getType

public ThemeResource.Type getType()

Specified by:

getType in interface ThemeResource

getLocation

public java.lang.String getLocation()

Description copied from interface: ThemeResource

Returns the location of this resource as defined in the plugin xml.

Specified by:

getLocation in interface ThemeResource

Specified by:

getLocation in interface ThemeStylesheet

getCompleteModuleKey

public java.lang.String getCompleteModuleKey()

Description copied from interface: ThemeResource

Returns the plugin module key which this stylesheet belongs to, or the plugin key if the resource is specified at the plugin level. Returns null if the resource is not part of a plugin.

Specified by:

getCompleteModuleKey in interface ThemeResource

Specified by:

getCompleteModuleKey in interface ThemeStylesheet

getName

public java.lang.String getName()

Description copied from interface: ThemeResource

Returns the name of the stylesheet resource.

Specified by:

getName in interface ThemeResource

Specified by:

getName in interface ThemeStylesheet

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isIeOnly

public boolean isIeOnly()

Description copied from interface: ThemeResource

Returns true iff the ieonly param is set to true in the plugin, false otherwise.

Specified by:

isIeOnly in interface ThemeResource

Specified by:

isIeOnly in interface ThemeStylesheet

Returns:

true if the ieonly param is set to true.