Package com.polarion.alm.ui.server.forms.extensions

Interface IFormExtension

public interface IFormExtension
Interface of form extension - that means a panel which can be displayed in the form of persistent object in Polarion UI. See example com.polarion.example.formextension in Polarion SDK.
Since:
3.6.0

  • Method Details

    • render

      @Deprecated default String render(IPObject object, Map<String,String> attributes)
      Deprecated.
      Deprecated since 3.21.2. This method is kept for backward compatibility. New extensions should implement render(IFormExtensionContext)
      Older versions of Polarion called this method to get the HTML content that should be displayed in the Form or Sidebar of an object. New versions of Polarion call the render(IFormExtensionContext).
      Parameters:
      object - The object that the extension should render the content for, never null.
      attributes - The attributes of the XML configuration tag from the form layout configuration except for the ID attribute
      Returns:
      html string, may return null.

    • render

      @Nullable default String render(@NotNull IFormExtensionContext context)
      Polarion calls this method to get the HTML content that should be displayed in the Form or Sidebar of an object.
      Parameters:
      context - The object containing the contextual information that the extension should use to render the content, never null.
      Returns:
      html string, may return null.
      Since:
      3.21.2

    • getIcon

      @Nullable default String getIcon(@NotNull IPObject object, @Nullable Map<String,String> attributes)
      Returns the icon to be used in the title of the extension on work item form.
      Parameters:
      object - The object for which the extension should render the content, never null.
      attributes - The attributes of the xml configuration tag from the form layout configuration except the id attribute
      Returns:
      file name string, may return null.
      Since:
      3.18.2

    • getLabel

      @Nullable default String getLabel(@NotNull IPObject object, @Nullable Map<String,String> attributes)
      Returns the label to be used in the title of the extension on work item form.
      Parameters:
      object - The object for which the extension should render the content, never null.
      attributes - The attributes of the xml configuration tag from the form layout configuration except the id attribute
      Returns:
      html string, may return null.
      Since:
      3.18.2