com.communote.server.web.commons.resource

Class ResourceExtension

java.lang.Object

com.communote.server.web.commons.resource.ResourceExtension

public class ResourceExtension
extends Object

Pojo describing an extension that allows a plugin to provide additional JavaScript or CSS that should be included into different pages.

The inclusion into a page is achieved with the help of categories for JavaScript and CSS. A Category for JavaScript or CSS is identified by a name and is associated with a collection of resources. The author of a page decides which categories and thus which resources are required for the page. This extension provides means to extend existing categories with additional resources or define new ones.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
ResourceExtension()

Method Summary

Modifier and Type	Method and Description
Set<ResourceCategoryDefinition>	getDefinitions() Return the definitions of categories for resources.
Map<String,List<String>>	getExtensions() Return the category names that should be extended with additional resources provided by the plugin.
void	setDefinitions(Set<ResourceCategoryDefinition> definitions)
void	setExtensions(Map<String,List<String>> extensions)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceExtension

public ResourceExtension()

Method Detail

getDefinitions

public Set<ResourceCategoryDefinition> getDefinitions()

Return the definitions of categories for resources. A category will temporarily replace an existing one with the same name until the plugin is removed or another plugin is added that defines a category with the same name.

Returns:

the category definitions or null if the plugin does not need to define new categories

getExtensions

public Map<String,List<String>> getExtensions()

Return the category names that should be extended with additional resources provided by the plugin. The resources to be added to the category have to be provided as a list of file paths relative to the 'static' directory within the plugins resources directory. The order of the resource list will be respected when including them. The category names can refer to built-in categories or categories provided by plugins.

Returns:

a mapping from category name to a collection of resources that should be added to that category. Can be null if the plugin does not need to extend categories.

setDefinitions

public void setDefinitions(Set<ResourceCategoryDefinition> definitions)

Parameters:

definitions - the category definitions to set or null if the plugin does not need to define new categories

See Also:

getDefinitions()

setExtensions

public void setExtensions(Map<String,List<String>> extensions)

Parameters:

extensions - a mapping from category name to a collection of resources that should be added to that category. Can be null if the plugin does not need to extend categories.

See Also:

getExtensions()