com.xpn.xwiki.plugin.skinx
Class SkinFileExtensionPluginApi

java.lang.Object
  com.xpn.xwiki.api.Api
      com.xpn.xwiki.plugin.PluginApi<AbstractSkinExtensionPlugin>
          com.xpn.xwiki.plugin.skinx.SkinExtensionPluginApi
              com.xpn.xwiki.plugin.skinx.SkinFileExtensionPluginApi

public class SkinFileExtensionPluginApi
extends SkinExtensionPluginApi

API for the SkinExtension Plugin.

Version:

$Id: 2ab98e4a5eb11a57f56541ca9ef13e2ec6080e50 $

See Also:

PluginApi, SkinExtensionPluginApi

Field Summary

Fields inherited from class com.xpn.xwiki.api.Api

context

Constructor Summary

SkinFileExtensionPluginApi(AbstractSkinExtensionPlugin plugin, com.xpn.xwiki.XWikiContext context)
XWiki Plugin API constructor.

Method Summary

void	use(String resource) Mark a resource as used in the current result.
void	use(String resource, boolean forceSkinAction) Mark a resource as used in the current result.

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

getImportString, use

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

getInternalPlugin, getProtectedPlugin, setPlugin

Methods inherited from class com.xpn.xwiki.api.Api

convert, convert, getXWikiContext, hasAccessLevel, hasAdminRights, hasProgrammingRights, hasWikiAdminRights

Methods inherited from class java.lang.Object

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

Constructor Detail

SkinFileExtensionPluginApi

public SkinFileExtensionPluginApi(AbstractSkinExtensionPlugin plugin,
                                  com.xpn.xwiki.XWikiContext context)

XWiki Plugin API constructor.

Parameters:

plugin - The wrapped plugin.

context - The current request context.

See Also:

PluginApi.PluginApi(com.xpn.xwiki.plugin.XWikiPluginInterface, XWikiContext)

Method Detail

use

public void use(String resource)

Mark a resource as used in the current result. A resource is registered only once per request, further calls will not result in additional links, even if it is pulled with different parameters.

Overrides:

use in class SkinExtensionPluginApi

Parameters:

resource - The name of the resource to pull.

See Also:

AbstractSkinExtensionPlugin.use(String, XWikiContext)

use

public void use(String resource,
                boolean forceSkinAction)

Mark a resource as used in the current result. A resource is registered only once per request, further calls will not result in additional links, even if it is pulled with different parameters.

Parameters:

resource - The name of the resource to pull.

forceSkinAction - True if the resource should be pulled by the 'skin' action.

See Also:

AbstractSkinExtensionPlugin.use(String, XWikiContext)