com.xpn.xwiki.plugin.skinx

Class JsSkinExtensionPlugin

java.lang.Object

com.xpn.xwiki.plugin.XWikiDefaultPlugin

com.xpn.xwiki.plugin.skinx.AbstractSkinExtensionPlugin

com.xpn.xwiki.plugin.skinx.AbstractDocumentSkinExtensionPlugin

com.xpn.xwiki.plugin.skinx.JsSkinExtensionPlugin

All Implemented Interfaces:

com.xpn.xwiki.internal.cache.rendering.RenderingCacheAware, com.xpn.xwiki.plugin.XWikiPluginInterface, org.xwiki.observation.EventListener

public class JsSkinExtensionPlugin
extends com.xpn.xwiki.plugin.skinx.AbstractDocumentSkinExtensionPlugin

Skin Extension plugin that allows pulling javascript code stored inside wiki documents as XWiki.JavaScriptExtension objects.

Version:

$Id: 67a1b58624a0f960611fcefd6fa178d115fd120a $

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	JSX_CLASS_NAME The name of the XClass storing the code for this type of extensions.
static org.xwiki.model.reference.EntityReference	JSX_CLASS_REFERENCE
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.AbstractDocumentSkinExtensionPlugin

LOGGER

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

contextKey, parametersContextKey

Constructor Summary

Constructors

Constructor and Description
JsSkinExtensionPlugin(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)
protected String	getExtensionClassName()
protected String	getExtensionName()
String	getLink(String documentName, com.xpn.xwiki.XWikiContext context)
void	virtualInit(com.xpn.xwiki.XWikiContext context)

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

getAlwaysUsedExtensions, getAlwaysUsedExtensions, getEvents, getExtensionClass, hasPageExtensions, init, onEvent, use, use

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

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

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xwiki.observation.EventListener

getName

Field Detail

JSX_CLASS_NAME

public static final String JSX_CLASS_NAME

The name of the XClass storing the code for this type of extensions.

See Also:

Constant Field Values

JSX_CLASS_REFERENCE

public static final org.xwiki.model.reference.EntityReference JSX_CLASS_REFERENCE

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

JsSkinExtensionPlugin

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

virtualInit

public void virtualInit(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:

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

Overrides:

virtualInit in class com.xpn.xwiki.plugin.skinx.AbstractDocumentSkinExtensionPlugin

See Also:

XWikiPluginInterface.virtualInit(com.xpn.xwiki.XWikiContext)

getLink

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

Specified by:

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

getExtensionClassName

protected String getExtensionClassName()

Specified by:

getExtensionClassName in class com.xpn.xwiki.plugin.skinx.AbstractDocumentSkinExtensionPlugin

getExtensionName

protected String getExtensionName()

Specified by:

getExtensionName in class com.xpn.xwiki.plugin.skinx.AbstractDocumentSkinExtensionPlugin

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.AbstractDocumentSkinExtensionPlugin

See Also:

AbstractSkinExtensionPlugin.endParsing(String, XWikiContext)