org.xwiki.uiextension

Interface UIExtension

@Role
public interface UIExtension

Represents a User Interface Extension.

Since:

4.2M3

Version:

$Id: 1c0f1d707b8afe19e6e3198a71c3b8b868dba534 $

Method Summary

Modifier and Type	Method and Description
org.xwiki.rendering.block.Block	execute()
String	getExtensionPointId()
String	getId()
Map<String,String>	getParameters() A map of parameters provided by the extension.

Method Detail

getId

String getId()

Returns:

the ID of this extension

getExtensionPointId

String getExtensionPointId()

Returns:

the ID of the extension point this UI extension is providing an extension for

getParameters

Map<String,String> getParameters()

A map of parameters provided by the extension. When providing a new Extension Point the developer must document the list of parameters he requires.

Returns:

a map of parameters provided by the extension

execute

org.xwiki.rendering.block.Block execute()

Returns:

the Block that must be rendered when this extension is displayed