Package de.espirit.firstspirit.client.plugin

Interface ExternalPreviewItem

All Superinterfaces:
Item<ExternalPreviewContext>
public interface ExternalPreviewItem extends Item<ExternalPreviewContext>
Provides access to an external preview service. This item might be used to support previews for multiple devices and browsers.
Since:
5.2.101

  • Method Details

    • getLabel

      String getLabel(@NotNull @NotNull ExternalPreviewContext context)
      Returns a human-readable title representing this report plug-in.
      Parameters:
      context - The context to be considered for providing a label.
      Returns:
      plugin title.
      Since:
      5.2.101

    • getIcon

      @Nullable @Nullable Icon getIcon(@NotNull @NotNull ExternalPreviewContext context)
      Returns an icon representing this report plug-in, or null if not available.
      Parameters:
      context - The context to be considered for providing an icon.
      Returns:
      plugin icon or null.
      Since:
      5.2.101

    • getBrowserType

      @Nullable @Nullable EngineType getBrowserType()
      Returns the browser type to be used for opening an application tab, or null if the current default browser should be used.
      Returns:
      The preferred browser type, or null
      Since:
      5.2.101

    • getUrl

      @Nullable @Nullable String getUrl(@NotNull @NotNull ExternalPreviewContext context)
      Provides an url for the given IDProvider. This method may generate and deploy the related page for usage in an external webservice.
      Parameters:
      context - The context to be considered for providing a url.
      Returns:
      The url of the external webservice to be displayed.
      Since:
      5.2.101