com.xpn.xwiki.plugin.skinx
Class JsSkinExtensionPlugin

java.lang.Object
  com.xpn.xwiki.plugin.XWikiDefaultPlugin
      com.xpn.xwiki.plugin.skinx.SkinExtensionPlugin
          com.xpn.xwiki.plugin.skinx.AbstractDocumentSkinExtensionPlugin
              com.xpn.xwiki.plugin.skinx.JsSkinExtensionPlugin

All Implemented Interfaces:

com.xpn.xwiki.notify.XWikiActionNotificationInterface, com.xpn.xwiki.notify.XWikiDocChangeNotificationInterface, com.xpn.xwiki.plugin.XWikiPluginInterface

public class JsSkinExtensionPlugin
extends AbstractDocumentSkinExtensionPlugin

Field Summary

static java.lang.String

JSX_CLASS_NAME

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

LOG

Fields inherited from interface com.xpn.xwiki.notify.XWikiDocChangeNotificationInterface

EVENT_CHANGE, EVENT_DELETE, EVENT_NEW, EVENT_UPDATE_CLASS, EVENT_UPDATE_CONTENT, EVENT_UPDATE_OBJECT

Constructor Summary

JsSkinExtensionPlugin(java.lang.String name, java.lang.String className, com.xpn.xwiki.XWikiContext context)

Method Summary

void	beginParsing(com.xpn.xwiki.XWikiContext context)
java.lang.String	endParsing(java.lang.String content, com.xpn.xwiki.XWikiContext context)
protected java.lang.String	getExtensionClassName()
protected java.lang.String	getExtensionName()
java.lang.String	getLink(java.lang.String documentName, com.xpn.xwiki.XWikiContext context) Abstract method for obtaining a link that points to the actual pulled resource.
java.lang.String	getName()
void	init(com.xpn.xwiki.XWikiContext context)
void	virtualInit(com.xpn.xwiki.XWikiContext context)

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

getAlwaysUsedExtensions, getExtensionClass, notify, notify

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

getImportString, getPluginApi, getRequestList, initializeRequestListIfNeeded, use

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

beginRendering, commonTagsHandler, downloadAttachment, endRendering, endRenderingHandler, flushCache, flushCache, getClassName, insidePREHandler, outsidePREHandler, setClassName, setName, startRenderingHandler

Methods inherited from class java.lang.Object

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

Field Detail

JSX_CLASS_NAME

public static final java.lang.String JSX_CLASS_NAME

See Also:

Constant Field Values

Constructor Detail

JsSkinExtensionPlugin

public JsSkinExtensionPlugin(java.lang.String name,
                             java.lang.String className,
                             com.xpn.xwiki.XWikiContext context)

Method Detail

getName

public java.lang.String getName()

Specified by:

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

Overrides:

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

See Also:

XWikiDefaultPlugin.getName()

getLink

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

Description copied from class: SkinExtensionPlugin

Abstract method for obtaining a link that points to the actual pulled resource. Each type of resource has its own format for the link, for example Javascript uses <script src="/path/to/Document">, while CSS uses <link rel="stylesheet" href="/path/to/Document"> (the actual syntax is longer, this is just a simplified example).

Specified by:

getLink in class SkinExtensionPlugin

Parameters:

documentName - the name of the wiki document holding the resource.

context - the current request context, needed to access the URLFactory.

Returns:

A String representation of the linking element that should be printed in the generated HTML.

getExtensionClassName

protected java.lang.String getExtensionClassName()

Specified by:

getExtensionClassName in class AbstractDocumentSkinExtensionPlugin

getExtensionName

protected java.lang.String getExtensionName()

Specified by:

getExtensionName in class AbstractDocumentSkinExtensionPlugin

beginParsing

public void beginParsing(com.xpn.xwiki.XWikiContext context)

Description copied from class: SkinExtensionPlugin

Specified by:

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

Overrides:

beginParsing in class AbstractDocumentSkinExtensionPlugin

See Also:

XWikiDefaultPlugin.beginParsing(XWikiContext)

endParsing

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

Description copied from class: SkinExtensionPlugin

Specified by:

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

Overrides:

endParsing in class AbstractDocumentSkinExtensionPlugin

See Also:

XWikiDefaultPlugin.endParsing(String, XWikiContext)

init

public void init(com.xpn.xwiki.XWikiContext context)

Specified by:

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

Overrides:

init in class AbstractDocumentSkinExtensionPlugin

See Also:

XWikiDefaultPlugin.init(com.xpn.xwiki.XWikiContext)

virtualInit

public void virtualInit(com.xpn.xwiki.XWikiContext context)

Specified by:

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

Overrides:

virtualInit in class AbstractDocumentSkinExtensionPlugin

See Also:

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