com.xpn.xwiki.plugin.skinx

Class AbstractResourceSkinExtensionPlugin

java.lang.Object

com.xpn.xwiki.plugin.XWikiDefaultPlugin

com.xpn.xwiki.plugin.skinx.AbstractSkinExtensionPlugin

com.xpn.xwiki.plugin.skinx.AbstractResourceSkinExtensionPlugin

All Implemented Interfaces:

com.xpn.xwiki.internal.cache.rendering.RenderingCacheAware, com.xpn.xwiki.plugin.XWikiPluginInterface

public abstract class AbstractResourceSkinExtensionPlugin
extends com.xpn.xwiki.plugin.skinx.AbstractSkinExtensionPlugin

Skin Extension plugin to use extension files from JAR resources.

Version:

$Id: 75f450dc803e0868df7c57610db93c093d2193de $

Field Summary

Fields inherited from class com.xpn.xwiki.plugin.skinx.AbstractSkinExtensionPlugin

contextKey, parametersContextKey

Constructor Summary

Constructors

Constructor and Description
AbstractResourceSkinExtensionPlugin(String name, String className, com.xpn.xwiki.XWikiContext context) XWiki plugin constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract String	generateLink(String url, String resourceName, com.xpn.xwiki.XWikiContext context) Takes a URL string and outputs a link which will cause the browser to load the url.
protected abstract String	getAction() Get the action which the url should specify for calling this resource.
Set<String>	getAlwaysUsedExtensions(com.xpn.xwiki.XWikiContext context)
String	getLink(String resourceName, com.xpn.xwiki.XWikiContext context)
boolean	hasPageExtensions(com.xpn.xwiki.XWikiContext context)

Methods inherited from class com.xpn.xwiki.plugin.skinx.AbstractSkinExtensionPlugin

endParsing, getCacheResources, getImportString, getParameter, getParametersForResource, getParametersMap, getPluginApi, getPulledResources, initializeRequestListIfNeeded, parametersAsQueryString, restoreCacheResources, sanitize, use, use

Methods inherited from class com.xpn.xwiki.plugin.XWikiDefaultPlugin

beginParsing, beginRendering, commonTagsHandler, downloadAttachment, endRendering, endRenderingHandler, flushCache, flushCache, getClassName, getLocalization, getName, init, insidePREHandler, localizePlainOrKey, outsidePREHandler, setClassName, setName, startRenderingHandler, virtualInit

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractResourceSkinExtensionPlugin

public AbstractResourceSkinExtensionPlugin(String name,
                                           String className,
                                           com.xpn.xwiki.XWikiContext context)

XWiki plugin constructor.

Parameters:

name - The name of the plugin, which can be used for retrieving the plugin API from velocity. Unused.

className - The canonical classname of the plugin. Unused.

context - The current request context.

See Also:

XWikiDefaultPlugin(String,String,com.xpn.xwiki.XWikiContext)

Method Detail

getAction

protected abstract String getAction()

Get the action which the url should specify for calling this resource.

Returns:

String Action name.

generateLink

protected abstract String generateLink(String url,
                                       String resourceName,
                                       com.xpn.xwiki.XWikiContext context)

Takes a URL string and outputs a link which will cause the browser to load the url.

Parameters:

url - String representation of the url to load (eg: /res/url.js)

resourceName - name of the pulled resource

context - the current request context

Returns:

HTML code linking to the pulled resource (eg: <script type="text/javascript" src="/res/url.js"/>)

getLink

public String getLink(String resourceName,
                      com.xpn.xwiki.XWikiContext context)

Specified by:

getLink in class com.xpn.xwiki.plugin.skinx.AbstractSkinExtensionPlugin

getAlwaysUsedExtensions

public Set<String> getAlwaysUsedExtensions(com.xpn.xwiki.XWikiContext context)

There is no support for always used resource-based extensions yet.

Specified by:

getAlwaysUsedExtensions in class com.xpn.xwiki.plugin.skinx.AbstractSkinExtensionPlugin

See Also:

AbstractSkinExtensionPlugin.getAlwaysUsedExtensions(XWikiContext)

hasPageExtensions

public boolean hasPageExtensions(com.xpn.xwiki.XWikiContext context)

Not supported for resource extensions.

Specified by:

hasPageExtensions in class com.xpn.xwiki.plugin.skinx.AbstractSkinExtensionPlugin

See Also:

AbstractSkinExtensionPlugin.hasPageExtensions(com.xpn.xwiki.XWikiContext)