Package com.blueriq.component.api.documents

Interface IDocumentImageProvider

public interface IDocumentImageProvider
Register a Spring bean that implements this interface to provide images to be used in a PDF document generated by the Blueriq Document Renderer.

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,byte[]>
    getImages(com.aquima.interactions.composer.ICompositeElement document, com.aquima.interactions.foundation.text.ILanguage language, com.aquima.interactions.foundation.ApplicationID applicationId, com.aquima.interactions.portal.IPortalContext portalContext)
    This method is used to provide images to be used in a PDF document generated by the Blueriq Document Renderer.

  • Method Details

    • getImages

      Map<String,byte[]> getImages(com.aquima.interactions.composer.ICompositeElement document, com.aquima.interactions.foundation.text.ILanguage language, com.aquima.interactions.foundation.ApplicationID applicationId, com.aquima.interactions.portal.IPortalContext portalContext)
      This method is used to provide images to be used in a PDF document generated by the Blueriq Document Renderer. An image provided through this interface will replace an image already collected by Blueriq in case of a duplicate id.
      Parameters:
      document - The document that is being rendered.
      language - The language used for rendering.
      applicationId - The current application id.
      portalContext - The current portal context.
      Returns:
      a map containing ids and corresponding images that should be used in the document. The id should match the image element name or the content of the element with the image content style.