Interface UIExtension


  • @Role
    public interface UIExtension
    Represents a User Interface Extension.
    Since:
    4.2M3
    Version:
    $Id: cef029bbf121296691801a110befac49127b8f52 $
    • 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
      • execute

        @Unstable
        default org.xwiki.rendering.block.Block execute​(boolean inline)
        Parameters:
        inline - true if the UI extension is executed in an inline context
        Returns:
        the Block that must be rendered when this extension is displayed
        Since:
        14.0RC1