com.xpn.xwiki.plugin.skinx

Class CssSkinFileExtensionPlugin

java.lang.Object

com.xpn.xwiki.plugin.XWikiDefaultPlugin

com.xpn.xwiki.plugin.skinx.AbstractSkinExtensionPlugin

com.xpn.xwiki.plugin.skinx.CssSkinFileExtensionPlugin

All Implemented Interfaces:

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

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

CSs Skin File Extension plugin to use css files from the skin.

Since:

1.6

Version:

$Id: 28189aae64dde224d6f2dea1c05e9991f3cf38cd $

Field Summary

Fields

Modifier and Type	Field and Description
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
CssSkinFileExtensionPlugin(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

Constructor Detail

CssSkinFileExtensionPlugin

public CssSkinFileExtensionPlugin(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)