com.xpn.xwiki.plugin.skinx

Class JsSkinFileExtensionPlugin

java.lang.Object

com.xpn.xwiki.plugin.XWikiDefaultPlugin

com.xpn.xwiki.plugin.skinx.AbstractSkinExtensionPlugin

com.xpn.xwiki.plugin.skinx.JsSkinFileExtensionPlugin

All Implemented Interfaces:

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

public class JsSkinFileExtensionPlugin
extends com.xpn.xwiki.plugin.skinx.AbstractSkinExtensionPlugin

Javascript Skin File Extension plugin to use js files from the skin.

Since:

1.6

Version:

$Id: 54cf556d89bc79096bebe4a66b8f6801f8e8804c $

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFER_DEFAULT_PARAM The name of the preference (in the configuration file) specifying what is the default value of the defer, in case nothing is specified in the parameters of this extension.
static String	PLUGIN_NAME The identifier for this plugin; used for accessing the plugin from velocity, and as the action returning the extension content.

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

contextKey, parametersContextKey

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	endParsing(String content, com.xpn.xwiki.XWikiContext context)
Set<String>	getAlwaysUsedExtensions(com.xpn.xwiki.XWikiContext context)
String	getLink(String filename, com.xpn.xwiki.XWikiContext context)
String	getName()
com.xpn.xwiki.api.Api	getPluginApi(com.xpn.xwiki.plugin.XWikiPluginInterface plugin, com.xpn.xwiki.XWikiContext context)
boolean	hasPageExtensions(com.xpn.xwiki.XWikiContext context)

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

getCacheResources, getImportString, getParameter, getParametersForResource, getParametersMap, 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, 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

Field Detail

PLUGIN_NAME

public static final String PLUGIN_NAME

The identifier for this plugin; used for accessing the plugin from velocity, and as the action returning the extension content.

See Also:

Constant Field Values

DEFER_DEFAULT_PARAM

public static final String DEFER_DEFAULT_PARAM

The name of the preference (in the configuration file) specifying what is the default value of the defer, in case nothing is specified in the parameters of this extension.

See Also:

Constant Field Values

Constructor Detail

JsSkinFileExtensionPlugin

public JsSkinFileExtensionPlugin(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

getName

public String getName()

Specified by:

getName in interface com.xpn.xwiki.plugin.XWikiPluginInterface

Overrides:

getName in class com.xpn.xwiki.plugin.XWikiDefaultPlugin

getPluginApi

public com.xpn.xwiki.api.Api getPluginApi(com.xpn.xwiki.plugin.XWikiPluginInterface plugin,
                                          com.xpn.xwiki.XWikiContext context)

Specified by:

getPluginApi in interface com.xpn.xwiki.plugin.XWikiPluginInterface

Overrides:

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

getLink

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

Specified by:

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

endParsing

public String endParsing(String content,
                         com.xpn.xwiki.XWikiContext context)

We must override this method since the plugin manager only calls it for classes that provide their own implementation, and not an inherited one.

Specified by:

endParsing in interface com.xpn.xwiki.plugin.XWikiPluginInterface

Overrides:

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

See Also:

AbstractSkinExtensionPlugin.endParsing(String, XWikiContext)

getAlwaysUsedExtensions

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

There is no support for always used skinfile-based extensions.

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 skinfile-based extensions.

Specified by:

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

See Also:

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